跳至内容 跳至搜索
方法
A
D
S

实例公共方法

all(all_queries: nil)

返回一个 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 22
def all(all_queries: nil)
  scope = current_scope

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

default_scoped(scope = relation, all_queries: nil)

返回带有默认范围的模型范围。

# 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

scope(name, body, &block)

添加一个用于检索和查询对象类方法。该方法旨在返回一个 ActiveRecord::Relation 对象,该对象可以与其他范围组合使用。如果它返回 nilfalse,则返回一个 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.redShirt.dry_clean_onlyShirt.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.firstShirt.red.countShirt.red.where(size: 'small')。此外,与关联对象一样,命名范围的行为类似于 Array,实现了 EnumerableShirt.red.each(&block)Shirt.red.firstShirt.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 将返回 Elton 所有红色、干洗的衬衫。

命名范围也可以有扩展,就像 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
# 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