Spec-Zone.ru › Ruby on Rails 4.1

модуль ActionDispatch::Routing::PolymorphicRoutes

Включенные модули:
ActionController::ModelNaming

Полиморфные помощники 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_for(@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_for([blog, @post])         # => "/blog/posts/1"

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

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

Возвращает компонент пути URL для заданной записи. Он использует polymorphic_url с routing_type: :path.

# File actionpack/lib/action_dispatch/routing/polymorphic_routes.rb, line 147
def polymorphic_path(record_or_hash_or_array, options = {})
  polymorphic_url(record_or_hash_or_array, options.merge(:routing_type => :path))
end
polymorphic_url(record_or_hash_or_array, options = {}) Показать исходный код

Создает вызов именованного маршрута 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()
# File actionpack/lib/action_dispatch/routing/polymorphic_routes.rb, line 103
def polymorphic_url(record_or_hash_or_array, options = {})
  if record_or_hash_or_array.kind_of?(Array)
    record_or_hash_or_array = record_or_hash_or_array.compact
    if record_or_hash_or_array.first.is_a?(ActionDispatch::Routing::RoutesProxy)
      proxy = record_or_hash_or_array.shift
    end
    record_or_hash_or_array = record_or_hash_or_array[0] if record_or_hash_or_array.size == 1
  end

  record = extract_record(record_or_hash_or_array)
  record = convert_to_model(record)

  args = Array === record_or_hash_or_array ?
    record_or_hash_or_array.dup :
    [ record_or_hash_or_array ]

  inflection = if options[:action] && options[:action].to_s == "new"
    args.pop
    :singular
  elsif (record.respond_to?(:persisted?) && !record.persisted?)
    args.pop
    :plural
  elsif record.is_a?(Class)
    args.pop
    :plural
  else
    :singular
  end

  args.delete_if {|arg| arg.is_a?(Symbol) || arg.is_a?(String)}
  named_route = build_named_route_call(record_or_hash_or_array, inflection, options)

  url_options = options.except(:action, :routing_type)
  unless url_options.empty?
    args.last.kind_of?(Hash) ? args.last.merge!(url_options) : args << url_options
  end

  args.collect! { |a| convert_to_model(a) }

  (proxy || self).send(named_route, *args)
end

© 2004–2016 David Heinemeier Hansson
Licensed under the MIT License.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API