rack-mount 0.0.1 → 0.8.3

data/lib/rack/mount/route_set.rb

@@ -3,16 +3,12 @@ require 'rack/mount/route'
 require 'rack/mount/utils'
 
 module Rack::Mount
-  class RouteSet
-    extend Mixover
-
-    # Include generation and recognition concerns
-    include Generation::RouteSet, Recognition::RouteSet
-    include Recognition::CodeGeneration
+  class RoutingError < StandardError; end
 
+  class RouteSet
     # Initialize a new RouteSet without optimizations
-    def self.new_without_optimizations(*args, &block)
-      new_without_module(Recognition::CodeGeneration, *args, &block)
+    def self.new_without_optimizations(options = {}, &block)
+      new(options.merge(:_optimize => false), &block)
     end
 
     # Basic RouteSet initializer.
@@ -23,7 +19,22 @@ module Rack::Mount
     # - <tt>Generation::RouteSet.new</tt>
     # - <tt>Recognition::RouteSet.new</tt>
     def initialize(options = {}, &block)
+      @parameters_key = options.delete(:parameters_key) || 'rack.routing_args'
+      @parameters_key.freeze
+
+      @named_routes = {}
+
+      @recognition_key_analyzer = Analysis::Splitting.new
+
+      @generation_keys = [:controller, :action]
+      @generation_route_keys = []
+
       @request_class = options.delete(:request_class) || Rack::Request
+      @valid_conditions = @request_class.public_instance_methods.map! { |m| m.to_sym }
+
+      extend CodeGeneration unless options[:_optimize] == false
+      @optimized_recognize_defined = false
+
       @routes = []
       expire!
 
@@ -40,28 +51,201 @@ module Rack::Mount
     #                       Conditions may be expressed as strings or
     #                       regexps to match against.
     # <tt>defaults</tt>:: A hash of values that always gets merged in
-    # <tt>name</tt>:: Symbol identifier for the route used with named 
+    # <tt>name</tt>:: Symbol identifier for the route used with named
     #                 route generations
     def add_route(app, conditions = {}, defaults = {}, name = nil)
-      route = Route.new(self, app, conditions, defaults, name)
+      unless conditions.is_a?(Hash)
+        raise ArgumentError, 'conditions must be a Hash'
+      end
+
+      unless conditions.all? { |method, pattern|
+          @valid_conditions.include?(method)
+        }
+        raise ArgumentError, 'conditions may only include ' +
+          @valid_conditions.inspect
+      end
+
+      route = Route.new(app, conditions, defaults, name)
       @routes << route
+
+      @recognition_key_analyzer << route.conditions
+
+      @named_routes[route.name] = route if route.name
+      @generation_route_keys << route.generation_keys
+
       expire!
       route
     end
 
-    # See <tt>Recognition::RouteSet#call</tt>
+    def recognize(obj)
+      raise 'route set not finalized' unless @recognition_graph
+
+      cache = {}
+      keys = @recognition_keys.map { |key|
+        if key.respond_to?(:call)
+          key.call(cache, obj)
+        else
+          obj.send(key)
+        end
+      }
+
+      @recognition_graph[*keys].each do |route|
+        matches = {}
+        params  = route.defaults.dup
+
+        if route.conditions.all? { |method, condition|
+            value = obj.send(method)
+            if condition.is_a?(Regexp) && (m = value.match(condition))
+              matches[method] = m
+              captures = m.captures
+              route.named_captures[method].each do |k, i|
+                if v = captures[i]
+                  params[k] = v
+                end
+              end
+              true
+            elsif value == condition
+              true
+            else
+              false
+            end
+          }
+          if block_given?
+            yield route, matches, params
+          else
+            return route, matches, params
+          end
+        end
+      end
+
+      nil
+    end
+
+    X_CASCADE = 'X-Cascade'.freeze
+    PASS      = 'pass'.freeze
+    PATH_INFO = 'PATH_INFO'.freeze
+
+    # Rack compatible recognition and dispatching method. Routes are
+    # tried until one returns a non-catch status code. If no routes
+    # match, then catch status code is returned.
+    #
+    # This method can only be invoked after the RouteSet has been
+    # finalized.
     def call(env)
