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

# File actionpack/lib/action_dispatch/routing/mapper.rb, line 607
def has_named_route?(name)
  @set.named_routes.routes[name.to_sym]
end

Определяет, был ли уже определён именованный маршрут.

# File actionpack/lib/action_dispatch/routing/mapper.rb, line 546
def match(path, options=nil)
end

Сопоставляет шаблон URL с одним или несколькими маршрутами.

Не следует использовать метод match в своём маршрутизаторе без указания HTTP-метода.

Если нужно экспонировать действие и для GET, и для POST, используйте:

# sets :controller, :action and :id in params
match ':controller/:action/:id', via: [:get, :post]

Обратите внимание, что :controller, :action и :id интерпретируются как параметры запроса URL и, таким образом, доступны через params в действии.

Если нужно экспонировать действие только для GET, используйте get в маршрутизаторе:

Вместо:

match ":controller/:action/:id"

Используйте:

get ":controller/:action/:id"

Два из этих символов являются специальными: :controller сопоставляется с контроллером, а :action — с действием контроллера. Шаблон также может сопоставлять символы подстановки (глобы) с параметрами:

get 'songs/*category/:title', to: 'songs#show'

# 'songs/rock/classic/stairway-to-heaven' sets
#  params[:category] = 'rock/classic'
#  params[:title] = 'stairway-to-heaven'

Для сопоставления параметра с символом подстановки ему необходимо назначить имя. Без имени переменной для прикрепления параметра с символом подстановки маршрут не может быть проанализирован.

Когда шаблон ссылается на внутренний маршрут, :action и :controller маршрута должны быть заданы в параметрах или в сокращённом виде. Примеры:

match 'photos/:id' => 'photos#show', via: :get
match 'photos/:id', to: 'photos#show', via: :get
match 'photos/:id', controller: 'photos', action: 'show', via: :get

Шаблон также может указывать на конечную точку Rack, то есть на всё, что отвечает на call:

match 'photos/:id', to: lambda {|hash| [200, {}, ["Coming soon"]] }, via: :get
match 'photos/:id', to: PhotoRackApp, via: :get
# Yes, controller actions are just rack endpoints
match 'photos/:id', to: PhotosController.action(:show), via: :get

Поскольку запросы разных HTTP-версий с одним действием могут иметь последствия для безопасности, необходимо либо указать действия в параметрах via, либо использовать один из HttpHelpers вместо match

Параметры

Любые параметры, не указанные здесь, передаются как параметры с URL.

:controller

Контроллер маршрута.

:action

Действие маршрута.

:param

Переопределяет идентификатор ресурса по умолчанию :id (имя динамического сегмента, используемого для генерации маршрутов). Вы можете получить доступ к этому сегменту в контроллере с помощью params[<:param>].

:path

Префикс пути для маршрутов.

:module

Пространство имён для :controller.

match 'path', to: 'c#a', module: 'sekret', controller: 'posts', via: :get
# => Sekret::PostsController

См. Scoping#namespace для эквивалента области.

:as

Имя, используемое для генерации помощников маршрутизации.

:via

Разрешённые HTTP-верба для маршрута.

match 'path', to: 'c#a', via: :get
match 'path', to: 'c#a', via: [:get, :post]
match 'path', to: 'c#a', via: :all

:to

Указывает на конечную точку Rack. Может быть объектом, отвечающим на call, или строкой, представляющей действие контроллера.

match 'path', to: 'controller#action', via: :get
match 'path', to: lambda { |env| [200, {}, ["Success!"]] }, via: :get
match 'path', to: RackApp, via: :get

:on

Сокращение для обертывания маршрутов в определённом контексте REST. Допустимые значения: :member, :collection, и :new. Используйте только в блоке resource(s). Например:

resource :bar do
  match 'foo', to: 'c#a', on: :member, via: [:get, :post]
end

Эквивалентно:

resource :bar do
  member do
    match 'foo', to: 'c#a', via: [:get, :post]
  end
end

:constraints

Ограничивает параметры с помощью хэша регулярных выражений или объекта, который отвечает на matches?. Кроме того, ограничения, отличные от пути, также можно указать с помощью любого объекта, который отвечает на === (например, Строка, Массив, Диапазон и т. д.).

match 'path/:id', constraints: { id: /[A-Z]\d{5}/ }, via: :get

match 'json_only', constraints: { format: 'json' }, via: :get

class Whitelist
  def matches?(request) request.remote_ip == '1.2.3.4' end
end
match 'path', to: 'c#a', constraints: Whitelist.new, via: :get

См. Scoping#constraints для получения дополнительных примеров с эквивалентом области.

:defaults

Задает значения параметров по умолчанию

# Sets params[:format] to 'jpg' by default
match 'path', to: 'c#a', defaults: { format: 'jpg' }, via: :get

См. Scoping#defaults для эквивалента области.

:anchor

Логическое значение для привязки шаблона match. По умолчанию true. Если установлено в false, шаблон сопоставляется с любым запросом, начинающимся с заданного пути.

# Matches any request starting with 'path'
match 'path', to: 'c#a', anchor: false, via: :get

:format

Позволяет указать значение по умолчанию для необязательного сегмента format или отключить его, указав false.

# File actionpack/lib/action_dispatch/routing/mapper.rb, line 568
def mount(app, options = nil)
  if options
    path = options.delete(:at)
  else
    unless Hash === app
      raise ArgumentError, "must be called with mount point"
    end

    options = app
    app, path = options.find { |k, _| k.respond_to?(:call) }
    options.delete(app) if app
  end

  raise "A rack application must be specified" unless path

  rails_app = rails_app? app
  options[:as] ||= app_name(app, rails_app)

  target_as       = name_for_action(options[:as], path)
  options[:via] ||= :all

  match(path, options.merge(:to => app, :anchor => false, :format => false))

  define_generate_prefix(app, target_as) if rails_app
  self
end

Подключает приложение на основе Rack для использования в приложении.

mount SomeRackApp, at: "some_route"

В качестве альтернативы:

mount(SomeRackApp => "some_route")

Для параметров см. match, так как mount использует их во внутренней работе.

Все подключенные приложения поставляются с помощниками маршрутизации для доступа к ним. Их имена основаны на указанном классе, поэтому для вышеприведённого примера помощник называется либо some_rack_app_path или some_rack_app_url. Чтобы настроить имя этого помощника, используйте параметр :as:

mount(SomeRackApp => "some_route", as: "exciting")

Это сгенерирует помощников exciting_path и exciting_url, которые можно использовать для перехода к этому подключённому приложению.

# File actionpack/lib/action_dispatch/routing/mapper.rb, line 387
def root(options = {})
  match '/', { :as => :root, :via => :get }.merge!(options)
end

С помощью метода root можно указать, к чему должно перенаправлять Rails “/”:

root to: 'pages#main'

Для параметров см. match, так как root использует их во внутренней работе.

Можно также передать строку, которая будет расширена

root 'pages#main'

Маршрут root следует помещать в начало config/routes.rb, так как это означает, что он будет сопоставлен в первую очередь. Поскольку это самый популярный маршрут для большинства приложений Rails, это полезно.