http_router 0.8.10 → 0.8.11

data/README.md

@@ -41,10 +41,12 @@ Once you have a route object, use `HttpRouter::Route#to` to add a destination an
 
 e.g.
 
+```ruby
   r = HttpRouter.new
   r.add('/test/:variable(.:format)').name(:my_test_path).to {|env| [200, {}, "Hey dude #{env['router.params'][:variable]}"]}
   r.add('/test').redirect("http://www.google.com/")
   r.add('/static').static('/my_file_system')
+```
 
 As well, you can support regex matching and request conditions. To add a regex match, use `matching(:id => /\d+/)`.
 To match on a request condition you can use `condition(:request_method => %w(POST HEAD))` or more succinctly `request_method('POST', 'HEAD')`.

data/Rakefile

@@ -3,7 +3,7 @@ require 'bundler'
 Bundler::GemHelper.install_tasks
 
 desc "Run all tests"
-task :test => ['test:integration', 'test:examples', 'test:rdoc_examples']
+task :test => ['test:generation', 'test:recognition', 'test:integration', 'test:examples', 'test:rdoc_examples']
 
 require 'pp'
 
@@ -21,6 +21,21 @@ namespace :test do
     require './test/helper'
     Dir['./test/**/test_*.rb'].each { |test| require test }
   end
+
+  desc "Run generic recognition tests"
+  task :recognition do
+    $: << 'lib'
+    require 'http_router'
+    require './test/recognition'
+  end
+
+  desc "Run generic recognition tests"
+  task :generation do
+    $: << 'lib'
+    require 'http_router'
+    require './test/generation'
+  end
+
   desc "Run example tests"
   task :examples do
     $: << 'lib'

data/http_router.gemspec

@@ -26,6 +26,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'code_stats'
   s.add_development_dependency 'rake',     '~> 0.8.7'
   s.add_development_dependency 'rbench'
+  s.add_development_dependency 'json'
   s.add_development_dependency 'phocus'
   s.add_development_dependency 'bundler',  '~> 1.0.0'
   s.add_development_dependency 'thin',  '= 1.2.8'

data/lib/http_router.rb

@@ -202,7 +202,8 @@ class HttpRouter
 
   private
   def no_response(env, perform_call = true)
-    supported_methods = (@known_methods - [env['REQUEST_METHOD']]).select do |m|
+    supported_methods = @known_methods.select do |m|
+      next if m == env['REQUEST_METHOD']
       test_env = ::Rack::Request.new(env.clone)
       test_env.env['REQUEST_METHOD'] = m
       test_env.env['_HTTP_ROUTER_405_TESTING_ACCEPTANCE'] = true

data/lib/http_router/version.rb

@@ -1,4 +1,4 @@
 # encoding: utf-8
 class HttpRouter #:nodoc
-  VERSION = '0.8.10'
+  VERSION = '0.8.11'
 end

data/test/common/generate.txt

