usher 0.7.1 → 0.7.2

data/spec/private/sinatra/recognize_spec.rb

@@ -0,0 +1,102 @@
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "..", "spec_helper"))
+require "usher"
+require "sinatra"
+
+describe "Usher (for Sinatra) route recognition" do
+  before(:each) do
+    @app = Sinatra.new { register Usher::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 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
+  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
+end

data/spec/spec_helper.rb

@@ -22,4 +22,4 @@ class MockApp
     @headers.merge("Content-Length" => @body.length.to_s)
     [@status, @headers, [@body]]
   end
-end
+end

data/usher.gemspec

@@ -5,7 +5,7 @@ require "base64"
 
 Gem::Specification.new do |s|
   s.name = "usher"
-  s.version = "0.7.1"
+  s.version = "0.7.2"
   s.authors = ["Daniel Neighman", "Daniel Vartanov", "Jakub Šťastný", "Joshua Hull"]
   s.homepage = "http://github.com/joshbuddy/usher"
   s.summary = "Pure ruby general purpose router with interfaces for rails, rack, email or choose your own adventure"
@@ -14,12 +14,15 @@ Gem::Specification.new do |s|
   s.has_rdoc = true
 
   # files
-  s.files = `git ls-files`.split("\n") - `git ls-files spec/rails2_2/vendor`.split("\n") - `git ls-files spec/rails2_3/vendor`.split("\n")
+  s.files = `git ls-files`.split("\n") - `git ls-files spec/rails2_2`.split("\n") - `git ls-files spec/rails2_3`.split("\n")
   s.require_paths = ["lib"]
 
   # dependencies
   s.add_dependency "fuzzyhash", ">= 0.0.11"
-
-  # RubyForge
-  s.rubyforge_project = "joshbuddy-usher"
+  
+  # development dependencies
+  s.add_development_dependency "yard"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "code_stats"
+  s.add_development_dependency "rake"
 end

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: usher
 version: !ruby/object:Gem::Version 
-  version: 0.7.1
+  prerelease: false
+  segments: 
+  - 0
+  - 7
+  - 2
+  version: 0.7.2
 platform: ruby
 authors: 
 - Daniel Neighman
@@ -13,19 +18,71 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: 
-date: 2010-03-22 00:00:00 -04:00
+date: 2010-04-29 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: fuzzyhash
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 0
+        - 11
         version: 0.0.11
-    version: 
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: code_stats
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
 description: 
 email: joshbuddy@gmail.com
 executables: []
@@ -37,11 +94,13 @@ extra_rdoc_files: []
 files: 
 - .gitignore
 - CHANGES.rdoc
+- Gemfile
 - History.txt
 - Manifest.txt
-- README.rdoc
+- README.markdown
 - Rakefile
 - benchmarks/generation_bm.rb
+- benchmarks/rack_recognition_bm.rb
 - benchmarks/recognition_bm.rb
 - lib/usher.rb
 - lib/usher/delimiters.rb
@@ -51,6 +110,8 @@ files:
 - lib/usher/interface/email.rb
 - lib/usher/interface/merb.rb
 - lib/usher/interface/rack.rb
+- lib/usher/interface/rack/builder.rb
+- lib/usher/interface/rack/middleware.rb
 - lib/usher/interface/rack/route.rb
 - lib/usher/interface/rails20.rb
 - lib/usher/interface/rails22.rb
@@ -88,16 +149,9 @@ files:
 - spec/private/rack/route_spec.rb
 - spec/private/recognize_spec.rb
 - spec/private/request_method_spec.rb
+- spec/private/sinatra/recognize_spec.rb
 - spec/private/splitter_spec.rb
 - spec/private/url_parts_spec.rb
-- spec/rails2_2/compat.rb
-- spec/rails2_2/generate_spec.rb
-- spec/rails2_2/path_spec.rb
-- spec/rails2_2/recognize_spec.rb
-- spec/rails2_3/compat.rb
-- spec/rails2_3/generate_spec.rb
-- spec/rails2_3/path_spec.rb
-- spec/rails2_3/recognize_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
 - tasks/routes.rake
@@ -115,18 +169,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
-rubyforge_project: joshbuddy-usher
-rubygems_version: 1.3.5
+rubyforge_project: 
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Pure ruby general purpose router with interfaces for rails, rack, email or choose your own adventure

data/README.rdoc

@@ -1,158 +0,0 @@
-= Usher
-
-Tree-based router library. Useful for (specifically) for Rails and Rack, but probably generally useful for anyone interested in doing routing. Based on Ilya Grigorik suggestion, turns out looking up in a hash and following a tree is faster than Krauter's massive regex approach.
-
-== Features
-
-* Understands single and path-globbing variables
-* Understands arbitrary regex variables
-* Arbitrary HTTP header requirements
-* No optimization phase, so routes are always alterable after the fact
-* Understands Proc and Regex transformations, validations
-* Really, really fast
-* Relatively light and happy code-base, should be easy and fun to alter (it hovers around 1,000 LOC, 800 for the core)
-* Interface and implementation are separate, encouraging cross-pollination
-* Works in 1.9!
-
-== Projects using or other references to Usher
-
-* http://github.com/Tass/CRUDtree - RESTful resource mapper
-* http://github.com/padrino/padrino-framework - Web framework
-* http://github.com/botanicus/rango - Web framework
-* http://github.com/hassox/pancake - Web framework
-* http://github.com/eddanger/junior - Web framework
-* http://github.com/lifo/cramp - Web framework
-* http://yehudakatz.com/2009/08/26/how-to-build-sinatra-on-rails-3/ - How to Build Sinatra on Rails 3
-
-Any probably more!
-
-== Route format
-
-From the rdoc:
-
-Creates a route from +path+ and +options+
-
-=== +path+
-A path consists a mix of dynamic and static parts delimited by <tt>/</tt>
-
-==== Dynamic
-Dynamic parts are prefixed with either :, *.  :variable matches only one part of the path, whereas *variable can match one or
-more parts.
-
-<b>Example:</b>
-<tt>/path/:variable/path</tt> would match
-
-* <tt>/path/test/path</tt>
-* <tt>/path/something_else/path</tt>
-* <tt>/path/one_more/path</tt>
-
-In the above examples, 'test', 'something_else' and 'one_more' respectively would be bound to the key <tt>:variable</tt>.
-However, <tt>/path/test/one_more/path</tt> would not be matched.
-
-<b>Example:</b>
-<tt>/path/*variable/path</tt> would match
-
-* <tt>/path/one/two/three/path</tt>
-* <tt>/path/four/five/path</tt>
-
-In the above examples, ['one', 'two', 'three'] and ['four', 'five'] respectively would be bound to the key :variable.
-
-As well, variables can have a regex matcher.
-
-<b>Example:</b>
-<tt>/product/{:id,\d+}</tt> would match
-
-* <tt>/product/123</tt>
-* <tt>/product/4521</tt>
-
-But not
-* <tt>/product/AE-35</tt>
-
-As well, the same logic applies for * variables as well, where only parts matchable by the supplied regex will
-actually be bound to the variable
-
-Variables can also have a greedy regex matcher. These matchers ignore all delimiters, and continue matching for as long as much as their
-regex allows.
-
-<b>Example:</b>
-<tt>/product/{!id,hello/world|hello}</tt> would match
-
-* <tt>/product/hello/world</tt>
-* <tt>/product/hello</tt>
-
-
-==== Static
-
-Static parts of literal character sequences. For instance, <tt>/path/something.html</tt> would match only the same path.
-As well, static parts can have a regex pattern in them as well, such as <tt>/path/something.{html|xml}</tt> which would match only
-<tt>/path/something.html</tt> and <tt>/path/something.xml</tt>
-
-==== Optional sections
-
-Sections of a route can be marked as optional by surrounding it with brackets. For instance, in the above static example, <tt>/path/something(.html)</tt> would match both <tt>/path/something</tt> and <tt>/path/something.html</tt>.
-
-==== One and only one sections
-
-Sections of a route can be marked as "one and only one" by surrounding it with brackets and separating parts of the route with pipes.
-For instance, the path, <tt>/path/something(.xml|.html)</tt> would only match <tt>/path/something.xml</tt> and
-<tt>/path/something.html</tt>. Generally its more efficent to use one and only sections over using regex.
-
-=== +options+
-* +requirements+ - After transformation, tests the condition using ===. If it returns false, it raises an <tt>Usher::ValidationException</tt>
-* +conditions+ - Accepts any of the +request_methods+ specificied in the construction of Usher. This can be either a <tt>string</tt> or a regular expression.
-* +default_values+ - Provides values for variables in your route for generation. If you're using URL generation, then any values supplied here that aren't included in your path will be appended to the query string.
-* +priority+ - If there are two routes which equally match, the route with the highest priority will match first.
-* Any other key is interpreted as a requirement for the variable of its name.
-
-== Rails
-
-  script/plugin install git://github.com/joshbuddy/usher.git
-
-In your config/initializers/usher.rb (create if it doesn't exist) add:
-
-  Usher::Util::Rails.activate
-
-== Rack
-
-=== config.ru
-
-  require 'usher'
-  app = proc do |env|
-    body = "Hi there #{env['usher.params'][:name]}"
-    [
-      200,          # Status code
-      {             # Response headers
-        'Content-Type' => 'text/plain',
-        'Content-Length' => body.size.to_s,
-      },
-      [body]        # Response body
-    ]
-  end
-
-  routes = Usher::Interface.for(:rack) do
-    add('/hello/:name').to(app)
-  end
-
-  run routes
-
-------------
-
-  >> curl http://127.0.0.1:3000/hello/samueltanders
-  << Hi there samueltanders
-
-
-== Sinatra
-
-In Sinatra, you get the extra method, +generate+, which lets you generate a url. Name your routes with <tt>:name</tt> when you define them.
-
-  require 'rubygems'
-  require 'usher'
-  require 'sinatra'
-  
-  Usher::Interface.for(:sinatra)
-  
-  get '/hi', :name => :hi do
-    "Hello World! #{generate(:hi)}"
-  end
-
-(Let me show you to your request)

data/spec/rails2_2/compat.rb

@@ -1,3 +0,0 @@
-require File.expand_path(File.join(File.dirname(__FILE__), "..", "spec_helper"))
-require File.expand_path(File.join(File.dirname(__FILE__), 'vendor', 'rails', 'config', 'environment'))
-

data/spec/rails2_2/generate_spec.rb

@@ -1,28 +0,0 @@
-require File.expand_path(File.join(File.dirname(__FILE__), 'compat'))
-require "usher"
-
-route_set = Usher::Interface.for(:rails22)
-
-describe "Usher (for rails 2.2) URL generation" do
-  
-  before(:each) do
-    route_set.reset!
-  end
-
-  it "should fill in the controller from recall" do
-    route_set.add_route('/:controller/:action/:id')
-    route_set.generate({:action => 'thingy'}, {:controller => 'sample', :action => 'index', :id => 123}, :generate).should == '/sample/thingy'
-  end
-
-  it "should skip the action if not provided" do
-    route_set.add_route('/:controller/:action/:id')
-    route_set.generate({:controller => 'thingy'}, {:controller => 'sample', :action => 'index', :id => 123}, :generate).should == '/thingy'
-  end
-
-  it "should pick the correct param from optional parts" do
-    route_set.add_route('/:controller/:action(.:format)')
-    route_set.generate({:action => 'thingy', :format => 'html'}, {:controller => 'sample', :action => 'index', :id => 123}, :generate).should == '/sample/thingy.html'
-    route_set.generate({:action => 'thingy'}, {:controller => 'sample', :action => 'index', :id => 123}, :generate).should == '/sample/thingy'
-  end
-
-end

data/spec/rails2_2/path_spec.rb

@@ -1,16 +0,0 @@
-require File.expand_path(File.join(File.dirname(__FILE__), 'compat'))
-require "usher"
-
-route_set = Usher::Interface.for(:rails22)
-
-describe "Usher (for rails 2.2) route adding" do
-
-  before(:each) do
-    route_set.reset!
-  end
-
-  it "shouldn't allow routes without a controller to be added" do
-    proc { route_set.add_route('/bad/route') }.should raise_error
-  end
-
-end

data/spec/rails2_2/recognize_spec.rb

@@ -1,78 +0,0 @@
-require File.expand_path(File.join(File.dirname(__FILE__), 'compat'))
-require "usher"
-
-route_set = Usher::Interface.for(:rails22)
-
-def build_request_mock_rails22(path, method, params)
-  request = mock "Request"
-  request.should_receive(:path).any_number_of_times.and_return(path)
-  request.should_receive(:method).any_number_of_times.and_return(method)
-  params = params.with_indifferent_access
-  request.should_receive(:path_parameters=).any_number_of_times.with(params)
-  request.should_receive(:path_parameters).any_number_of_times.and_return(params)
-  request
-end
-
-SampleController = Object.new
-
-describe "Usher (for rails 2.2) route recognition" do
-
-  before(:each) do
-    route_set.reset!
-  end
-
-  it "should recognize a simple request" do
-    route_set.add_route('/sample', :controller => 'sample', :action => 'action')
-    route_set.recognize(build_request_mock_rails22('/sample', 'get', {:controller => 'sample', :action => 'action'})).should == SampleController
-  end
-
-  it "should interpolate action :index" do
-    route_set.add_route('/sample', :controller => 'sample')
-    route_set.recognize(build_request_mock_rails22('/sample', 'get', {:controller => 'sample', :action => 'index'})).should == SampleController
-  end
-
-  it "should correctly distinguish between multiple request methods" do
-    route_set.add_route('/sample', :controller => 'not_sample', :conditions => {:method => :get})
-    correct_route = route_set.add_route('/sample', :controller => 'sample', :conditions => {:method => :post})
-    route_set.add_route('/sample', :controller => 'not_sample', :conditions => {:method => :put})
-    route_set.recognize(build_request_mock_rails22('/sample', :post, {:controller => 'sample', :action => 'index'})).should == SampleController
-  end
-
-  it "should prefer the static route to the dynamic route" do
-    route_set.add_route('/sample/:action', :controller => 'not_sample')
-    route_set.add_route('/sample/test', :controller => 'sample', :action => 'action')
-    route_set.recognize(build_request_mock_rails22('/sample/test', 'get', {:controller => 'sample', :action => 'action'})).should == SampleController
-  end
-  
-  it "should raise based upon an invalid param" do
-    route_set.add_named_route(:sample, '/sample/:action', :controller => 'sample', :requirements => {:action => /\d+/})
-    proc { route_set.recognize(build_request_mock_rails22('/sample/asdqwe', :post, {})) }.should raise_error
-  end
-  
-  it "should raise based upon an invalid route" do
-    route_set.add_named_route(:sample, '/sample', :controller => 'sample', :action => 'test')
-    proc { route_set.recognize(build_request_mock_rails22('/test/asdqwe', :post, {})) }.should raise_error
-  end
-  
-  it "should add /:controller and /:controller/:action if /:controller/:action/:id is added" do
-    route_set.add_route('/:controller/:action/:id')
-    route_set.route_count.should == 3
-  end
-  
-  it "should correctly recognize a format (dynamic path path with . delimiter)" do
-    route_set.add_route('/:controller/:action/:id.:format')
-    route_set.recognize(build_request_mock_rails22('/sample/test/123.html', 'get', {:controller => 'sample', :action => 'test', :id => '123', :format => 'html'})).should == SampleController
-  end
-  
-  it "should support root nodes" do
-    route_set.add_route('/', :controller => 'sample')
-    route_set.recognize(build_request_mock_rails22('/', :get, {:controller => 'sample', :action => 'index'})).should == SampleController
-  end
-  
-  it "should default action to 'index' when controller (and not index) is specified" do
-    route_set.add_route('/:controller/:action')
-    route_set.recognize(build_request_mock_rails22('/sample', :get, {:controller => 'sample', :action => 'index'})).should == SampleController
-  end
-  
-  
-end

data/spec/rails2_3/compat.rb

@@ -1,2 +0,0 @@
-require File.expand_path(File.join(File.dirname(__FILE__), "..", "spec_helper"))
-require File.expand_path(File.join(File.dirname(__FILE__), 'vendor', 'rails', 'config', 'environment'))

data/spec/rails2_3/generate_spec.rb

@@ -1,28 +0,0 @@
-require File.expand_path(File.join(File.dirname(__FILE__), 'compat'))
-require "usher"
-
-route_set = Usher::Interface.for(:rails23)
-
-describe "Usher (for rails 2.3) URL generation" do
-  
-  before(:each) do
-    route_set.reset!
-  end
-
-  it "should fill in the controller from recall" do
-    route_set.add_route('/:controller/:action/:id')
-    route_set.generate({:action => 'thingy'}, {:controller => 'sample', :action => 'index', :id => 123}, :generate).should == '/sample/thingy'
-  end
-
-  it "should skip the action if not provided" do
-    route_set.add_route('/:controller/:action/:id')
-    route_set.generate({:controller => 'thingy'}, {:controller => 'sample', :action => 'index', :id => 123}, :generate).should == '/thingy'
-  end
-
-  it "should pick the correct param from optional parts" do
-    route_set.add_route('/:controller/:action(.:format)')
-    route_set.generate({:action => 'thingy', :format => 'html'}, {:controller => 'sample', :action => 'index', :id => 123}, :generate).should == '/sample/thingy.html'
-    route_set.generate({:action => 'thingy'}, {:controller => 'sample', :action => 'index', :id => 123}, :generate).should == '/sample/thingy'
-  end
-
-end

data/spec/rails2_3/path_spec.rb

@@ -1,16 +0,0 @@
-require File.expand_path(File.join(File.dirname(__FILE__), 'compat'))
-require "usher"
-
-route_set = Usher::Interface.for(:rails23)
-
-describe "Usher (for rails 2.3) route adding" do
-
-  before(:each) do
-    route_set.reset!
-  end
-
-  it "shouldn't allow routes without a controller to be added" do
-    proc { route_set.add_route('/bad/route') }.should raise_error
-  end
-
-end