Spec-Zone.ru › Ruby on Rails 5.0

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

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

%%%NON_TRANSLABLE_7%%%

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

resource :profile

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

resources :magazines do
  resources :ads
end

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

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

По умолчанию параметр :id не принимает точки. Если вам нужно использовать точки как часть параметра :id, добавьте ограничение, которое переопределяет это ограничение, например:

resources :articles, id: /[^\/]+/

Это позволяет использовать любой символ, кроме слэша, в вашем параметре :id.

Константы

CANONICAL_ACTIONS
RESOURCE_OPTIONS
VALID_ON_OPTIONS

CANONICAL_ACTIONS содержит все действия, которым не нужен префикс или путь, так как они подходят для своего уровня области видимости.

Публичные методы экземпляров

collection() { || ... } Показать исходный код
# File actionpack/lib/action_dispatch/routing/mapper.rb, line 1469
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.

get_to_from_path(path, to, action) Показать исходный код
# File actionpack/lib/action_dispatch/routing/mapper.rb, line 1604
def get_to_from_path(path, to, action)
  return to if to || action

  path_without_format = path.sub(/\(\.:format\)$/, '')
  if using_match_shorthand?(path_without_format)
    path_without_format.gsub(%r{^/}, "").sub(%r{/([^/]*)$}, '#\1').tr("-", "_")
  else
    nil
  end
end
match(path, *rest, &block) Показать исходный код
# File actionpack/lib/action_dispatch/routing/mapper.rb, line 1566
def match(path, *rest, &block)
  if rest.empty? && Hash === path
    options  = path
    path, to = options.find { |name, _value| name.is_a?(String) }

    if path.nil?
      ActiveSupport::Deprecation.warn 'Omitting the route path is deprecated. '                 'Specify the path with a String or a Symbol instead.'
      path = ''
    end

    case to
    when Symbol
      options[:action] = to
    when String
      if 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
member() { || ... } Показать исходный код
# File actionpack/lib/action_dispatch/routing/mapper.rb, line 1492
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.

namespace(path, options = {}) Показать исходный код
# File actionpack/lib/action_dispatch/routing/mapper.rb, line 1541
def namespace(path, options = {})
  if resource_scope?
    nested { super }
  else
    super
  end
end

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

Вызывает метод суперкласса
nested() { || ... } Показать исходный код
# File actionpack/lib/action_dispatch/routing/mapper.rb, line 1520
def nested
  unless resource_scope?
    raise ArgumentError, "can't use nested outside resource(s) scope"
  end

  with_scope_level(:nested) do
    if shallow? && shallow_nesting_depth >= 1
      shallow_scope do
        path_scope(parent_resource.nested_scope) do
          scope(nested_options) { yield }
        end
      end
    else
      path_scope(parent_resource.nested_scope) do
        scope(nested_options) { yield }
      end
    end
  end
end
new() { || ... } Показать исходный код
# File actionpack/lib/action_dispatch/routing/mapper.rb, line 1508
def new
  unless resource_scope?
    raise ArgumentError, "can't use new outside resource(s) scope"
  end

  with_scope_level(:new) do
    path_scope(parent_resource.new_scope(action_path(:new))) do
      yield
    end
  end
end
resource(*resources) { || ... } Показать исходный код
# File actionpack/lib/action_dispatch/routing/mapper.rb, line 1266
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.

resources(*resources) { || ... } Показать исходный код
# File actionpack/lib/action_dispatch/routing/mapper.rb, line 1427
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 :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

Параметры

Принимает те же параметры, что и Base#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_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.

Примеры

# routes call <tt>Admin::PostsController</tt>
resources :posts, module: "admin"

# resource actions are at /admin/posts.
resources :posts, path: "admin/posts"
resources_path_names(options) Показать исходный код
# File actionpack/lib/action_dispatch/routing/mapper.rb, line 1241
def resources_path_names(options)
  @scope[:path_names].merge!(options)
end
root(path, options = {}) Показать исходный код
# File actionpack/lib/action_dispatch/routing/mapper.rb, line 1674
def root(path, options = {})
  if path.is_a?(String)
    options[:to] = path
  elsif path.is_a?(Hash) and 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, это полезно.

shallow() { || ... } Показать исходный код
# File actionpack/lib/action_dispatch/routing/mapper.rb, line 1549
def shallow
  @scope = @scope.new(shallow: true)
  yield
ensure
  @scope = @scope.parent
end
shallow?() Показать исходный код
# File actionpack/lib/action_dispatch/routing/mapper.rb, line 1556
def shallow?
  !parent_resource.singleton? && @scope[:shallow]
end
using_match_shorthand?(path) Показать исходный код
# File actionpack/lib/action_dispatch/routing/mapper.rb, line 1615
def using_match_shorthand?(path)
  path =~ %r{^/?[-\w]+/[-\w/]+$}
end

Защищённые методы экземпляров

api_only?() Показать исходный код
# File actionpack/lib/action_dispatch/routing/mapper.rb, line 1874
def api_only?
  @set.api_only?
end
set_member_mappings_for_resource() Показать исходный код
# File actionpack/lib/action_dispatch/routing/mapper.rb, line 1862
def set_member_mappings_for_resource
  member do
    get :edit if parent_resource.actions.include?(:edit)
    get :show if parent_resource.actions.include?(:show)
    if parent_resource.actions.include?(:update)
      patch :update
      put   :update
    end
    delete :destroy if parent_resource.actions.include?(:destroy)
  end
end
with_scope_level(kind) { || ... } Показать исходный код
# File actionpack/lib/action_dispatch/routing/mapper.rb, line 1758
def with_scope_level(kind)
  @scope = @scope.new_level(kind)
  yield
ensure
  @scope = @scope.parent
end

© 2004–2018 David Heinemeier Hansson
Licensed under the MIT License.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API