@@ -0,0 +1,87 @@
+{"a": "/"}
+{"b": "/test"}
+{"c": "/test/time"}
+{"d": "/one/more/what"}
+{"e": "/test.html"}
+	["/", "a"]
+	["/test", "b"]
+	["/test/time", "c"]
+	["/one/more/what", "d"]
+	["/test.html", "e"]
+
+{"a": "/:var"}
+	["/test", "a", {"var":"test"}]
+	["/test", "a", ["test"]]
+
+{"a": "/:var"}
+	["/test?query=string", "a", {"var":"test", "query": "string"}]
+	["/test?query=string", "a", ["test", {"query": "string"}]]
+
+{"a": "/:var/:baz"}
+	["/one/two", "a", {"var":"one", "baz": "two"}]
+	["/one/two", "a", ["one", "two"]]
+
+{"a": "/test.:format"}
+	["/test.html", "a", {"format":"html"}]
+	["/test.html", "a", ["html"]]
+
+{"a": "/test(.:format)"}
+	["/test.html", "a", {"format":"html"}]
+	["/test.html", "a", ["html"]]
+	["/test", "a"]
+
+{"a": "/:var.:format"}
+	["/test.html", "a", {"var": "test", "format":"html"}]
+	["/test.html", "a", ["test", "html"]]
+	["/test.html", "a", ["test", {"format": "html"}]]
+	[null, "a", {"format": "html"}]
+
+{"a": "/:var(.:format)"}
+	["/test.html", "a", {"var": "test", "format":"html"}]
+	["/test.html", "a", ["test", "html"]]
+	["/test.html", "a", ["test", {"format": "html"}]]
+	["/test", "a", ["test"]]
+	["/test", "a", {"var": "test"}]
+	[null, "a", {"format": "html"}]
+	[null, "a"]
+
+{"a": "/:var1(/:var2)"}
+	["/foo/bar", "a", {"var1": "foo", "var2":"bar"}]
+	[null, "a", ["foo", {"var1": "bar"}]]
+	["/foo", "a", {"var1": "foo"}]
+	["/foo", "a", ["foo"]]
+	["/foo", "a", ["foo", null]]
+
+{"a": "/:var1(/:var2.:format)"}
+	["/test/test2.html", "a", {"var1": "test", "var2": "test2", "format":"html"}]
+	["/test/test2.html", "a", ["test", "test2", "html"]]
+	["/test", "a", ["test"]]
+
+{"a": "/:var1(/:var2(/:var3))"}
+	["/var/fooz/baz", "a", {"var1": "var", "var2":"fooz", "var3": "baz"}]
+	["/var/fooz", "a", {"var1": "var", "var2":"fooz"}]
+	["/var", "a", {"var1": "var"}]
+	["/var/fooz/baz", "a", ["var", "fooz", "baz"]]
+	["/var/fooz", "a", ["var", "fooz"]]
+	["/var", "a", ["var"]]
+
+{"a": {"path":"/:var", "default":{"page":1}}}
+	["/123?page=1", "a", [123]]
+
+{"a": {"path":"/:page/:entry", "default":{"page":1}}}
+	["/1/123", "a", {"entry": "123"}]
+
+{"a": "/:var"}
+	["/%C3%A4", "a", "ä"]
+
+{"a": {"path": ":var", "var": {"regex": "\\d+"}}}
+	[null, "a", "asd"]
+
+{"a": "/var"}
+	["/var?foo%5B%5D=baz&foo%5B%5D=bar", "a", {"foo": ["baz", "bar"]}]
+
+{"a": "/var"}
+	["/var?foo%5Baz%5D=baz", "a", {"foo": {"az": "baz"}}]
+
+{"a": "/var"}
+	["/var?foo%5Baz%5D%5B%5D=baz", "a", {"foo": {"az": ["baz"]}}]

data/test/common/recognize.txt

