joshbuddy-usher 0.4.3 → 0.4.5

data/lib/usher/route/path.rb

@@ -1,10 +1,8 @@
-require 'set'
-
 class Usher
   class Route
     class Path
   
-      attr_reader :dynamic_parts, :dynamic_map, :dynamic_indicies, :route, :dynamic_set, :parts
+      attr_reader :dynamic_parts, :dynamic_map, :dynamic_indicies, :route, :parts, :dynamic_required_keys, :dynamic_keys
       
       def initialize(route, parts)
         @route = route
@@ -14,9 +12,13 @@ class Usher
         @dynamic_parts = @parts.values_at(*@dynamic_indicies)
         @dynamic_map = {}
         @dynamic_parts.each{|p| @dynamic_map[p.name] = p }
-        @dynamic_set = Set.new(@dynamic_map.keys)
+        @dynamic_keys = @dynamic_map.keys
+        @dynamic_required_keys = @dynamic_parts.select{|dp| !dp.default_value}.map{|dp| dp.name}
+      end
+
+      def can_generate_from?(keys)
+        (@dynamic_required_keys - keys).size.zero?
       end
-  
     end
   end
 end

data/lib/usher/route/variable.rb

@@ -2,7 +2,7 @@ class Usher
   class Route
     class Variable
       attr_reader :type, :name, :validator, :regex_matcher
-      attr_accessor :look_ahead, :globs_capture_separators
+      attr_accessor :look_ahead, :globs_capture_separators, :default_value
       
       def initialize(type, name, validator = nil, regex_matcher = nil, globs_capture_separators = false)
         @type = type
@@ -19,14 +19,16 @@ class Usher
       def valid!(val)
         case @validator
         when Proc
-          @validator.call(val)
+          begin
+            @validator.call(val)
+          rescue Exception => e
+            raise ValidationException.new("#{val} does not conform to #{@validator}, root cause #{e.inspect}")
+          end
         else
-          @validator === val or raise
+          @validator === val or raise(ValidationException.new("#{val} does not conform to #{@validator}, root cause #{e.inspect}"))
         end if @validator
-      rescue Exception => e
-        raise ValidationException.new("#{val} does not conform to #{@validator}, root cause #{e.inspect}")
       end
-  
+      
       def ==(o)
         o && (o.type == @type && o.name == @name && o.validator == @validator)
       end

data/lib/usher/route.rb

@@ -6,17 +6,27 @@ require 'route/request_method'
 
 class Usher
   class Route
-    attr_reader :paths, :original_path, :requirements, :conditions, :params, :primary_path
+    attr_reader :paths, :original_path, :requirements, :conditions, :destination, :named
     
-    def initialize(original_path, router, options = nil) # :nodoc:
+    def initialize(original_path, router, conditions, requirements, default_values) # :nodoc:
       @original_path = original_path
       @router = router
-      @requirements = options && options.delete(:requirements)
-      @conditions = options && options.delete(:conditions)
-      @paths = @router.splitter.split(@original_path, @requirements).collect {|path| Path.new(self, path)}
-      @primary_path = @paths.first
-      #FIXME params is poorly named. this shouldn't be an array
-      @params = []
+      @requirements = requirements
+      @conditions = conditions
+      @default_values = default_values
+      @paths = @router.splitter.split(@original_path, @requirements, @default_values).collect {|path| Path.new(self, path)}
+    end
+    
+    def grapher
+      unless @grapher
+        @grapher = Grapher.new
+        @grapher.add_route(self)
+      end
+      @grapher
+    end
+
+    def find_matching_path(params)
+      @paths.size == 1 ? @paths.first : grapher.find_matching_path(params)
     end
     
     
@@ -28,7 +38,7 @@ class Usher
     #   route.to(:controller => 'testing', :action => 'index')
     #   set.recognize(Request.new('/test')).first.params => {:controller => 'testing', :action => 'index'}
     def to(options = nil, &block)
-      @params << (block_given? ? block : options)
+      @destination = (block_given? ? block : options)
       self
     end
 
