@@ -70,6 +70,8 @@ module Merb def resources(name, *args, &block) name = name.to_s options = extract_options_from_args!(args) || {} + match_opts = options.except(*resource_options) + options = options.only(*resource_options) singular = options[:singular] ? options[:singular].to_s : Extlib::Inflection.singularize(name) klass_name = args.first ? args.first.to_s : Extlib::Inflection.classify(singular) klass = Object.full_const_get(klass_name) rescue nil @@ -118,45 +120,48 @@ module Merb end # => show - resource.match("/#{root_keys}(.:format)", :method => :get).to(:action => "show"). + resource.match("/#{root_keys}(.:format)", match_opts.merge(:method => :get)).to(:action => "show"). name(singular).register_resource(klass_name) # => user defined member routes member.each_pair do |action, method| action = action.to_s - resource.match("/#{root_keys}/#{action}(.:format)", :method => method). + resource.match("/#{root_keys}/#{action}(.:format)", match_opts.merge(:method => method)). to(:action => "#{action}").name(action, singular).register_resource(klass_name, action) end # => update - resource.match("/#{root_keys}(.:format)", :method => :put). + resource.match("/#{root_keys}(.:format)", match_opts.merge(:method => :put)). to(:action => "update") # => destroy - resource.match("/#{root_keys}(.:format)", :method => :delete). + resource.match("/#{root_keys}(.:format)", match_opts.merge(:method => :delete)). to(:action => "destroy") if block_given? nested_keys = keys.map do |k| k.to_s == "id" ? ":#{singular}_id" : ":#{k}" end.join("/") + + nested_match_opts = match_opts.except(:id) + nested_match_opts["#{singular}_id".to_sym] = match_opts[:id] if match_opts[:id] # Procs for building the extra collection/member resource routes placeholder = Router.resource_routes[ [@options[:resource_prefix], klass_name].flatten.compact ] builders = {} builders[:collection] = lambda do |action, to, method| - resource.before(placeholder).match("/#{action}(.:format)", :method => method). + resource.before(placeholder).match("/#{action}(.:format)", match_opts.merge(:method => method)). to(:action => to).name(action, name).register_resource(name, action) end builders[:member] = lambda do |action, to, method| - resource.match("/#{root_keys}/#{action}(.:format)", :method => method). + resource.match("/#{root_keys}/#{action}(.:format)", match_opts.merge(:method => method)). to(:action => to).name(action, singular).register_resource(klass_name, action) end resource.options(:name_prefix => singular, :resource_prefix => klass_name). - match("/#{nested_keys}").resource_block(builders, &block) + match("/#{nested_keys}", nested_match_opts).resource_block(builders, &block) end end # namespace end # resources @@ -226,6 +231,7 @@ module Merb self.namespace(name, options).to(params) do |resource| # => show + resource.match("(.:format)", :method => :get).to(:action => "show"). name(name).register_resource(name) @@ -270,6 +276,11 @@ module Merb behavior = ResourceBehavior.new(builders, @proxy, @conditions, @params, @defaults, @identifiers, @options, @blocks) with_behavior_context(behavior, &block) end + + def resource_options + [:singular, :keys, :key, :controller, :member, :collection, :identify, + :name_prefix, :resource_prefix, :controller_prefix, :namespace, :path] + end end # Resources lib/merb-core/dispatch/router/resources.rb @@ -1,93 +1,5 @@ require File.join(File.dirname(__FILE__), "..", "spec_helper") -def it_should_be_a_resource_collection_route(name, prefix, params = {}) - it "should provide #{name} with an 'index' route" do - route_for("#{prefix}/#{name}").should have_route(params.merge(:action => "index", :controller => "#{name}")) - end - - it "should provide #{name} with an 'index' route when explicitly specified" do - route_for("#{prefix}/#{name}/index").should have_route(params.merge(:action => "index", :controller => "#{name}")) - end - - it "should provide #{name} with a 'new' route" do - route_for("#{prefix}/#{name}/new").should have_route(params.merge(:action => "new", :controller => "#{name}")) - end - - it "should provide #{name} with a 'create' route" do - route_for("#{prefix}/#{name}", :method => :post).should have_route(params.merge(:action => "create", :controller => "#{name}")) - end - - it "should provide #{name} with a 'show' route" do - route_for("#{prefix}/#{name}/45").should have_route(params.merge(:action => "show", :controller => "#{name}", :id => "45")) - end - - it "should provide #{name} with an 'edit' route" do - route_for("#{prefix}/#{name}/45/edit").should have_route(params.merge(:action => "edit", :controller => "#{name}", :id => "45")) - end - - it "should provide #{name} with an 'update' route" do - route_for("#{prefix}/#{name}/45", :method => :put).should have_route(params.merge(:action => "update", :controller => "#{name}", :id => "45")) - end - - it "should provide #{name} with a 'delete' route" do - route_for("#{prefix}/#{name}/45/delete").should have_route(params.merge(:action => "delete", :controller => "#{name}", :id => "45")) - end - - it "should provide #{name} with a 'destroy' route" do - route_for("#{prefix}/#{name}/45", :method => :delete).should have_route(params.merge(:action => "destroy", :controller => "#{name}", :id => "45")) - end - - # --- I decided that all the routes here will have the following --- - - it "should provide #{name} with a 'one' collection route" do - route_for("#{prefix}/#{name}/one").should have_route(params.merge(:action => "one", :controller => "#{name}")) - end - - it "should provide #{name} with a 'two' member route" do - route_for("#{prefix}/#{name}/45/two").should have_route(params.merge(:action => "two", :controller => "#{name}", :id => "45")) - end - - it "should provide #{name} with a 'three' collection route that maps the 'awesome' method" do - route_for("#{prefix}/#{name}/three").should have_route(params.merge(:action => "awesome", :controller => "#{name}")) - end - - it "should provide #{name} with a 'four' member route that maps to the 'awesome' method" do - route_for("#{prefix}/#{name}/45/four").should have_route(params.merge(:action => "awesome", :controller => "#{name}", :id => "45")) - end -end - -def it_should_be_a_resource_object_route(name, prefix, params = {}) - controller = "#{name}s" - - it "should provide #{name} with a 'show' route" do - route_for("#{prefix}/#{name}").should have_route(params.merge(:action => "show", :controller => controller)) - end - - it "should provide #{name} with an 'edit' route" do - route_for("#{prefix}/#{name}/edit").should have_route(params.merge(:action => "edit", :controller => controller)) - end - - it "should provide #{name} with an 'update' route" do - route_for("#{prefix}/#{name}", :method => :put).should have_route(params.merge(:action => "update", :controller => controller)) - end - - it "should provide #{name} with a 'delete' route" do - route_for("#{prefix}/#{name}/delete").should have_route(params.merge(:action => "delete", :controller => controller)) - end - - it "should provide #{name} with a 'destroy' route" do - route_for("#{prefix}/#{name}", :method => :delete).should have_route(params.merge(:action => "destroy", :controller => controller)) - end - - it "should provide #{name} with a 'one' member route" do - route_for("#{prefix}/#{name}/one").should have_route(params.merge(:action => "one", :controller => controller)) - end - - it "should provide #{name} with a 'two' member route that maps to the 'awesome' method" do - route_for("#{prefix}/#{name}/two").should have_route(params.merge(:action => "awesome", :controller => controller)) - end -end - describe "Recognizing requests for nested resources routes" do before(:each) do @@ -140,4 +52,54 @@ describe "Recognizing requests for nested resources routes" do it "should match a get to /domains/merbivore_com/emails to the emails controller and index action with domain => 'merbivore_com" do route_for('/domains/merbivore_com/emails', :method => :get).should have_route(:controller => 'emails', :action => 'index', :username => nil, :domain => 'merbivore_com') end + +end + +describe "Recognizing requests for nested resources routes with custom matchers" do + + it "should convert the :id condition to :user_id" do + Merb::Router.prepare do + resources :users, :id => /[a-z]+/ do + resources :comments + end + end + + route_for("/users/abc/comments/1").should have_route(:user_id => "abc") + lambda { route_for('/users/123/comments/1') }.should raise_not_found + end + + it "should leave single keys not named :id alone" do + Merb::Router.prepare do + resources :users, :key => :name, :name => /[a-z]+/ do + resources :comments + end + end + + route_for("/users/abc/comments/1").should have_route(:name => "abc") + lambda { route_for('/users/123/comments/1') }.should raise_not_found + end + + it "should work with multi-key resources that have an :id as part of the identifier" do + Merb::Router.prepare do + resources :users, :key => [:name, :id], :id => /[a-z]+/ do + resources :comments + end + end + + route_for("/users/abc/efg/comments/1").should have_route(:name => "abc", :user_id => "efg") + lambda { route_for('/users/abc/123/comments/1') }.should raise_not_found + end + + it "should work with mult-key resources" do + Merb::Router.prepare do + resources :users, :key => [:first, :last], :first => /[a-z]+/, :last => /[a-z]+\/[a-z]+/ do + resources :comments + end + end + + route_for("/users/abc/efg/hij/comments/1").should have_route(:first => "abc", :last => "efg/hij") + lambda { route_for('/users/abc/123/comments/1') }.should raise_not_found + lambda { route_for('/users/abc/efg/comments/1') }.should raise_not_found + end + end \ No newline at end of file spec/public/router/recognition/nested_resources_spec.rb @@ -1,63 +1,28 @@ require File.join(File.dirname(__FILE__), "..", "spec_helper") describe "When recognizing requests," do - - describe "a basic resource collection route" do + describe "a basic resource collection route" do + before :each do Merb::Router.prepare do resources :blogposts end end - - it "should have an index action with an optional :format" do - route_for('/blogposts').should have_route(:controller => 'blogposts', :action => 'index', :id => nil, :format => nil) - route_for('/blogposts/index').should have_route(:controller => 'blogposts', :action => 'index', :id => nil, :format => nil) - route_for('/blogposts.js').should have_route(:controller => 'blogposts', :action => 'index', :id => nil, :format => "js") - route_for('/blogposts/index.xml').should have_route(:controller => 'blogposts', :action => 'index', :id => nil, :format => "xml") - end - - it "should have a create action with an optional :format" do - route_for('/blogposts', :method => :post).should have_route(:controller => 'blogposts', :action => 'create', :id => nil, :format => nil) - route_for('/blogposts.js', :method => :post).should have_route(:controller => 'blogposts', :action => 'create', :id => nil, :format => "js") - end - + + it_should_be_a_resource_collection_route :blogposts, { :extra => false }, { } + it "should not match put or delete on the collection" do [:put, :delete].each do |method| lambda { route_for('/blogposts', :method => method) }.should raise_not_found lambda { route_for('/blogposts.js', :method => method) }.should raise_not_found end end - - it "should have a new action with an optional :format" do - route_for('/blogposts/new', :method => :get).should have_route(:controller => 'blogposts', :action => 'new', :id => nil, :format => nil) - route_for('/blogposts/new.js', :method => :get).should have_route(:controller => 'blogposts', :action => 'new', :id => nil, :format => "js") - end it "should not match post on the new action" do lambda { route_for('/blogposts/new', :method => :post) }.should raise_not_found lambda { route_for('/blogposts/new.xml', :method => :post) }.should raise_not_found end - - it "should have a show action with an optional :format" do - route_for('/blogposts/1', :method => :get).should have_route(:controller => 'blogposts', :action => 'show', :id => "1", :format => nil) - route_for('/blogposts/1.css', :method => :get).should have_route(:controller => 'blogposts', :action => 'show', :id => "1", :format => "css") - end - - it "should have an update action with an optional :format" do - route_for('/blogposts/1', :method => :put).should have_route(:controller => 'blogposts', :action => 'update', :id => "1", :format => nil) - route_for('/blogposts/1.csv', :method => :put).should have_route(:controller => 'blogposts', :action => 'update', :id => "1", :format => "csv") - end - - it "should have a destroy action with an optional :format" do - route_for('/blogposts/1', :method => :delete).should have_route(:controller => 'blogposts', :action => 'destroy', :id => "1", :format => nil) - route_for('/blogposts/1.xxl', :method => :delete).should have_route(:controller => 'blogposts', :action => 'destroy', :id => "1", :format => 'xxl') - end - - it "should have an edit action with an optional :format" do - route_for('/blogposts/1/edit', :method => :get).should have_route(:controller => 'blogposts', :action => 'edit', :id => "1", :format => nil) - route_for('/blogposts/1/edit.rss', :method => :get).should have_route(:controller => 'blogposts', :action => 'edit', :id => "1", :format => "rss") - end it "should not match post, put, or delete on the edit action" do [:put, :post, :delete].each do |method| @@ -65,11 +30,6 @@ describe "When recognizing requests," do lambda { route_for('/blogposts/edit.hi', :method => :post) }.should raise_not_found end end - - it "should should have a delete action with an optional :format" do - route_for('/blogposts/1/delete', :method => :get).should have_route(:controller => 'blogposts', :action => 'delete', :id => "1", :format => nil) - route_for('/blogposts/1/delete.mp3', :method => :get).should have_route(:controller => 'blogposts', :action => 'delete', :id => "1", :format => "mp3") - end it "should not match post, put, or delete on the delete action" do [:put, :post, :delete].each do |method| @@ -77,6 +37,27 @@ describe "When recognizing requests," do lambda { route_for('/blogposts/delete.flv', :method => :post) }.should raise_not_found end end + + end + + describe "a basic resource collection with custom " do + + before :each do + Merb::Router.prepare do + resources :blogposts, :id => %r([a-z]+/\d+) + end + end + + it_should_be_a_resource_collection_route :blogposts, { :extra => false, :id => "abc/123" }, { } + + it "should not match a numeric ID for the routes" do + lambda { route_for("/blogposts/10") }.should raise_not_found + lambda { route_for("/blogposts/10", :method => :put) }.should raise_not_found + lambda { route_for("/blogposts/10", :method => :delete) }.should raise_not_found + lambda { route_for("/blogposts/10/edit") }.should raise_not_found + lambda { route_for("/blogposts/10/delete") }.should raise_not_found + end + end describe "a customized resource collection route" do @@ -267,6 +248,28 @@ describe "When recognizing requests," do it "should match a get to /emails/bidule/merbivore_com/delete to the emails controller and the delete action with username => 'bidule', domain => 'merbivore_com'" do route_for('/emails/bidule/merbivore_com/delete', :method => :get).should have_route(:controller => 'emails', :action => 'delete', :username => "bidule", :domain => "merbivore_com") end + + it "should be able to set matches on each key" do + Merb::Router.prepare do + resources :emails, :keys => ["username", "domain"], :username => /[a-z]+/, :domain => /[a-z]+\.com/ + end + + route_for("/emails/abc/abc.com").should have_route(:username => "abc", :domain => "abc.com") + lambda { route_for("/emails/123/456") }.should raise_not_found + lambda { route_for("/emails/abc/123") }.should raise_not_found + lambda { route_for("/emails/123/abc.com") }.should raise_not_found + end + + it "should be able to set matches on a single key" do + Merb::Router.prepare do + resources :emails, :keys => ["username", "domain"], :username => /[a-z]+/ + end + + route_for("/emails/abc/123").should have_route(:username => "abc", :domain => "123") + route_for("/emails/abc/abc").should have_route(:username => "abc", :domain => "abc") + lambda { route_for("/emails/123/456") }.should raise_not_found + lambda { route_for("/emails/123/abc") }.should raise_not_found + end end spec/public/router/recognition/resources_spec.rb @@ -157,6 +157,123 @@ module Spec end end +def it_should_be_a_resource_collection_route(name, *args) + params = extract_options_from_args!(args) || {} + prefix = args.first.is_a?(String) ? args.shift : "" + opts = args.first.is_a?(Hash) ? args.shift : {} + + id = opts[:id] || "45" + + it "should provide #{name} with an 'index' route" do + route_for("#{prefix}/#{name}").should have_route({:action => "index", :controller => "#{name}", :id => nil, :format => nil }.merge(params)) + route_for("#{prefix}/#{name}/index").should have_route({:action => "index", :controller => "#{name}", :id => nil, :format => nil }.merge(params)) + route_for("#{prefix}/#{name}.js").should have_route({:action => "index", :controller => "#{name}", :id => nil, :format => "js"}.merge(params)) + route_for("#{prefix}/#{name}/index.js").should have_route({:action => "index", :controller => "#{name}", :id => nil, :format => "js"}.merge(params)) + end + + it "should provide #{name} with a 'new' route" do + route_for("#{prefix}/#{name}/new").should have_route({:action => "new", :controller => "#{name}", :id => nil, :format => nil }.merge(params)) + route_for("#{prefix}/#{name}/new.js").should have_route({:action => "new", :controller => "#{name}", :id => nil, :format => "js"}.merge(params)) + end + + it "should provide #{name} with a 'create' route" do + route_for("#{prefix}/#{name}", :method => :post).should have_route({:action => "create", :controller => "#{name}", :id => nil, :format => nil }.merge(params)) + route_for("#{prefix}/#{name}.js", :method => :post).should have_route({:action => "create", :controller => "#{name}", :id => nil, :format => "js"}.merge(params)) + end + + it "should provide #{name} with a 'show' route" do + route_for("#{prefix}/#{name}/#{id}").should have_route({:action => "show", :controller => "#{name}", :id => id, :format => nil }.merge(params)) + route_for("#{prefix}/#{name}/#{id}.js").should have_route({:action => "show", :controller => "#{name}", :id => id, :format => "js"}.merge(params)) + end + + it "should provide #{name} with an 'edit' route" do + route_for("#{prefix}/#{name}/#{id}/edit").should have_route({:action => "edit", :controller => "#{name}", :id => id, :format => nil }.merge(params)) + route_for("#{prefix}/#{name}/#{id}/edit.js").should have_route({:action => "edit", :controller => "#{name}", :id => id, :format => "js"}.merge(params)) + end + + it "should provide #{name} with an 'update' route" do + route_for("#{prefix}/#{name}/#{id}", :method => :put).should have_route({:action => "update", :controller => "#{name}", :id => id, :format => nil }.merge(params)) + route_for("#{prefix}/#{name}/#{id}.js", :method => :put).should have_route({:action => "update", :controller => "#{name}", :id => id, :format => "js"}.merge(params)) + end + + it "should provide #{name} with a 'delete' route" do + route_for("#{prefix}/#{name}/#{id}/delete").should have_route({:action => "delete", :controller => "#{name}", :id => id, :format => nil }.merge(params)) + route_for("#{prefix}/#{name}/#{id}/delete.js").should have_route({:action => "delete", :controller => "#{name}", :id => id, :format => "js"}.merge(params)) + end + + it "should provide #{name} with a 'destroy' route" do + route_for("#{prefix}/#{name}/#{id}", :method => :delete).should have_route({:action => "destroy", :controller => "#{name}", :id => id, :format => nil }.merge(params)) + route_for("#{prefix}/#{name}/#{id}.js", :method => :delete).should have_route({:action => "destroy", :controller => "#{name}", :id => id, :format => "js"}.merge(params)) + end + + # --- I decided that all the routes here will have the following --- + + if !opts.has_key?(:extra) || opts[:extra] + + it "should provide #{name} with a 'one' collection route" do + route_for("#{prefix}/#{name}/one").should have_route({:action => "one", :controller => "#{name}", :format => nil }.merge(params)) + route_for("#{prefix}/#{name}/one.js").should have_route({:action => "one", :controller => "#{name}", :format => "js"}.merge(params)) + end + + it "should provide #{name} with a 'two' member route" do + route_for("#{prefix}/#{name}/#{id}/two").should have_route({:action => "two", :controller => "#{name}", :id => id, :format => nil }.merge(params)) + route_for("#{prefix}/#{name}/#{id}/two.js").should have_route({:action => "two", :controller => "#{name}", :id => id, :format => "js"}.merge(params)) + end + + it "should provide #{name} with a 'three' collection route that maps the 'awesome' method" do + route_for("#{prefix}/#{name}/three").should have_route({:action => "awesome", :controller => "#{name}", :format => nil }.merge(params)) + route_for("#{prefix}/#{name}/three.js").should have_route({:action => "awesome", :controller => "#{name}", :format => "js"}.merge(params)) + end + + it "should provide #{name} with a 'four' member route that maps to the 'awesome' method" do + route_for("#{prefix}/#{name}/#{id}/four").should have_route({:action => "awesome", :controller => "#{name}", :id => id, :format => nil }.merge(params)) + route_for("#{prefix}/#{name}/#{id}/four.js").should have_route({:action => "awesome", :controller => "#{name}", :id => id, :format => "js"}.merge(params)) + end + end +end + +def it_should_be_a_resource_object_route(name, *args) + controller = "#{name}s" + params = extract_options_from_args!(args) || {} + prefix = args.first.is_a?(String) ? args.shift : "" + opts = args.first.is_a?(Hash) ? args.shift : {} + + it "should provide #{name} with a 'show' route" do + route_for("#{prefix}/#{name}").should have_route({:action => "show", :controller => controller, :format => nil }.merge(params)) + route_for("#{prefix}/#{name}.js").should have_route({:action => "show", :controller => controller, :format => "js"}.merge(params)) + end + + it "should provide #{name} with an 'edit' route" do + route_for("#{prefix}/#{name}/edit").should have_route({:action => "edit", :controller => controller, :format => nil }.merge(params)) + route_for("#{prefix}/#{name}/edit.js").should have_route({:action => "edit", :controller => controller, :format => "js"}.merge(params)) + end + + it "should provide #{name} with an 'update' route" do + route_for("#{prefix}/#{name}", :method => :put).should have_route({:action => "update", :controller => controller, :format => nil }.merge(params)) + route_for("#{prefix}/#{name}.js", :method => :put).should have_route({:action => "update", :controller => controller, :format => "js"}.merge(params)) + end + + it "should provide #{name} with a 'delete' route" do + route_for("#{prefix}/#{name}/delete").should have_route({:action => "delete", :controller => controller, :format => nil }.merge(params)) + route_for("#{prefix}/#{name}/delete.js").should have_route({:action => "delete", :controller => controller, :format => "js"}.merge(params)) + end + + it "should provide #{name} with a 'destroy' route" do + route_for("#{prefix}/#{name}", :method => :delete).should have_route({:action => "destroy", :controller => controller, :format => nil}.merge(params)) + route_for("#{prefix}/#{name}.js", :method => :delete).should have_route({:action => "destroy", :controller => controller, :format => "js"}.merge(params)) + end + + it "should provide #{name} with a 'one' member route" do + route_for("#{prefix}/#{name}/one").should have_route({:action => "one", :controller => controller, :format => nil}.merge(params)) + route_for("#{prefix}/#{name}/one.js").should have_route({:action => "one", :controller => controller, :format => "js"}.merge(params)) + end + + it "should provide #{name} with a 'two' member route that maps to the 'awesome' method" do + route_for("#{prefix}/#{name}/two").should have_route({:action => "awesome", :controller => controller, :format => nil }.merge(params)) + route_for("#{prefix}/#{name}/two.js").should have_route({:action => "awesome", :controller => controller, :format => "js"}.merge(params)) + end +end + Spec::Runner.configure do |config| config.include(Spec::Helpers) config.include(Spec::Matchers) spec/public/router/spec_helper.rb e3ec4814766fc1dfbbdbf2f1b7bff1f13b08ecc8 Carl Lerche carllerche@mac.com http://github.com/wycats/merb-core/commit/3c1d2dcfc2fd64957ff0f9b65ca11bb8b52d11fd 3c1d2dcfc2fd64957ff0f9b65ca11bb8b52d11fd 2008-10-12T10:50:08-07:00 2008-10-11T17:22:14-07:00 Adding the ability to set conditions on resource keys When defining resource routes, conditions for the keys can now be set by simply passing those conditions along as extra keys of the options hash. For example: Merb::Router.prepare do resources :users, :id => /[a-z]+/ end This will also work with Array keys, such as. Merb::Router.prepare do resources :users, :keys => [:name, :age], :name => /[a-z]+/, :age => /\d+/ end 2eaa101dcea098db8e0bedd94171c47aaac72515 Carl Lerche carllerche@mac.com