1.9 hash syntax changes to docs

1 files changed, 55 insertions, 55 deletions

diff --git a/actionpack/lib/action_dispatch/routing/mapper.rb b/actionpack/lib/action_dispatch/routing/mapper.rb
index c5cf413c8f..e337e30766 100644
--- a/actionpack/lib/action_dispatch/routing/mapper.rb
+++ b/actionpack/lib/action_dispatch/routing/mapper.rb
@@ -121,7 +121,7 @@ module ActionDispatch
               # Add a default constraint for :controller path segments that matches namespaced
               # controllers with default routes like :controller/:action/:id(.:format), e.g:
               # GET /admin/products/show/1
-              # => { :controller => 'admin/products', :action => 'show', :id => '1' }
+              # => { controller: 'admin/products', action: 'show', id: '1' }
               @options[:controller] ||= /.+?/
             end
 
@@ -272,7 +272,7 @@ module ActionDispatch
       module Base
         # You can specify what Rails should route "/" to with the root method:
         #
-        #   root :to => 'pages#main'
+        #   root to: 'pages#main'
         #
         # For options, see +match+, as +root+ uses it internally.
         #
@@ -309,8 +309,8 @@ module ActionDispatch
         # +: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'
+        #   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+:
@@ -336,7 +336,7 @@ module ActionDispatch
         # [:module]
         #   The namespace for :controller.
         #
-        #     match 'path' => 'c#a', :module => 'sekret', :controller => 'posts'
+        #     match 'path' => 'c#a', module: 'sekret', controller: 'posts'
         #     #=> Sekret::PostsController
         #
         #   See <tt>Scoping#namespace</tt> for its scope equivalent.
@@ -347,16 +347,16 @@ module ActionDispatch
         # [:via]
         #   Allowed HTTP verb(s) for route.
         #
-        #      match 'path' => 'c#a', :via => :get
-        #      match 'path' => 'c#a', :via => [:get, :post]
+        #      match 'path' => 'c#a', via: :get
+        #      match 'path' => 'c#a', via: [:get, :post]
         #
         # [:to]
         #   Points to a +Rack+ endpoint. Can be an object that responds to
         #   +call+ or a string representing a controller's action.
         #
-        #      match 'path', :to => 'controller#action'
-        #      match 'path', :to => lambda { |env| [200, {}, "Success!"] }
-        #      match 'path', :to => RackApp
+        #      match 'path', to: 'controller#action'
+        #      match 'path', to: lambda { |env| [200, {}, "Success!"] }
+        #      match 'path', to: RackApp
         #
         # [:on]
         #   Shorthand for wrapping routes in a specific RESTful context. Valid
@@ -364,14 +364,14 @@ module ActionDispatch
         #   <tt>resource(s)</tt> block. For example:
         #
         #      resource :bar do
-        #        match 'foo' => 'c#a', :on => :member, :via => [:get, :post]
+        #        match 'foo' => 'c#a', on: :member, via: [:get, :post]
         #      end
         #
         #   Is equivalent to:
         #
         #      resource :bar do
         #        member do
-        #          match 'foo' => 'c#a', :via => [:get, :post]
+        #          match 'foo' => 'c#a', via: [:get, :post]
         #        end
         #      end
         #
@@ -379,12 +379,12 @@ module ActionDispatch
         #   Constrains parameters with a hash of regular expressions or an
         #   object that responds to <tt>matches?</tt>
         #
-        #     match 'path/:id', :constraints => { :id => /[A-Z]\d{5}/ }
+        #     match 'path/:id', constraints: { id: /[A-Z]\d{5}/ }
         #
         #     class Blacklist
         #       def matches?(request) request.remote_ip == '1.2.3.4' end
         #     end
-        #     match 'path' => 'c#a', :constraints => Blacklist.new
+        #     match 'path' => 'c#a', constraints: Blacklist.new
         #
         #   See <tt>Scoping#constraints</tt> for more examples with its scope
         #   equivalent.
@@ -393,7 +393,7 @@ module ActionDispatch
         #   Sets defaults for parameters
         #
         #     # Sets params[:format] to 'jpg' by default
-        #     match 'path' => 'c#a', :defaults => { :format => 'jpg' }
+        #     match 'path' => 'c#a', defaults: { format: 'jpg' }
         #
         #   See <tt>Scoping#defaults</tt> for its scope equivalent.
         #
@@ -402,7 +402,7 @@ module ActionDispatch
         #   false, the pattern matches any request prefixed with the given path.
         #
         #     # Matches any request starting with 'path'
-        #     match 'path' => 'c#a', :anchor => false
+        #     match 'path' => 'c#a', anchor: false
         #
         # [:format]
         #   Allows you to specify the default value for optional +format+
@@ -412,7 +412,7 @@ module ActionDispatch
 
         # Mount a Rack-based application to be used within the application.
         #
-        #   mount SomeRackApp, :at => "some_route"
+        #   mount SomeRackApp, at: "some_route"
         #
         # Alternatively:
         #
@@ -425,7 +425,7 @@ module ActionDispatch
         # the helper is either +some_rack_app_path+ or +some_rack_app_url+.
         # To customize this helper's name, use the +:as+ option:
         #