@@ -38,7 +48,9 @@ class Usher
     #   route = set.add_route('/test').name(:route)
     #   set.generate_url(:route) => '/test'
     def name(name)
+      @named = name
       @router.name(name, self)
+      self
     end
 
   end

data/lib/usher/splitter.rb

@@ -8,7 +8,7 @@ class Usher
       SplitterInstance.new(
         delimiters,
         Regexp.new('((:|\*)?' + valid_regex + '|' + delimiters_regex + '|\(|\)|\||\{)'),
-        Regexp.new(delimiters_regex + '|' + valid_regex)
+        Regexp.new("[#{delimiters.collect{|d| Regexp.quote(d)}}]|[^#{delimiters.collect{|d| Regexp.quote(d)}}]+")
       )
     end
     
@@ -16,21 +16,20 @@ class Usher
 
     class SplitterInstance
       
+      attr_reader :delimiter_chars
+      
       def initialize(delimiters, split_regex, url_split_regex)
         @delimiters = delimiters
         @delimiter_chars = delimiters.collect{|d| d[0]}
-        @delimiter_chars_map = Hash[*@delimiter_chars.map{|c| [c, c.chr.to_sym]}.flatten]
         @split_regex = split_regex
         @url_split_regex = url_split_regex
       end
       
       def url_split(path)
-        parts = path.scan(@url_split_regex)
-        parts.map!{ |part| @delimiter_chars_map[part[0]] || part}
-        parts
+        path.scan(@url_split_regex)
       end
 
-      def split(path, requirements = nil)
+      def split(path, requirements = nil, default_values = nil)
         parts = Group.new(:all, nil)
         ss = StringScanner.new(path)
         current_group = parts
@@ -80,8 +79,6 @@ class Usher
             end
             current_group.parent << Group.new(:all, current_group.parent)
             current_group = current_group.parent.last
-          when *@delimiter_chars
-            current_group << part.to_sym
           else
             current_group << part
           end
@@ -90,11 +87,13 @@ class Usher
         paths.each do |path|
           path.each_with_index do |part, index|
             if part.is_a?(Usher::Route::Variable)
+              part.default_value = default_values[part.name] if default_values
+              
               case part.type
               when :*
-                part.look_ahead = path[index + 1, path.size].find{|p| !p.is_a?(Symbol) && !p.is_a?(Usher::Route::Variable)} || nil
+                part.look_ahead = path[index + 1, path.size].find{|p| !p.is_a?(Usher::Route::Variable) && !@delimiter_chars.include?(p[0])} || nil
               when :':'
-                part.look_ahead = path[index + 1, path.size].find{|p| p.is_a?(Symbol)} || @delimiters.first.to_sym
+                part.look_ahead = path[index + 1, path.size].find{|p| @delimiter_chars.include?(p[0])} || @delimiters.first
               end
             end
           end

data/lib/usher.rb

@@ -8,9 +8,10 @@ require 'usher/grapher'
 require 'usher/interface'
 require 'usher/splitter'
 require 'usher/exceptions'
+require 'usher/generate'
 
 class Usher
-  attr_reader :tree, :named_routes, :route_count, :routes, :splitter
+  attr_reader :tree, :named_routes, :route_count, :routes, :splitter, :delimiters
   
   SymbolArraySorter = proc {|a,b| a.hash <=> b.hash} #:nodoc:
   
@@ -75,7 +76,8 @@ class Usher
   #   route = set.add_route('/test')
   #   set.name(:test, route)
   def name(name, route)
-    @named_routes[name] = route.primary_path
+    @named_routes[name] = route
+    route
   end
 
   # Creates a route from +path+ and +options+
@@ -142,6 +144,7 @@ class Usher
   def add_route(path, options = nil)
     conditions = options && options.delete(:conditions) || {}
     requirements = options && options.delete(:requirements) || {}
+    default_values = options && options.delete(:default_values) || {}
     if options
       options.delete_if do |k, v|
         if v.is_a?(Regexp) || v.is_a?(Proc)
