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

# File actionpack/lib/action_dispatch/routing/mapper.rb, line 1547
def collection(&block)
  unless resource_scope?
    raise ArgumentError, "can't use collection outside resource(s) scope"
  end

  with_scope_level(:collection) do
    path_scope(parent_resource.collection_scope, &block)
  end
end

Чтобы добавить маршрут в коллекцию:

resources :photos do
  collection do
    get 'search'
  end
end

Это позволит Rails распознавать пути, такие как /photos/search с GET и перенаправлять их на действие поиска PhotosController. Также будут созданы вспомогательные методы маршрутов search_photos_url и search_photos_path.

# File actionpack/lib/action_dispatch/routing/mapper.rb, line 1656
def draw(name)
  path = @draw_paths.find do |_path|
    File.exist? "#{_path}/#{name}.rb"
  end

  unless path
    msg  = "Your router tried to #draw the external file #{name}.rb,\n" \
           "but the file was not found in:\n\n"
    msg += @draw_paths.map { |_path| " * #{_path}" }.join("\n")
    raise ArgumentError, msg
  end

  route_path = "#{path}/#{name}.rb"
  instance_eval(File.read(route_path), route_path.to_s)
end

Загружает другой файл маршрутов с заданным name, расположенным в каталоге config/routes. В этом файле вы можете использовать обычный DSL для маршрутизации, но не заключайте его в блок Rails.application.routes.draw.

# config/routes.rb
Rails.application.routes.draw do
  draw :admin                 # Loads `config/routes/admin.rb`
  draw "third_party/some_gem" # Loads `config/routes/third_party/some_gem.rb`
end

# config/routes/admin.rb
namespace :admin do
  resources :accounts
end

# config/routes/third_party/some_gem.rb
mount SomeGem::Engine, at: "/some_gem"

ВНИМАНИЕ: Используйте эту функцию с осторожностью. Наличие нескольких файлов маршрутов может негативно повлиять на обнаруживаемость и читаемость. Для большинства приложений, даже тех, которые содержат несколько сотен маршрутов, проще для разработчиков иметь один файл маршрутов.

# File actionpack/lib/action_dispatch/routing/mapper.rb, line 1678
def match(path, *rest, &block)
  if rest.empty? && Hash === path
    options  = path
    path, to = options.find { |name, _value| name.is_a?(String) }

    raise ArgumentError, "Route path not specified" if path.nil?

    case to
    when Symbol
      options[:action] = to
    when String
      if to.include?("#")
        options[:to] = to
      else
        options[:controller] = to
      end
    else
      options[:to] = to
    end

    options.delete(path)
    paths = [path]
  else
    options = rest.pop || {}
    paths = [path] + rest
  end

  if options.key?(:defaults)
    defaults(options.delete(:defaults)) { map_match(paths, options, &block) }
  else
    map_match(paths, options, &block)
  end
end

Сопоставляет шаблон URL с одним или несколькими маршрутами. Для получения дополнительной информации см. match.

match 'path' => 'controller#action', via: :patch
match 'path', to: 'controller#action', via: :post
match 'path', 'otherpath', on: :member, via: :get

# File actionpack/lib/action_dispatch/routing/mapper.rb, line 1568
def member(&block)
  unless resource_scope?
    raise ArgumentError, "can't use member outside resource(s) scope"
  end

  with_scope_level(:member) do
    if shallow?
      shallow_scope {
        path_scope(parent_resource.member_scope, &block)
      }
    else
      path_scope(parent_resource.member_scope, &block)
    end
  end
end

Чтобы добавить маршрут участника, добавьте блок участника в блок ресурса:

resources :photos do
  member do
    get 'preview'
  end
end

Это позволит распознать /photos/1/preview с GET и перенаправить его на действие preview PhotosController. Также будут созданы вспомогательные методы preview_photo_url и preview_photo_path.

# File actionpack/lib/action_dispatch/routing/mapper.rb, line 1615
def namespace(path, options = {})
  if resource_scope?
    nested { super }
  else
    super
  end
end

См. ActionDispatch::Routing::Mapper::Scoping#namespace.

# File actionpack/lib/action_dispatch/routing/mapper.rb, line 1336
def resource(*resources, &block)
  options = resources.extract_options!.dup

  if apply_common_behavior_for(:resource, resources, options, &block)
    return self
  end

  with_scope_level(:resource) do
    options = apply_action_options options
    resource_scope(SingletonResource.new(resources.pop, api_only?, @scope[:shallow], options)) do
      yield if block_given?

      concerns(options[:concerns]) if options[:concerns]

      new do
        get :new
      end if parent_resource.actions.include?(:new)

      set_member_mappings_for_resource

      collection do
        post :create
      end if parent_resource.actions.include?(:create)
    end
  end

  self
end

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

resource :profile

Это создаёт шесть разных маршрутов в вашем приложении, все они сопоставлены с контроллером Profiles (обратите внимание, что контроллер называется по имени множественного числа):

GET       /profile/new
GET       /profile
GET       /profile/edit
PATCH/PUT /profile
DELETE    /profile
POST      /profile

Если вы хотите работать с экземплярами модели с этим ресурсом с помощью идентификации записей (например, в form_with или redirect_to), вам необходимо вызвать resolve:

resource :profile
resolve('Profile') { [:profile] }

