activerecord 3.2.6 → 6.0.0

data/lib/active_record/scoping/default.rb

@@ -1,4 +1,4 @@
-require 'active_support/concern'
+# frozen_string_literal: true
 
 module ActiveRecord
   module Scoping
@@ -6,136 +6,145 @@ module ActiveRecord
       extend ActiveSupport::Concern
 
       included do
-        # Stores the default scope for the class
-        class_attribute :default_scopes, :instance_writer => false
-        self.default_scopes = []
+        # Stores the default scope for the class.
+        class_attribute :default_scopes, instance_writer: false, instance_predicate: false, default: []
+        class_attribute :default_scope_override, instance_writer: false, instance_predicate: false, default: nil
       end
 
       module ClassMethods
-        # Returns a scope for the model without the default_scope.
+        # Returns a scope for the model without the previously set scopes.
         #
         #   class Post < ActiveRecord::Base
         #     def self.default_scope
-        #       where :published => true
+        #       where(published: true)
         #     end
         #   end
         #
-        #   Post.all          # Fires "SELECT * FROM posts WHERE published = true"
-        #   Post.unscoped.all # Fires "SELECT * FROM posts"
+        #   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"
         #
         # This method also accepts a block. All queries inside the block will
-        # not use the default_scope:
+        # not use the previously set scopes.
         #
         #   Post.unscoped {
         #     Post.limit(10) # Fires "SELECT * FROM posts LIMIT 10"
         #   }
-        #
-        # It is recommended to use the block form of unscoped because chaining
-        # unscoped with <tt>scope</tt> does not work.  Assuming that
-        # <tt>published</tt> is a <tt>scope</tt>, the following two statements
-        # are equal: the default_scope is applied on both.
-        #
-        #   Post.unscoped.published
-        #   Post.published
-        def unscoped #:nodoc:
+        def unscoped
           block_given? ? relation.scoping { yield } : relation
         end
 
+        # Are there attributes associated with this scope?
+        def scope_attributes? # :nodoc:
+          super || default_scopes.any? || respond_to?(:default_scope)
+        end
+
         def before_remove_const #:nodoc:
           self.current_scope = nil
         end
 
-        protected
+        private
 