@@ -150,7 +153,7 @@ class Usher
         end
       end
     end
-    route = Route.new(path, self, {:conditions => conditions, :requirements => requirements})
+    route = Route.new(path, self, conditions, requirements, default_values)
     route.to(options) if options && !options.empty?
     
     @tree.add(route)
@@ -167,87 +170,16 @@ class Usher
   #   route = set.add_route('/test')
   #   set.recognize(Request.new('/test')).path.route == route => true
   def recognize(request, path = request.path)
-    @tree.find(request, @splitter.url_split(path))
+    @tree.find(self, request, @splitter.url_split(path))
   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.route_for_options({:controller => 'test', :action => 'action'}) == path.route => true
-  def route_for_options(options)
+  #   set.path_for_options({:controller => 'test', :action => 'action'}) == path.route => true
+  def path_for_options(options)
     @grapher.find_matching_path(options)
   end
   
-  # Generates a completed URL based on a +route+ or set of optional +params+
-  #   
-  #   set = Usher.new
-  #   route = set.add_named_route(:test_route, '/:controller/:action')
-  #   set.generate_url(nil, {:controller => 'c', :action => 'a'}) == '/c/a' => true
-  #   set.generate_url(:test_route, {:controller => 'c', :action => 'a'}) == '/c/a' => true
-  #   set.generate_url(route.primary_path, {:controller => 'c', :action => 'a'}) == '/c/a' => true
-  def generate_url(route, params = nil, options = nil)
-    check_variables = options && options.key?(:check_variables) ? options.delete(:check_variables) : false
-    delimiter = options && options.key?(:delimiter) ? options.delete(:delimiter) : @delimiters.first
-    extra_params = options && options.key?(:extra_params) ? options.delete(:extra_params) : {}
-    
-    path = case route
-    when Symbol
-      @named_routes[route]
-    when nil
-      route_for_options(params)
-    when Route
-      route.paths.first
-    else
-      route
-    end
-    raise UnrecognizedException.new unless path
-    params_hash = extra_params
-    param_list = case params
-    when Hash
-      params_hash.merge!(params)
-      path.dynamic_parts.collect{|k| params_hash.delete(k.name) {|el| raise MissingParameterException.new(k.name)} }
-    when Array
-      path.dynamic_parts.size == params.size ? params : raise(MissingParameterException.new("got #{params.size} arguments, expected #{path.dynamic_parts.size}"))
-    when nil
-      nil
-    else
-      Array(params)
-    end
-
-    generated_path = ''
-    
-    path.parts.each do |p|
-      case p
-      when Route::Variable
-        case p.type
-        when :*
-          param_list.first.each {|dp| p.valid!(dp.to_s) } if check_variables
-          generated_path << param_list.shift.collect{|dp| URI.escape(dp.to_s)} * delimiter
-        else
-          p.valid!(param_list.first.to_s) if check_variables
-          if dp = param_list.shift
-            generated_path << URI.escape(dp.to_s)
-          end
-        end
-      else
-        generated_path << p.to_s
-      end
-    end
-    
-    unless params_hash.empty?
-      has_query = generated_path[??]
-      params_hash.each do |k,v|
-        case v
-        when Array
-          v.each do |v_part|
-            generated_path << (has_query ? '&' : has_query = true && '?') << CGI.escape("#{k.to_s}[]") << '=' << CGI.escape(v_part.to_s)
-          end
-        else
-          generated_path << (has_query ? '&' : has_query = true && '?') << CGI.escape(k.to_s) << '=' << CGI.escape(v.to_s)
-        end
-      end
-    end
-    generated_path
-  end
 end

data/rails/init.rb

