http_router 0.6.4 → 0.6.5

data/lib/http_router/node/free_regex.rb

@@ -8,7 +8,7 @@ class HttpRouter
 
       def [](request)
         whole_path = "/#{join_whole_path(request)}"
-        if match = @matcher.match(whole_path)
+        if match = @matcher.match(whole_path) and match[0].size == whole_path.size
           request = request.clone
           request.extra_env['router.regex_match'] = match
           match.names.size.times{|i| request.params << match[i + 1]} if match.respond_to?(:names) && match.names

data/lib/http_router/node.rb

@@ -141,20 +141,6 @@ class HttpRouter
       add_prioritized_match(SpanningRegex.new(@router, regexp, matching_indicies, priority, splitting_indicies))
     end
 
-    def add_prioritized_match(match)
-      @linear ||= []
-      if match.priority != 0
-        @linear.each_with_index { |n, i|
-          if match.priority > (n.priority || 0)
-            @linear[i, 0] = match
-            return @linear[i]
-          end
-        }
-      end
-      @linear << match
-      @linear.last
-    end
-
     def add_free_match(regexp)
       @linear ||= []
       @linear << FreeRegex.new(@router, regexp)
@@ -172,8 +158,22 @@ class HttpRouter
     end
 
     def join_whole_path(request)
-      request.path.join('/')
+      request.path * '/'
     end
 
+    private
+    def add_prioritized_match(match)
+      @linear ||= []
+      if match.priority != 0
+        @linear.each_with_index { |n, i|
+          if match.priority > (n.priority || 0)
+            @linear[i, 0] = match
+            return @linear[i]
+          end
+        }
+      end
+      @linear << match
+      @linear.last
+    end
   end
 end

data/lib/http_router/path.rb

@@ -2,7 +2,7 @@ class HttpRouter
   class Path
     attr_reader :route, :param_names
     def initialize(route, path, param_names = [])
-      @route, @path, @param_names, @static = route, path, param_names, param_names.empty?
+      @route, @path, @param_names, @dynamic = route, path, param_names, !param_names.empty?
       duplicate_param_names = param_names.dup.uniq!
       raise AmbiguousVariableException, "You have duplicate variable name present: #{duplicate_param_names.join(', ')}" if duplicate_param_names
       if path.respond_to?(:split)
@@ -34,7 +34,7 @@ class HttpRouter
     end
 
     def hashify_params(params)
-      !@static && params ? param_names.zip(params).inject({}) { |h, (k,v)| h[k] = v; h } : {}
+      @dynamic && params ? param_names.zip(params).inject({}) { |h, (k,v)| h[k] = v; h } : {}
     end
 
     def url(args, options)
@@ -50,7 +50,7 @@ class HttpRouter
     end
 
     private
-    def raw_url(args,options)
+    def raw_url(args, options)
       raise UngeneratableRouteException
     end
 

data/lib/http_router/route.rb

@@ -125,7 +125,7 @@ class HttpRouter
 
     def url(*args)
       result, extra_params = url_with_params(*args)
-      @router.append_querystring(result, extra_params)
+      append_querystring(result, extra_params)
     end
 
     def clone(new_router)
@@ -262,5 +262,21 @@ class HttpRouter
       end
       path_obj
     end
+
+    def append_querystring(uri, params)
+      if params && !params.empty?
+        uri_size = uri.size
+        params.each do |k,v|
+          case v
+          when Array
+            v.each { |v_part| uri << '&' << ::Rack::Utils.escape(k.to_s) << '%5B%5D=' << ::Rack::Utils.escape(v_part.to_s) }
+          else
+            uri << '&' << ::Rack::Utils.escape(k.to_s) << '=' << ::Rack::Utils.escape(v.to_s)
+          end
+        end
+        uri[uri_size] = ??
+      end
+      uri
+    end
   end
 end

data/lib/http_router/version.rb

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

data/lib/http_router.rb