@@ -0,0 +1,263 @@
+{"route": ":one"}
+	["route", "/two", {"one": "two"}]
+
+{"route": "test/:one"}
+	["route", "/test/three", {"one": "three"}]
+
+{"static": "one"}
+{"dynamic": ":one"}
+	["dynamic", "/two", {"one": "two"}]
+	["static", "/one"]
+
+[{"variable": ":var/one"}, {"static": "one"}]
+	["variable", "/two/one", {"var": "two"}]
+	["static",   "/one"]
+	[null,       "/two"]
+
+[{"dynamic": "/foo/:id"}, {"static": "/foo"}]
+	["dynamic", "/foo/id", {"id": "id"}]
+	["static", "/foo"]
+
+[{"static": "/foo/foo"}, {"dynamic": "/:foo/foo2"}]
+	["dynamic", "/foo/foo2", {"foo": "foo"}]
+	["static", "/foo/foo"]
+
+[{"route": ":var"}]
+	["route", "/%E6%AE%BA%E3%81%99", {"var": "殺す"}]
+
+[{"route": {"path":{"regex": "/(test123|\\d+)"}}}]
+	["route", "/test123"]
+	["route", "/123"]
+	[null, "/test123andmore"]
+	[null, "/lesstest123"]
+
+[{"route": "/test.:format"}]
+	["route", "/test.html", {"format": "html"}]
+
+[{"route": "/test(.:format)"}]
+	["route", "/test.html", {"format": "html"}]
+	["route", "/test"]
+
+[{"route": "(.:format)"}]
+	["route", "/.html", {"format": "html"}]
+	["route", "/"]
+
+[{"route": "/:test.:format"}]
+	["route", "/foo.bar", {"format": "bar", "test": "foo"}]
+
+[{"route": "/:test(.:format)"}]
+	["route", "/foo", {"test": "foo"}]
+	["route", "/foo.bar", {"format": "bar", "test": "foo"}]
+
+[{"route": {"path": "/:test(.:format)", "format": {"regex": "[^\\.]+"}}}]
+	["route", "/asd@asd.com.json", {"test": "asd@asd.com", "format": "json"}]
+
+[{"route": "/test/*variable"}]
+	["route", "/test/one/two/three", {"variable": ["one", "two", "three"]}]
+
+[{"route": "test/*variable/test"}]
+	[null, "/test/one/two/three"]
+	["route", "/test/one/two/three/test", {"variable": ["one", "two", "three"]}]
+
+[{"route": "test/*variable/test/*variable2"}]
+	[null, "/test/one/two/three"]
+	["route", "/test/one/two/three/test/four/five/six", {"variable": ["one", "two", "three"], "variable2": ["four", "five", "six"]}]
+
+[{"route": "/test/:test-*variable.:format"}]
+	["route", "/test/one-two/three/four/five.six", {"test": "one", "variable": ["two", "three", "four", "five"], "format": "six"}]
+
+[{"route": {"path": "test/*variable", "variable": {"regex": "[a-z]+"}}}]
+	[null, "/test/asd/123"]
+	[null, "/test/asd/asd123"]
+	["route", "/test/asd/qwe", {"variable": ["asd", "qwe"]}]
+
+[{"route": {"path": "test/*variable/test", "variable": {"regex": "[a-z]+"}}}]
+	[null, "/test/asd/123"]
+	[null, "/test/asd/asd123"]
+	[null, "/test/asd/qwe"]
+	["route", "/test/asd/qwe/test", {"variable": ["asd", "qwe"]}]
+
+[{"route": {"path": "test/*variable/:test", "variable": {"regex": "[a-z]+"}}}]
+	["route", "/test/asd/qwe/help", {"variable": ["asd", "qwe"], "test": "help"}]
+
+[{"route": {"path": "test/*variable.:format"}}]
+	["route", "/test/asd/qwe.html", {"variable": ["asd", "qwe"], "format": "html"}]
+
+[{"route": {"path": "test/*variable.:format", "variable": {"regex": "[a-z]+"}}}]
+	[null, "/test/asd/123"]
+	[null, "/test/asd/asd123"]
+	[null, "/test/asd/qwe"]
+	["route", "/test/asd/qwe.html", {"variable": ["asd", "qwe"], "format": "html"}]
+
+
+[{"route": {"path": "test/*variable(.:format)", "variable": {"regex": "[a-z]+"}}}]
+	[null, "/test/asd/123"]
+	[null, "/test/asd/asd123"]
+	["route", "/test/asd/qwe", {"variable": ["asd", "qwe"]}]
+	["route", "/test/asd/qwe.html", {"variable": ["asd", "qwe"], "format": "html"}]
+
+[{"route": {"path": "test/*variable.html"}}]
+	[null, "/test/asd/123"]
+	["route", "/test/asd/qwe.html", {"variable": ["asd", "qwe"]}]
+
+[{"with_regex": {"path": "/:common_variable/:matched", "matched": {"regex": "\\d+"}}}, {"with_post": {"path": "/:common_variable/:matched", "conditions": {"request_method": "POST"}}}, {"without_regex": "/:common_variable/:unmatched"}]
+	["with_regex", "/common/123", {"common_variable": "common", "matched": "123"}]
+	["without_regex", "/common/other", {"common_variable": "common", "unmatched": "other"}]
+	["with_regex", {"path": "/common/123", "method": "POST"}, {"common_variable": "common", "matched": "123"}]
+	["with_post", {"path": "/common/other", "method": "POST"}, {"common_variable": "common", "matched": "other"}]
+
+[{"regex": {"path":":test/number", "test": {"regex": "\\d+"}}}, {"greedy": ":test/anything"}]
+   ["regex", "/123/number", {"test": "123"}]
+   ["greedy", "/123/anything", {"test": "123"}]
+
+[{"route": {"path": ":test", "test": {"regex": ".*"}}}]
+	["route", "/test/", {"test": "test/"}]
+
+[{"route": {"path": "/:test", "test": {"regex": ".*"}}}]
+	["route", "/test.html", {"test": "test.html"}]
+
+[{"route": {"path": ":test", "test": {"regex": "\\d+"}}}]
+  ["route", "/123", {"test": "123"}]
+  [null, "/a123"]
+
+[{"route": ""}]
+	["route", "/"]
+	["route", ""]
+
+[{"route": "/"}]
+	["route", "/"]
+
+[{"route": "/test"}]
+	["route", "/test"]
+
+[{"route": "/test/one"}]
+	["route", "/test/one"]
+
+[{"route": "/test/one/two"}]
+	["route", "/test/one/two"]
+
+[{"route": "/test.html"}]
+	["route", "/test.html"]
+
+[{"route": ".html"}]
+	["route", "/.html"]
+
+[{"route": "one(/two(/three(/four)(/five)))"}]
+	["route", "/one"]
+	["route", "/one/two"]
+	["route", "/one/two/three"]
+	["route", "/one/two/three/four"]
+	["route", "/one/two/three/five"]
+	["route", "/one/two/three/four/five"]
+	[null, "/one/two/four/five"]
+
+[{"route": "test\\(:variable\\)"}]
+	["route", "/test(hello)", {"variable": "hello"}]
+
+[{"route": "test\\:variable"}]
+	["route", "/test:variable"]
+
+[{"route": "test\\*variable"}]
+	["route", "/test*variable"]
+
+[{"route": "/føø"}]
+	["route", "/f%C3%B8%C3%B8"]
+
+[{"route": "/test*"}]
+	["route", "/test/optional", {"PATH_INFO": "/optional"}]
+	["route", "/test", {"PATH_INFO": "/"}]
+	
+[{"route": "/*"}]
+	["route", "/optional", {"PATH_INFO": "/optional"}]
+	["route", "/", {"PATH_INFO": "/"}]
+
+[{"test": "/test*"}, {"root": "/*"}]
+	["test", "/test/optional", {"PATH_INFO": "/optional"}]
+	["test", "/test/optional/", {"PATH_INFO": "/optional/"}]
+	["root", "/testing/optional", {"PATH_INFO": "/testing/optional"}]
+
+[{"route": "/one-:variable-time"}]
+	["route", "one-value-time", {"variable": "value"}]
+
+[{"route": {"path": "/one-:variable-time", "variable": {"regex": "\\d+"}}}]
+	["route", "one-123-time", {"variable": "123"}]
+	[null, "one-value-time"]
+
+[{"route": {"path": "/one-:variable-time", "variable": {"regex": "\\d+"}}}]
+	["route", "one-123-time", {"variable": "123"}]
+	[null, "one-value-time"]
+
+[{"route": "hey.:greed.html"}]
+	["route", "/hey.greedybody.html", {"greed": "greedybody"}]
+
+[{"r6": "/:v1-:v2-:v3-:v4-:v5-:v6"}, {"r5": "/:v1-:v2-:v3-:v4-:v5"}, {"r4": "/:v1-:v2-:v3-:v4"}, {"r3": "/:v1-:v2-:v3"}, {"r2": "/:v1-:v2"}, {"r1":"/:v1"}]
+	["r1", "/one", {"v1": "one"}]
+	["r2", "/one-two", {"v1": "one", "v2": "two"}]
+	["r3", "/one-two-three", {"v1": "one", "v2":"two", "v3":"three"}]
+	["r4", "/one-two-three-four", {"v1": "one", "v2":"two", "v3":"three", "v4":"four"}]
+	["r5", "/one-two-three-four-five", {"v1": "one", "v2":"two", "v3":"three", "v4":"four", "v5":"five"}]
+	["r6", "/one-two-three-four-five-six", {"v1": "one", "v2":"two", "v3":"three", "v4":"four", "v5":"five", "v6":"six"}]
+
+{"with_regex": {"path": "/:common_variable.:matched", "matched": {"regex": "\\d+"}}}
+{"without_regex": "/:common_variable.:unmatched"}
+	["with_regex", "/common.123", {"common_variable": "common", "matched": "123"}]
+	["without_regex", "/common.other", {"common_variable": "common", "unmatched": "other"}]
+
+{"nothing":{"path":"/", "conditions": {"request_method": "GET"}}}
+{"post":{"path":"/test", "conditions": {"request_method": "POST"}}}
+{"put":{"path":"/test", "conditions": {"request_method": "PUT"}}}
+	["post", {"path": "/test", "method": "POST"}]
+	[[405, {"Allow": "POST, PUT"}], {"path": "/test", "method": "GET"}]
+
+{"router": {"path": "/test", "conditions": {"request_method": ["POST", "GET"]}}}
+	["router", {"path": "/test", "method": "POST"}]
+	["router", {"path": "/test", "method": "GET"}]
+	[[405, {"Allow": "GET, POST"}], {"path": "/test", "method": "PUT"}]
+
+{"get": {"path": "/test(.:format)", "conditions": {"request_method": "GET"}}}
+{"post": {"path": "/test(.:format)", "conditions": {"request_method": "POST"}}}
+{"delete": {"path": "/test(.:format)", "conditions": {"request_method": "DELETE"}}}
+	["get", {"path": "/test", "method": "GET"}]
+	["post", {"path": "/test", "method": "POST"}]
+	["delete", {"path": "/test", "method": "DELETE"}]
+	["get", {"path": "/test.html", "method": "GET"}, {"format": "html"}]
+	["post", {"path": "/test.html", "method": "POST"}, {"format": "html"}]
+	["delete", {"path": "/test.html", "method": "DELETE"}, {"format": "html"}]
+	[[405, {"Allow": "DELETE, GET, POST"}], {"path": "/test", "method": "PUT"}]
+
+{"post": {"path": "/test", "conditions": {"request_method": "POST"}}}
+{"post_2": {"path": "/test/post", "conditions": {"request_method": "POST"}}}
+{"get": {"path": "/test", "conditions": {"request_method": "GET"}}}
+{"get_2": {"path": "/test/post", "conditions": {"request_method": "GET"}}}
+{"any_2": "/test/post"}
+{"any": "/test"}
+	["post", {"path": "/test", "method": "POST"}]
+	["get", {"path": "/test", "method": "GET"}]
+	["any", {"path": "/test", "method": "PUT"}]
+	["post_2", {"path": "/test/post", "method": "POST"}]
+	["get_2", {"path": "/test/post", "method": "GET"}]
+	["any_2", {"path": "/test/post", "method": "PUT"}]
+
+{"post": {"path": "/test", "conditions": {"request_method": "POST"}}}
+{"any": "/test"}
+	["post", {"path": "/test", "method": "POST"}]
+	["any", {"path": "/test", "method": "PUT"}]
+
+{"host2_post": {"path": "/test", "conditions": {"request_method": "POST", "host": "host2"}}}
+{"host2_get": {"path": "/test", "conditions": {"request_method": "GET", "host": "host2"}}}
+{"host2": {"path": "/test", "conditions": {"host": "host2"}}}
+{"post": {"path": "/test", "conditions": {"request_method": "POST"}}}
+	["host2", {"path": "http://host2/test", "method": "PUT"}]
+	["post", {"path": "http://host1/test", "method": "POST"}]
+	["host2_get", {"path": "http://host2/test", "method": "GET"}]
+	["host2_post", {"path": "http://host2/test", "method": "POST"}]
+
+{"with": {"path": "/test", "conditions": {"request_method": "GET", "host": {"regex": "host1"}}}}
+{"without": {"path": "/test", "conditions": {"request_method": "GET"}}}
+	["without", "http://host2/test"]
+	["with", "http://host2.host1.com/test"]
+
+{"http": {"path": "/test", "conditions": {"scheme": "http"}}}
+{"https": {"path": "/test", "conditions": {"scheme": "https"}}}
+	["http", {"path": "/test", "scheme": "http"}]
+	["https", {"path": "/test", "scheme": "https"}]