@@ -1,4 +1,8 @@
-class Usher::Interface::Rails2Interface::Mapper
-  include ActionController::Resources
+if Rails::VERSION::MAJOR == 2 && Rails::VERSION::MINOR == 3
+  ActionController::Routing.module_eval "remove_const(:Routes); Routes = Usher::Interface.for(:rails2_3)"
+elsif Rails::VERSION::MAJOR == 2 && Rails::VERSION::MINOR >= 2
+  class Usher::Interface::Rails2_2Interface::Mapper
+    include ActionController::Resources
+  end
+  ActionController::Routing.module_eval "remove_const(:Routes); Routes = Usher::Interface.for(:rails2_2)"
 end
-ActionController::Routing.module_eval "remove_const(:Routes); Routes = Usher::Interface.for(:rails2);"

data/spec/private/generate_spec.rb

@@ -1,107 +1,136 @@
 require 'lib/usher'
 
-route_set = Usher.new
 
 describe "Usher URL generation" do
   
   before(:each) do
-    route_set.reset!
+    @route_set = Usher.new
+    @route_set.reset!
+    @url_generator = Usher::Generators::URL.new(@route_set)
   end
   
   it "should generate a simple URL" do
-    route_set.add_named_route(:sample, '/sample', :controller => 'sample', :action => 'action')
-    route_set.generate_url(:sample, {}).should == '/sample'
+    @route_set.add_named_route(:sample, '/sample', :controller => 'sample', :action => 'action')
+    @url_generator.generate(:sample, {}).should == '/sample'
   end
   
   it "should generate a simple URL with a single variable" do
-    route_set.add_named_route(:sample, '/sample/:action', :controller => 'sample')
-    route_set.generate_url(:sample, {:action => 'action'}).should == '/sample/action'
+    @route_set.add_named_route(:sample, '/sample/:action', :controller => 'sample')
+    @url_generator.generate(:sample, {:action => 'action'}).should == '/sample/action'
   end
   
   it "should generate a simple URL with a single variable (and escape)" do
-    route_set.add_named_route(:sample, '/sample/:action', :controller => 'sample')
-    route_set.generate_url(:sample, {:action => 'action time'}).should == '/sample/action%20time'
+    @route_set.add_named_route(:sample, '/sample/:action', :controller => 'sample')
+    @url_generator.generate(:sample, {:action => 'action time'}).should == '/sample/action%20time'
   end
   
   it "should generate a simple URL with a single variable (thats not a string)" do
-    route_set.add_named_route(:sample, '/sample/:action/:id', :controller => 'sample')
-    route_set.generate_url(:sample, {:action => 'action', :id => 123}).should == '/sample/action/123'
+    @route_set.add_named_route(:sample, '/sample/:action/:id', :controller => 'sample')
+    @url_generator.generate(:sample, {:action => 'action', :id => 123}).should == '/sample/action/123'
   end
   
   it "should generate a simple URL with a glob variable" do
-    route_set.add_named_route(:sample, '/sample/*action', :controller => 'sample')
-    route_set.generate_url(:sample, {:action => ['foo', 'baz']}).should == '/sample/foo/baz'
+    @route_set.add_named_route(:sample, '/sample/*action', :controller => 'sample')
+    @url_generator.generate(:sample, {:action => ['foo', 'baz']}).should == '/sample/foo/baz'
   end
   
   it "should generate a mutliple vairable URL from a hash" do
-    route_set.add_named_route(:sample, '/sample/:first/:second', :controller => 'sample')
-    route_set.generate_url(:sample, {:first => 'zoo', :second => 'maz'}).should == '/sample/zoo/maz'
+    @route_set.add_named_route(:sample, '/sample/:first/:second', :controller => 'sample')
+    @url_generator.generate(:sample, {:first => 'zoo', :second => 'maz'}).should == '/sample/zoo/maz'
   end
 
   it "should generate a mutliple vairable URL from an array" do
-    route_set.add_named_route(:sample, '/sample/:first/:second', :controller => 'sample')
-    route_set.generate_url(:sample, ['maz', 'zoo']).should == '/sample/maz/zoo'
+    @route_set.add_named_route(:sample, '/sample/:first/:second', :controller => 'sample')
+    @url_generator.generate(:sample, ['maz', 'zoo']).should == '/sample/maz/zoo'
   end
 
   it "should generate append extra hash variables to the end" do
