activerecord 3.2.22.5 → 5.2.8

data/lib/active_record/scoping/named.rb

@@ -1,139 +1,130 @@
-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
+        # You can define a scope that applies to all finders using
+        # {default_scope}[rdoc-ref:Scoping::Default::ClassMethods#default_scope].
+        def all
+          current_scope = self.current_scope
+
+          if current_scope
+            if self == current_scope.klass
               current_scope.clone
             else
-              scope = relation
-              scope.default_scoped = true
-              scope
+              relation.merge!(current_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:
+          current_scope = self.current_scope
+
+          if current_scope && current_scope.empty_scope?
+            scope
           else
-            scope = relation
-            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
+
+        def default_extensions # :nodoc:
+          if scope = current_scope || build_default_scope
+            scope.extensions
+          else
+            []
+          end
         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>.
+        # 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>.
         #
-        # Note that this is simply 'syntactic sugar' for defining an actual class method:
+        # 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:
         #
         #   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.
+        # 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:
+        # \Named scopes can also have extensions, just as with
+        # {has_many}[rdoc-ref:Associations::ClassMethods#has_many] declarations:
         #
         #   class Shirt < ActiveRecord::Base
-        #     scope :colored, lambda { |color| where(:color => color) }
-        #   end
-        #
-        # In this example, <tt>Shirt.colored('puce')</tt> finds all puce 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:
-        #
-        #   class Shirt < ActiveRecord::Base
-        #     scope :red, where(:color => 'red') do
+        #     scope :red, -> { where(color: 'red') } do
         #       def dom_id
         #         'red_shirts'
         #       end
@@ -143,18 +134,18 @@ 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
@@ -169,31 +160,53 @@ module ActiveRecord
         #
         #   Article.published.featured.latest_article
         #   Article.featured.titles
-        def scope(name, scope_options = {})
-          name = name.to_sym
-          valid_scope_name?(name)
-          extension = Module.new(&Proc.new) if block_given?
+        def scope(name, body, &block)
+          unless body.respond_to?(:call)
+            raise ArgumentError, "The scope body needs to be callable."
+          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 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
 
-            relation = scoped.merge(options)
+          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
+
+          valid_scope_name?(name)
+          extension = Module.new(&block) if block
 
-            extension ? relation.extending(extension) : relation
+          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
 
-          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

data/lib/active_record/scoping.rb

@@ -1,4 +1,6 @@
-require 'active_support/concern'
+# frozen_string_literal: true
+
+require "active_support/per_thread_registry"
 
 module ActiveRecord
   module Scoping
@@ -9,144 +11,96 @@ module ActiveRecord
       include Named
     end
 
-    module ClassMethods
-      # with_scope lets you apply options to inner block incrementally. It takes a hash and the keys must be
-      # <tt>:find</tt> or <tt>:create</tt>. <tt>:find</tt> parameter is <tt>Relation</tt> while
-      # <tt>:create</tt> parameters are an attributes hash.
-      #
-      #   class Article < ActiveRecord::Base
-      #     def self.create_with_scope
-      #       with_scope(:find => where(:blog_id => 1), :create => { :blog_id => 1 }) do
-      #         find(1) # => SELECT * from articles WHERE blog_id = 1 AND id = 1
-      #         a = create(1)
-      #         a.blog_id # => 1
-      #       end
-      #     end
-      #   end
-      #
-      # In nested scopings, all previous parameters are overwritten by the innermost rule, with the exception of
-      # <tt>where</tt>, <tt>includes</tt>, and <tt>joins</tt> operations in <tt>Relation</tt>, which are merged.
-      #
-      # <tt>joins</tt> operations are uniqued so multiple scopes can join in the same table without table aliasing
-      # problems. If you need to join multiple tables, but still want one of the tables to be uniqued, use the
-      # array of strings format for your joins.
-      #
-      #   class Article < ActiveRecord::Base
-      #     def self.find_with_scope
-      #       with_scope(:find => where(:blog_id => 1).limit(1), :create => { :blog_id => 1 }) do
-      #         with_scope(:find => limit(10)) do
-      #           all # => SELECT * from articles WHERE blog_id = 1 LIMIT 10
-      #         end
-      #         with_scope(:find => where(:author_id => 3)) do
-      #           all # => SELECT * from articles WHERE blog_id = 1 AND author_id = 3 LIMIT 1
-      #         end
-      #       end
-      #     end
-      #   end
-      #
-      # You can ignore any previous scopings by using the <tt>with_exclusive_scope</tt> method.
-      #
-      #   class Article < ActiveRecord::Base
-      #     def self.find_with_exclusive_scope
-      #       with_scope(:find => where(:blog_id => 1).limit(1)) do
-      #         with_exclusive_scope(:find => limit(10)) do
-      #           all # => SELECT * from articles LIMIT 10
-      #         end
-      #       end
-      #     end
-      #   end
-      #
-      # *Note*: the +:find+ scope also has effect on update and deletion methods, like +update_all+ and +delete_all+.
-      def with_scope(scope = {}, action = :merge, &block)
-        # If another Active Record class has been passed in, get its current scope
-        scope = scope.current_scope if !scope.is_a?(Relation) && scope.respond_to?(:current_scope)
-
-        previous_scope = self.current_scope
-
-        if scope.is_a?(Hash)
-          # Dup first and second level of hash (method and params).
-          scope = scope.dup
-          scope.each do |method, params|
-            scope[method] = params.dup unless params == true
-          end
-
-          scope.assert_valid_keys([ :find, :create ])
-          relation = construct_finder_arel(scope[:find] || {})
-          relation.default_scoped = true unless action == :overwrite
-
-          if previous_scope && previous_scope.create_with_value && scope[:create]
-            scope_for_create = if action == :merge
-              previous_scope.create_with_value.merge(scope[:create])
-            else
-              scope[:create]
-            end
-
-            relation = relation.create_with(scope_for_create)
-          else
-            scope_for_create = scope[:create]
-            scope_for_create ||= previous_scope.create_with_value if previous_scope
-            relation = relation.create_with(scope_for_create) if scope_for_create
-          end
-
-          scope = relation
-        end
-
-        scope = previous_scope.merge(scope) if previous_scope && action == :merge
+    module ClassMethods # :nodoc:
+      def current_scope(skip_inherited_scope = false)
+        ScopeRegistry.value_for(:current_scope, self, skip_inherited_scope)
+      end
 
-        self.current_scope = scope
-        begin
-          yield
-        ensure
-          self.current_scope = previous_scope
-        end
+      def current_scope=(scope)
+        ScopeRegistry.set_value_for(:current_scope, self, scope)
       end
 
-      protected
+      # Collects attributes from scopes that should be applied when creating
+      # an AR instance for the particular class this is called on.
+      def scope_attributes
+        all.scope_for_create
+      end
 
-      # Works like with_scope, but discards any nested properties.
-      def with_exclusive_scope(method_scoping = {}, &block)
-        if method_scoping.values.any? { |e| e.is_a?(ActiveRecord::Relation) }
-          raise ArgumentError, <<-MSG
-  New finder API can not be used with_exclusive_scope. You can either call unscoped to get an anonymous scope not bound to the default_scope:
+      # Are there attributes associated with this scope?
+      def scope_attributes?
+        current_scope
+      end
+    end
 
-  User.unscoped.where(:active => true)
+    def populate_with_current_scope_attributes # :nodoc:
+      return unless self.class.scope_attributes?
 
-  Or call unscoped with a block:
+      attributes = self.class.scope_attributes
+      _assign_attributes(attributes) if attributes.any?
+    end
 
-  User.unscoped do
-  User.where(:active => true).all
-  end
+    def initialize_internals_callback # :nodoc:
+      super
+      populate_with_current_scope_attributes
+    end
 
-  MSG
-        end
-        with_scope(method_scoping, :overwrite, &block)
+    # This class stores the +:current_scope+ and +:ignore_default_scope+ values
+    # for different classes. The registry is stored as a thread local, which is
+    # accessed through +ScopeRegistry.current+.
+    #
+    # This class allows you to store and get the scope values on different
+    # classes and different types of scopes. For example, if you are attempting
+    # to get the current_scope for the +Board+ model, then you would use the
+    # following code:
+    #
+    #   registry = ActiveRecord::Scoping::ScopeRegistry
+    #   registry.set_value_for(:current_scope, Board, some_new_scope)
+    #
+    # Now when you run:
+    #
+    #   registry.value_for(:current_scope, Board)
+    #
+    # You will obtain whatever was defined in +some_new_scope+. The #value_for
+    # and #set_value_for methods are delegated to the current ScopeRegistry
+    # object, so the above example code can also be called as:
+    #
+    #   ActiveRecord::Scoping::ScopeRegistry.set_value_for(:current_scope,
+    #       Board, some_new_scope)
+    class ScopeRegistry # :nodoc:
+      extend ActiveSupport::PerThreadRegistry
+
+      VALID_SCOPE_TYPES = [:current_scope, :ignore_default_scope]
+
+      def initialize
+        @registry = Hash.new { |hash, key| hash[key] = {} }
       end
 
-      def current_scope #:nodoc:
-        Thread.current["#{self}_current_scope"]
+      # Obtains the value for a given +scope_type+ and +model+.
+      def value_for(scope_type, model, skip_inherited_scope = false)
+        raise_invalid_scope_type!(scope_type)
+        return @registry[scope_type][model.name] if skip_inherited_scope
+        klass = model
+        base = model.base_class
+        while klass <= base
+          value = @registry[scope_type][klass.name]
+          return value if value
+          klass = klass.superclass
+        end
       end
 
-      def current_scope=(scope) #:nodoc:
-        Thread.current["#{self}_current_scope"] = scope
+      # Sets the +value+ for a given +scope_type+ and +model+.
+      def set_value_for(scope_type, model, value)
+        raise_invalid_scope_type!(scope_type)
+        @registry[scope_type][model.name] = value
       end
 
       private
 
-      def construct_finder_arel(options = {}, scope = nil)
-        relation = options.is_a?(Hash) ? unscoped.apply_finder_options(options) : options
-        relation = scope.merge(relation) if scope
-        relation
-      end
-
-    end
-
-    def populate_with_current_scope_attributes
-      return unless self.class.scope_attributes?
-
-      self.class.scope_attributes.each do |att,value|
-        send("#{att}=", value) if respond_to?("#{att}=")
-      end
+        def raise_invalid_scope_type!(scope_type)
+          if !VALID_SCOPE_TYPES.include?(scope_type)
+            raise ArgumentError, "Invalid scope type '#{scope_type}' sent to the registry. Scope types must be included in VALID_SCOPE_TYPES"
+          end
+        end
     end
-
   end
 end

data/lib/active_record/secure_token.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module SecureToken
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      # Example using #has_secure_token
+      #
+      #   # Schema: User(token:string, auth_token:string)
+      #   class User < ActiveRecord::Base
+      #     has_secure_token
+      #     has_secure_token :auth_token
+      #   end
+      #
+      #   user = User.new
+      #   user.save
+      #   user.token # => "pX27zsMN2ViQKta1bGfLmVJE"
+      #   user.auth_token # => "77TMHrHJFvFDwodq8w7Ev2m7"
+      #   user.regenerate_token # => true
+      #   user.regenerate_auth_token # => true
+      #
+      # <tt>SecureRandom::base58</tt> is used to generate the 24-character unique token, so collisions are highly unlikely.
+      #
+      # Note that it's still possible to generate a race condition in the database in the same way that
+      # {validates_uniqueness_of}[rdoc-ref:Validations::ClassMethods#validates_uniqueness_of] can.
+      # You're encouraged to add a unique index in the database to deal with this even more unlikely scenario.
+      def has_secure_token(attribute = :token)
+        # Load securerandom only when has_secure_token is used.
+        require "active_support/core_ext/securerandom"
+        define_method("regenerate_#{attribute}") { update! attribute => self.class.generate_unique_secure_token }
+        before_create { send("#{attribute}=", self.class.generate_unique_secure_token) unless send("#{attribute}?") }
+      end
+
+      def generate_unique_secure_token
+        SecureRandom.base58(24)
+      end
+    end
+  end
+end

data/lib/active_record/serialization.rb

@@ -1,18 +1,22 @@
+# frozen_string_literal: true
+
 module ActiveRecord #:nodoc:
-  # = Active Record Serialization
+  # = Active Record \Serialization
   module Serialization
     extend ActiveSupport::Concern
     include ActiveModel::Serializers::JSON
 
+    included do
+      self.include_root_in_json = false
+    end
+
     def serializable_hash(options = nil)
-      options = options.try(:clone) || {}
+      options = options.try(:dup) || {}
 
-      options[:except] = Array.wrap(options[:except]).map { |n| n.to_s }
-      options[:except] |= Array.wrap(self.class.inheritance_column)
+      options[:except] = Array(options[:except]).map(&:to_s)
+      options[:except] |= Array(self.class.inheritance_column)
 
       super(options)
     end
   end
 end
-
-require 'active_record/serializers/xml_serializer'