# Enables this to work with singular routes:
form_with(model: @profile) {}

Параметры

Принимает те же параметры, что и resources

# File actionpack/lib/action_dispatch/routing/mapper.rb, line 1506
def resources(*resources, &block)
  options = resources.extract_options!.dup

  if apply_common_behavior_for(:resources, resources, options, &block)
    return self
  end

  with_scope_level(:resources) do
    options = apply_action_options options
    resource_scope(Resource.new(resources.pop, api_only?, @scope[:shallow], options)) do
      yield if block_given?

      concerns(options[:concerns]) if options[:concerns]

      collection do
        get  :index if parent_resource.actions.include?(:index)
        post :create if parent_resource.actions.include?(:create)
      end

      new do
        get :new
      end if parent_resource.actions.include?(:new)

      set_member_mappings_for_resource
    end
  end

  self
end

В Rails, ресурсный маршрут обеспечивает сопоставление между HTTP-глаголами и URL-адресами и действиями контроллера. По соглашению, каждое действие также сопоставляется с определёнными операциями CRUD в базе данных. Одна запись в файле маршрутизации, например

resources :photos

создаёт семь разных маршрутов в вашем приложении, все они сопоставлены с контроллером Photos:

GET       /photos
GET       /photos/new
POST      /photos
GET       /photos/:id
GET       /photos/:id/edit
PATCH/PUT /photos/:id
DELETE    /photos/:id

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

resources :photos do
  resources :comments
end

Это генерирует следующие маршруты комментариев:

GET       /photos/:photo_id/comments
GET       /photos/:photo_id/comments/new
POST      /photos/:photo_id/comments
GET       /photos/:photo_id/comments/:id
GET       /photos/:photo_id/comments/:id/edit
PATCH/PUT /photos/:photo_id/comments/:id
DELETE    /photos/:photo_id/comments/:id

Параметры

Принимает те же параметры, что и match, а также:

:path_names

Позволяет изменить компонент сегмента действий edit и new. Действия, не указанные явно, не изменятся.

    resources :posts, path_names: { new: "brand_new" }

The above example will now change /posts/new to /posts/brand_new.

:path

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

    resources :posts, path: 'postings'

The resource and all segments will now route to /postings instead of
/posts.

:only

Генерировать маршруты только для указанных действий.

    resources :cows, only: :show
    resources :cows, only: [:show, :index]

:except

Генерировать все маршруты, кроме указанных действий.

    resources :cows, except: :show
    resources :cows, except: [:show, :index]

:shallow

Генерирует мелководные маршруты для вложенных ресурса(ов). При размещении на родительском ресурсе генерирует мелководные маршруты для всех вложенных ресурсов.

    resources :posts, shallow: true do
      resources :comments
    end

Is the same as:

    resources :posts do
      resources :comments, except: [:show, :edit, :update, :destroy]
    end
    resources :comments, only: [:show, :edit, :update, :destroy]

This allows URLs for resources that otherwise would be deeply nested such
as a comment on a blog post like `/posts/a-long-permalink/comments/1234`
to be shortened to just `/comments/1234`.

Set `shallow: false` on a child resource to ignore a parent's shallow
parameter.

:shallow_path

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

    scope shallow_path: "sekret" do
      resources :posts do
        resources :comments, shallow: true
      end
    end

The `comments` resource here will have the following routes generated for
it:

    post_comments    GET       /posts/:post_id/comments(.:format)
    post_comments    POST      /posts/:post_id/comments(.:format)
    new_post_comment GET       /posts/:post_id/comments/new(.:format)
    edit_comment     GET       /sekret/comments/:id/edit(.:format)
    comment          GET       /sekret/comments/:id(.:format)
    comment          PATCH/PUT /sekret/comments/:id(.:format)
    comment          DELETE    /sekret/comments/:id(.:format)

:shallow_prefix

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

    scope shallow_prefix: "sekret" do
      resources :posts do
        resources :comments, shallow: true
      end
    end

The `comments` resource here will have the following routes generated for
it:

    post_comments           GET       /posts/:post_id/comments(.:format)
    post_comments           POST      /posts/:post_id/comments(.:format)
    new_post_comment        GET       /posts/:post_id/comments/new(.:format)
    edit_sekret_comment     GET       /comments/:id/edit(.:format)
    sekret_comment          GET       /comments/:id(.:format)
    sekret_comment          PATCH/PUT /comments/:id(.:format)
    sekret_comment          DELETE    /comments/:id(.:format)

:format

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

:param

Позволяет переопределить имя параметра по умолчанию :id в URL.

Примеры

# routes call +Admin::PostsController+
resources :posts, module: "admin"

# resource actions are at /admin/posts.
resources :posts, path: "admin/posts"

# File actionpack/lib/action_dispatch/routing/mapper.rb, line 1725
def root(path, options = {})
  if path.is_a?(String)
    options[:to] = path
  elsif path.is_a?(Hash) && options.empty?
    options = path
  else
    raise ArgumentError, "must be called with a path and/or options"
  end

  if @scope.resources?
    with_scope_level(:root) do
      path_scope(parent_resource.path) do
        match_root_route(options)
      end
    end
  else
    match_root_route(options)
  end
end

Вы можете указать, на что Rails должен перенаправлять “/”, используя метод root:

root to: 'pages#main'

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

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

root 'pages#main'

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