-    route_set.add_named_route(:sample, '/sample/:first/:second', :controller => 'sample')
-    route_set.generate_url(:sample, {:first => 'maz', :second => 'zoo', :third => 'zanz'}).should == '/sample/maz/zoo?third=zanz'
+    @route_set.add_named_route(:sample, '/sample/:first/:second', :controller => 'sample')
+    @url_generator.generate(:sample, {:first => 'maz', :second => 'zoo', :third => 'zanz'}).should == '/sample/maz/zoo?third=zanz'
   end
 
   it "should generate append extra hash variables to the end (when the first parts are an array)" do
-    route_set.add_named_route(:sample, '/sample/:first/:second', :controller => 'sample')
-    ['/sample/maz/zoo?four=jane&third=zanz', '/sample/maz/zoo?third=zanz&four=jane'].include?(route_set.generate_url(:sample, ['maz', 'zoo'], :extra_params => {:third => 'zanz', :four => 'jane'})).should == true
+    @route_set.add_named_route(:sample, '/sample/:first/:second', :controller => 'sample')
+    ['/sample/maz/zoo?four=jane&third=zanz', '/sample/maz/zoo?third=zanz&four=jane'].include?(@url_generator.generate(:sample, ['maz', 'zoo', {:third => 'zanz', :four => 'jane'}])).should == true
   end
 
   it "should generate append extra hash variables to the end using [] syntax if its an array" do
-    route_set.add_named_route(:sample, '/sample/:first/:second', :controller => 'sample')
-    route_set.generate_url(:sample, {:first => 'maz', :second => 'zoo', :third => ['zanz', 'susie']}).should == '/sample/maz/zoo?third%5B%5D=zanz&third%5B%5D=susie'
+    @route_set.add_named_route(:sample, '/sample/:first/:second', :controller => 'sample')
+    @url_generator.generate(:sample, {:first => 'maz', :second => 'zoo', :third => ['zanz', 'susie']}).should == '/sample/maz/zoo?third%5B%5D=zanz&third%5B%5D=susie'
   end
 
   it "should generate a mutliple vairable URL from an array" do
-    route_set.add_named_route(:sample, '/sample/:first/:second', :controller => 'sample')
-    route_set.generate_url(:sample, ['maz', 'zoo']).should == '/sample/maz/zoo'
+    @route_set.add_named_route(:sample, '/sample/:first/:second', :controller => 'sample')
+    @url_generator.generate(:sample, ['maz', 'zoo']).should == '/sample/maz/zoo'
   end
 
   it "should generate a simple URL with a format" do
-    route_set.add_named_route(:sample, '/sample/:action.:format', :controller => 'sample')
-    route_set.generate_url(:sample, {:action => 'action', :format => 'html'}).should == '/sample/action.html'
+    @route_set.add_named_route(:sample, '/sample/:action.:format', :controller => 'sample')
+    @url_generator.generate(:sample, {:action => 'action', :format => 'html'}).should == '/sample/action.html'
   end
 
   it "should generate from parameters" do
-    caf = route_set.add_route('/:controller/:action.:format')
-    ca = route_set.add_route('/:controller/:action')
-    route_set.generate_url(nil, {:controller => 'controller', :action => 'action'}).should == '/controller/action'
-    route_set.generate_url(nil, {:controller => 'controller', :action => 'action', :format => 'html'}).should == '/controller/action.html'
+    caf = @route_set.add_route('/:controller/:action.:format')
+    ca = @route_set.add_route('/:controller/:action')
+    @url_generator.generate(nil, {:controller => 'controller', :action => 'action'}).should == '/controller/action'
+    @url_generator.generate(nil, {:controller => 'controller', :action => 'action', :format => 'html'}).should == '/controller/action.html'
   end
 
   it "should use the first route when generating a URL from two ambiguous routes" do