-        # Use this macro in your model to set a default scope for all operations on
-        # the model.
-        #
-        #   class Article < ActiveRecord::Base
-        #     default_scope where(:published => true)
-        #   end
-        #
-        #   Article.all # => SELECT * FROM articles WHERE published = true
-        #
-        # The <tt>default_scope</tt> is also applied while creating/building a record. It is not
-        # applied while updating a record.
-        #
-        #   Article.new.published    # => true
-        #   Article.create.published # => true
-        #
-        # You can also use <tt>default_scope</tt> with a block, in order to have it lazily evaluated:
-        #
-        #   class Article < ActiveRecord::Base
-        #     default_scope { where(:published_at => Time.now - 1.week) }
-        #   end
-        #
-        # (You can also pass any object which responds to <tt>call</tt> to the <tt>default_scope</tt>
-        # macro, and it will be called when building the default scope.)
-        #
-        # If you use multiple <tt>default_scope</tt> declarations in your model then they will
-        # be merged together:
-        #
-        #   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'
-        #
-        # This is also the case with inheritance and module includes where the parent or module
-        # defines a <tt>default_scope</tt> and the child or including class defines a second one.
-        #
-        # If you need to do more complex things with a default scope, you can alternatively
-        # define it as a class method:
-        #
-        #   class Article < ActiveRecord::Base
-        #     def self.default_scope
-        #       # Should return a scope, you can call 'super' here etc.
-        #     end
-        #   end
-        def default_scope(scope = {})
-          scope = Proc.new if block_given?
-          self.default_scopes = default_scopes + [scope]
-        end
+          # Use this macro in your model to set a default scope for all operations on
+          # the model.
+          #
+          #   class Article < ActiveRecord::Base
+          #     default_scope { where(published: true) }
+          #   end
+          #
+          #   Article.all # => SELECT * FROM articles WHERE published = true
+          #
+          # The #default_scope is also applied while creating/building a record.
+          # It is not applied while updating a record.
+          #
+          #   Article.new.published    # => true
+          #   Article.create.published # => true
+          #
+          # (You can also pass any object which responds to +call+ to the
+          # +default_scope+ macro, and it will be called when building the
+          # default scope.)
+          #
+          # If you use multiple #default_scope declarations in your model then
+          # they will be merged together:
+          #
+          #   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'
+          #
+          # This is also the case with inheritance and module includes where the
+          # parent or module defines a #default_scope and the child or including
+          # class defines a second one.
+          #
+          # If you need to do more complex things with a default scope, you can
+          # alternatively define it as a class method:
+          #
+          #   class Article < ActiveRecord::Base
+          #     def self.default_scope
+          #       # Should return a scope, you can call 'super' here etc.
+          #     end
+          #   end
+          def default_scope(scope = 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
+
+            self.default_scopes += [scope]
+          end
+
+          def build_default_scope(relation = relation())
+            return if abstract_class?
+
+            if default_scope_override.nil?
+              self.default_scope_override = !Base.is_a?(method(:default_scope).owner)
+            end
 
-        def build_default_scope #:nodoc:
-          if method(:default_scope).owner != ActiveRecord::Scoping::Default::ClassMethods
-            evaluate_default_scope { default_scope }
-          elsif default_scopes.any?
-            evaluate_default_scope do
-              default_scopes.inject(relation) do |default_scope, scope|
-                if scope.is_a?(Hash)
-                  default_scope.apply_finder_options(scope)
-                elsif !scope.is_a?(Relation) && scope.respond_to?(:call)
-                  default_scope.merge(scope.call)
-                else
-                  default_scope.merge(scope)
+            if default_scope_override
+              # The user has defined their own default scope method, so call that
+              evaluate_default_scope do
+                if scope = default_scope
+                  relation.merge!(scope)
+                end
+              end
+            elsif default_scopes.any?
+              evaluate_default_scope do
+                default_scopes.inject(relation) do |default_scope, scope|
+                  scope = scope.respond_to?(:to_proc) ? scope : scope.method(:call)
+                  default_scope.instance_exec(&scope) || default_scope
                 end
               end
             end
           end
-        end
 
-        def ignore_default_scope? #:nodoc:
-          Thread.current["#{self}_ignore_default_scope"]
-        end
+          def ignore_default_scope?
+            ScopeRegistry.value_for(:ignore_default_scope, base_class)
+          end
 
-        def ignore_default_scope=(ignore) #:nodoc:
-          Thread.current["#{self}_ignore_default_scope"] = ignore
-        end
+          def ignore_default_scope=(ignore)
+            ScopeRegistry.set_value_for(:ignore_default_scope, base_class, ignore)
+          end
 
-        # The ignore_default_scope flag is used to prevent an infinite recursion situation where
-        # a default scope references a scope which has a default scope which references a scope...
-        def evaluate_default_scope
-          return if ignore_default_scope?
+          # The ignore_default_scope flag is used to prevent an infinite recursion
+          # situation where a default scope references a scope which has a default
+          # scope which references a scope...
+          def evaluate_default_scope
+            return if ignore_default_scope?
 
-          begin
-            self.ignore_default_scope = true
-            yield
-          ensure
-            self.ignore_default_scope = false
+            begin
+              self.ignore_default_scope = true
+              yield
+            ensure
+              self.ignore_default_scope = false
+            end
           end
-        end
-
       end
     end
   end

data/lib/active_record/scoping/named.rb

@@ -1,139 +1,136 @@
-require 'active_support/core_ext/array'
-require 'active_support/core_ext/hash/except'
-require 'active_support/core_ext/kernel/singleton_class'
-require 'active_support/core_ext/object/blank'
-require 'active_support/core_ext/class/attribute'
+# frozen_string_literal: true
+
+require "active_support/core_ext/array"
+require "active_support/core_ext/hash/except"
+require "active_support/core_ext/kernel/singleton_class"
 
 module ActiveRecord
-  # = Active Record Named \Scopes
+  # = Active Record \Named \Scopes
   module Scoping
     module Named
       extend ActiveSupport::Concern
 
       module ClassMethods
-        # Returns an anonymous \scope.
+        # Returns an ActiveRecord::Relation scope object.
         #
-        #   posts = Post.scoped
+        #   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.scoped
-        #   fruits = fruits.where(:color => 'red') if options[:red_only]
+        #   fruits = Fruit.all
+        #   fruits = fruits.where(color: 'red') if options[:red_only]
         #   fruits = fruits.limit(10) if limited?
         #
-        # Anonymous \scopes tend to be useful when procedurally generating complex
-        # queries, where passing intermediate values (\scopes) around as first-class
-        # objects is convenient.
-        #
-        # You can define a \scope that applies to all finders using
-        # ActiveRecord::Base.default_scope.
-        def scoped(options = nil)
-          if options
-            scoped.apply_finder_options(options)
-          else
-            if current_scope
-              current_scope.clone
+        # You can define a scope that applies to all finders using
+        # {default_scope}[rdoc-ref:Scoping::Default::ClassMethods#default_scope].
+        def all
+          scope = current_scope
+
+          if scope
+            if scope._deprecated_scope_source
+              ActiveSupport::Deprecation.warn(<<~MSG.squish)
+                Class level methods will no longer inherit scoping from `#{scope._deprecated_scope_source}`
+                in Rails 6.1. To continue using the scoped relation, pass it into the block directly.
+                To instead access the full set of models, as Rails 6.1 will, use `#{name}.unscoped`.
+              MSG
+            end
+
+            if self == scope.klass
+              scope.clone
             else
-              scope = relation.clone
-              scope.default_scoped = true
-              scope
+              relation.merge!(scope)
             end
+          else
+            default_scoped
           end
         end
 
-        ##
-        # Collects attributes from scopes that should be applied when creating
-        # an AR instance for the particular class this is called on.
-        def scope_attributes # :nodoc:
-          if current_scope
-            current_scope.scope_for_create
+        def scope_for_association(scope = relation) # :nodoc:
+          if current_scope&.empty_scope?
+            scope
           else
-            scope = relation.clone
-            scope.default_scoped = true
-            scope.scope_for_create
+            default_scoped(scope)
           end
         end
 
-        ##
-        # Are there default attributes associated with this scope?
-        def scope_attributes? # :nodoc:
-          current_scope || default_scopes.any?
+        def default_scoped(scope = relation) # :nodoc:
+          build_default_scope(scope) || scope
         end
 
-        # Adds a class method for retrieving and querying objects. A \scope represents a narrowing of a database query,
-        # such as <tt>where(:color => :red).select('shirts.*').includes(:washing_instructions)</tt>.
+        def default_extensions # :nodoc:
+          if scope = scope_for_association || build_default_scope
+            scope.extensions
+          else
+            []
+          end
+        end
+
+        # Adds a class method for retrieving and querying objects.
+        # The method is intended to return an ActiveRecord::Relation
+        # object, which is composable with other scopes.
+        # If it returns +nil+ or +false+, an
+        # {all}[rdoc-ref:Scoping::Named::ClassMethods#all] scope is returned instead.
+        #
+        # A \scope represents a narrowing of a database query, such as
+        # <tt>where(color: :red).select('shirts.*').includes(:washing_instructions)</tt>.
         #
         #   class Shirt < ActiveRecord::Base
-        #     scope :red, where(:color => 'red')
-        #     scope :dry_clean_only, joins(:washing_instructions).where('washing_instructions.dry_clean_only = ?', true)
+        #     scope :red, -> { where(color: 'red') }
+        #     scope :dry_clean_only, -> { joins(:washing_instructions).where('washing_instructions.dry_clean_only = ?', true) }
         #   end
         #
-        # The above calls to <tt>scope</tt> define class methods Shirt.red and Shirt.dry_clean_only. Shirt.red,
-        # in effect, represents the query <tt>Shirt.where(:color => 'red')</tt>.
+        # The above calls to #scope define class methods <tt>Shirt.red</tt> and
+        # <tt>Shirt.dry_clean_only</tt>. <tt>Shirt.red</tt>, in effect,
+        # represents the query <tt>Shirt.where(color: 'red')</tt>.
+        #
+        # You should always pass a callable object to the scopes defined
+        # with #scope. This ensures that the scope is re-evaluated each
+        # time it is called.
         #
-        # Note that this is simply 'syntactic sugar' for defining an actual class method:
+        # Note that this is simply 'syntactic sugar' for defining an actual
+        # class method:
         #
         #   class Shirt < ActiveRecord::Base
         #     def self.red
-        #       where(:color => 'red')
+        #       where(color: 'red')
         #     end
         #   end
         #
-        # Unlike <tt>Shirt.find(...)</tt>, however, the object returned by Shirt.red is not an Array; it
-        # resembles the association object constructed by a <tt>has_many</tt> declaration. For instance,
-        # you can invoke <tt>Shirt.red.first</tt>, <tt>Shirt.red.count</tt>, <tt>Shirt.red.where(:size => 'small')</tt>.
-        # Also, just as with the association objects, named \scopes act like an Array, implementing Enumerable;
-        # <tt>Shirt.red.each(&block)</tt>, <tt>Shirt.red.first</tt>, and <tt>Shirt.red.inject(memo, &block)</tt>
-        # all behave as if Shirt.red really was an Array.
-        #
-        # These named \scopes are composable. For instance, <tt>Shirt.red.dry_clean_only</tt> will produce
-        # all shirts that are both red and dry clean only.
-        # Nested finds and calculations also work with these compositions: <tt>Shirt.red.dry_clean_only.count</tt>
-        # returns the number of garments for which these criteria obtain. Similarly with
-        # <tt>Shirt.red.dry_clean_only.average(:thread_count)</tt>.
-        #
-        # All \scopes are available as class methods on the ActiveRecord::Base descendant upon which
-        # the \scopes were defined. But they are also available to <tt>has_many</tt> associations. If,
+        # Unlike <tt>Shirt.find(...)</tt>, however, the object returned by
+        # <tt>Shirt.red</tt> is not an Array but an ActiveRecord::Relation,
+        # which is composable with other scopes; it resembles the association object
+        # constructed by a {has_many}[rdoc-ref:Associations::ClassMethods#has_many]
+        # declaration. For instance, you can invoke <tt>Shirt.red.first</tt>, <tt>Shirt.red.count</tt>,
+        # <tt>Shirt.red.where(size: 'small')</tt>. Also, just as with the
+        # association objects, named \scopes act like an Array, implementing
+        # Enumerable; <tt>Shirt.red.each(&block)</tt>, <tt>Shirt.red.first</tt>,
+        # and <tt>Shirt.red.inject(memo, &block)</tt> all behave as if
+        # <tt>Shirt.red</tt> really was an array.
+        #
+        # These named \scopes are composable. For instance,
+        # <tt>Shirt.red.dry_clean_only</tt> will produce all shirts that are
+        # both red and dry clean only. Nested finds and calculations also work
+        # with these compositions: <tt>Shirt.red.dry_clean_only.count</tt>
+        # returns the number of garments for which these criteria obtain.
+        # Similarly with <tt>Shirt.red.dry_clean_only.average(:thread_count)</tt>.
+        #
+        # All scopes are available as class methods on the ActiveRecord::Base
+        # descendant upon which the \scopes were defined. But they are also
+        # available to {has_many}[rdoc-ref:Associations::ClassMethods#has_many]
+        # associations. If,
         #
         #   class Person < ActiveRecord::Base
         #     has_many :shirts
         #   end
         #
-        # then <tt>elton.shirts.red.dry_clean_only</tt> will return all of Elton's red, dry clean
-        # only shirts.
-        #
-        # Named \scopes can also be procedural:
-        #
-        #   class Shirt < ActiveRecord::Base
-        #     scope :colored, lambda { |color| where(:color => color) }
-        #   end
-        #
-        # In this example, <tt>Shirt.colored('puce')</tt> finds all puce shirts.
+        # then <tt>elton.shirts.red.dry_clean_only</tt> will return all of
+        # Elton's red, dry clean only shirts.
         #
-        # On Ruby 1.9 you can use the 'stabby lambda' syntax:
-        #
-        #   scope :colored, ->(color) { where(:color => color) }
-        #
-        # Note that scopes defined with \scope will be evaluated when they are defined, rather than
-        # when they are used. For example, the following would be incorrect:
-        #
-        #   class Post < ActiveRecord::Base
-        #     scope :recent, where('published_at >= ?', Time.current - 1.week)
-        #   end
-        #
-        # The example above would be 'frozen' to the <tt>Time.current</tt> value when the <tt>Post</tt>
-        # class was defined, and so the resultant SQL query would always be the same. The correct
-        # way to do this would be via a lambda, which will re-evaluate the scope each time
-        # it is called:
-        #
-        #   class Post < ActiveRecord::Base
-        #     scope :recent, lambda { where('published_at >= ?', Time.current - 1.week) }
-        #   end
-        #
-        # Named \scopes can also have extensions, just as with <tt>has_many</tt> declarations:
+        # \Named scopes can also have extensions, just as with
+        # {has_many}[rdoc-ref:Associations::ClassMethods#has_many] declarations:
         #
         #   class Shirt < ActiveRecord::Base
-        #     scope :red, where(:color => 'red') do
+        #     scope :red, -> { where(color: 'red') } do
         #       def dom_id
         #         'red_shirts'
         #       end
@@ -143,59 +140,77 @@ module ActiveRecord
         # Scopes can also be used while creating/building a record.
         #
         #   class Article < ActiveRecord::Base
-        #     scope :published, where(:published => true)
+        #     scope :published, -> { where(published: true) }
         #   end
         #
         #   Article.published.new.published    # => true
         #   Article.published.create.published # => true
         #
-        # Class methods on your model are automatically available
+        # \Class methods on your model are automatically available
         # on scopes. Assuming the following setup:
         #
         #   class Article < ActiveRecord::Base
-        #     scope :published, where(:published => true)
-        #     scope :featured, where(:featured => true)
+        #     scope :published, -> { where(published: true) }
+        #     scope :featured, -> { where(featured: true) }
         #
         #     def self.latest_article
         #       order('published_at desc').first
         #     end
         #
         #     def self.titles
-        #       map(&:title)
+        #       pluck(:title)
         #     end
-        #
         #   end
         #
         # We are able to call the methods like this:
         #
         #   Article.published.featured.latest_article
         #   Article.featured.titles
+        def scope(name, body, &block)
+          unless body.respond_to?(:call)
+            raise ArgumentError, "The scope body needs to be callable."
+          end
 
-        def scope(name, scope_options = {})
-          name = name.to_sym
-          valid_scope_name?(name)
-          extension = Module.new(&Proc.new) if block_given?
+          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
 
-          scope_proc = lambda do |*args|
-            options = scope_options.respond_to?(:call) ? unscoped { scope_options.call(*args) } : scope_options
-            options = scoped.apply_finder_options(options) if options.is_a?(Hash)
+          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
 
-            relation = scoped.merge(options)
+          valid_scope_name?(name)
+          extension = Module.new(&block) if block
 
-            extension ? relation.extending(extension) : relation
+          if body.respond_to?(:to_proc)
+            singleton_class.define_method(name) do |*args|
+              scope = all._exec_scope(name, *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(:redefine_method, name, &scope_proc)
+          generate_relation_method(name)
         end
 
-      protected
+        private
 
-        def valid_scope_name?(name)
-          if logger && respond_to?(name, true)
-            logger.warn "Creating scope :#{name}. " \
-                        "Overwriting existing method #{self.name}.#{name}."
+          def valid_scope_name?(name)
+            if respond_to?(name, true) && logger
+              logger.warn "Creating scope :#{name}. " \
+                "Overwriting existing method #{self.name}.#{name}."
+            end
           end
-        end
       end
     end
   end