модуль ActionDispatch::Routing

Модуль маршрутизации предоставляет перенаправление URL в чистом Ruby. Это способ перенаправить входящие запросы на контроллеры и действия. Он заменяет правила mod_rewrite. Лучше всего, маршрутизация Rails работает с любым веб-сервером. Маршруты определяются в config/routes.rb.

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

Rails.application.routes.draw do
  Pattern 1 tells some request to go to one place
  Pattern 2 tell them to go to another
  ...
end

Следующие символы являются специальными:

:controller maps to your controller name
:action     maps to an action with your controllers

Другие имена просто отображаются на параметр, как в случае с :id.

Ресурсы

Маршрутизация ресурсов позволяет быстро объявлять все общие маршруты для данного контроллера ресурсов. Вместо объявления отдельных маршрутов для ваших index, show, new, edit, create, update и destroy действий, маршрут ресурсов объявляет их в одной строке кода:

resources :photos

Иногда у вас есть ресурс, который клиенты всегда ищут без указания идентификатора. Частый пример: /profile всегда отображает профиль текущего вошедшего пользователя. В этом случае вы можете использовать единственный ресурс для сопоставления /profile (вместо /profile/:id) с действием show.

resource :profile

Часто встречаются ресурсы, которые логически являются дочерними ресурсами других ресурсов:

resources :magazines do
  resources :ads
end

Вы можете захотеть организовать группы контроллеров в пространстве имен. Чаще всего, вы можете сгруппировать несколько административных контроллеров в пространстве имен admin. Эти контроллеры вы разместите в каталоге app/controllers/admin, и вы можете сгруппировать их вместе в вашем маршрутизаторе:

namespace "admin" do
  resources :posts, :comments
end

В качестве альтернативы вы можете добавлять префиксы к вашему пути без использования отдельного каталога, используя scope. scope принимает дополнительные параметры, которые применяются ко всем включенным маршрутам.

scope path: "/cpanel", as: 'admin' do
  resources :posts, :comments
end

Для более подробной информации см. Routing::Mapper::Resources#resources, Routing::Mapper::Scoping#namespace, и Routing::Mapper::Scoping#scope.

Маршруты, не являющиеся ресурсами

Для маршрутов, которые не подходят под шаблон resources, вы можете использовать вспомогательные методы HTTP get, post, patch, put и delete.

get 'post/:id' => 'posts#show'
post 'post/:id' => 'posts#create_comment'

Теперь, если вы POST на /posts/:id, он будет перенаправлен на действие create_comment. GET на тот же URL будет перенаправлен на действие show.

Если ваш маршрут должен реагировать на более чем один HTTP-метод (или на все методы), то использование опции :via в match предпочтительнее.

match 'post/:id' => 'posts#show', via: [:get, :post]

Именованные маршруты

Маршруты могут быть именованы, передав опцию :as, что позволяет легко ссылаться в вашем коде как на name_of_route_url для полного URL и name_of_route_path для пути URI.

Пример:

# In config/routes.rb
get '/login' => 'accounts#login', as: 'login'

# With render, redirect_to, tests, etc.
redirect_to login_url

Аргументы также могут быть переданы.

redirect_to show_item_path(id: 25)

Используйте root в качестве сокращения для именования маршрута для корневого пути “/”.

# In config/routes.rb
root to: 'blogs#index'

# would recognize http://www.example.com/ as
params = { controller: 'blogs', action: 'index' }

# and provide these named routes
root_url   # => 'http://www.example.com/'
root_path  # => '/'

Примечание: при использовании controller, маршрут просто получает имя по методу, который вы вызываете на параметре блока, а не на карте.

# In config/routes.rb
controller :blog do
  get 'blog/show'     => :list
  get 'blog/delete'   => :delete
  get 'blog/edit'     => :edit
end

# provides named routes for show, delete, and edit
link_to @article.title, blog_show_path(id: @article.id)

Красивые URL

Маршруты могут генерировать красивые URL. Например:

get '/articles/:year/:month/:day' => 'articles#find_by_id', constraints: {
  year:       /\d{4}/,
  month:      /\d{1,2}/,
  day:        /\d{1,2}/
}

Используя маршрут выше, URL “localhost:3000/articles/2005/11/06” отображается на

params = {year: '2005', month: '11', day: '06'}

Регулярные выражения и параметры

Вы можете указать регулярное выражение для определения формата параметра.

controller 'geocode' do
  get 'geocode/:postalcode' => :show, constraints: {
    postalcode: /\d{5}(-\d{4})?/
  }
end

Ограничения могут включать модификаторы регулярного выражения 'ignorecase' и 'extended syntax':

controller 'geocode' do
  get 'geocode/:postalcode' => :show, constraints: {
    postalcode: /hx\d\d\s\d[a-z]{2}/i
  }
end

controller 'geocode' do
  get 'geocode/:postalcode' => :show, constraints: {
    postalcode: /# Postalcode format
       \d{5} #Prefix
       (-\d{4})? #Suffix
       /x
  }
end

Использование модификатора multiline вызовет ArgumentError. Модификаторы кодирования регулярных выражений игнорируются. Сопоставление всегда будет использовать кодировку по умолчанию или ASCII.

Внешние перенаправления

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

get "/stories" => redirect("/posts")

Маршруты с символами Юникод

Вы можете указать маршруты с символами Юникод в вашем маршрутизаторе:

get "こんにちは" => "welcome#index"

Маршрутизация к Rack-приложениям

Вместо строки, например posts#index, которая соответствует действию index в PostsController, вы можете указать любое Rack-приложение в качестве конечной точки для сопоставления:

get "/application.js" => Sprockets

Перезагрузка маршрутов

Вы можете перезагрузить маршруты, если это необходимо:

Rails.application.reload_routes!

Это очистит все именованные маршруты и перезагрузит config/routes.rb, если файл был изменен с момента последней загрузки. Чтобы абсолютно принудительно перезагрузить, используйте reload!.

Тестирование маршрутов

Два основных метода для тестирования ваших маршрутов:

assert_routing

def test_movie_route_properly_splits
 opts = {controller: "plugin", action: "checkout", id: "2"}
 assert_routing "plugin/checkout/2", opts
end

assert_routing позволяет проверить, правильно ли маршрут резолвится в опции.

assert_recognizes

def test_route_has_options
 opts = {controller: "plugin", action: "show", id: "12"}
 assert_recognizes opts, "/plugins/show/12"
end

Обратите внимание на тонкое различие между ними: assert_routing проверяет, соответствует ли URL опциям, а assert_recognizes проверяет, правильно ли URL разбивается на параметры.

В тестах вы можете просто передать URL или именованный маршрут в get или post.

def send_to_jail
  get '/jail'
  assert_response :success
end

def goes_to_login
  get login_url
  #...
end

Просмотр списка всех ваших маршрутов

rails routes

Для выбора конкретных контроллеров добавьте префикс к команде с опцией -c.