-        #   mount(SomeRackApp => "some_route", :as => "exciting")
+        #   mount(SomeRackApp => "some_route", as: "exciting")
         #
         # This will generate the +exciting_path+ and +exciting_url+ helpers
         # which can be used to navigate to this mounted app.
@@ -503,7 +503,7 @@ module ActionDispatch
         # Define a route that only recognizes HTTP GET.
         # For supported arguments, see <tt>Base#match</tt>.
         #
-        #   get 'bacon', :to => 'food#bacon'
+        #   get 'bacon', to: 'food#bacon'
         def get(*args, &block)
           map_method(:get, args, &block)
         end
@@ -511,7 +511,7 @@ module ActionDispatch
         # Define a route that only recognizes HTTP POST.
         # For supported arguments, see <tt>Base#match</tt>.
         #
-        #   post 'bacon', :to => 'food#bacon'
+        #   post 'bacon', to: 'food#bacon'
         def post(*args, &block)
           map_method(:post, args, &block)
         end
@@ -519,7 +519,7 @@ module ActionDispatch
         # Define a route that only recognizes HTTP PATCH.
         # For supported arguments, see <tt>Base#match</tt>.
         #
-        #   patch 'bacon', :to => 'food#bacon'
+        #   patch 'bacon', to: 'food#bacon'
         def patch(*args, &block)
           map_method(:patch, args, &block)
         end
@@ -527,7 +527,7 @@ module ActionDispatch
         # Define a route that only recognizes HTTP PUT.
         # For supported arguments, see <tt>Base#match</tt>.
         #
-        #   put 'bacon', :to => 'food#bacon'
+        #   put 'bacon', to: 'food#bacon'
         def put(*args, &block)
           map_method(:put, args, &block)
         end
@@ -535,7 +535,7 @@ module ActionDispatch
         # Define a route that only recognizes HTTP DELETE.
         # For supported arguments, see <tt>Base#match</tt>.
         #
-        #   delete 'broccoli', :to => 'food#broccoli'
+        #   delete 'broccoli', to: 'food#broccoli'
         def delete(*args, &block)
           map_method(:delete, args, &block)
         end
@@ -574,13 +574,13 @@ module ActionDispatch
       # If you want to route /posts (without the prefix /admin) to
       # <tt>Admin::PostsController</tt>, you could use
       #
-      #   scope :module => "admin" do
+      #   scope module: "admin" do
       #     resources :posts
       #   end
       #
       # or, for a single case
       #
-      #   resources :posts, :module => "admin"
+      #   resources :posts, module: "admin"
       #
       # If you want to route /admin/posts to +PostsController+
       # (without the Admin:: module prefix), you could use
@@ -591,7 +591,7 @@ module ActionDispatch
       #
       # or, for a single case
       #
-      #   resources :posts, :path => "/admin/posts"
+      #   resources :posts, path: "/admin/posts"
       #
       # In each of these cases, the named routes remain the same as if you did
       # not use scope. In the last case, the following paths map to
@@ -609,7 +609,7 @@ module ActionDispatch
         #
         # Take the following route definition as an example:
         #
-        #   scope :path => ":account_id", :as => "account" do
+        #   scope path: ":account_id", as: "account" do
         #     resources :projects
         #   end
         #
@@ -624,17 +624,17 @@ module ActionDispatch
         # === Examples
         #
         #   # route /posts (without the prefix /admin) to <tt>Admin::PostsController</tt>
-        #   scope :module => "admin" do
+        #   scope module: "admin" do
         #     resources :posts
         #   end
         #
         #   # prefix the posts resource's requests with '/admin'
-        #   scope :path => "/admin" do
+        #   scope path: "/admin" do
         #     resources :posts
         #   end
         #
         #   # prefix the routing helper name: +sekret_posts_path+ instead of +posts_path+
-        #   scope :as => "sekret" do
+        #   scope as: "sekret" do
         #     resources :posts
         #   end
         def scope(*args)
@@ -680,7 +680,7 @@ module ActionDispatch
         # Scopes routes to a specific controller
         #
         #   controller "food" do
-        #     match "bacon", :action => "bacon"
+        #     match "bacon", action: "bacon"
         #   end
         def controller(controller, options={})
           options[:controller] = controller
@@ -714,17 +714,17 @@ module ActionDispatch
         # === Examples
         #
         #   # accessible through /sekret/posts rather than /admin/posts
-        #   namespace :admin, :path => "sekret" do
+        #   namespace :admin, path: "sekret" do
         #     resources :posts
         #   end
         #
         #   # maps to <tt>Sekret::PostsController</tt> rather than <tt>Admin::PostsController</tt>
-        #   namespace :admin, :module => "sekret" do
+        #   namespace :admin, module: "sekret" do
         #     resources :posts
         #   end
         #
         #   # generates +sekret_posts_path+ rather than +admin_posts_path+
-        #   namespace :admin, :as => "sekret" do
+        #   namespace :admin, as: "sekret" do
         #     resources :posts
         #   end
         def namespace(path, options = {})
