module ActionDispatch::Routing::Mapper::Concerns

Routing Concerns позволяют объявлять общие маршруты, которые можно повторно использовать внутри других ресурсов и маршрутов.

concern :commentable do
  resources :comments
end

concern :image_attachable do
  resources :images, only: :index
end

Эти concerns используются в маршрутизации Resources:

resources :messages, concerns: [:commentable, :image_attachable]

или в области видимости либо пространстве имён:

namespace :posts do
  concerns :commentable
end

Открытые методы экземпляра

concern (name, callable = nil, &block) Показать исходный код

# File actionpack/lib/action_dispatch/routing/mapper.rb, line 2297
def concern(name, callable = nil, &block)
  callable ||= lambda { |mapper, options| mapper.instance_exec(options, &block) }
  @concerns[name] = callable
end

Определяет concern маршрутизации с помощью имени.

Concerns можно определить непосредственно с помощью блока или поручить обработку другому объекту, передав этот объект в качестве второго параметра.

Если объект concern указан, он должен отвечать на вызов call, которому будут переданы два параметра:

* The current mapper
* A hash of options which the concern object may use

В блоках, определяющих concerns, также можно использовать параметры, принимая параметр блока. Например, с помощью блока можно ограничить доступные действия для определённых ресурсов, передав concern стандартные параметры ресурса:

concern :commentable do |options|
  resources :comments, options
end

resources :posts, concerns: :commentable
resources :archived_posts do
  # Don't allow comments on archived posts
  concerns :commentable, only: [:index, :show]
end

Или, используя вызываемый объект, можно реализовать что-то более специфичное для приложения, что было бы неуместно размещать в файле маршрутов.

# purchasable.rb
class Purchasable
  def initialize(defaults = {})
    @defaults = defaults
  end

  def call(mapper, options = {})
    options = @defaults.merge(options)
    mapper.resources :purchases
    mapper.resources :receipts
    mapper.resources :returns if options[:returnable]
  end
end

# routes.rb
concern :purchasable, Purchasable.new(returnable: true)

resources :toys, concerns: :purchasable
resources :electronics, concerns: :purchasable
resources :pets do
  concerns :purchasable, returnable: false
end

Внутри concern можно использовать любые помощники маршрутизации. При использовании вызываемого объекта они доступны через Mapper, переданный в call.

concerns (*args, **options) Показать исходный код

# File actionpack/lib/action_dispatch/routing/mapper.rb, line 2313
def concerns(*args, **options)
  args.flatten.each do |name|
    if concern = @concerns[name]
      concern.call(self, options)
    else
      raise ArgumentError, "No concern named #{name} was found!"
    end
  end
end

Использует именованные concerns

resources :posts do
  concerns :commentable
end

Concerns также работают в любых помощниках маршрутизации, которые вы хотите использовать:

namespace :posts do
  concerns :commentable
end