http_router 0.0.1

data/spec/recognize_spec.rb

@@ -0,0 +1,176 @@
+describe "HttpRouter#recognize" do
+  before(:each) do
+    @router = HttpRouter.new
+  end
+
+  context("static paths") do
+    ['/', '/test', '/test/time', '/one/more/what', '/test.html'].each do |path|
+      it "should recognize #{path.inspect}" do
+        route = @router.add(path)
+        @router.recognize(Rack::MockRequest.env_for(path)).route.should == route
+      end
+    end
+
+    context("with optional parts") do
+      it "work either way" do
+        route = @router.add("/test(/optional)")
+        @router.recognize(Rack::MockRequest.env_for('/test')).route.should == route
+        @router.recognize(Rack::MockRequest.env_for('/test/optional')).route.should == route
+      end
+    end
+
+    context("partial matching") do
+      it "should match partially or completely" do
+        route = @router.add("/test*")
+        @router.recognize(Rack::MockRequest.env_for('/test')).route.should == route
+        response = @router.recognize(Rack::MockRequest.env_for('/test/optional'))
+        response.route.should == route
+        response.remaining_path.should == '/optional'
+      end
+    end
+
+    context("trailing slashes") do
+      it "should ignore a trailing slash" do
+        route = @router.add("/test")
+        @router.recognize(Rack::MockRequest.env_for('/test/')).route.should == route
+      end
+
+      it "should not recognize a trailing slash when used with the /? syntax and ignore_trailing_slash disabled" do
+        @router = HttpRouter.new(:ignore_trailing_slash => false)
+        route = @router.add("/test/?")
+        @router.recognize(Rack::MockRequest.env_for('/test/')).route.should == route
+      end
+
+      it "should recognize a trailing slash when used with the /? syntax and ignore_trailing_slash enabled" do
+        @router = HttpRouter.new(:ignore_trailing_slash => false)
+        route = @router.add("/test")
+        @router.recognize(Rack::MockRequest.env_for('/test/')).should be_nil
+      end
+    end
+
+  end
+
+  context "request methods" do
+    it "should pick a specific request_method" do
+      route = @router.add("/test", :conditions => {:request_method => 'POST'})
+      @router.recognize(Rack::MockRequest.env_for('/test', :method => 'POST')).route.should == route
+      @router.recognize(Rack::MockRequest.env_for('/test', :method => 'GET')).status.should == 405
+      @router.recognize(Rack::MockRequest.env_for('/test', :method => 'GET')).headers['Allow'].should == "POST"
+    end
+
+    it "should pick a specific request_method with other paths all through it" do
+      @router.add("/test", :conditions => {:request_method => 'POST'}).name(:test_post)
+      @router.add("/test/post", :conditions => {:request_method => 'POST'}).name(:test_post_post)
+      @router.add("/test", :conditions => {:request_method => 'GET'}).name(:test_get)
+      @router.add("/test/post", :conditions => {:request_method => 'GET'}).name(:test_post_get)
+      @router.add("/test/post").name(:test_post_catchall)
+      @router.add("/test").name(:test_catchall)
+      @router.recognize(Rack::MockRequest.env_for('/test', :method => 'POST')).route.named.should == :test_post
+      @router.recognize(Rack::MockRequest.env_for('/test', :method => 'GET')).route.named.should == :test_get
+      @router.recognize(Rack::MockRequest.env_for('/test', :method => 'PUT')).route.named.should == :test_catchall
+      @router.recognize(Rack::MockRequest.env_for('/test/post', :method => 'POST')).route.named.should == :test_post_post
+      @router.recognize(Rack::MockRequest.env_for('/test/post', :method => 'GET')).route.named.should == :test_post_get
+      @router.recognize(Rack::MockRequest.env_for('/test/post', :method => 'PUT')).route.named.should == :test_post_catchall
+    end
+
+    it "should move an endpoint to the non-specific request method when a more specific route gets added" do
+      @router.add("/test").name(:test_catchall)
+      @router.add("/test", :conditions => {:request_method => 'POST'}).name(:test_post)
+      @router.recognize(Rack::MockRequest.env_for('/test', :method => 'POST')).route.named.should == :test_post
+      @router.recognize(Rack::MockRequest.env_for('/test', :method => 'PUT')).route.named.should == :test_catchall
+    end
+
+  end
+
+  context("dynamic paths") do
+    it "should recognize '/:variable'" do
+      route = @router.add('/:variable')
+      response = @router.recognize(Rack::MockRequest.env_for('/value'))
+      response.route.should == route
+      response.params.should == ['value']
+      response.params_as_hash[:variable].should == 'value'
+    end
+
+    it "should recognize '/test.:format'" do
+      route = @router.add('/test.:format')
+      response = @router.recognize(Rack::MockRequest.env_for('/test.html'))
+      response.route.should == route
+      response.extension.should == 'html'
+      response.params_as_hash[:format].should == 'html'
+    end
+
+    it "should recognize '/test(.:format)'" do
+      route = @router.add('/test(.:format)')
+      response = @router.recognize(Rack::MockRequest.env_for('/test.html'))
+      response.route.should == route
+      response.extension.should == 'html'
+      response.params_as_hash[:format].should == 'html'
+      response = @router.recognize(Rack::MockRequest.env_for('/test'))
+      response.route.should == route
+      response.extension.should be_nil
+      response.params_as_hash[:format].should be_nil
+    end
+
+    it "should recognize '/:test.:format'" do
+      route = @router.add('/:test.:format')
+      response = @router.recognize(Rack::MockRequest.env_for('/hey.html'))
+      response.route.should == route
+      response.extension.should == 'html'
+      response.params_as_hash[:format].should == 'html'
+      response.params_as_hash[:test].should == 'hey'
+    end
+
+    it "should recognize '/:test(.:format)'" do
+      route = @router.add('/:test(.:format)')
+      response = @router.recognize(Rack::MockRequest.env_for('/hey.html'))
+      response.route.should == route
+      response.extension.should == 'html'
+      response.params_as_hash[:format].should == 'html'
+      response.params_as_hash[:test].should == 'hey'
+      response = @router.recognize(Rack::MockRequest.env_for('/hey'))
+      response.route.should == route
+      response.extension.should be_nil
+      response.params_as_hash[:format].should be_nil
+      response.params_as_hash[:test].should == 'hey'
+    end
+    
+    context "globs" do
+      it "should recognize a glob" do
+        route = @router.add('/test/*variable')
+        response = @router.recognize(Rack::MockRequest.env_for('/test/one/two/three'))
+        response.route.should == route
+        response.params.should == [['one', 'two', 'three']]
+      end
+      it "should recognize a glob with a regexp" do
+        route = @router.add('/test/*variable/anymore', :matches_with => {:variable => /^\d+$/})
+        response = @router.recognize(Rack::MockRequest.env_for('/test/123/345/567/anymore'))
+        response.route.should == route
+        response.params.should == [['123', '345', '567']]
+        response = @router.recognize(Rack::MockRequest.env_for('/test/123/345/567'))
+        response.should be_nil
+      end
+    end
+    
+  end
+  
+  context("interstitial variables") do
+    it "should recognize interstitial variables" do
+      route = @router.add('/one-:variable-time')
+      response = @router.recognize(Rack::MockRequest.env_for('/one-value-time'))
+      response.route.should == route
+      response.params_as_hash[:variable].should == 'value'
+    end
+  end
+
+  context("dynamic greedy paths") do
+    it "should recognize greedy variables" do
+      route = @router.add('/:variable', :matches_with => { :variable => /\d+/})
+      response = @router.recognize(Rack::MockRequest.env_for('/123'))
+      response.route.should == route
+      response.params.should == ['123']
+      response.params_as_hash[:variable].should == '123'
+      response = @router.recognize(Rack::MockRequest.env_for('/asd'))
+      response.should be_nil
+    end
+  end
+end