@@ -738,7 +738,7 @@ module ActionDispatch
         # Allows you to constrain the nested routes based on a set of rules.
         # For instance, in order to change the routes to allow for a dot character in the +id+ parameter:
         #
-        #   constraints(:id => /\d+\.\d+/) do
+        #   constraints(id: /\d+\.\d+/) do
         #     resources :posts
         #   end
         #
@@ -748,7 +748,7 @@ module ActionDispatch
         # You may use this to also restrict other parameters:
         #
         #   resources :posts do
-        #     constraints(:post_id => /\d+\.\d+/) do
+        #     constraints(post_id: /\d+\.\d+/) do
         #       resources :comments
         #     end
         #   end
@@ -757,7 +757,7 @@ module ActionDispatch
         #
         # Routes can also be constrained to an IP or a certain range of IP addresses:
         #
-        #   constraints(:ip => /192\.168\.\d+\.\d+/) do
+        #   constraints(ip: /192\.168\.\d+\.\d+/) do
         #     resources :posts
         #   end
         #
@@ -794,8 +794,8 @@ module ActionDispatch
         end
 
         # Allows you to set default parameters for a route, such as this:
-        #   defaults :id => 'home' do
-        #     match 'scoped_pages/(:id)', :to => 'pages#show'
+        #   defaults id: 'home' do
+        #     match 'scoped_pages/(:id)', to: 'pages#show'
         #   end
         # Using this, the +:id+ parameter here will default to 'home'.
         def defaults(defaults = {})
@@ -902,7 +902,7 @@ module ActionDispatch
       # use dots as part of the +:id+ parameter add a constraint which
       # overrides this restriction, e.g:
       #
-      #   resources :articles, :id => /[^\/]+/
+      #   resources :articles, id: /[^\/]+/
       #
       # This allows any character other than a slash as part of your +:id+.
       #
@@ -1112,43 +1112,43 @@ module ActionDispatch
         #   Allows you to change the segment component of the +edit+ and +new+ actions.
         #   Actions not specified are not changed.
         #
-        #     resources :posts, :path_names => { :new => "brand_new" }
+        #     resources :posts, path_names: { new: "brand_new" }
         #
         #   The above example will now change /posts/new to /posts/brand_new
         #
         # [:path]
         #   Allows you to change the path prefix for the resource.
         #
-        #     resources :posts, :path => 'postings'
+        #     resources :posts, path: 'postings'
         #
         #   The resource and all segments will now route to /postings instead of /posts
         #
         # [:only]
         #   Only generate routes for the given actions.
         #
-        #     resources :cows, :only => :show
-        #     resources :cows, :only => [:show, :index]
+        #     resources :cows, only: :show
+        #     resources :cows, only: [:show, :index]
         #
         # [:except]
         #   Generate all routes except for the given actions.
         #
-        #     resources :cows, :except => :show
-        #     resources :cows, :except => [:show, :index]
+        #     resources :cows, except: :show
+        #     resources :cows, except: [:show, :index]
         #
         # [:shallow]
         #   Generates shallow routes for nested resource(s). When placed on a parent resource,
         #   generates shallow routes for all nested resources.
         #
-        #     resources :posts, :shallow => true do
+        #     resources :posts, shallow: true do
         #       resources :comments
         #     end
         #
         #   Is the same as:
         #
         #     resources :posts do
-        #       resources :comments, :except => [:show, :edit, :update, :destroy]
+        #       resources :comments, except: [:show, :edit, :update, :destroy]
         #     end
-        #     resources :comments, :only => [:show, :edit, :update, :destroy]
+        #     resources :comments, only: [:show, :edit, :update, :destroy]
         #
         #   This allows URLs for resources that otherwise would be deeply nested such
         #   as a comment on a blog post like <tt>/posts/a-long-permalink/comments/1234</tt>
@@ -1157,9 +1157,9 @@ module ActionDispatch
         # [:shallow_path]
         #   Prefixes nested shallow routes with the specified path.
         #
-        #     scope :shallow_path => "sekret" do
+        #     scope shallow_path: "sekret" do
         #       resources :posts do
-        #         resources :comments, :shallow => true
+        #         resources :comments, shallow: true
         #       end
         #     end
         #
@@ -1176,9 +1176,9 @@ module ActionDispatch
         # [:shallow_prefix]
         #   Prefixes nested shallow route names with specified prefix.
         #
-        #     scope :shallow_prefix => "sekret" do
+        #     scope shallow_prefix: "sekret" do
         #       resources :posts do
-        #         resources :comments, :shallow => true
+        #         resources :comments, shallow: true
         #       end
         #     end
         #
@@ -1199,10 +1199,10 @@ module ActionDispatch
         # === Examples
         #
         #   # routes call <tt>Admin::PostsController</tt>
-        #   resources :posts, :module => "admin"
+        #   resources :posts, module: "admin"
         #
         #   # resource actions are at /admin/posts.
-        #   resources :posts, :path => "admin/posts"
+        #   resources :posts, path: "admin/posts"
         def resources(*resources, &block)
           options = resources.extract_options!.dup