модуль ActionDispatch::Routing::Mapper::Resources
Маршрутизация ресурсов позволяет быстро объявлять все общие маршруты для заданного контроллера ресурсов. Вместо объявления отдельных маршрутов для ваших index, show, new, edit, create, update и destroy действий, маршрут ресурса объявляет их в одной строке кода:
Иногда у вас есть ресурс, который клиенты всегда ищут без указания идентификатора. Типичный пример, /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_METHOD_SCOPES
- RESOURCE_OPTIONS
- RESOURCE_SCOPES
- VALID_ON_OPTIONS
-
CANONICAL_ACTIONS содержит все действия, которым не нужен префикс или путь, добавленный, так как они подходят на уровне своего охвата.
Публичные методы экземпляра
Чтобы добавить маршрут в коллекцию:
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 1336
def collection
unless resource_scope?
raise ArgumentError, "can't use collection outside resource(s) scope"
end
with_scope_level(:collection) do
scope(parent_resource.collection_scope) do
yield
end
end
end match 'path' => 'controller#action' match 'path', to: 'controller#action' match 'path', 'otherpath', on: :member, via: :get
# File actionpack/lib/action_dispatch/routing/mapper.rb, line 1421
def match(path, *rest)
if rest.empty? && Hash === path
options = path
path, to = options.find { |name, _value| name.is_a?(String) }
options[:to] = to
options.delete(path)
paths = [path]
else
options = rest.pop || {}
paths = [path] + rest
end
options[:anchor] = true unless options.key?(:anchor)
if options[:on] && !VALID_ON_OPTIONS.include?(options[:on])
raise ArgumentError, "Unknown scope #{on.inspect} given to :on"
end
if @scope[:controller] && @scope[:action]
options[:to] ||= "#{@scope[:controller]}##{@scope[:action]}"
end
paths.each do |_path|
route_options = options.dup
route_options[:path] ||= _path if _path.is_a?(String)
path_without_format = _path.to_s.sub(/\(\.:format\)$/, '')
if using_match_shorthand?(path_without_format, route_options)
route_options[:to] ||= path_without_format.gsub(%r{^/}, "").sub(%r{/([^/]*)$}, '#\1')
route_options[:to].tr!("-", "_")
end
decomposed_match(_path, route_options)
end
self
end Чтобы добавить маршрут члена, добавьте блок 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 1359
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(parent_resource.member_scope) { yield }
else
scope(parent_resource.member_scope) { yield }
end
end
end См. ActionDispatch::Routing::Mapper::Scoping#namespace
# File actionpack/lib/action_dispatch/routing/mapper.rb, line 1400
def namespace(path, options = {})
if resource_scope?
nested { super }
else
super
end
end # File actionpack/lib/action_dispatch/routing/mapper.rb, line 1385
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(parent_resource.nested_scope, nested_options) { yield }
else
scope(parent_resource.nested_scope, nested_options) { yield }
end
end
end # File actionpack/lib/action_dispatch/routing/mapper.rb, line 1373
def new
unless resource_scope?
raise ArgumentError, "can't use new outside resource(s) scope"
end
with_scope_level(:new) do
scope(parent_resource.new_scope(action_path(:new))) do
yield
end
end
end Иногда у вас есть ресурс, который клиенты всегда ищут без ссылки на идентификатор. Частый пример — /profile всегда отображает профиль текущего пользователя. В этом случае вы можете использовать единственный ресурс для сопоставления /profile (а не /profile/:id) с действием show:
resource :profile
создаёт шесть различных маршрутов в вашем приложении, все сопоставленные с контроллером Profiles (обратите внимание, что контроллер назван в соответствии с множественным числом):
GET /profile/new POST /profile GET /profile GET /profile/edit PATCH/PUT /profile DELETE /profile
Параметры
Принимает те же параметры, что и resources.
# File actionpack/lib/action_dispatch/routing/mapper.rb, line 1139
def resource(*resources, &block)
options = resources.extract_options!.dup
if apply_common_behavior_for(:resource, resources, options, &block)
return self
end
resource_scope(:resource, SingletonResource.new(resources.pop, options)) do
yield if block_given?
concerns(options[:concerns]) if options[:concerns]
collection do
post :create
end if parent_resource.actions.include?(:create)
new do
get :new
end if parent_resource.actions.include?(:new)
set_member_mappings_for_resource
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"
# File actionpack/lib/action_dispatch/routing/mapper.rb, line 1297
def resources(*resources, &block)
options = resources.extract_options!.dup
if apply_common_behavior_for(:resources, resources, options, &block)
return self
end
resource_scope(:resources, Resource.new(resources.pop, 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
self
end # File actionpack/lib/action_dispatch/routing/mapper.rb, line 1114 def resources_path_names(options) @scope[:path_names].merge!(options) end
# File actionpack/lib/action_dispatch/routing/mapper.rb, line 1498
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[:scope_level] == :resources
with_scope_level(:root) do
scope(parent_resource.path) do
super(options)
end
end
else
super(options)
end
end # File actionpack/lib/action_dispatch/routing/mapper.rb, line 1408
def shallow
scope(:shallow => true) do
yield
end
end # File actionpack/lib/action_dispatch/routing/mapper.rb, line 1414 def shallow? parent_resource.instance_of?(Resource) && @scope[:shallow] end
# File actionpack/lib/action_dispatch/routing/mapper.rb, line 1458
def using_match_shorthand?(path, options)
path && (options[:to] || options[:action]).nil? && path =~ %r{/[\w/]+$}
end Защищённые методы экземпляра
# File actionpack/lib/action_dispatch/routing/mapper.rb, line 1717
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 # File actionpack/lib/action_dispatch/routing/mapper.rb, line 1585
def with_exclusive_scope
begin
old_name_prefix, old_path = @scope[:as], @scope[:path]
@scope[:as], @scope[:path] = nil, nil
with_scope_level(:exclusive) do
yield
end
ensure
@scope[:as], @scope[:path] = old_name_prefix, old_path
end
end # File actionpack/lib/action_dispatch/routing/mapper.rb, line 1598 def with_scope_level(kind) old, @scope[:scope_level] = @scope[:scope_level], kind yield ensure @scope[:scope_level] = old end
© 2004–2016 David Heinemeier Hansson
Licensed under the MIT License.