модуль ActionDispatch::Routing::Mapper::Scoping

# File actionpack/lib/action_dispatch/routing/mapper.rb, line 995
def constraints(constraints = {})
  scope(constraints: constraints) { yield }
end

Ограничение параметров

Позволяет ограничивать вложенные маршруты на основе набора правил. Например, для изменения маршрутов, чтобы разрешить использование точки в параметре id:

constraints(id: /\d+\.\d+/) do
  resources :posts
end

Теперь такие маршруты, как /posts/1, больше не будут валидными, но /posts/1.1 будут. Параметр id должен соответствовать ограничению, переданному в этом примере.

Вы также можете использовать это для ограничения других параметров:

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

Ограничение по IP

Маршруты также могут быть ограничены по IP-адресу или определённому диапазону IP-адресов:

constraints(ip: /192\.168\.\d+\.\d+/) do
  resources :posts
end

Любой пользователь, подключившийся из диапазона 192.168.*, сможет увидеть этот ресурс, в то время как любой пользователь, подключившийся вне этого диапазона, получит сообщение, что такого маршрута не существует.

Динамическое сопоставление запросов

Запросы к маршрутам могут быть ограничены по определённым критериям:

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

Если логика слишком сложна для маршрутов, вы можете вынести её в отдельный класс. В этом классе должен быть определён метод matches?, который возвращает true, если пользователю должен быть предоставлен доступ к этому маршруту, или false, если доступ запрещён.

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

Ожидаемое место для этого кода — lib/constraints.

Этот класс используется следующим образом:

constraints(Iphone) do
  resources :iphones
end

# File actionpack/lib/action_dispatch/routing/mapper.rb, line 880
def controller(controller)
  @scope = @scope.new(controller: controller)
  yield
ensure
  @scope = @scope.parent
end

Ограничивает маршруты определённым контроллером

controller "food" do
  match "bacon", action: :bacon, via: :get
end

# File actionpack/lib/action_dispatch/routing/mapper.rb, line 1004
def defaults(defaults = {})
  @scope = @scope.new(defaults: merge_defaults_scope(@scope[:defaults], defaults))
  yield
ensure
  @scope = @scope.parent
end

Позволяет задать значения по умолчанию для параметров маршрута, например:

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

В этом случае параметр :id будет иметь значение по умолчанию 'home'.

# File actionpack/lib/action_dispatch/routing/mapper.rb, line 925
def namespace(path, options = {})
  path = path.to_s

  defaults = {
    module:         path,
    as:             options.fetch(:as, path),
    shallow_path:   options.fetch(:path, path),
    shallow_prefix: options.fetch(:as, path)
  }

  path_scope(options.delete(:path) { path }) do
    scope(defaults.merge!(options)) { yield }
  end
end

Ограничивает маршруты определённым пространством имён. Например:

namespace :admin do
  resources :posts
end

Это генерирует следующие маршруты:

    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 PATCH/PUT /admin/posts/:id(.:format)      admin/posts#update
     admin_post DELETE    /admin/posts/:id(.:format)      admin/posts#destroy

Параметры

Параметры :path, :as, :module, :shallow_path и :shallow_prefix по умолчанию принимают имя пространства имён.

Для параметров см. Base#match. Для параметра :shallow_path см. Resources#resources.

# 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

# File actionpack/lib/action_dispatch/routing/mapper.rb, line 821
def scope(*args)
  options = args.extract_options!.dup
  scope = {}

  options[:path] = args.flatten.join("/") if args.any?
  options[:constraints] ||= {}

  unless nested_scope?
    options[:shallow_path] ||= options[:path] if options.key?(:path)
    options[:shallow_prefix] ||= options[:as] if options.key?(:as)
  end

  if options[:constraints].is_a?(Hash)
    defaults = options[:constraints].select do |k, v|
      URL_OPTIONS.include?(k) && (v.is_a?(String) || v.is_a?(Integer))
    end

    options[:defaults] = defaults.merge(options[:defaults] || {})
  else
    block, options[:constraints] = options[:constraints], {}
  end

  if options.key?(:only) || options.key?(:except)
    scope[:action_options] = { only: options.delete(:only),
                               except: options.delete(:except) }
  end

  if options.key? :anchor
    raise ArgumentError, "anchor is ignored unless passed to `match`"
  end

  @scope.options.each do |option|
    if option == :blocks
      value = block
    elsif option == :options
      value = options
    else
      value = options.delete(option) { POISON }
    end

    unless POISON == value
      scope[option] = send("merge_#{option}_scope", @scope[option], value)
    end
  end

  @scope = @scope.new scope
  yield
  self
ensure
  @scope = @scope.parent
end

Ограничивает набор маршрутов заданными значениями по умолчанию.

Рассмотрим следующее определение маршрута:

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

Это генерирует помощники, такие как account_projects_path, так же как и resources. Разница здесь заключается в том, что сгенерированные маршруты похожи на /:account_id/projects, а не на /accounts/:account_id/projects.

Параметры

Принимает те же параметры, что и Base#match и Resources#resources.

# 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