joshbuddy-usher 0.1.1 → 0.1.2

data/README.rdoc

@@ -8,7 +8,7 @@ This is a tree-based router (based on Ilya Grigorik suggestion). Turns out looki
 
 Here are some examples of routes recognized by usher (so far)
 
-  _Route_                  _Matches_
+  *Route*                  *Matches*
   /path/to/something       /path/to/something
   /path/:variable/more     /path/foo/more, /path/bar/more ...
   /show/*tags              /show/hot /show/hot/coffee /show/some/more/hot/coffee ...
@@ -48,10 +48,10 @@ Here are some examples of routes recognized by usher (so far)
 == DONE
 
 * add support for () optional parts
+* Add support for arbitrary HTTP header checks
 
 == TODO
 
-* Add support for arbitrary HTTP header checks
 * Make it integrate with merb
 * Make it integrate with rails3
 * Create decent DSL for use with rack

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
+:patch: 2
 :major: 0
 :minor: 1
-:patch: 1

data/lib/usher/exceptions.rb

@@ -1,4 +1,5 @@
 class Usher
   class UnrecognizedException < RuntimeError; end
   class ValidationException < RuntimeError; end
+  class MissingParameterException < RuntimeError; end
 end

data/lib/usher.rb

@@ -90,7 +90,7 @@ class Usher
   #    * :transformers - Transforms a variable before it gets to the conditions and requirements. Takes either a +proc+ or a +symbol+. If its a +symbol+, calls the method on the incoming parameter. If its a +proc+, its called with the variable.
   #    * :requirements - After transformation, tests the condition using ===. If it returns false, it raises an +Usher::ValidationException+
   #    * :conditions - Accepts any of the following +:protocol+, +:domain+, +:port+, +:query_string+, +:remote_ip+, +:user_agent+, +:referer+ and +:method+. This can be either a +string+ or a +regexp+.
-  #   
+  #    * any other key is interpreted as a requirement for the variable of its name.
   def add_route(path, options = {})
     transformers = options.delete(:transformers) || {}
     conditions = options.delete(:conditions) || {}
@@ -120,10 +120,22 @@ class Usher
     @tree.find(request)
   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)
     Grapher.instance.find_matching_path(options)
   end
   
+  # Generates a completed URL based on a +route+ or set of +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)
     path = case route
     when Symbol
@@ -138,9 +150,9 @@ class Usher
     param_list = case params
     when Hash
       params_hash = params
-      path.dynamic_parts.collect{|k| params_hash.delete(k.name)}
+      path.dynamic_parts.collect{|k| params_hash.delete(k.name) {|el| raise MissingParameterException.new(k.name)} }
     when Array
-      params
+      path.dynamic_parts.size == params.size ? params : raise(MissingParameterException.new("got #{params.size} arguments, expected #{path.dynamic_parts.size}"))
     else
       Array(params)
     end

data/spec/generate_spec.rb

@@ -58,4 +58,31 @@ describe "Usher URL generation" do
     route_set.generate_url(: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'
+  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'
+  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'
+  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
+  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
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: joshbuddy-usher
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors: 
 - Joshua Hull
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-03-27 00:00:00 -07:00
+date: 2009-03-28 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency