iv-org-mirror/shard-radix
1
0
Fork 0
mirror of https://gitea.invidious.io/iv-org/shard-radix.git synced 2024-08-15 00:43:21 +00:00
Code Issues Projects Releases Packages Wiki Activity

Introduce types for forward compiler compatiblity

Browse source 
After Crystal 0.15, compiler will require declare the types used
by instance variables on classes.

This require changes to the usage of `Radix::Tree` by introducing
the type of payload elements it will handle:

    # Will only support symbols as payload
    tree = Radix::Tree(Symbol).new
    tree.add "/", :root

    # Error: cannot add node with anything other than Symbol
    tree.add "/meaning-of-life", 42

The changes ensure future compatibility with Crystal and also
enforces a more declarative usage of `Radix::Tree`.

If necessary, you can combine multiple types to ensure a tree
can contain all the wide range of payloads you need:

    tree = Radix::Tree.new(Foo | Bar | Symbol).new
    tree.add "/", :root
    tree.add "/foo", foo_instance

This change includes:

- Tree, Node and Result has been updated to require types.
- Node is capable of have optional payload (from defined type).
- Documentation has been updated to reflect this change.
This commit is contained in:
Luis Lavena 2016-04-14 20:46:12 -03:00
parent 18bf9b132e
commit 9003075ec7
8 changed files with 190 additions and 109 deletions
Download patch file Download diff file Expand all files Collapse all files

40
spec/radix/node_spec.cr
View file

@ -4,7 +4,7 @@ module Radix
describe Node do
describe "#key=" do
it "accepts change of key after initialization" do
node = Node.new("abc")
node = Node(Nil).new("abc")
node.key.should eq("abc")
node.key = "xyz"
@ -23,39 +23,45 @@ module Radix
node.payload.should eq(1_000)
end
# This example focuses on the internal representation of `payload`
# as inferred from supplied types and default values.
#
# We cannot compare `typeof` against `property!` since it excludes `Nil`
# from the possible types.
it "makes optional to provide a payload" do
node = Node.new("abc")
node = Node(Int32).new("abc")
node.payload?.should be_falsey
typeof(node.@payload).should eq(Int32 | Nil)
end
end
describe "#priority" do
it "calculates it based on key size" do
node = Node.new("a")
node = Node(Nil).new("a")
node.priority.should eq(1)
node = Node.new("abc")
node = Node(Nil).new("abc")
node.priority.should eq(3)
end
it "returns zero for catch all (globbed) key" do
node = Node.new("*filepath")
node = Node(Nil).new("*filepath")
node.priority.should eq(0)
node = Node.new("/src/*filepath")
node = Node(Nil).new("/src/*filepath")
node.priority.should eq(0)
end
it "returns one for keys with named parameters" do
node = Node.new(":query")
node = Node(Nil).new(":query")
node.priority.should eq(1)
node = Node.new("/search/:query")
node = Node(Nil).new("/search/:query")
node.priority.should eq(1)
end
it "changes when key changes" do
node = Node.new("a")
node = Node(Nil).new("a")
node.priority.should eq(1)
node.key = "abc"
@ -71,10 +77,10 @@ module Radix
describe "#sort!" do
it "orders children by priority" do
root = Node.new("/")
node1 = Node.new("a")
node2 = Node.new("bc")
node3 = Node.new("def")
root = Node(Int32).new("/")
node1 = Node(Int32).new("a", 1)
node2 = Node(Int32).new("bc", 2)
node3 = Node(Int32).new("def", 3)
root.children.push(node1, node2, node3)
root.sort!
@ -85,10 +91,10 @@ module Radix
end
it "orders catch all and named parameters lower than others" do
root = Node.new("/")
node1 = Node.new("*filepath")
node2 = Node.new("abc")
node3 = Node.new(":query")
root = Node(Int32).new("/")
node1 = Node(Int32).new("*filepath", 1)
node2 = Node(Int32).new("abc", 2)
node3 = Node(Int32).new(":query", 3)
root.children.push(node1, node2, node3)
root.sort!

26
spec/radix/result_spec.cr
View file