-    route_set.add_route('/:controller/:action')
-    route_set.add_route('/:action/:controller')
-    route_set.generate_url(nil, {:controller => 'controller', :action => 'action'}).should == '/controller/action'
+    @route_set.add_route('/:controller/:action')
+    @route_set.add_route('/:action/:controller')
+    @url_generator.generate(nil, {:controller => 'controller', :action => 'action'}).should == '/controller/action'
   end
 
   it "should accept an array of parameters" do
-    caf = route_set.add_named_route(:name, '/:controller/:action.:format')
-    route_set.generate_url(:name, ['controller', 'action', 'html']).should == '/controller/action.html'
+    caf = @route_set.add_named_route(:name, '/:controller/:action.:format')
+    @url_generator.generate(:name, ['controller', 'action', 'html']).should == '/controller/action.html'
   end
 
   it "should require all the parameters (hash) to generate a route" do
-    proc {route_set.generate_url(route_set.add_route('/:controller/:action').primary_path, {:controller => 'controller'})}.should raise_error Usher::MissingParameterException
+    proc {@url_generator.generate(@route_set.add_route('/:controller/:action'), {:controller => 'controller'})}.should raise_error Usher::MissingParameterException
   end
 
   it "should generate from a route" do
-    route_set.generate_url(route_set.add_route('/:controller/:action'), {:controller => 'controller', :action => 'action'}).should == '/controller/action'
+    @url_generator.generate(@route_set.add_route('/:controller/:action'), {:controller => 'controller', :action => 'action'}).should == '/controller/action'
   end
 
   it "should require all the parameters (array) to generate a route" do
-    route_set.add_named_route(:name, '/:controller/:action.:format')
-    proc {route_set.generate_url(:name, ['controller', 'action'])}.should raise_error Usher::MissingParameterException
+    @route_set.add_named_route(:name, '/:controller/:action.:format')
+    proc {@url_generator.generate(:name, ['controller', 'action'])}.should raise_error Usher::MissingParameterException
   end
 
   it "should generate a route when only one parameter is given" do
-    route_set.add_named_route(:name, '/:controller')
-    route_set.generate_url(:name, 'controller').should == '/controller'
+    @route_set.add_named_route(:name, '/:controller')
+    @url_generator.generate(:name, 'controller').should == '/controller'
   end
 
+  it "should generate the correct route from a route containing optional parts" do
+    @route_set.add_named_route(:name, '/:controller(/:action(/:id))')
+    @url_generator.generate(:name, {:controller => 'controller'}).should == '/controller'
+    @url_generator.generate(:name, {:controller => 'controller', :action => 'action'}).should == '/controller/action'
+    @url_generator.generate(:name, {:controller => 'controller', :action => 'action', :id => 'id'}).should == '/controller/action/id'
+  end
+
+  it "should generate a route using defaults for everything but the first parameter" do
+    @route_set.add_named_route(:name, '/:one/:two/:three', {:default_values => {:one => 'one', :two => 'two', :three => 'three'}})
+    @url_generator.generate(:name, {:one => "1"}).should == '/1/two/three'
+  end
+
+  it "should generate a route using defaults for everything" do
+    @route_set.add_named_route(:name, '/:one/:two/:three', {:default_values => {:one => 'one', :two => 'two', :three => 'three'}})
+    @url_generator.generate(:name).should == '/one/two/three'
+  end
+  
+  it "should generate a route using defaults and optionals using the last parameter" do
+    @route_set.add_named_route(:opts_with_defaults, '/:one(/:two(/:three))', {:default_values => {:one => '1', :two => '2', :three => '3'}})
+    @url_generator.generate(:opts_with_defaults, {:three => 'three'}).should == '/1/2/three'
+  end
+
+  it "should generate a route with optional segments given two nested optional parameters" do
+    @route_set.add_named_route(:optionals, '/:controller(/:action(/:id))(.:format)')
+    @url_generator.generate(:optionals, {:controller => "foo", :action => "bar"}).should == '/foo/bar'
+  end
+
+
 end