модуль ActiveRecord::Scoping::Default::ClassMethods
Публичные методы экземпляра
# File activerecord/lib/active_record/scoping/default.rb, line 58
def default_scopes?(all_queries: false)
if all_queries
self.default_scopes.any?(&:all_queries)
else
self.default_scopes.any?
end
end Проверяет, имеет ли модель какие-либо стандартные области действия. Если all_queries установлено в true, метод проверит, существуют ли какие-либо стандартные области действия для модели, где all_queries равно true.
# File activerecord/lib/active_record/scoping/default.rb, line 42 def unscoped(&block) block_given? ? relation.scoping(&block) : relation end
Возвращает область действия для модели без ранее установленных областей действия.
class Post < ActiveRecord::Base
def self.default_scope
where(published: true)
end
end
Post.all # Fires "SELECT * FROM posts WHERE published = true"
Post.unscoped.all # Fires "SELECT * FROM posts"
Post.where(published: false).unscoped.all # Fires "SELECT * FROM posts"
Этот метод также принимает блок. Все запросы внутри блока не будут использовать ранее установленные области действия.
Post.unscoped {
Post.limit(10) # Fires "SELECT * FROM posts LIMIT 10"
}
Приватные методы экземпляра
# File activerecord/lib/active_record/scoping/default.rb, line 123
def default_scope(scope = nil, all_queries: nil, &block) # :doc:
scope = block if block_given?
if scope.is_a?(Relation) || !scope.respond_to?(:call)
raise ArgumentError,
"Support for calling #default_scope without a block is removed. For example instead " \
"of `default_scope where(color: 'red')`, please use " \
"`default_scope { where(color: 'red') }`. (Alternatively you can just redefine " \
"self.default_scope.)"
end
default_scope = DefaultScope.new(scope, all_queries)
self.default_scopes += [default_scope]
end Используйте эту макрокоманду в вашей модели, чтобы установить стандартную область действия для всех операций с моделью.
class Article < ActiveRecord::Base
default_scope { where(published: true) }
end
Article.all # => SELECT * FROM articles WHERE published = true
Также применяется default_scope при создании/создании записи. Он не применяется при обновлении или удалении записи.
Article.new.published # => true Article.create.published # => true
Чтобы применить default_scope при обновлении или удалении записи, добавьте all_queries: true:
class Article < ActiveRecord::Base
default_scope { where(blog_id: 1) }, all_queries: true
end Применение стандартной области действия ко всем запросам гарантирует, что записи всегда будут запрошены с дополнительными условиями. Обратите внимание, что применяются только условия WHERE, так как не имеет смысла добавлять порядок сортировки к запросам, которые возвращают единственный объект по первичному ключу.
Article.find(1).destroy => DELETE ... FROM `articles` where ID = 1 AND blog_id = 1;
(Вы также можете передать любой объект, который отвечает на call, макрокоманде default_scope, и он будет вызван при построении стандартной области действия.)
Если вы используете несколько default_scope объявлений в вашей модели, они будут объединены:
class Article < ActiveRecord::Base
default_scope { where(published: true) }
default_scope { where(rating: 'G') }
end
Article.all # => SELECT * FROM articles WHERE published = true AND rating = 'G'
Это также относится к наследованию и включению модулей, где родитель или модуль определяет default_scope, а дочерний или включающий класс определяет второе.
Если вам нужно выполнить более сложные действия со стандартной областью действия, вы можете альтернативно определить её как метод класса:
class Article < ActiveRecord::Base
def self.default_scope
# Should return a scope, you can call 'super' here etc.
end
end
© 2004–2021 David Heinemeier Hansson
Licensed under the MIT License.