@ -5,15 +5,15 @@ module Radix
describe "#found?" do
context "a new instance" do
it "returns false when no payload is associated" do
result = Result.new
result = Result(Nil).new
result.found?.should be_false
end
end
context "with a payload" do
it "returns true" do
node = Node.new("/", :root)
result = Result.new
node = Node(Symbol).new("/", :root)
result = Result(Symbol).new
result.use node
result.found?.should be_true
@ -24,15 +24,15 @@ module Radix
describe "#key" do
context "a new instance" do
it "returns an empty key" do
result = Result.new
result = Result(Nil).new
result.key.should eq("")
end
end
context "given one used node" do
it "returns the node key" do
node = Node.new("/", :root)
result = Result.new
node = Node(Symbol).new("/", :root)
result = Result(Symbol).new
result.use node
result.key.should eq("/")
@ -41,9 +41,9 @@ module Radix
context "using multiple nodes" do
it "combines the node keys" do
node1 = Node.new("/", :root)
node2 = Node.new("about", :about)
result = Result.new
node1 = Node(Symbol).new("/", :root)
node2 = Node(Symbol).new("about", :about)
result = Result(Symbol).new
result.use node1
result.use node2
@ -54,8 +54,8 @@ module Radix
describe "#use" do
it "uses the node payload" do
node = Node.new("/", :root)
result = Result.new
node = Node(Symbol).new("/", :root)
result = Result(Symbol).new
result.payload?.should be_falsey
result.use node
@ -64,8 +64,8 @@ module Radix
end
it "allow not to assign payload" do
node = Node.new("/", :root)
result = Result.new
node = Node(Symbol).new("/", :root)
result = Result(Symbol).new
result.payload?.should be_falsey
result.use node, payload: false

86
spec/radix/tree_spec.cr
View file

