http_router 0.3.13 → 0.3.14

data/README.rdoc

@@ -1,13 +1,5 @@
 = HTTP Router
 
-== Introduction
- 
-When I wrote Usher, I made a few compromises in design that I wasn't totally happy with. More and more features got added to it, and eventually, it became harder to maintain. I took a few moments to work in Node.js, and wrote a router there called Sherpa, which I was happier with. But I felt that by losing more abstraction, and tackling just the problem of HTTP routing, I could come up with something even better.
-
-== Warning
-
-This is very new code. Lots of stuff probably doesn't work right. I will likely never support all the features I had in Usher. Documentation is super-sparse.
-
 == Features
 
 * Supports variables, and globbing, both named and unnamed.

data/benchmarks/rec2.rb

@@ -2,9 +2,10 @@ require 'rubygems'
 require 'rbench'
 
 $LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
-
 require 'lib/http_router'
 
+#require 'http_router'
+
 u = HttpRouter.new
 u.add('/simple').to {|env| [200, {'Content-type'=>'text/html'}, []]}
 u.add('/simple/again').compile.to {|env| [200, {'Content-type'=>'text/html'}, []]}

data/lib/http_router/glob.rb

@@ -1,7 +1,8 @@
 class HttpRouter
   class Glob < Variable
     def matches?(parts)
-      @matches_with.nil? or (!parts.empty? and match = @matches_with.match(parts.first) and match.begin(0)) ? match : nil
+      return if @matches_with.nil? or parts.empty? or !match.begin(0)
+      @matches_with.match(parts.first)
     end
 
     def consume(match, parts)

data/lib/http_router/interface/sinatra.rb

@@ -1,4 +1,3 @@
-$LOAD_PATH << File.join(File.dirname(__FILE__), '..', '..')
 require 'http_router'
 
 class HttpRouter

data/lib/http_router/node.rb

@@ -88,7 +88,7 @@ class HttpRouter
     end
     
     def generate_request_method_tree(request_options)
-      raise(UnsupportedRequestConditionError.new) if (request_options.keys & RequestNode::RequestMethods).size != request_options.size
+      raise UnsupportedRequestConditionError if (request_options.keys & RequestNode::RequestMethods).size != request_options.size
       current_nodes = [self]
       RequestNode::RequestMethods.each do |method|
         if request_options.key?(method) # so, the request method we care about it ..
@@ -136,47 +136,44 @@ class HttpRouter
 
     def find_on_parts(request, parts, params)
       if parts and !parts.empty?
-        if parts.size == 1 and parts.first == ''
-          potential_match = find_on_parts(request, [], params)
-          if potential_match and (router.ignore_trailing_slash? or potential_match.value && potential_match.value.route.trailing_slash_ignore?)
-            parts.shift
-            return potential_match
-          end
-        end
+        return potential if potential = potential_match(request, parts, params)
         if @linear && !@linear.empty?
           response = nil
           dupped_parts = nil
+          dupped_params = nil
           next_node = @linear.find do |(tester, node)|
             if tester.respond_to?(:matches?) and match = tester.matches?(parts)
               dupped_parts = parts.dup
-              params.push((val = tester.consume(match, dupped_parts) and val.is_a?(Array)) ? val.map{|v| HttpRouter.uri_unescape(v)} : HttpRouter.uri_unescape(val))
-              parts.replace(dupped_parts) if response = node.find_on_parts(request, dupped_parts, params)
+              dupped_params = params.dup
+              dupped_params.push((val = tester.consume(match, dupped_parts) and val.is_a?(Array)) ? val.map{|v| HttpRouter.uri_unescape(v)} : HttpRouter.uri_unescape(val))
+              parts.replace(dupped_parts) if response = node.find_on_parts(request, dupped_parts, dupped_params)
             elsif tester.respond_to?(:match) and match = tester.match(parts.whole_path) and match.begin(0) == 0
               dupped_parts = router.split(parts.whole_path[match[0].size, parts.whole_path.size])
-              parts.replace(dupped_parts) if response = node.find_on_parts(request, dupped_parts, params)
+              dupped_params = params.dup
+              parts.replace(dupped_parts) if response = node.find_on_parts(request, dupped_parts, dupped_params)
             else
               nil
             end
           end
-          return response if response
+          if response
+            params.replace(dupped_params)
+            return response
+          end
         end
         if match = @lookup && @lookup[parts.first]
-          parts.shift
-          return match.find_on_parts(request, parts, params)
-        elsif @catchall
+          part = parts.shift
+          if match = match.find_on_parts(request, parts, params)
+            return match
+          else
+            parts.unshift(part)
+          end
+        end
+        if @catchall
           params.push((val = @catchall.variable.consume(nil, parts) and val.is_a?(Array)) ? val.map{|v| HttpRouter.uri_unescape(v)} : HttpRouter.uri_unescape(val))
           return @catchall.find_on_parts(request, parts, params)
         end
       end
