модуль 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 также позволяет получить доступ к методам, которые были сгенерированы автоматически из именованных маршрутов. Например, предположим, что у вас есть ресурс «пользователи» в вашей 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"