joshbuddy-usher 0.5.4 → 0.5.6

data/README.rdoc

@@ -1,4 +1,4 @@
-= Usher 
+= 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.
 
@@ -19,13 +19,13 @@ Tree-based router library. Useful for (specifically) for Rails and Rack, but pro
 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. 
+more parts.
 
 <b>Example:</b>
 <tt>/path/:variable/path</tt> would match
@@ -35,7 +35,7 @@ more parts.
 * <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. 
+However, <tt>/path/test/one_more/path</tt> would not be matched.
 
 <b>Example:</b>
 <tt>/path/*variable/path</tt> would match
@@ -59,7 +59,7 @@ But not
 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 
+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>
@@ -110,7 +110,7 @@ For instance, the path, <tt>/path/something(.xml|.html)</tt> would only match <t
       [body]        # Response body
     ]
   end
-  
+
   routes = Usher::Interface.for(:rack) do
     add('/hello/:name').to(app)
   end

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
-:patch: 4
-:major: 0
 :minor: 5
+:patch: 6
+:major: 0

data/lib/usher.rb

@@ -7,12 +7,12 @@ require File.join(File.dirname(__FILE__), 'usher', 'exceptions')
 require File.join(File.dirname(__FILE__), 'usher', 'util')
 
 class Usher
-  attr_reader :root, :named_routes, :routes, :splitter, 
-              :delimiters, :delimiter_chars, :delimiters_regex, 
+  attr_reader :root, :named_routes, :routes, :splitter,
+              :delimiters, :delimiter_chars, :delimiters_regex,
               :parent_route, :generator
-  
+
   # Returns whether the route set is empty
-  #   
+  #
   #   set = Usher.new
   #   set.empty? => true
   #   set.add_route('/test')
@@ -20,13 +20,13 @@ class Usher
   def empty?
     @routes.empty?
   end
-  
+
   def route_count
     @routes.size
   end
-  
+
   # Resets the route set back to its initial state
-  #   
+  #
   #   set = Usher.new
   #   set.add_route('/test')
   #   set.empty? => false
@@ -39,14 +39,14 @@ class Usher
     @grapher = Grapher.new
   end
   alias clear! reset!
-  
+
   # Creates a route set, with options
-  # 
+  #
   # <tt>:delimiters</tt>: Array of Strings. (default <tt>['/', '.']</tt>). Delimiters used in path separation. Array must be single character strings.
-  # 
+  #
   # <tt>:valid_regex</tt>: String. (default <tt>'[0-9A-Za-z\$\-_\+!\*\',]+'</tt>). String that can be interpolated into regex to match
   # valid character sequences within path.
-  # 
+  #
   # <tt>:request_methods</tt>: Array of Symbols. (default <tt>[:protocol, :domain, :port, :query_string, :remote_ip, :user_agent, :referer, :method, :subdomains]</tt>)
   # Array of methods called against the request object for the purposes of matching route requirements.
   def initialize(options = nil)
@@ -64,13 +64,13 @@ class Usher
   def can_generate?
     !@generator.nil?
   end
-  
+
   def generator
     @generator
   end
-  
+
   # Adds a route referencable by +name+. See add_route for format +path+ and +options+.
-  #   
+  #
   #   set = Usher.new
   #   set.add_named_route(:test_route, '/test')
   def add_named_route(name, path, options = nil)
@@ -78,7 +78,7 @@ class Usher
   end
 
   # Deletes a route referencable by +name+. At least the path and conditions have to match the route you intend to delete.
-  #   
+  #
   #   set = Usher.new
   #   set.delete_named_route(:test_route, '/test')
   def delete_named_route(name, path, options = nil)
@@ -87,7 +87,7 @@ class Usher
   end
 
   # Attaches a +route+ to a +name+
-  #   
+  #
   #   set = Usher.new
   #   route = set.add_route('/test')
   #   set.name(:test, route)
@@ -97,13 +97,13 @@ class Usher
   end
 
   # 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. 
+  # more parts.
   #
   # <b>Example:</b>
   # <tt>/path/:variable/path</tt> would match
@@ -113,7 +113,7 @@ class Usher
   # * <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. 
+  # However, <tt>/path/test/one_more/path</tt> would not be matched.
   #
   # <b>Example:</b>
   # <tt>/path/*variable/path</tt> would match
@@ -127,22 +127,22 @@ class Usher
   #
   # <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 
+  # 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>
   #
@@ -176,7 +176,7 @@ class Usher
   end
 
   # Deletes a route. At least the path and conditions have to match the route you intend to delete.
-  #   
+  #
   #   set = Usher.new
   #   set.delete_route('/test')
   def delete_route(path, options = nil)
@@ -188,7 +188,7 @@ class Usher
   end
 
   # Recognizes a +request+ and returns +nil+ or an Usher::Node::Response, which is a struct containing a Usher::Route::Path and an array of arrays containing the extracted parameters.
-  #   
+  #
   #   Request = Struct.new(:path)
   #   set = Usher.new
   #   route = set.add_route('/test')
@@ -198,7 +198,7 @@ class Usher
   end
 
   # Recognizes a +path+ and returns +nil+ or an Usher::Node::Response, which is a struct containing a Usher::Route::Path and an array of arrays containing the extracted parameters. Convenience method for when recognizing on the request object is unneeded.
-  #   
+  #
   #   Request = Struct.new(:path)
   #   set = Usher.new
   #   route = set.add_route('/test')
@@ -208,35 +208,43 @@ class Usher
   end
 
   # Recognizes a set of +parameters+ and gets the closest matching Usher::Route::Path or +nil+ if no route exists.
-  #   
+  #
   #   set = Usher.new
   #   route = set.add_route('/:controller/:action')
   #   set.path_for_options({:controller => 'test', :action => 'action'}) == path.route => true
   def path_for_options(options)
     @grapher.find_matching_path(options)
   end
-  
+
   def parent_route=(route)
     @parent_route = route
     routes.each{|r| r.parent_route = route}
   end
-  
+
   def dup
     replacement = super
     original = self
+    inverted_named_routes = original.named_routes.invert
     replacement.instance_eval do
+      @parser = nil
       reset!
       original.routes.each do |route|
-        @root.add(route)
-        @routes << route
+        new_route = route.dup
+        new_route.router = self
+        @root.add(new_route)
+        @routes << new_route
+        if name = inverted_named_routes[route]
+          @named_routes[name] = new_route
+        end
       end
+      send(:generator=, original.generator.class.new) if original.can_generate?
       rebuild_grapher!
     end
     replacement
   end
-  
+
   private
-  
+
   attr_accessor :request_methods
   attr_reader :valid_regex
 
@@ -247,7 +255,7 @@ class Usher
     end
     @generator
   end
-  
+
   def delimiters=(delimiters)
     @delimiters = delimiters
     @delimiter_chars = @delimiters.collect{|d| d[0]}
@@ -274,12 +282,12 @@ class Usher
         end
       end
     end
-    
+
     route = parser.generate_route(path, conditions, requirements, default_values, generate_with)
     route.to(options) if options && !options.empty?
     route
   end
-  
+
   def rebuild_grapher!
     @grapher = Grapher.new
     @routes.each{|r| @grapher.add_route(r)}

data/lib/usher/interface.rb

@@ -6,6 +6,7 @@ class Usher
     autoload :RackInterface, File.join(File.dirname(__FILE__), 'interface', 'rack_interface')
     autoload :EmailInterface, File.join(File.dirname(__FILE__), 'interface', 'email_interface')
     autoload :Rails3Interface, File.join(File.dirname(__FILE__), 'interface', 'rails3_interface')
+    autoload :TextInterface, File.join(File.dirname(__FILE__), 'interface', 'text_interface')
     
     def self.for(type, &blk)
       class_for(type).new(&blk)
@@ -25,6 +26,8 @@ class Usher
         EmailInterface
       when :rails3
         Rails3Interface
+      when :text
+        TextInterface
       end
       
     end

data/lib/usher/interface/rack_interface.rb

@@ -3,28 +3,34 @@ require 'rack'
 class Usher
   module Interface
     class RackInterface
-      
+
       attr_reader :router
-      
+      attr_accessor :app
+
+      DEFAULT_APPLICATION = lambda do |env|
+        Rack::Response.new("No route found", 404).finish
+      end
+
       class Builder < Rack::Builder
-        
+
         def initialize(&block)
           @usher = Usher::Interface::RackInterface.new
           super
         end
-        
+
         def map(path, options = nil, &block)
           @usher.add(path, options).to(&block)
           @ins << @usher unless @ins.last == @usher
         end
-        
+
       end
-      
-      def initialize(&blk)
+
+      def initialize(app = nil, &blk)
+        @app = app || DEFAULT_APPLICATION
         @router = Usher.new(:request_methods => [:request_method, :host, :port, :scheme], :generator => Usher::Util::Generators::URL.new)
         instance_eval(&blk) if blk
       end
-      
+
       def dup
         new_one = super
         original = self
@@ -33,15 +39,15 @@ class Usher
         end
         new_one
       end
-      
+
       def add(path, options = nil)
         @router.add_route(path, options)
-      end
-      
+       end
+
       def parent_route=(route)
         @router.parent_route = route
       end
-      
+
       def parent_route
         @router.parent_route
       end
@@ -51,30 +57,55 @@ class Usher
       end
 
       def call(env)
-        env['usher.params'] ||= {}
         response = @router.recognize(request = Rack::Request.new(env), request.path_info)
-        if response.nil?
-          body = "No route found"
-          headers = {"Content-Type" => "text/plain", "Content-Length" => body.length.to_s}
-          [404, headers, [body]]
+        after_match(env, response) if response
+        determine_respondant(response).call(env)
+      end
+
+      def generate(route, options = nil)
+        @router.generator.generate(route, options)
+      end
+
+      # Allows a hook to be placed for sub classes to make use of between matching
+      # and calling the application
+      #
+      # @api plugin
+      def after_match(env, response)
+        params = response.path.route.default_values ?
+          response.path.route.default_values.merge(Hash[response.params]) :
+          Hash[response.params]
+        
+        env['usher.params'] ?
+          env['usher.params'].merge!(params) :
+          env['usher.params'] = params
+        
+        # consume the path_info to the script_name
+        # response.remaining_path
+        consume_path!(env, response) if response.partial_match?
+      end
+
+      # Determines which application to respond with.
+      #
+      #  Within the request when determine respondant is called
+      #  If there is a matching route to an application, that
+      #  application is called, Otherwise the middleware application is called.
+      #
+      # @api private
+      def determine_respondant(response)
+        unless response
+          app
         else
-          params = response.path.route.default_values || {}
-          response.params.each{ |hk| params[hk.first] = hk.last}
-          
-          # consume the path_info to the script_name response.remaining_path
-          env["SCRIPT_NAME"] << response.matched_path   || ""
-          env["PATH_INFO"] = response.remaining_path    || ""
-                    
-          env['usher.params'].merge!(params)
-          
-          response.path.route.destination.call(env)
+          respondant = response.path.route.destination
+          respondant = app unless respondant.respond_to?(:call)
+          respondant
         end
       end
 
-      def generate(route, params = nil, options = nil)
-        @usher.generator.generate(route, params, options)
+      # Consume the path from path_info to script_name
+      def consume_path!(env, response)
+        env["SCRIPT_NAME"] = (env["SCRIPT_NAME"] + response.matched_path)   || ""
+        env["PATH_INFO"] = response.remaining_path    || ""
       end
-
     end
   end
 end

data/lib/usher/interface/rails3_interface.rb

@@ -26,12 +26,13 @@ class Usher
         @configurations_files << file
       end
       
-      def reload!
+      def reload
         @usher.reset!
         @configurations_files.each do |c|
           Kernel.load(c)
         end
       end
+      alias_method :reload!, :reload
       
       def call(env)
         request = ActionDispatch::Request.new(env)