data/spec/sinatra/recognize_spec.rb

@@ -0,0 +1,140 @@
+require "sinatra"
+require "http_router/sinatra"
+
+describe "Usher (for Sinatra) route recognition" do
+  before(:each) do
+    @app = Sinatra.new { register HttpRouter::Interface::Sinatra::Extension }
+    @app.extend(CallWithMockRequestMixin)
+    @app.reset!
+  end
+
+  describe "basic functionality" do
+    it "should map not found" do
+      response = @app.call_with_mock_request('/bar')
+      response.status.should == 404
+    end
+
+    it "should map index" do
+      @app.get("/") { "index" }
+      response = @app.call_with_mock_request('/')
+      response.status.should == 200
+      response.body.should == "index"
+    end
+
+    it "should ignore trailing delimiters" do
+      @app.get("/foo") { "foo" }
+      response = @app.call_with_mock_request('/foo')
+      response.status.should == 200
+      response.body.should == "foo"
+      response = @app.call_with_mock_request('/foo/')
+      response.status.should == 200
+      response.body.should == "foo"
+    end
+
+    it "should ignore trailing delimiters in a more advanced route" do
+      @app.get("/foo") { "foo" }
+      @app.get("/foo/bar") { "bar" }
+      response = @app.call_with_mock_request('/foo')
+      response.status.should == 200
+      response.body.should == "foo"
+      response = @app.call_with_mock_request('/foo/bar')
+      response.status.should == 200
+      response.body.should == "bar"
+      response = @app.call_with_mock_request('/foo/')
+      response.status.should == 200
+      response.body.should == "foo"
+      response = @app.call_with_mock_request('/foo/bar/')
+      response.status.should == 200
+      response.body.should == "bar"
+    end
+
+    it "should ignore trailing delimiters with an optional param" do
+      @app.get("/foo/(:bar)") { params[:bar] }
+      @app.get("/bar(/:foo)") { params[:foo] }
+      response = @app.call_with_mock_request('/foo/bar')
+      response.status.should == 200
+      response.body.should == "bar"
+      response = @app.call_with_mock_request('/bar/foo')
+      response.status.should == 200
+      response.body.should == "foo"
+      response = @app.call_with_mock_request('/bar')
+      response.status.should == 200
+      response.body.should == ""
+      response = @app.call_with_mock_request('/bar/')
+      response.status.should == 200
+      response.body.should == ""
+    end
+
+    it "should use sinatra optionals trailing delimiters" do
+      @app.get("/foo/?") { "foo" }
+      response = @app.call_with_mock_request('/foo')
+      response.status.should == 200
+      response.body.should == "foo"
+      response = @app.call_with_mock_request('/foo/')
+      response.status.should == 200
+      response.body.should == "foo"
+    end
+  end
+
+  describe "mapping functionality" do
+
+    it "should map a basic route" do
+      @app.get('/hi', :name => :hi) { generate(:hi) } 
+      response = @app.call_with_mock_request('/hi')
+      response.status.should == 200
+      response.body.should == "/hi"
+    end
+
+    it "should map a basic route ignoring trailing delimiters" do
+      @app.get('/hi', :name => :hi) { generate(:hi) } 
+      response = @app.call_with_mock_request('/hi/')
+      response.status.should == 200
+      response.body.should == "/hi"
+    end
+
+    it "should map a basic route with params" do
+      @app.get('/hi/:id', :name => :hi) { generate(:hi, :id => 18) } 
+      response = @app.call_with_mock_request('/hi/1')
+      response.status.should == 200
+      response.body.should == "/hi/18"
+    end
+
+    it "should map route with params" do
+      @app.get('/hi-:id', :name => :hi) { generate(:hi, :id => 18) } 
+      response = @app.call_with_mock_request('/hi-1')
+      response.status.should == 200
+      response.body.should == "/hi-18"
+    end
+
+    it "should map route with complex params" do
+      @app.get('/hi/:foo/:bar/:baz(.:format)') { "/#{params[:foo]}/#{params[:bar]}/#{params[:baz]}/#{params[:format]}" }
+      response = @app.call_with_mock_request('/hi/foo/bar/baz')
+      response.status.should == 200
+      response.body.should == "/foo/bar/baz/"
+      response = @app.call_with_mock_request('/hi/foo/bar-bax/baz')
+      response.status.should == 200
+      response.body.should == "/foo/bar-bax/baz/"
+    end
+  end
+
+  describe "not found" do
+
+    it "should correctly generate a not found page without images" do
+      response = @app.call_with_mock_request('/bar')
+      response.status.should == 404
+      response.body.should_not match(/__sinatra__/)
+    end
+  end
+
+  describe "method not allowed" do
+
+    it "should correctly generate a not found page without images and return a 405" do
+      @app.post('/bar') { 'found' }
+      @app.put('/bar') { 'found' }
+      response = @app.call_with_mock_request('/bar')
+      response.status.should == 405
+      response.headers['Allow'].should == 'POST, PUT'
+      response.body.should_not match(/__sinatra__/)
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,7 @@
+--colour
+--format
+specdoc
+--loadby
+mtime
+--reverse
+--backtrace

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+require 'rack'
+
+module CallWithMockRequestMixin
+  def call_with_mock_request(url = "/sample", method = "GET", params = Hash.new)
+    params.merge!(:method => method)
+    request = Rack::MockRequest.new(self)
+    request.request(method, url, params)
+  end
+end
+
+class MockApp
+  attr_accessor :status, :headers, :body, :env
+  def initialize(body)
+    @status  = 200
+    @headers = {"Content-Type" => "text/html"}
+    @body    = body
+  end
+
+  def call(env)
+    @env = env
+    @headers.merge("Content-Length" => @body.length.to_s)
+    [@status, @headers, [@body]]
+  end
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification 
+name: http_router
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Joshua Hull
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-25 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: A kick-ass HTTP router for use in Rack & Sinatra
+email: joshbuddy@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/http_router.rb
+- lib/http_router/glob.rb
+- lib/http_router/node.rb
+- lib/http_router/path.rb
+- lib/http_router/response.rb
+- lib/http_router/root.rb
+- lib/http_router/route.rb
+- lib/http_router/sinatra.rb
+- lib/http_router/variable.rb
+- lib/rack/uri_escape.rb
+- spec/generate_spec.rb
+- spec/rack/dispatch_spec.rb
+- spec/rack/generate_spec.rb
+- spec/rack/route_spec.rb
+- spec/recognize_spec.rb
+- spec/sinatra/recognize_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/joshbuddy/http_router
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: A kick-ass HTTP router for use in Rack & Sinatra
+test_files: 
+- spec/generate_spec.rb
+- spec/rack/dispatch_spec.rb
+- spec/rack/generate_spec.rb
+- spec/rack/route_spec.rb
+- spec/recognize_spec.rb
+- spec/sinatra/recognize_spec.rb
+- spec/spec_helper.rb