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

В config/routes.rb вы определяете сопоставления URL-адресов с контроллерами, но обратное также возможно: URL-адрес можно сгенерировать по одному из ваших маршрутных определений. Функциональность генерации URL-адресов централизована в этом модуле.

См. ActionDispatch::Routing для общей информации о маршрутизации и файле routes.rb.

Подсказка: Если вам нужно генерировать URL-адреса из ваших моделей или из другого места, то ActionController::UrlFor — это то, что вам нужно. Читайте далее для введения. В общем случае, этот модуль не следует включать самостоятельно, так как он обычно включается url_helpers (как в Rails.application.routes.url_helpers).

Генерация URL-адресов из параметров

Как вы знаете, некоторые функции, такие как ActionController::Base#url_for и ActionView::Helpers::UrlHelper#link_to, могут генерировать URL-адреса, используя набор параметров. Например, вы, вероятно, имели возможность написать код подобный этому в одном из ваших представлений:

<%= link_to('Click here', controller: 'users',
        action: 'new', message: 'Welcome!') %>
# => <a href="/users/new?message=Welcome%21">Click here</a>

link_to и все другие функции, которые требуют функциональности генерации URL-адресов, фактически используют ActionController::UrlFor под капотом. И, в частности, они используют метод ActionController::UrlFor#url_for. Можно сгенерировать тот же путь, что и в приведённом выше примере, используя следующий код:

include UrlFor
url_for(controller: 'users',
        action: 'new',
        message: 'Welcome!',
        only_path: true)
# => "/users/new?message=Welcome%21"

Обратите внимание на only_path: true часть. Это потому, что UrlFor не имеет информации о хост-имени сайта, на котором обслуживается ваше приложение Rails. Поэтому, если вы хотите включить хост-имя, то необходимо также передать :host аргумент:

include UrlFor
url_for(controller: 'users',
        action: 'new',
        message: 'Welcome!',
        host: 'www.example.com')
# => "http://www.example.com/users/new?message=Welcome%21"

По умолчанию все контроллеры и представления имеют доступ к специальной версии #url_for, которая уже знает текущее хост-имя. Поэтому, если вы используете #url_for в своих контроллерах или представлениях, то вам не нужно явно передавать :host аргумент.

Для удобства почтовые сообщения предоставляют сокращение для ActionController::UrlFor#url_for. Таким образом, в почтовых сообщениях вам нужно только написать url_for вместо 'ActionController::UrlFor#url_for' в полном виде. Однако почтовые сообщения не имеют информации о хост-имени, и вам все равно нужно предоставить :host аргумент или установить значение по умолчанию для хоста, которое будет использоваться во всех почтовых сообщениях, используя опцию конфигурации config.action_mailer.default_url_options. Для получения дополнительной информации о #url_for в почтовых сообщениях, ознакомьтесь с документацией ActionMailer#Base.

Генерация URL-адресов для именованных маршрутов

UrlFor также позволяет получить доступ к методам, которые были автоматически сгенерированы из именованных маршрутов. Например, предположим, что у вас есть ресурс 'users' в вашем config/routes.rb:

resources :users

Это генерирует, среди прочего, метод users_path. По умолчанию этот метод доступен из ваших контроллеров, представлений и почтовых сообщений. Если вам нужно получить доступ к этому автоматически сгенерированному методу из других мест (например, из модели), вы можете сделать это, включив Rails.application.routes.url_helpers в свой класс:

class User < ActiveRecord::Base
  include Rails.application.routes.url_helpers

  def base_uri
    user_path(self)
  end
end

User.find(1).base_uri # => "/users/1"