@@ -13,18 +13,45 @@ class HttpRouter
   attr_reader :root, :routes, :known_methods, :named_routes
   attr_accessor :default_app, :url_mount
 
+  # Raised when a Route is not able to be generated.
   UngeneratableRouteException = Class.new(RuntimeError)
+  # Raised when a Route is generated that isn't valid.
   InvalidRouteException       = Class.new(RuntimeError)
+  # Raised when a Route is not able to be generated due to a missing parameter.
   MissingParameterException   = Class.new(RuntimeError)
 
-  def initialize(options = nil, &blk)
-    reset!
+  # Creates a new HttpRouter.
+  # Can be called with either <tt>HttpRouter.new(proc{|env| ... }, { .. options .. })</tt> or with the first argument omitted.
+  # If there is a proc first, then it's used as the default app in the case of a non-match.
+  # Supported options are
+  # * :default_app -- Default application used if there is a non-match on #call. Defaults to 404 generator.
+  # * :ignore_trailing_slash -- Ignore a trailing / when attempting to match. Defaults to +true+.
+  # * :redirect_trailing_slash -- On trailing /, redirect to the same path without the /. Defaults to +false+.
+  def initialize(*args, &blk)
+    default_app, options = args.first.is_a?(Hash) ? [nil, args.first] : [args.first, args[1]]
     @options = options
     @default_app = default_app || options && options[:default_app] || proc{|env| ::Rack::Response.new("Not Found", 404).finish }
     @ignore_trailing_slash = options && options.key?(:ignore_trailing_slash) ? options[:ignore_trailing_slash] : true
+    @redirect_trailing_slash = options && options.key?(:redirect_trailing_slash) ? options[:redirect_trailing_slash] : false
+    reset!
     instance_eval(&blk) if blk
   end
 
+  # Adds a path to be recognized.
+  #
+  # To assign a part of the path to a specific variable, use :variable_name within the route.
+  # For example, <tt>add('/path/:id')</tt> would match <tt>/path/test</tt>, with the variable <tt>:id</tt> having the value <tt>"test"</tt>.
+  #
+  # You can receive mulitple parts into a single variable by using the glob syntax.
+  # For example, <tt>add('/path/*id')</tt> would match <tt>/path/123/456/789</tt>, with the variable <tt>:id</tt> having the value <tt>["123", "456", "789"]</tt>.
+  #
+  # As well, paths can end with two optional parts, <tt>*</tt> and <tt>/?</tt>. If it ends with a <tt>*</tt>, it will match partially, returning the part of the path unmatched in the PATH_INFO value of the env. The part matched to will be returned in the SCRIPT_NAME. If it ends with <tt>/?</tt>, then a trailing / on the path will be optionally matched for that specific route. As trailing /'s are ignored by default, you probably don't actually want to use this option that frequently.
+  #
+  # Routes can also contain optional parts. There are surrounded with <tt>( )</tt>'s. If you need to match on a bracket in the route itself, you can escape the parentheses with a backslash.
+  #
+  # The second argument, options, is an optional hash that can modify the route in further ways. See HttpRouter::Route#with_options for details. Typically, you want to add further options to the route by calling additional methods on it. See HttpRouter::Route for further details.
+  #
+  # Returns the route object.
   def add(path, opts = {}, &app)
     route = case path
     when Regexp
@@ -41,40 +68,65 @@ class HttpRouter
     @routes << route
   end
 
-  def add_with_request_method(path, method, opts = {}, &app)
-    route = add(path, opts).send(method.to_sym)
-    route.to(app) if app
-    route
-  end
+  # Adds a path that only responds to the request method +GET+.
+  #
+  # Returns the route object.
+  def get(path, opts = {}, &app);    add_with_request_method(path, :get, opts, &app);    end
 