-      if request_node
-        request_node.find_on_request_methods(request)
-      elsif arbitrary_node
-        arbitrary_node.find_on_arbitrary(request)
-      elsif @value
-        self
-      else
-        nil
-      end
+      request_node and request_node.find_on_request_methods(request) or resolve_node(request)
     end
 
     def create_linear
@@ -186,57 +183,60 @@ class HttpRouter
     def create_lookup
       @lookup ||= {}
     end
+    
+    protected
+      def resolve_node(request)
+        if arbitrary_node
+          arbitrary_node.find_on_arbitrary(request)
+        elsif @value
+          self
+        else
+          nil
+        end
+      end
+    
+      def potential_match(request, parts, params)
+        if parts.size == 1 and parts.first == ''
+          potential = find_on_parts(request, [], params)
+          if potential and (router.ignore_trailing_slash? or potential.value && potential.value.route.trailing_slash_ignore?)
+            parts.shift
+            potential
+          end
+        end
+        nil
+      end
   end
 
   class ArbitraryNode < Node
     def find_on_arbitrary(request)
-      if @linear && !@linear.empty?
-        next_node = @linear.find do |(procs, node)|
-          procs.all?{|p| p.call(request)}
-        end
-        return next_node.last if next_node
-      end
-      @catchall
+      next_node = @linear && !@linear.empty? && @linear.find { |(procs, node)| procs.all?{|p| p.call(request)} }
+      next_node && next_node.last || @catchall
     end
   end
   
   class RequestNode < Node
-    RequestMethods =  [:request_method, :host, :port, :scheme, :user_agent, :ip, :fullpath, :query_string]
+    RequestMethods = [:request_method, :host, :port, :scheme, :user_agent, :ip, :fullpath, :query_string].freeze
     attr_accessor :request_method
-
-    def find_on_request_methods(request)
-      if @request_method
-        request_method_satisfied = false
+    def find_on_request_methods(request)    
+      next_node = if @request_method
         request_value = request.send(request_method)
+        linear_node(request, request_value) or lookup_node(request, request_value) or catchall_node(request)
+      end
+      next_node or resolve_node(request)
+    end
+    private
+      def linear_node(request, request_value)
         if @linear && !@linear.empty?
-          next_node = @linear.find do |(regexp, node)|
-            regexp === request_value
-          end
-          request_method_satisfied = true if next_node
-          next_node &&= next_node.last.find_on_request_methods(request)
-          return next_node if next_node
-        end
-        if @lookup and next_node = @lookup[request_value]
-          request_method_satisfied = true
-          next_node = next_node.find_on_request_methods(request)
-          return next_node if next_node
-        end
-        if @catchall
-          request_method_satisfied = true
-          next_node = @catchall.find_on_request_methods(request)
-          return next_node if next_node
+          node = @linear.find { |(regexp, node)| regexp === request_value }
+          node.last.find_on_request_methods(request) if node
         end
       end
-
-      if @arbitrary_node
-        @arbitrary_node.find_on_arbitrary(request)
-      elsif @value
-        self
-      else
-        nil
+      def lookup_node(request, request_value)
+        @lookup[request_value].find_on_request_methods(request) if @lookup and @lookup[request_value]
+      end
+      def catchall_node(request)
+        @catchall.find_on_request_methods(request) if @catchall
       end
-    end
-
   end
   
 end

data/lib/http_router/path.rb

@@ -3,9 +3,9 @@ class HttpRouter
     attr_reader :parts, :route, :splitting_indexes
     def initialize(route, path, parts, splitting_indexes)
       @route, @path, @parts, @splitting_indexes = route, path, parts, splitting_indexes
-      if duplicate_variable_names = variable_names.dup.uniq!
-        raise AmbiguousVariableException.new("You have duplicate variable name present: #{duplicate_variable_names.join(', ')}")
-      end
+      
+      duplicate_variable_names = variable_names.dup.uniq!
+      raise AmbiguousVariableException, "You have duplicate variable name present: #{duplicate_variable_names.join(', ')}" if duplicate_variable_names
 
       @path_validation_regex = path.split(/([:\*][a-zA-Z0-9_]+)/).map{ |part|
         case part[0]
@@ -17,7 +17,7 @@ class HttpRouter
       }.join
       @path_validation_regex = Regexp.new("^#{@path_validation_regex}$")
 
-      eval_path = path.gsub(/[:\*]([a-zA-Z0-9_]+)/) {"\#{args.shift || (options && options.delete(:#{$1})) || raise(MissingParameterException.new(\"missing parameter #{$1}\"))}" }
+      eval_path = path.gsub(/[:\*]([a-zA-Z0-9_]+)/) {"\#{args.shift || (options && options.delete(:#{$1})) || raise(MissingParameterException, \"missing parameter #{$1}\")}" }
       instance_eval "
       def raw_url(args,options)
         \"#{eval_path}\"
@@ -35,17 +35,16 @@ class HttpRouter
 
     def compare_parts(p1, p2)
       case p1
-      when Glob then p2.is_a?(Glob)
+      when Glob     then p2.is_a?(Glob)
       when Variable then p2.is_a?(Variable)
