модуль 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

Для применения стандартной области при обновлении или удалении записи добавьте 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