-  [:post, :get, :delete, :put, :head].each do |rm|
-    class_eval "def #{rm}(path, opts = {}, &app); add_with_request_method(path, #{rm.inspect}, opts, &app); end", __FILE__, __LINE__
-  end
+  # Adds a path that only responds to the request method +POST+.
+  #
+  # Returns the route object.
+  def post(path, opts = {}, &app);   add_with_request_method(path, :post, opts, &app);   end
+
+  # Adds a path that only responds to the request method +HEAD+.
+  #
+  # Returns the route object.
+  def head(path, opts = {}, &app);   add_with_request_method(path, :head, opts, &app);   end
+
+  # Adds a path that only responds to the request method +DELETE+.
+  #
+  # Returns the route object.
+  def delete(path, opts = {}, &app); add_with_request_method(path, :delete, opts, &app); end
+
+  # Adds a path that only responds to the request method +PUT+.
+  #
+  # Returns the route object.
+  def put(path, opts = {}, &app);    add_with_request_method(path, :put, opts, &app);    end
 
   def recognize(env)
     call(env, false)
   end
 
+  # Rack compatible #call. If matching route is found, and +dest+ value responds to #call, processing will pass to the matched route. Otherwise,
+  # the default application will be called. The router will be available in the env under the key <tt>router</tt>. And parameters matched will
+  # be available under the key <tt>router.params</tt>.
   def call(env, perform_call = true)
     rack_request = Rack::Request.new(env)
-    request = Request.new(rack_request.path_info, rack_request, perform_call)
-    response = catch(:success) { @root[request] }
-    if !response
-      supported_methods = (@known_methods - [env['REQUEST_METHOD']]).select do |m| 
-        test_env = Rack::Request.new(rack_request.env.clone)
-        test_env.env['REQUEST_METHOD'] = m
-        test_env.env['HTTP_ROUTER_405_TESTING_ACCEPTANCE'] = true
-        test_request = Request.new(test_env.path_info, test_env, 405)
-        catch(:success) { @root[test_request] }
-      end
-      supported_methods.empty? ? @default_app.call(env) : [405, {'Allow' => supported_methods.sort.join(", ")}, []]
-    elsif response
-      response
+    if redirect_trailing_slash? && (rack_request.head? || rack_request.get?) && rack_request.path_info[-1] == ?/
+      response = ::Rack::Response.new
+      response.redirect(request.path_info[0, request.path_info.size - 1], 302)
+      response.finish
     else
-      @default_app.call(env)
+      request = Request.new(rack_request.path_info, rack_request, perform_call)
+      response = catch(:success) { @root[request] }
+      if !response
+        supported_methods = (@known_methods - [env['REQUEST_METHOD']]).select do |m| 
+          test_env = Rack::Request.new(rack_request.env.clone)
+          test_env.env['REQUEST_METHOD'] = m
+          test_env.env['HTTP_ROUTER_405_TESTING_ACCEPTANCE'] = true
+          test_request = Request.new(test_env.path_info, test_env, 405)
+          catch(:success) { @root[test_request] }
+        end
+        supported_methods.empty? ? @default_app.call(env) : [405, {'Allow' => supported_methods.sort.join(", ")}, []]
+      elsif response
+        response
+      else
+        @default_app.call(env)
+      end
     end
   end
 
+  # Resets the router to a clean state.
   def reset!
     @root = Node.new(self)
     @default_app = Proc.new{ |env| Rack::Response.new("Your request couldn't be found", 404).finish }
@@ -83,32 +135,41 @@ class HttpRouter
     @known_methods = ['GET', "POST", "PUT", "DELETE"]
   end
 
+  # Assigns the default application.
+  def default(app)
+    @default_app = app
+  end
+
+  # Generate a URL for a specified route. This will accept a list of variable values plus any other variable names named as a hash.
+  # This first value must be either the Route object or the name of the route.
+  #
+  # Example:
+  #   router = HttpRouter.new
+  #   router.add('/:foo.:format).name(:test).compile
+  #   router.url(:test, 123, 'html')
+  #   # ==> "/123.html"
+  #   router.url(:test, 123, :format => 'html')
+  #   # ==> "/123.html"
+  #   router.url(:test, :foo => 123, :format => 'html')
+  #   # ==> "/123.html"
+  #   router.url(:test, :foo => 123, :format => 'html', :fun => 'inthesun')
+  #   # ==> "/123.html?fun=inthesun"
   def url(route, *args)
     case route