-      else
-        p1 == p2
+      else               p1 == p2
       end
     end
 
     def url(args, options)
       path = raw_url(args, options)
-      raise InvalidRouteException.new if path !~ @path_validation_regex
-      raise TooManyParametersException.new unless args.empty?
+      raise InvalidRouteException if path !~ @path_validation_regex
+      raise TooManyParametersException unless args.empty?
       HttpRouter.uri_escape!(path)
       generate_querystring(path, options)
       path

data/lib/http_router/route.rb

@@ -190,7 +190,7 @@ class HttpRouter
         @paths = compile_paths
         @paths.each_with_index do |p1, i|
           @paths[i+1, @paths.size].each do |p2|
-            raise AmbiguousRouteException.new if p1 === p2
+            raise AmbiguousRouteException if p1 === p2
           end
         end
         @paths.each do |path|
@@ -207,7 +207,7 @@ class HttpRouter
 
     # Sets the destination of this route to redirect to an arbitrary URL.
     def redirect(path, status = 302)
-      raise(ArgumentError, "Status has to be an integer between 300 and 399") unless (300..399).include?(status)
+      raise ArgumentError, "Status has to be an integer between 300 and 399" unless (300..399).include?(status)
       to { |env|
         params = env['router.params']
         response = ::Rack::Response.new
@@ -247,7 +247,7 @@ class HttpRouter
       else
         matching_path(args, options)
       end
-      raise UngeneratableRouteException.new unless path
+      raise UngeneratableRouteException unless path
 
       mount_point = nil
       if !router.url_mount.nil?
@@ -363,7 +363,7 @@ class HttpRouter
     end
 
     def guard_compiled
-      raise AlreadyCompiledException.new if compiled?
+      raise AlreadyCompiledException if compiled?
     end
 
     def significant_variable_names

data/lib/http_router/version.rb

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

data/lib/http_router.rb

@@ -170,7 +170,7 @@ class HttpRouter
       when Symbol
         url(@named_routes[route], *args)
       when nil
-        raise UngeneratableRouteException.new
+        raise UngeneratableRouteException
       else
         route.url(*args)
     end

data/spec/recognize_spec.rb

@@ -223,6 +223,13 @@ describe "HttpRouter#recognize" do
       @router.recognize(Rack::MockRequest.env_for('/foo/id')).params_as_hash[:$1].should == 'id'
     end
 
+    it "should use a static part as a variable if no further match is available" do
+      @router.add("/foo/foo").to(:test1)
+      @router.add("/:foo/foo2").to(:test2)
+      @router.recognize(Rack::MockRequest.env_for('/foo/foo')).dest.should == :test1
+      @router.recognize(Rack::MockRequest.env_for('/foo/foo2')).dest.should == :test2
+    end
+
     it "should recognize /foo/:/: and map it to $1 and $2" do
       @router.add("/foo/:/:").to(:test2)
       @router.recognize(Rack::MockRequest.env_for('/foo/id/what')).dest.should == :test2
@@ -400,5 +407,43 @@ describe "HttpRouter#recognize" do
       @router.recognize(Rack::MockRequest.env_for('/test.html')).params.first.should == 'test.html'
     end
 
+    # BUG: http://gist.github.com/554909
+    context "when there is an additional route for the case of regex matching failure" do
+      before :each do
+        @matched = @router.add("/:common_variable/:matched").matching(:matched => /\d+/).to(:something)
+        @unmatched = @router.add("/:common_variable/:unmatched").to(:something_unmatched)
+      end
+
+      it "should use main route if pattern is matched" do
+        response = @router.recognize(Rack::MockRequest.env_for('/common/123'))
+        response.route.should == @matched
+        response.params.should == ['common', '123']
+      end
+
+      it "should use additional route if pattern is not matched" do
+        response = @router.recognize(Rack::MockRequest.env_for('/common/other'))
+        response.route.should == @unmatched
+        response.params.should == ['common', 'other']
+      end
+
+      context "when delimiter is not a slash" do
+        before :each do
+          @matched = @router.add("/:common_variable.:matched").matching(:matched => /\d+/).to(:something)
+          @unmatched = @router.add("/:common_variable.:unmatched").to(:something_unmatched)
+        end
+
+        it "should use main route if pattern is matched" do
+          response = @router.recognize(Rack::MockRequest.env_for('/common.123'))
+          response.route.should == @matched
+          response.params.should == ['common', '123']
+        end
+
+        it "should use additional route if pattern is not matched" do
+          response = @router.recognize(Rack::MockRequest.env_for('/common.other'))
+          response.route.should == @unmatched
+          response.params.should == ['common', 'other']
+        end
+      end
+    end
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: http_router
 version: !ruby/object:Gem::Version 
-  hash: 9
+  hash: 15
   prerelease: false
   segments: 
   - 0
   - 3
-  - 13
-  version: 0.3.13
+  - 14
+  version: 0.3.14
 platform: ruby
 authors: 
 - Joshua Hull
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-20 00:00:00 -07:00
+date: 2010-09-01 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency