From ac15647bf0e6ed85714dee4e2b14b2e7e6f29320 Mon Sep 17 00:00:00 2001 From: Gabriel Horner Date: Thu, 3 Feb 2011 23:51:06 -0500 Subject: keep options titles consistent to "Options" --- actionpack/lib/action_dispatch/routing/mapper.rb | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) (limited to 'actionpack/lib/action_dispatch/routing/mapper.rb') diff --git a/actionpack/lib/action_dispatch/routing/mapper.rb b/actionpack/lib/action_dispatch/routing/mapper.rb index b28b68ad83..b5ff6e0dcb 100644 --- a/actionpack/lib/action_dispatch/routing/mapper.rb +++ b/actionpack/lib/action_dispatch/routing/mapper.rb @@ -273,7 +273,7 @@ module ActionDispatch # match 'photos/:id', :to => 'photos#show' # match 'photos/:id', :controller => 'photos', :action => 'show' # - # === Supported options + # === Options # # [:controller] # The route's controller. @@ -549,7 +549,7 @@ module ActionDispatch # The difference here being that the routes generated are like /rails/projects/2, # rather than /accounts/rails/projects/2. # - # === Supported options + # === Options # # Takes same options as Base#match and Resources#resources. # @@ -632,7 +632,7 @@ module ActionDispatch # admin_post PUT /admin/posts/:id(.:format) {:action=>"update", :controller=>"admin/posts"} # admin_post DELETE /admin/posts/:id(.:format) {:action=>"destroy", :controller=>"admin/posts"} # - # === Supported options + # === Options # # The +:path+, +:as+, +:module+, +:shallow_path+ and +:shallow_prefix+ # options all default to the name of the namespace. @@ -950,7 +950,7 @@ module ActionDispatch # PUT /geocoder # DELETE /geocoder # - # === Supported options + # === Options # Takes same options as +resources+. def resource(*resources, &block) options = resources.extract_options! @@ -1013,7 +1013,7 @@ module ActionDispatch # PUT /photos/:id/comments/:id # DELETE /photos/:id/comments/:id # - # === Supported options + # === Options # Takes same options as Base#match as well as: # # [:path_names] -- cgit v1.2.3 From 277327bb7f389a140eb4ae7722d64d6cf45e06cf Mon Sep 17 00:00:00 2001 From: Gabriel Horner Date: Sat, 5 Feb 2011 13:12:09 -0500 Subject: improve routing docs, mostly for #match --- actionpack/lib/action_dispatch/routing/mapper.rb | 46 +++++++++++++++++------- 1 file changed, 34 insertions(+), 12 deletions(-) (limited to 'actionpack/lib/action_dispatch/routing/mapper.rb') diff --git a/actionpack/lib/action_dispatch/routing/mapper.rb b/actionpack/lib/action_dispatch/routing/mapper.rb index b5ff6e0dcb..a91b2e88fb 100644 --- a/actionpack/lib/action_dispatch/routing/mapper.rb +++ b/actionpack/lib/action_dispatch/routing/mapper.rb @@ -247,7 +247,7 @@ module ActionDispatch # # root :to => 'pages#main' # - # For options, see the +match+ method's documentation, as +root+ uses it internally. + # For options, see +match+, as +root+ uses it internally. # # You should put the root route at the top of config/routes.rb, # because this means it will be matched first. As this is the most popular route @@ -256,25 +256,42 @@ module ActionDispatch match '/', options.reverse_merge(:as => :root) end - # Matches a pattern to one or more urls. Any symbols in a pattern are - # interpreted as url parameters: + # Matches a url pattern to one or more routes. Any symbols in a pattern + # are interpreted as url query parameters and thus available as +params+ + # in an action: # - # # sets parameters :controller, :action and :id + # # sets :controller, :action and :id in params # match ':controller/:action/:id' # - # Two of these symbols are special: :controller maps to the - # controller name and :action to the action name within that - # controller. Anything other than :controller or - # :action will be available to the action as part of +params+. - # If a pattern does not have :controller and :action symbols, then they - # must be set in options or shorthand. For example: + # Two of these symbols are special, +:controller+ maps to the controller + # and +:action+ to the controller's action. A pattern can also map + # wildcard segments (globs) to params: + # + # match 'songs/*category/:title' => 'songs#show' + # + # # 'songs/rock/classic/stairway-to-heaven' sets + # # params[:category] = 'rock/classic' + # # params[:title] = 'stairway-to-heaven' + # + # When a pattern points to an internal route, the route's +:action+ and + # +:controller+ should be set in options or hash shorthand. Examples: # # match 'photos/:id' => 'photos#show' # match 'photos/:id', :to => 'photos#show' # match 'photos/:id', :controller => 'photos', :action => 'show' # + # A pattern can also point to a +Rack+ endpoint i.e. anything that + # responds to +call+: + # + # match 'photos/:id' => lambda {|hash| [200, {}, "Coming soon" } + # match 'photos/:id' => PhotoRackApp + # # Yes, controller actions are just rack endpoints + # match 'photos/:id' => PhotosController.action(:show) + # # === Options # + # Any options not seen here are passed on as params with the url. + # # [:controller] # The route's controller. # @@ -302,9 +319,12 @@ module ActionDispatch # match 'path' => 'c#a', :via => [:get, :post] # # [:to] - # Shorthand for specifying :controller and :action. + # Points to a +Rack+ endpoint. Can be an object that responds to + # +call+ or a string representing a controller's action. # - # match 'path' => 'c#a', :to => 'controller#action' + # match 'path', :to => 'controller#action' + # match 'path', :to => lambda { [200, {}, "Success!"] } + # match 'path', :to => RackApp # # [:on] # Shorthand for wrapping routes in a specific RESTful context. Valid @@ -358,6 +378,8 @@ module ActionDispatch # # mount(SomeRackApp => "some_route") # + # For options, see +match+, as +mount+ uses it internally. + # # All mounted applications come with routing helpers to access them. # These are named after the class specified, so for the above example # the helper is either +some_rack_app_path+ or +some_rack_app_url+. -- cgit v1.2.3