-      raise NotImplementedError
+      raise 'route set not finalized' unless @recognition_graph
+
+      env[PATH_INFO] = Utils.normalize_path(env[PATH_INFO])
+
+      request = nil
+      req = @request_class.new(env)
+      recognize(req) do |route, matches, params|
+        # TODO: We only want to unescape params from uri related methods
+        params.each { |k, v| params[k] = Utils.unescape_uri(v) if v.is_a?(String) }
+
+        if route.prefix?
+          env[Prefix::KEY] = matches[:path_info].to_s
+        end
+
+        old_params = env[@parameters_key]
+        env[@parameters_key] = (old_params || {}).merge(params)
+
+        result = route.app.call(env)
+
+        if result[1][X_CASCADE] == PASS
+          env[@parameters_key] = old_params
+        else
+          return result
+        end
+      end
+
+      request || [404, {'Content-Type' => 'text/html', 'X-Cascade' => 'pass'}, ['Not Found']]
     end
 
-    # See <tt>Generation::RouteSet#url</tt>
-    def url(*args)
-      raise NotImplementedError
+    # Generates a url from Rack env and identifiers or significant keys.
+    #
+    # To generate a url by named route, pass the name in as a +Symbol+.
+    #   url(env, :dashboard) # => "/dashboard"
+    #
+    # Additional parameters can be passed in as a hash
+    #   url(env, :people, :id => "1") # => "/people/1"
+    #
+    # If no named route is given, it will fall back to a slower
+    # generation search.
+    #   url(env, :controller => "people", :action => "show", :id => "1")
+    #     # => "/people/1"
+    def url(env, *args)
+      named_route, params = nil, {}
+
+      case args.length
+      when 2
+        named_route, params = args[0], args[1].dup
+      when 1
+        if args[0].is_a?(Hash)
+          params = args[0].dup
+        else
+          named_route = args[0]
+        end
+      else
+        raise ArgumentError
+      end
+
+      only_path = params.delete(:only_path)
+      recall = env[@parameters_key] || {}
+
+      unless result = generate(:all, named_route, params, recall,
+          :parameterize => lambda { |name, param| Utils.escape_uri(param) })
+        return
+      end
+
+      parts, params = result
+      return unless parts
+
+      params.each do |k, v|
+        if v
+          params[k] = v
+        else
+          params.delete(k)
+        end
+      end
+
+      req = stubbed_request_class.new(env)
+      req._stubbed_values = parts.merge(:query_string => Utils.build_nested_query(params))
+      only_path ? req.fullpath : req.url
     end
 
-    # See <tt>Generation::RouteSet#generate</tt>
-    def generate(*args)
-      raise NotImplementedError
+    def generate(method, *args) #:nodoc:
+      raise 'route set not finalized' unless @generation_graph
+
+      method = nil if method == :all
+      named_route, params, recall, options = extract_params!(*args)
+      merged = recall.merge(params)
+      route = nil
+
+      if named_route
+        if route = @named_routes[named_route.to_sym]
+          recall = route.defaults.merge(recall)
+          url = route.generate(method, params, recall, options)
+          [url, params]
+        else
+          raise RoutingError, "#{named_route} failed to generate from #{params.inspect}"
+        end
+      else
+        keys = @generation_keys.map { |key|
+          if k = merged[key]
+            k.to_s
+          else
+            nil
+          end
+        }
+        @generation_graph[*keys].each do |r|
+          next unless r.significant_params?
+          if url = r.generate(method, params, recall, options)
+            return [url, params]
+          end
+        end
+
+        raise RoutingError, "No route matches #{params.inspect}"
+      end
     end
 
     # Number of routes in the set
@@ -70,6 +254,13 @@ module Rack::Mount
     end
 
     def rehash #:nodoc:
+      Utils.debug "rehashing"
+
+      @recognition_keys  = build_recognition_keys
+      @recognition_graph = build_recognition_graph
+      @generation_graph  = build_generation_graph
+
+      self
     end
 
     # Finalizes the set and builds optimized data structures. You *must*
@@ -78,6 +269,12 @@ module Rack::Mount
     def freeze
       unless frozen?
         rehash
+        stubbed_request_class
+
+        @recognition_key_analyzer = nil
+        @generation_route_keys    = nil
+        @valid_conditions         = nil
+
         @routes.each { |route| route.freeze }
         @routes.freeze
       end
@@ -85,8 +282,21 @@ module Rack::Mount
       super
     end
 
+    protected
+      def recognition_stats
+        { :keys => @recognition_keys,
+          :keys_size => @recognition_keys.size,
+          :graph_size => @recognition_graph.size,
+          :graph_height => @recognition_graph.height,
+          :graph_average_height => @recognition_graph.average_height }
+      end
+
     private
       def expire! #:nodoc:
+        @recognition_keys = @recognition_graph = nil
+        @recognition_key_analyzer.expire!
+
+        @generation_graph = nil
       end
 
       # An internal helper method for constructing a nested set from
