модуль ActiveRecord::Scoping::Default::ClassMethods
Открытые методы экземпляра
# File activerecord/lib/active_record/scoping/default.rb, line 62
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 50 def unscoped(&block) block_given? ? relation.scoping(&block) : relation end
Возвращает область видимости модели без ранее заданных областей видимости.
class Post < ActiveRecord::Base
belongs_to :user
def self.default_scope
where(published: true)
end
end
class User < ActiveRecord::Base
has_many :posts
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"
User.find(1).posts # Fires "SELECT * FROM posts WHERE published = true AND posts.user_id = 1"
User.find(1).posts.unscoped # Fires "SELECT * FROM posts"
Этот метод также принимает блок. Все запросы внутри блока не будут использовать ранее заданные области видимости.
Post.unscoped {
Post.limit(10) # Fires "SELECT * FROM posts LIMIT 10"
}
Закрытые методы экземпляра
# File activerecord/lib/active_record/scoping/default.rb, line 129
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;
(Вы также можете передать в макрос default_scope любой объект, который отвечает на call, и он будет вызван при построении области видимости по умолчанию.)
Если в модели объявлено несколько областей видимости 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.