module ActionDispatch::Routing::PolymorphicRoutes

Action Dispatch `Routing` `PolymorphicRoutes`

Полиморфные помощники URL — это методы для интеллектуального разрешения вызова именованного маршрута при передаче экземпляра модели Active Record. Их следует использовать вместе с ActionController::Resources.

Эти методы полезны, когда нужно сгенерировать правильный URL или путь к RESTful-ресурсу, не зная точный тип нужной записи.

Также поддерживаются вложенные ресурсы и/или пространства имён, как показано в примере:

polymorphic_url([:admin, @article, @comment])

даёт следующий результат:

admin_article_comment_url(@article, @comment)

Использование в рамках фреймворка

Полиморфные помощники URL используются в различных местах фреймворка Rails:

url_for, поэтому его можно использовать с записью в качестве аргумента, например url_for(@article);
ActionView::Helpers::FormHelper использует polymorphic_path, поэтому можно написать form_with(model: @article), не указывая параметр :url для действия формы;
redirect_to (который фактически использует url_for), поэтому его можно вызывать в контроллерах следующим образом: redirect_to(post);
ActionView::Helpers::AtomFeedHelper, поэтому не нужно явно указывать URL для записей ленты.

Полиморфные помощники с префиксами

Помимо методов polymorphic_url и polymorphic_path, доступны несколько помощников с префиксами, сокращённо задающих action: "..." в параметрах. Это:

edit_polymorphic_url, edit_polymorphic_path
new_polymorphic_url, new_polymorphic_path

Пример использования:

edit_polymorphic_path(@post)           # => "/posts/1/edit"
polymorphic_path(@post, format: :pdf)  # => "/posts/1.pdf"

Использование с подключёнными движками

Если вы используете подключённый движок и вам нужно использовать polymorphic_url, указывающий на маршруты движка, передайте прокси маршрутов движка первым аргументом метода. Например:

polymorphic_url([blog, @post])  # calls blog.post_path(@post)
form_with(model: [blog, @post]) # => "/blog/posts/1"

Публичные методы экземпляра

polymorphic_path (record_or_hash_or_array, options = {}) Показать исходный код

# File actionpack/lib/action_dispatch/routing/polymorphic_routes.rb, line 133
def polymorphic_path(record_or_hash_or_array, options = {})
  if Hash === record_or_hash_or_array
    options = record_or_hash_or_array.merge(options)
    record  = options.delete :id
    return polymorphic_path record, options
  end

  if mapping = polymorphic_mapping(record_or_hash_or_array)
    return mapping.call(self, [record_or_hash_or_array, options], true)
  end

  opts   = options.dup
  action = opts.delete :action
  type   = :path

  HelperMethodBuilder.polymorphic_method self,
                                         record_or_hash_or_array,
                                         action,
                                         type,
                                         opts
end

Возвращает компонент пути URL для указанной записи.

polymorphic_url (record_or_hash_or_array, options = {}) Показать исходный код

# File actionpack/lib/action_dispatch/routing/polymorphic_routes.rb, line 110
def polymorphic_url(record_or_hash_or_array, options = {})
  if Hash === record_or_hash_or_array
    options = record_or_hash_or_array.merge(options)
    record  = options.delete :id
    return polymorphic_url record, options
  end

  if mapping = polymorphic_mapping(record_or_hash_or_array)
    return mapping.call(self, [record_or_hash_or_array, options], false)
  end

  opts   = options.dup
  action = opts.delete :action
  type   = opts.delete(:routing_type) || :url

  HelperMethodBuilder.polymorphic_method self,
                                         record_or_hash_or_array,
                                         action,
                                         type,
                                         opts
end

Формирует вызов именованного RESTful-маршрута для указанной записи и возвращает полученную строку URL. Например:

# calls post_url(post)
polymorphic_url(post) # => "http://example.com/posts/1"
polymorphic_url([blog, post]) # => "http://example.com/blogs/1/posts/1"
polymorphic_url([:admin, blog, post]) # => "http://example.com/admin/blogs/1/posts/1"
polymorphic_url([user, :blog, post]) # => "http://example.com/users/1/blog/posts/1"
polymorphic_url(Comment) # => "http://example.com/comments"

Параметры

:action — задаёт префикс действия для именованного маршрута: :new или :edit. По умолчанию префикс отсутствует.
:routing_type — допустимые значения: :path или :url. Значение по умолчанию — :url.

Также включает все параметры url_for. К ним относятся, например, :anchor или :trailing_slash. Пример использования приведён ниже:

polymorphic_url([blog, post], anchor: 'my_anchor')
  # => "http://example.com/blogs/1/posts/1#my_anchor"
polymorphic_url([blog, post], anchor: 'my_anchor', script_name: "/my_app")
  # => "http://example.com/my_app/blogs/1/posts/1#my_anchor"

Описание всех этих параметров см. в документации по url_for.

Функциональность

# an Article record
polymorphic_url(record)  # same as article_url(record)

# a Comment record
polymorphic_url(record)  # same as comment_url(record)

# it recognizes new records and maps to the collection
record = Comment.new
polymorphic_url(record)  # same as comments_url()

# the class of a record will also map to the collection
polymorphic_url(Comment) # same as comments_url()