Table of Contents
Rails的ActiveRecord中有一个非常重要的模块，就是Scope。
ActiveRecord::Relation
Rails中，where返回的对象其实是ActiveRecord::Relation.
Fund.where(deleted: false).class
SQL (2.4ms) USE [zhongyifunds_development]
=> Fund::ActiveRecord_Relation
有趣的是，许多类方法实际上都是delegate给all了。
module ActiveRecord
module Querying
delegate :select, :group, :order, :except, :reorder, :limit, :offset, :joins, :left_joins, :left_outer_joins, :or,
:where, :rewhere, :preload, :eager_load, :includes, :from, :lock, :readonly, :extending,
:having, :create_with, :distinct, :references, :none, :unscope, :merge, to: :all
所以，下面几个都是等效的：
Fund.all.where(deleted: false)
Fund.where(deleted: false)
#all
下面的all方法的定义。
如果current_scope为空，就返回default_scoped，否则就是current_scope的clone。
module ActiveRecord
module Scoping
module Named
module ClassMethods
def all
current_scope = self.current_scope
if current_scope
if self == current_scope.klass
current_scope.clone
else
relation.merge!(current_scope)
end
else
default_scoped
end
end
current_scope位于线程变量ScopeRegistry中，其实相当于查询上下文。
def current_scope(skip_inherited_scope = false)
ScopeRegistry.value_for(:current_scope, self, skip_inherited_scope)
end
def current_scope=(scope)
ScopeRegistry.set_value_for(:current_scope, self, scope)
end
default_scope
在第一次执行的时候，current_scope肯定为空，返回default_scoped。default_scoped第一次会build_default_scope，会查询default_scopes是否为空。不为空，就返回该scope。
def default_scoped(scope = relation) # :nodoc:
build_default_scope(scope) || scope
end
def build_default_scope(base_rel = nil)
#...
if default_scope_override
#...
elsif default_scopes.any?
base_rel ||= relation
evaluate_default_scope do
default_scopes.inject(base_rel) do |default_scope, scope|
scope = scope.respond_to?(:to_proc) ? scope : scope.method(:call)
default_scope.merge!(base_rel.instance_exec(&scope))
end
end
end
end
所以, default_scope方法就比较简单，就是单纯往default_scopes里面存入当前scope就行了。
def default_scope(scope = nil, &block) # :doc:
scope = block if block_given?
#...
self.default_scopes += [scope]
end
此外，这个default会影响新建的实例，即Fund.new创建的实例deleted为false。如果是软删除，可以用这种方法，这样新建的就默认是未删除的。
class Fund < ApplicationRecord
default_scope { where deleted: false }
end
#scope 方法
看完default_scope，来看看scope。scope传入的body要求是callable的，即可以是一个拥有#call方法的Module，或者代码块。比如这里是代码块，支持to_proc，就在Fund的单件类上面创建了一个active的方法。和where一样，是建立在all的基础上。
class Fund < ApplicationRecord
scope :active, -> { where(deleted: false) }
end
def scope(name, body, &block)
#...
extension = Module.new(&block) if block
if body.respond_to?(:to_proc)
singleton_class.send(:define_method, name) do |*args|
scope = all
scope = scope._exec_scope(*args, &body)
scope = scope.extending(extension) if extension
scope
end
else
singleton_class.send(:define_method, name) do |*args|
scope = all
scope = scope.scoping { body.call(*args) || scope }
scope = scope.extending(extension) if extension
scope
end
end
generate_relation_method(name)
end
scoping会存储当前上下文的current_scope，执行完成以后再恢复。
_exec_scope就直接执行block，不再存储current_scope。
def scoping
previous, klass.current_scope = klass.current_scope(true), self unless @delegate_to_klass
yield
ensure
klass.current_scope = previous unless @delegate_to_klass
end
def _exec_scope(*args, &block) # :nodoc:
@delegate_to_klass = true
instance_exec(*args, &block) || self
ensure
@delegate_to_klass = false
end
对new、create的影响
和default_scope一样，也会对new和create有影响。
Fund.active.new.deleted => false
链式scope
正是因为scope方法返回的是Relation，这样可以实现链式scope，即多个scope可以串在一起使用。虽然说，scope生成的方法，类似于类方法。下面的方式也可以支持链式，只是通过method_missing这种钩子方法来实现的。
class Fund < ApplicationRecord
def self.active
where(deleted: false)
end
def self.inactive
where(deleted: true)
end
end
generate_relation_method
Rails 5.2.4 中比 5.1 多了generate_relation_method，从名字上可以看出实际上就是给Relation上生成方法。其实注释掉这个方法也是可以的，只是这样就会走method_missing那种方式，这样非常不利于debug。所以这里显式的定义方法，这样Fund.active.method(:base).source_location就可以找到方法的定义了。
传入参数
如下例中，lambda中传入time参数。
scope :created_before, ->(time) { where("created_at < ?", time) }
callable Module
http://craftingruby.com/posts/2015/06/29/query-objects-through-scopes.html 中创建了一个拥有call方法的Module来自定义scope。