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

# File actionpack/lib/action_dispatch/routing/mapper.rb, line 1520
def collection
  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) do
      yield
    end
  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 1633
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 /#/.match?(to)
        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 1543
def member
  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) { yield }
      }
    else
      path_scope(parent_resource.member_scope) { yield }
    end
  end
end

Чтобы добавить маршрут member, добавьте блок member в блок resource:

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 1592
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 1312
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

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

resource :profile

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

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

Параметры

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

# File actionpack/lib/action_dispatch/routing/mapper.rb, line 1478
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" }

Приведённый выше пример теперь изменит /posts/new на /posts/brand_new.

:path

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

resources :posts, path: 'postings'

Ресурс и все сегменты теперь будут перенаправляться на /postings вместо /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

Это то же самое, что:

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

Это позволяет сократить URL-адреса для ресурсов, которые в противном случае были бы глубоко вложены, например, комментарий к статье блога, такой как /posts/a-long-permalink/comments/1234, до /comments/1234.

Установите shallow: false на дочернем ресурсе, чтобы проигнорировать параметр shallow родительского ресурса.

:shallow_path

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

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

Для ресурса comments будут сгенерированы следующие маршруты:

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

Для ресурса comments будут сгенерированы следующие маршруты:

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 <tt>Admin::PostsController</tt>
resources :posts, module: "admin"

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

# File actionpack/lib/action_dispatch/routing/mapper.rb, line 1680
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, это полезно.