@@ -98,12 +308,88 @@ module Rack::Mount
       def build_nested_route_set(keys, &block)
         graph = Multimap.new
         @routes.each_with_index do |route, index|
-          k = keys.map { |key| block.call(key, index) }
-          Utils.pop_trailing_nils!(k)
-          k.map! { |key| key || /.+/ }
-          graph[*k] = route
+          catch(:skip) do
+            k = keys.map { |key| block.call(key, index) }
+            Utils.pop_trailing_blanks!(k)
+            k.map! { |key| key || /.*/ }
+            graph[*k] = route
+          end
         end
         graph
       end
+
+      def build_recognition_graph
+        build_nested_route_set(@recognition_keys) { |k, i|
+          @recognition_key_analyzer.possible_keys[i][k]
+        }
+      end
+
+      def build_recognition_keys
+        keys = @recognition_key_analyzer.report
+        Utils.debug "recognition keys - #{keys.inspect}"
+        keys
+      end
+
+      def build_generation_graph
+        build_nested_route_set(@generation_keys) { |k, i|
+          throw :skip unless @routes[i].significant_params?
+
+          if k = @generation_route_keys[i][k]
+            k.to_s
+          else
+            nil
+          end
+        }
+      end
+
+      def extract_params!(*args)
+        case args.length
+        when 4
+          named_route, params, recall, options = args
+        when 3
+          if args[0].is_a?(Hash)
+            params, recall, options = args
+          else
+            named_route, params, recall = args
+          end
+        when 2
+          if args[0].is_a?(Hash)
+            params, recall = args
+          else
+            named_route, params = args
+          end
+        when 1
+          if args[0].is_a?(Hash)
+            params = args[0]
+          else
+            named_route = args[0]
+          end
+        else
+          raise ArgumentError
+        end
+
+        named_route ||= nil
+        params  ||= {}
+        recall  ||= {}
+        options ||= {}
+
+        [named_route, params.dup, recall.dup, options.dup]
+      end
+
+      def stubbed_request_class
+        @stubbed_request_class ||= begin
+          klass = Class.new(@request_class)
+          klass.public_instance_methods.each do |method|
+            next if method =~ /^__|object_id/
+            klass.class_eval <<-RUBY
+              def #{method}(*args, &block)
+                @_stubbed_values[:#{method}] || super
+              end
+            RUBY
+          end
+          klass.class_eval { attr_accessor :_stubbed_values }
+          klass
+        end
+      end
   end
 end

data/lib/rack/mount/strexp/parser.rb

@@ -0,0 +1,160 @@
+#
+# DO NOT MODIFY!!!!
+# This file is automatically generated by Racc 1.4.6
+# from Racc grammer file "".
+#
+
+require 'racc/parser.rb'
+
+require 'rack/mount/utils'
+require 'rack/mount/strexp/tokenizer'
+
+module Rack
+  module Mount
+    class StrexpParser < Racc::Parser
+
+
+if Regin.regexp_supports_named_captures?
+  REGEXP_NAMED_CAPTURE = '(?<%s>%s)'.freeze
+else
+  REGEXP_NAMED_CAPTURE = '(?:<%s>%s)'.freeze
+end
+
+attr_accessor :anchor, :requirements
+##### State transition tables begin ###
+
+racc_action_table = [
+     1,     2,     3,     9,     4,     1,     2,     3,    12,     4,
+     1,     2,     3,    11,     4,     1,     2,     3,   nil,     4 ]
+
+racc_action_check = [
+     0,     0,     0,     5,     0,     3,     3,     3,     9,     3,
+     8,     8,     8,     8,     8,     6,     6,     6,   nil,     6 ]
+
+racc_action_pointer = [
+    -2,   nil,   nil,     3,   nil,     3,    13,   nil,     8,     8,
+   nil,   nil,   nil ]
+
+racc_action_default = [
+    -8,    -4,    -5,    -8,    -7,    -8,    -1,    -3,    -8,    -8,
+    -2,    -6,    13 ]
+
+racc_goto_table = [
+     6,     5,    10,     8,    10 ]
+
+racc_goto_check = [
+     2,     1,     3,     2,     3 ]
+
+racc_goto_pointer = [
+   nil,     1,     0,    -4 ]
+
+racc_goto_default = [
+   nil,   nil,   nil,     7 ]
+
+racc_reduce_table = [
+  0, 0, :racc_error,
+  1, 8, :_reduce_1,
+  2, 9, :_reduce_2,
+  1, 9, :_reduce_none,
+  1, 10, :_reduce_4,
+  1, 10, :_reduce_5,
+  3, 10, :_reduce_6,
+  1, 10, :_reduce_7 ]
+
+racc_reduce_n = 8
+
+racc_shift_n = 13
+
+racc_token_table = {
+  false => 0,
+  :error => 1,
+  :PARAM => 2,
+  :GLOB => 3,
+  :LPAREN => 4,
+  :RPAREN => 5,
+  :CHAR => 6 }
+
+racc_nt_base = 7
+
+racc_use_result_var = true
+
+Racc_arg = [
+  racc_action_table,
+  racc_action_check,
+  racc_action_default,
+  racc_action_pointer,
+  racc_goto_table,
+  racc_goto_check,
+  racc_goto_default,
+  racc_goto_pointer,
+  racc_nt_base,
+  racc_reduce_table,
+  racc_token_table,
+  racc_shift_n,
+  racc_reduce_n,
+  racc_use_result_var ]
+
+Racc_token_to_s_table = [
+  "$end",
+  "error",
+  "PARAM",
+  "GLOB",
+  "LPAREN",
+  "RPAREN",
+  "CHAR",
+  "$start",
+  "target",
+  "expr",
+  "token" ]
+
+Racc_debug_parser = false
+
+##### State transition tables end #####
+
+# reduce 0 omitted
+
+def _reduce_1(val, _values, result)
+ result = anchor ? "\\A#{val.join}\\Z" : "\\A#{val.join}" 
+    result
+end
+
+def _reduce_2(val, _values, result)
+ result = val.join 
+    result
+end
+
+# reduce 3 omitted
+
+def _reduce_4(val, _values, result)
+           name = val[0].to_sym
+           requirement = requirements[name]
+           result = REGEXP_NAMED_CAPTURE % [name, requirement]
+         
+    result
+end
+
+def _reduce_5(val, _values, result)
+           name = val[0].to_sym
+           requirement = requirements.key?(name) ? requirements[name] : '.+'
+           result = REGEXP_NAMED_CAPTURE % [name, requirement]
+         
+    result
+end
+
+def _reduce_6(val, _values, result)
+ result = "(?:#{val[1]})?" 
+    result
+end
+
+def _reduce_7(val, _values, result)
+ result = Regexp.escape(val[0]) 
+    result
+end
+
+def _reduce_none(val, _values, result)
+  val[0]
+end
+
+    end   # class StrexpParser
+  end   # module Mount
+end   # module Rack

data/lib/rack/mount/strexp/tokenizer.rb

@@ -0,0 +1,83 @@
+#--
+# DO NOT MODIFY!!!!
+# This file is automatically generated by rex 1.0.5.beta1
+# from lexical definition file "lib/rack/mount/strexp/tokenizer.rex".
+#++
+
+require 'racc/parser'
+class Rack::Mount::StrexpParser < Racc::Parser
+  require 'strscan'
+
+  class ScanError < StandardError ; end
+
+  attr_reader   :lineno
+  attr_reader   :filename
+  attr_accessor :state
+
+  def scan_setup(str)
+    @ss = StringScanner.new(str)
+    @lineno =  1
+    @state  = nil
+  end
+
+  def action
+    yield
+  end
+
+  def scan_str(str)
+    scan_setup(str)
+    do_parse
+  end
+  alias :scan :scan_str
+
+  def load_file( filename )
+    @filename = filename
+    open(filename, "r") do |f|
+      scan_setup(f.read)
+    end
+  end
+
+  def scan_file( filename )
+    load_file(filename)
+    do_parse
+  end
+
+
+  def next_token
+    return if @ss.eos?
+
+    text = @ss.peek(1)
+    @lineno  +=  1  if text == "\n"
+    token = case @state
+    when nil
+      case
+      when (text = @ss.scan(/\\(\(|\)|:|\*)/))
+         action { [:CHAR,  @ss[1]] }
+
+      when (text = @ss.scan(/\:([a-zA-Z_]\w*)/))
+         action { [:PARAM, @ss[1]] }
+
+      when (text = @ss.scan(/\*([a-zA-Z_]\w*)/))
+         action { [:GLOB,  @ss[1]] }
+
+      when (text = @ss.scan(/\(/))
+         action { [:LPAREN, text]  }
+
+      when (text = @ss.scan(/\)/))
+         action { [:RPAREN, text]  }
+
+      when (text = @ss.scan(/./))
+         action { [:CHAR,   text]  }
+
+      else
+        text = @ss.string[@ss.pos .. -1]
+        raise  ScanError, "can not match: '" + text + "'"
+      end  # if
+
+    else
+      raise  ScanError, "undefined state: '" + state.to_s + "'"
+    end  # case state
+    token
+  end  # def next_token
+
+end # class