модуль ActiveRecord::Scoping::Named::ClassMethods

# File activerecord/lib/active_record/scoping/named.rb, line 22
def all(all_queries: nil)
  scope = current_scope

  if scope
    if self == scope.klass
      scope.clone
    else
      relation.merge!(scope)
    end
  else
    default_scoped(all_queries: all_queries)
  end
end

Возвращает объект ActiveRecord::Relation области.

posts = Post.all
posts.size # Fires "select count(*) from  posts" and returns the count
posts.each {|p| puts p.name } # Fires "select * from posts" and loads post objects

fruits = Fruit.all
fruits = fruits.where(color: 'red') if options[:red_only]
fruits = fruits.limit(10) if limited?

Можно определить область, которая применяется ко всем поисковым запросам, используя default_scope.

# File activerecord/lib/active_record/scoping/named.rb, line 45
def default_scoped(scope = relation, all_queries: nil)
  build_default_scope(scope, all_queries: all_queries) || scope
end

Возвращает область для модели с областями по умолчанию.

# File activerecord/lib/active_record/scoping/named.rb, line 154
def scope(name, body, &block)
  unless body.respond_to?(:call)
    raise ArgumentError, "The scope body needs to be callable."
  end

  if dangerous_class_method?(name)
    raise ArgumentError, "You tried to define a scope named \"#{name}\" " \
      "on the model \"#{self.name}\", but Active Record already defined " \
      "a class method with the same name."
  end

  if method_defined_within?(name, Relation)
    raise ArgumentError, "You tried to define a scope named \"#{name}\" " \
      "on the model \"#{self.name}\", but ActiveRecord::Relation already defined " \
      "an instance method with the same name."
  end

  extension = Module.new(&block) if block

  if body.respond_to?(:to_proc)
    singleton_class.define_method(name) do |*args|
      scope = all._exec_scope(*args, &body)
      scope = scope.extending(extension) if extension
      scope
    end
  else
    singleton_class.define_method(name) do |*args|
      scope = body.call(*args) || all
      scope = scope.extending(extension) if extension
      scope
    end
  end
  singleton_class.send(:ruby2_keywords, name)

  generate_relation_method(name)
end

Добавляет метод класса для получения и запроса объектов. Метод предназначен для возврата объекта ActiveRecord::Relation, который можно комбинировать с другими областями. Если он возвращает nil или false, вместо этого возвращается область all.

Область представляет собой сужение запроса к базе данных, например, where(color: :red).select('shirts.*').includes(:washing_instructions).

class Shirt < ActiveRecord::Base
  scope :red, -> { where(color: 'red') }
  scope :dry_clean_only, -> { joins(:washing_instructions).where('washing_instructions.dry_clean_only = ?', true) }
end

Вышеупомянутые вызовы scope определяют методы класса Shirt.red и Shirt.dry_clean_only. Shirt.red, по сути, представляет запрос Shirt.where(color: 'red').

Обратите внимание, что это просто «синтаксический сахар» для определения фактического метода класса:

class Shirt < ActiveRecord::Base
  def self.red
    where(color: 'red')
  end
end

В отличие от Shirt.find(...), однако, объект, возвращаемый Shirt.red, не является Array, а ActiveRecord::Relation, который можно комбинировать с другими областями; он напоминает объект ассоциации, созданный объявлением has_many. Например, можно вызвать Shirt.red.first, Shirt.red.count, Shirt.red.where(size: 'small').

Также, как и с объектами ассоциации, именованные области ведут себя как Array, реализующие Enumerable; Shirt.red.each(&block), Shirt.red.first, и Shirt.red.inject(memo, &block) все ведут себя так, как если бы Shirt.red действительно был массивом.

Эти именованные области могут комбинироваться. Например, Shirt.red.dry_clean_only выведет все красные рубашки, которые требуют только химчистки. Вложенные поиски и вычисления также работают с этими комбинациями: Shirt.red.dry_clean_only.count возвращает количество предметов одежды, для которых выполняются эти критерии. Точно так же с Shirt.red.dry_clean_only.average(:thread_count).

Все области доступны в качестве методов класса в потомке ActiveRecord::Base, на котором были определены области. Но они также доступны для ассоциаций has_many. Если,

class Person < ActiveRecord::Base
  has_many :shirts
end

тогда elton.shirts.red.dry_clean_only вернет все красные рубашки Элтона, которые требуют только химчистки.

Именованные области также могут иметь расширения, как и при объявлениях has_many:

class Shirt < ActiveRecord::Base
  scope :red, -> { where(color: 'red') } do
    def dom_id
      'red_shirts'
    end
  end
end

Области также могут использоваться при создании/создании записи.

class Article < ActiveRecord::Base
  scope :published, -> { where(published: true) }
end

Article.published.new.published    # => true
Article.published.create.published # => true

Методы класса вашей модели автоматически доступны в областях. Предполагая следующую настройку:

class Article < ActiveRecord::Base
  scope :published, -> { where(published: true) }
  scope :featured, -> { where(featured: true) }

  def self.latest_article
    order('published_at desc').first
  end

  def self.titles
    pluck(:title)
  end
end

Мы можем вызвать методы следующим образом:

Article.published.featured.latest_article
Article.featured.titles