-    when Symbol then url(@named_routes[route], *args)
+    when Symbol then @named_routes.key?(route) ? @named_routes[route].url(*args) : raise(UngeneratableRouteException)
     when Route  then route.url(*args)
     else raise UngeneratableRouteException
     end
   end
 
+  # Ignore trailing slash feature enabled? See #initialize for details.
   def ignore_trailing_slash?
     @ignore_trailing_slash
   end
 
-  def append_querystring(uri, params)
-    if params && !params.empty?
-      uri_size = uri.size
-      params.each do |k,v|
-        case v
-        when Array
-          v.each { |v_part| uri << '&' << ::Rack::Utils.escape(k.to_s) << '%5B%5D=' << ::Rack::Utils.escape(v_part.to_s) }
-        else
-          uri << '&' << ::Rack::Utils.escape(k.to_s) << '=' << ::Rack::Utils.escape(v.to_s)
-        end
-      end
-      uri[uri_size] = ??
-    end
-    uri
+  # Redirect trailing slash feature enabled? See #initialize for details.
+  def redirect_trailing_slash?
+    @redirect_trailing_slash
   end
 
   # Creates a deep-copy of the router.
@@ -126,4 +187,11 @@ class HttpRouter
     end
     cloned_router
   end
+
+  private
+  def add_with_request_method(path, method, opts = {}, &app)
+    route = add(path, opts).send(method.to_sym)
+    route.to(app) if app
+    route
+  end
 end

data/test/test_variable.rb

@@ -43,7 +43,7 @@ class TestVariable < MiniTest::Unit::TestCase
   end
 
   def test_match_path
-    r = router { add(%r{^/(test123|\d+)$}) }
+    r = router { add %r{/(test123|\d+)} }
     assert_route r, '/test123'
     assert_route r, '/123'
     assert_route nil, '/test123andmore'
@@ -92,6 +92,10 @@ class TestVariable < MiniTest::Unit::TestCase
     assert_route '/test/*variable.:format', 'test/one/two/three.html', {:variable => ['one', 'two', 'three'], :format => 'html'}
   end
 
+  def test_glob_with_optional_format
+    assert_route '/test/*variable(.:format)', 'test/one/two/three.html', {:variable => ['one', 'two', 'three'], :format => 'html'}
+  end
+
   def test_glob_with_literal
     assert_route '/test/*variable.html', 'test/one/two/three.html', {:variable => ['one', 'two', 'three']}
   end
@@ -116,6 +120,7 @@ class TestVariable < MiniTest::Unit::TestCase
     def test_match_path_with_groups
       r = router { add(%r{/(?<year>\\d{4})/(?<month>\\d{2})/(?<day>\\d{2})/?}) }
       assert_route r, '/1234/23/56', {:year => '1234', :month => '23', :day => '56'}
-    end"
+    end
+    "
   end
 end

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: http_router
 version: !ruby/object:Gem::Version 
+  hash: 13
   prerelease: false
   segments: 
   - 0
   - 6
-  - 4
-  version: 0.6.4
+  - 5
+  version: 0.6.5
 platform: ruby
 authors: 
 - Joshua Hull
@@ -14,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-22 00:00:00 -07:00
+date: 2011-03-23 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -25,6 +26,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 23
         segments: 
         - 1
         - 0
@@ -40,6 +42,7 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 21
         segments: 
         - 0
         - 2
@@ -55,6 +58,7 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 15
         segments: 
         - 2
         - 0
@@ -70,6 +74,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -83,6 +88,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -96,6 +102,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -109,6 +116,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
@@ -122,6 +130,7 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 23
         segments: 
         - 1
         - 0
@@ -208,6 +217,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
@@ -216,6 +226,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"