@ -3,7 +3,7 @@ require "../spec_helper"
# Silence deprecation warnings when running specs and allow
# capture them for inspection.
module Radix
class Tree
class Tree(T)
@show_deprecations = false
@stderr : MemoryIO?
@ -20,12 +20,15 @@ module Radix
end
end
# Simple Payload class
record Payload
module Radix
describe Tree do
context "a new instance" do
it "contains a root placeholder node" do
tree = Tree.new
tree.root.should be_a(Node)
tree = Tree(Symbol).new
tree.root.should be_a(Node(Symbol))
tree.root.payload?.should be_falsey
tree.root.placeholder?.should be_true
end
@ -34,9 +37,9 @@ module Radix
describe "#add" do
context "on a new instance" do
it "replaces placeholder with new node" do
tree = Tree.new
tree = Tree(Symbol).new
tree.add "/abc", :abc
tree.root.should be_a(Node)
tree.root.should be_a(Node(Symbol))
tree.root.placeholder?.should be_false
tree.root.payload?.should be_truthy
tree.root.payload.should eq(:abc)
@ -45,7 +48,7 @@ module Radix
context "shared root" do
it "inserts properly adjacent nodes" do
tree = Tree.new
tree = Tree(Symbol).new
tree.add "/", :root
tree.add "/a", :a
tree.add "/bc", :bc
@ -61,7 +64,7 @@ module Radix
end
it "inserts nodes with shared parent" do
tree = Tree.new
tree = Tree(Symbol).new
tree.add "/", :root
tree.add "/abc", :abc
tree.add "/axyz", :axyz
@ -78,7 +81,7 @@ module Radix
end
it "inserts multiple parent nodes" do
tree = Tree.new
tree = Tree(Symbol).new
tree.add "/", :root
tree.add "/admin/users", :users
tree.add "/admin/products", :products
@ -107,7 +110,7 @@ module Radix
end
it "inserts multiple nodes with mixed parents" do
tree = Tree.new
tree = Tree(Symbol).new
tree.add "/authorizations", :authorizations
tree.add "/authorizations/:id", :authorization
tree.add "/applications", :applications
@ -127,7 +130,7 @@ module Radix
end
it "supports insertion of mixed routes out of order" do
tree = Tree.new
tree = Tree(Symbol).new
tree.add "/user/repos", :my_repos
tree.add "/users/:user/repos", :user_repos
tree.add "/users/:user", :user
@ -148,9 +151,30 @@ module Radix
end
end
context "mixed payloads" do
it "allows node with different payloads" do
payload1 = Payload.new
payload2 = Payload.new
tree = Tree(Payload | Symbol).new
tree.add "/", :root
tree.add "/a", payload1
tree.add "/bc", payload2
# / (:root)
# +-bc (payload2)
# \-a (payload1)
tree.root.children.size.should eq(2)
tree.root.children[0].key.should eq("bc")
tree.root.children[0].payload.should eq(payload2)
tree.root.children[1].key.should eq("a")
tree.root.children[1].payload.should eq(payload1)
end
end
context "dealing with duplicates" do
it "does not allow same path be defined twice" do
tree = Tree.new
tree = Tree(Symbol).new
tree.add "/", :root
tree.add "/abc", :abc
@ -164,7 +188,7 @@ module Radix
context "dealing with catch all and named parameters" do
it "prioritizes nodes correctly" do
tree = Tree.new
tree = Tree(Symbol).new
tree.add "/", :root
tree.add "/*filepath", :all
tree.add "/products", :products
@ -193,7 +217,7 @@ module Radix
end
it "does not split named parameters across shared key" do
tree = Tree.new
tree = Tree(Symbol).new
tree.add "/", :root
tree.add "/:category", :category
tree.add "/:category/:subcategory", :subcategory
@ -210,7 +234,7 @@ module Radix
end
it "does not allow different named parameters sharing same level" do
tree = Tree.new
tree = Tree(Symbol).new
tree.add "/", :root
tree.add "/:post", :post
@ -224,7 +248,7 @@ module Radix
describe "#find" do
context "a single node" do
it "does not find when using different path" do
tree = Tree.new
tree = Tree(Symbol).new
tree.add "/about", :about
result = tree.find "/products"
@ -232,7 +256,7 @@ module Radix
end
it "finds when using matching path" do
tree = Tree.new
tree = Tree(Symbol).new
tree.add "/about", :about
result = tree.find "/about"
@ -243,7 +267,7 @@ module Radix
end
it "finds when using path with trailing slash" do
tree = Tree.new
tree = Tree(Symbol).new
tree.add "/about", :about
result = tree.find "/about/"
@ -252,7 +276,7 @@ module Radix
end
it "finds when key has trailing slash" do
tree = Tree.new
tree = Tree(Symbol).new
tree.add "/about/", :about
result = tree.find "/about"
@ -264,7 +288,7 @@ module Radix
context "nodes with shared parent" do
it "finds matching path" do
tree = Tree.new
tree = Tree(Symbol).new
tree.add "/", :root
tree.add "/abc", :abc
tree.add "/axyz", :axyz
@ -276,7 +300,7 @@ module Radix
end
it "finds matching path across parents" do
tree = Tree.new
tree = Tree(Symbol).new
tree.add "/", :root
tree.add "/admin/users", :users
tree.add "/admin/products", :products
@ -292,7 +316,7 @@ module Radix
context "dealing with catch all" do
it "finds matching path" do
tree = Tree.new
tree = Tree(Symbol).new
tree.add "/", :root
tree.add "/*filepath", :all
tree.add "/about", :about
@ -304,7 +328,7 @@ module Radix
end
it "returns catch all in parameters" do
tree = Tree.new
tree = Tree(Symbol).new
tree.add "/", :root
tree.add "/*filepath", :all
tree.add "/about", :about
@ -316,7 +340,7 @@ module Radix
end
it "returns optional catch all" do
tree = Tree.new
tree = Tree(Symbol).new
tree.add "/", :root
tree.add "/search/*extra", :extra
@ -328,7 +352,7 @@ module Radix
end
it "does not find when catch all is not full match" do
tree = Tree.new
tree = Tree(Symbol).new
tree.add "/", :root
tree.add "/search/public/*query", :search
@ -339,7 +363,7 @@ module Radix
context "dealing with named parameters" do
it "finds matching path" do
tree = Tree.new
tree = Tree(Symbol).new
tree.add "/", :root
tree.add "/products", :products
tree.add "/products/:id", :product
@ -352,7 +376,7 @@ module Radix
end
it "does not find partial matching path" do
tree = Tree.new
tree = Tree(Symbol).new
tree.add "/", :root
tree.add "/products", :products
tree.add "/products/:id/edit", :edit
@ -362,7 +386,7 @@ module Radix
end
it "returns named parameters in result" do
tree = Tree.new
tree = Tree(Symbol).new
tree.add "/", :root
tree.add "/products", :products
tree.add "/products/:id", :product
@ -375,7 +399,7 @@ module Radix
end
it "returns unicode values in parameters" do
tree = Tree.new
tree = Tree(Symbol).new
tree.add "/", :root
tree.add "/language/:name", :language
tree.add "/language/:name/about", :about
@ -389,7 +413,7 @@ module Radix
context "dealing with multiple named parameters" do
it "finds matching path" do
tree = Tree.new
tree = Tree(Symbol).new
tree.add "/", :root
tree.add "/:section/:page", :static_page
@ -400,7 +424,7 @@ module Radix
end
it "returns named parameters in result" do
tree = Tree.new
tree = Tree(Symbol).new
tree.add "/", :root
tree.add "/:section/:page", :static_page
@ -417,7 +441,7 @@ module Radix
context "dealing with both catch all and named parameters" do
it "finds matching path" do
tree = Tree.new
tree = Tree(Symbol).new
tree.add "/", :root
tree.add "/*filepath", :all
tree.add "/products", :products