модуль ActionDispatch::Routing::Mapper::CustomUrls

# File actionpack/lib/action_dispatch/routing/mapper.rb, line 2148
def direct(name, options = {}, &block)
  unless @scope.root?
    raise RuntimeError, "The direct method can't be used inside a routes scope block"
  end

  @set.add_url_helper(name, options, &block)
end

Определите пользовательские помощники URL, которые будут добавлены к маршрутам приложения. Это позволяет переопределять и/или заменять стандартное поведение помощников маршрутизации, например:

direct :homepage do
  "https://rubyonrails.org"
end

direct :commentable do |model|
  [ model, anchor: model.dom_id ]
end

direct :main do
  { controller: "pages", action: "index", subdomain: "www" }
end

Значение, возвращаемое блоком, переданным direct, должно быть допустимым набором аргументов для url_for, который фактически создаст строку URL. Это может быть одно из следующего:

• Строка, которая обрабатывается как сгенерированный URL

• Хэш, например { controller: "pages", action: "index" }

• Массив, который передаётся polymorphic_url

• Экземпляр Active Model

• Класс Active Model

ПРИМЕЧАНИЕ: В блоке могут вызываться другие помощники URL, но будьте внимательны, чтобы не вызывать свой пользовательский помощник URL повторно, иначе это приведёт к ошибке переполнения стека.

Вы также можете указать значения по умолчанию, которые будут переданы в определение вашего помощника URL, например:

direct :browse, page: 1, size: 10 do |options|
  [ :products, options.merge(params.permit(:page, :size).to_h.symbolize_keys) ]
end

В этом случае объект params поступает из контекста, в котором выполняется блок, например, при генерации URL внутри действия контроллера или представления. Если блок выполняется там, где нет объекта params, например так:

Rails.application.routes.url_helpers.browse_path

то это вызовет NameError. Поэтому необходимо учитывать контекст, в котором вы будете использовать свой пользовательский помощник URL при его определении.

ПРИМЕЧАНИЕ: Метод direct нельзя использовать внутри блока области видимости, например namespace или scope, и он вызовет ошибку, если обнаружит, что он находится внутри.

# File actionpack/lib/action_dispatch/routing/mapper.rb, line 2200
def resolve(*args, &block)
  unless @scope.root?
    raise RuntimeError, "The resolve method can't be used inside a routes scope block"
  end

  options = args.extract_options!
  args = args.flatten(1)

  args.each do |klass|
    @set.add_polymorphic_mapping(klass, options, &block)
  end
end

Определите пользовательские полиморфные отображения моделей на URL. Это изменяет поведение polymorphic_url и, следовательно, поведение link_to и form_for при передаче экземпляра модели, например:

resource :basket

resolve "Basket" do
  [:basket]
end

Теперь это сгенерирует “/basket”, когда экземпляр Basket передается в link_to или form_for, вместо стандартного “/baskets/:id”.

ПРИМЕЧАНИЕ: Это пользовательское поведение применяется только к простым полиморфным URL, где передается один экземпляр модели, а не к более сложным формам, например:

# config/routes.rb
resource :profile
namespace :admin do
  resources :users
end

resolve("User") { [:profile] }

# app/views/application/_menu.html.erb
link_to "Profile", @current_user
link_to "Profile", [:admin, @current_user]

Первый link_to сгенерирует “/profile”, но второй сгенерирует стандартный полиморфный URL “/admin/users/1”.

Вы можете передать параметры в полиморфное отображение — арность для блока должна быть две, так как экземпляр передается в качестве первого аргумента, например:

resolve "Basket", anchor: "items" do |basket, options|
  [:basket, options]
end

Это генерирует URL “/basket#items”, потому что, когда последний элемент в массиве, переданном в polymorphic_url, является хэшем, он обрабатывается как параметры к помощнику URL, который вызывается.

ПРИМЕЧАНИЕ: Метод resolve нельзя использовать внутри блока области видимости, например namespace или scope, и он вызовет ошибку, если обнаружит, что он находится внутри.