data/test/generation.rb

@@ -0,0 +1,119 @@
+require 'json'
+
+generation_file = "#{File.dirname(__FILE__)}/common/generate.txt"
+generation = File.read(generation_file)
+
+class GenerationTest
+  Info = Struct.new(:case, :original_line, :num)
+  
+  attr_reader :routes, :tests
+  def initialize(file)
+    @tests = []
+    @routes = Info.new([], "", 0)
+  end
+
+  def error(msg)
+    raise("Error in case: #{@routes.original_line.strip}:#{@routes.num + 1}\n#{msg}")
+  end
+
+  def add_test(line, num)
+    @tests << Info.new(JSON.parse(line), line, num)
+  end
+
+  def add_routes(line, num)
+    info = Info.new(JSON.parse(line), line, num)
+    error("Routes have already been defined without tests") if info.case.is_a?(Array) && !@routes.case.empty?
+    if info.case.is_a?(Array)
+      @routes = info
+    elsif @routes.case.empty?
+      info.case = [info.case]
+      @routes = info
+    else
+      @routes.case << info.case
+    end
+  end
+
+  def interpret_val(val)
+    case val
+    when nil
+      error("Unable to interpret #{val.inspect}")
+    when Hash
+      val['regex'] ? Regexp.new(val['regex']) : error("Okay serious, no idea #{val.inspect}")
+    else
+      val
+    end
+  end
+
+  def invoke
+    error("invoke called with no tests or routes") if @tests.empty? || @routes.nil?
+    router = HttpRouter.new
+    @routes.case.each do |route_definition|
+      error("Too many keys! #{route_definition.keys.inspect}") unless route_definition.keys.size == 1
+      route_name, route_properties = route_definition.keys.first, route_definition.values.first
+      route = case route_properties
+      when String
+        router.add(route_properties)
+      when Hash
+        opts = {}
+        route_path = interpret_val(route_properties.delete("path"))
+        if route_properties.key?("conditions")
+          opts[:conditions] = Hash[route_properties.delete("conditions").map{|k, v| [k.to_sym, interpret_val(v)]}]
+        end
+        if route_properties.key?("default")
+          opts[:default_values] = Hash[route_properties.delete("default").map{|k, v| [k.to_sym, interpret_val(v)]}]
+        end
+        route_properties.each do |key, val|
+          opts[key.to_sym] = interpret_val(val)
+        end
+        router.add(route_path, opts)
+      else
+        error("Route isn't a String or hash")
+      end
+      route.name(route_name.to_sym)
+      route.to{|env| [200, {"env-to-test" => env.dup}, [route_name]]}
+    end
+    @tests.map(&:case).each do |(expected_result, name, args)|
+      args = [args] unless args.is_a?(Array)
+      args.compact!
+      args.map!{|a| a.is_a?(Hash) ? Hash[a.map{|k,v| [k.to_sym, v]}] : a }
+      result = begin
+        router.url(name.to_sym, *args)
+      rescue HttpRouter::InvalidRouteException
+        nil
+      rescue HttpRouter::MissingParameterException
+        nil
+      end
+      error("Result #{result.inspect} did not match expectation #{expected_result.inspect}") unless result == expected_result
+    end
+    print '.'
+  end
+end
+
+tests = []
+test = nil
+num = 0
+generation.each_line do |line|
+  begin
+    case line
+    when /^#/, /^\s*$/
+      # skip
+    when /^(  |\t)/
+      test.add_test(line, num)
+    else
+      if test.nil? || !test.tests.empty?
+        tests << test if test
+        test = GenerationTest.new(generation_file)
+      end
+      test.add_routes(line, num)
+    end
+  rescue
+    warn "There was a problem with #{num}:#{line}"
+    raise
+  end
+  num += 1
+end
+tests << test
+
+puts "Running generation tests (Routes: #{tests.size}, Tests: #{tests.inject(0){|s, t| s+=t.tests.size}})..."
+tests.each(&:invoke)
+puts "\ndone!"