Module: ActionDispatch::Routing::Mapper::Scoping

Included in:
ActionDispatch::Routing::Mapper
Defined in:
actionpack/lib/action_dispatch/routing/mapper.rb

Overview

You may wish to organize groups of controllers under a namespace. Most commonly, you might group a number of administrative controllers under an admin namespace. You would place these controllers under the app/controllers/admin directory, and you can group them together in your router:

namespace "admin" do
  resources :posts, :comments
end

This will create a number of routes for each of the posts and comments controller. For Admin::PostsController, Rails will create:

GET	    /admin/posts
GET	    /admin/posts/new
POST	  /admin/posts
GET	    /admin/posts/1
GET	    /admin/posts/1/edit
PUT	    /admin/posts/1
DELETE  /admin/posts/1

If you want to route /posts (without the prefix /admin) to Admin::PostsController, you could use

scope :module => "admin" do
  resources :posts
end

or, for a single case

resources :posts, :module => "admin"

If you want to route /admin/posts to PostsController

(without the Admin

module prefix), you could use

scope "/admin" do
  resources :posts
end

or, for a single case

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 PostsController:

GET	    /admin/posts
GET	    /admin/posts/new
POST	  /admin/posts
GET	    /admin/posts/1
GET	    /admin/posts/1/edit
PUT	    /admin/posts/1
DELETE  /admin/posts/1

Instance Method Summary collapse

Instance Method Details

#constraints(constraints = {}) ⇒ Object

Parameter Restriction

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
  resources :posts
end

Now routes such as /posts/1 will no longer be valid, but /posts/1.1 will be. The id parameter must match the constraint passed in for this example.

You may use this to also restrict other parameters:

resources :posts do
  constraints(:post_id => /\d+\.\d+/) do
    resources :comments
  end
end

Restricting based on IP

Routes can also be constrained to an IP or a certain range of IP addresses:

constraints(:ip => /192.168.\d+.\d+/) do
  resources :posts
end

Any user connecting from the 192.168.* range will be able to see this resource, where as any user connecting outside of this range will be told there is no such route.

Dynamic request matching

Requests to routes can be constrained based on specific criteria:

constraints(lambda { |req| req.env["HTTP_USER_AGENT"] =~ /iPhone/ }) do
  resources :iphones
end

You are able to move this logic out into a class if it is too complex for routes. This class must have a matches? method defined on it which either returns true if the user should be given access to that route, or false if the user should not.

class Iphone
  def self.matches?(request)
    request.env["HTTP_USER_AGENT"] =~ /iPhone/
  end
end

An expected place for this code would be lib/constraints.

This class is then used like this:

constraints(Iphone) do
  resources :iphones
end



748
749
750
 
# File 'actionpack/lib/action_dispatch/routing/mapper.rb', line 748

def constraints(constraints = {})
  scope(:constraints => constraints) { yield }
end

#controller(controller, options = {}) ⇒ Object

Scopes routes to a specific controller

Example:

controller "food" do
  match "bacon", :action => "bacon"
end



641
642
643
644
 
# File 'actionpack/lib/action_dispatch/routing/mapper.rb', line 641

def controller(controller, options={})
  options[:controller] = controller
  scope(options) { yield }
end

#defaults(defaults = {}) ⇒ Object

Allows you to set default parameters for a route, such as this:

defaults :id => 'home' do
  match 'scoped_pages/(:id)', :to => 'pages#show'
end

Using this, the :id parameter here will default to ‘home’.



757
758
759
 
# File 'actionpack/lib/action_dispatch/routing/mapper.rb', line 757

def defaults(defaults = {})
  scope(:defaults => defaults) { yield }
end

#namespace(path, options = {}) ⇒ Object

Scopes routes to a specific namespace. For example:

namespace :admin do
  resources :posts
end

This generates the following routes:

    admin_posts GET    /admin/posts(.:format)          admin/posts#index
    admin_posts POST   /admin/posts(.:format)          admin/posts#create
 new_admin_post GET    /admin/posts/new(.:format)      admin/posts#new
edit_admin_post GET    /admin/posts/:id/edit(.:format) admin/posts#edit
     admin_post GET    /admin/posts/:id(.:format)      admin/posts#show
     admin_post PUT    /admin/posts/:id(.:format)      admin/posts#update
     admin_post DELETE /admin/posts/:id(.:format)      admin/posts#destroy

Options

The :path, :as, :module, :shallow_path and :shallow_prefix options all default to the name of the namespace.

For options, see Base#match. For :shallow_path option, see Resources#resources.

Examples

# accessible through /sekret/posts rather than /admin/posts
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
  resources :posts
end

# generates +sekret_posts_path+ rather than +admin_posts_path+
namespace :admin, :as => "sekret" do
  resources :posts
end



686
687
688
689
690
691
 
# File 'actionpack/lib/action_dispatch/routing/mapper.rb', line 686

def namespace(path, options = {})
  path = path.to_s
  options = { :path => path, :as => path, :module => path,
              :shallow_path => path, :shallow_prefix => path }.merge!(options)
  scope(options) { yield }
end

#scope(*args) ⇒ Object

Scopes a set of routes to the given default options.

Take the following route definition as an example:

scope :path => ":account_id", :as => "account" do
  resources :projects
end

This generates helpers such as account_projects_path, just like resources does. The difference here being that the routes generated are like /:account_id/projects, rather than /accounts/:account_id/projects.

Options

Takes same options as Base#match and Resources#resources.

Examples

# route /posts (without the prefix /admin) to <tt>Admin::PostsController</tt>
scope :module => "admin" do
  resources :posts
end

# prefix the posts resource's requests with '/admin'
scope :path => "/admin" do
  resources :posts
end

# prefix the routing helper name: +sekret_posts_path+ instead of +posts_path+
scope :as => "sekret" do
  resources :posts
end



599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
 
# File 'actionpack/lib/action_dispatch/routing/mapper.rb', line 599

def scope(*args)
  options = args.extract_options!
  options = options.dup

  options[:path] = args.first if args.first.is_a?(String)
  recover = {}

  options[:constraints] ||= {}
  unless options[:constraints].is_a?(Hash)
    block, options[:constraints] = options[:constraints], {}
  end

  scope_options.each do |option|
    if value = options.delete(option)
      recover[option] = @scope[option]
      @scope[option]  = send("merge_#{option}_scope", @scope[option], value)
    end
  end

  recover[:block] = @scope[:blocks]
  @scope[:blocks] = merge_blocks_scope(@scope[:blocks], block)

  recover[:options] = @scope[:options]
  @scope[:options]  = merge_options_scope(@scope[:options], options)

  yield
  self
ensure
  scope_options.each do |option|
    @scope[option] = recover[option] if recover.has_key?(option)
  end

  @scope[:options] = recover[:options]
  @scope[:blocks]  = recover[:block]
end