mongoid 9.0.11 → 9.1.1

data/lib/mongoid/association/embedded/embeds_many.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 require 'mongoid/association/embedded/embeds_many/binding'
 require 'mongoid/association/embedded/embeds_many/buildable'
@@ -8,7 +7,6 @@ require 'mongoid/association/embedded/embeds_many/proxy'
 module Mongoid
   module Association
     module Embedded
-
       # The EmbedsMany type association.
       class EmbedsMany
         include Relatable
@@ -18,16 +16,16 @@ module Mongoid
         # common ones.
         #
         # @return [ Array<Symbol> ] The extra valid options.
-        ASSOCIATION_OPTIONS = [
-            :as,
-            :cascade_callbacks,
-            :cyclic,
-            :order,
-            :store_as,
-            :before_add,
-            :after_add,
-            :before_remove,
-            :after_remove
+        ASSOCIATION_OPTIONS = %i[
+          as
+          cascade_callbacks
+          cyclic
+          order
+          store_as
+          before_add
+          after_add
+          before_remove
+          after_remove
         ]
 
         # The complete list of valid options for this association, including
@@ -50,7 +48,7 @@ module Mongoid
         #
         # @return [ String ] The field name.
         def store_as
-          @store_as ||= (@options[:store_as].try(:to_s) || name.to_s)
+          @store_as ||= @options[:store_as].try(:to_s) || name.to_s
         end
 
         # The key that is used to get the attributes for the associated object.
@@ -63,7 +61,9 @@ module Mongoid
         # Is this association type embedded?
         #
         # @return [ true ] Always true.
-        def embedded?; true; end
+        def embedded?
+          true
+        end
 
         # Get the default validation setting for the association. Determines if
         # by default a validates associated will occur.
@@ -72,12 +72,16 @@ module Mongoid
         #   Proxy.validation_default
         #
         # @return [ true ] Always true.
-        def validation_default; true; end
+        def validation_default
+          true
+        end
 
         # Does this association type store the foreign key?
         #
         # @return [ false ] Always false.
-        def stores_foreign_key?; false; end
+        def stores_foreign_key?
+          false
+        end
 
         # The primary key
         #
@@ -163,19 +167,18 @@ module Mongoid
           @relation_complements ||= [ Embedded::EmbeddedIn ].freeze
         end
 
-        def polymorphic_inverses(other = nil)
+        def polymorphic_inverses(_other = nil)
           [ as ]
         end
 
-        def determine_inverses(other)
+        def determine_inverses(_other)
           matches = relation_class.relations.values.select do |rel|
             relation_complements.include?(rel.class) &&
               # https://jira.mongodb.org/browse/MONGOID-4882
               rel.relation_class_name.sub(/\A::/, '') == inverse_class_name
           end
-          if matches.size > 1
-            raise Errors::AmbiguousRelationship.new(relation_class, @owner_class, name, matches)
-          end
+          raise Errors::AmbiguousRelationship.new(relation_class, @owner_class, name, matches) if matches.size > 1
+
           matches.collect { |m| m.name } unless matches.blank?
         end
       end

data/lib/mongoid/association/embedded/embeds_one/binding.rb

@@ -1,11 +1,9 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   module Association
     module Embedded
       class EmbedsOne
-
         # Binding class for all embeds_one associations.
         class Binding
           include Bindable

data/lib/mongoid/association/embedded/embeds_one/buildable.rb

@@ -1,11 +1,9 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   module Association
     module Embedded
       class EmbedsOne
-
         # Builder class for embeds_one associations.
         module Buildable
           include Threaded::Lifecycle
@@ -41,10 +39,8 @@ module Mongoid
           private
 
           def clear_associated(doc)
-            if doc && (inv = inverse(doc))
-              if associated = doc.ivar(inv)
-                associated.substitute(nil)
-              end
+            if doc && (inv = inverse(doc)) && (associated = doc.ivar(inv))
+              associated.substitute(nil)
             end
           end
         end

data/lib/mongoid/association/embedded/embeds_one.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 require 'mongoid/association/embedded/embeds_one/binding'
 require 'mongoid/association/embedded/embeds_one/buildable'
@@ -8,7 +7,6 @@ require 'mongoid/association/embedded/embeds_one/proxy'
 module Mongoid
   module Association
     module Embedded
-
       # The EmbedsOne type association.
       class EmbedsOne
         include Relatable
@@ -18,12 +16,13 @@ module Mongoid
         # common ones.
         #
         # @return [ Array<Symbol> ] The extra valid options.
-        ASSOCIATION_OPTIONS = [
-            :autobuild,
-            :as,
-            :cascade_callbacks,
-            :cyclic,
-            :store_as
+        ASSOCIATION_OPTIONS = %i[
+          autobuild
+          as
+          cascade_callbacks
+          cyclic
+          fallback
+          store_as
         ]
 
         # The complete list of valid options for this association, including
@@ -46,7 +45,7 @@ module Mongoid
         #
         # @return [ String ] The field name.
         def store_as
-          @store_as ||= (@options[:store_as].try(:to_s) || name.to_s)
+          @store_as ||= @options[:store_as].try(:to_s) || name.to_s
         end
 
         # The key that is used to get the attributes for the associated object.
@@ -59,7 +58,9 @@ module Mongoid
         # Is this association type embedded?
         #
         # @return [ true ] Always true.
-        def embedded?; true; end
+        def embedded?
+          true
+        end
 
         # Get the default validation setting for the association. Determines if
         # by default a validates associated will occur.
@@ -68,12 +69,16 @@ module Mongoid
         #   Proxy.validation_default
         #
         # @return [ true | false ] The validation default.
-        def validation_default; true; end
+        def validation_default
+          true
+        end
 
         # Does this association type store the foreign key?
         #
         # @return [ false ] Always false.
-        def stores_foreign_key?; false; end
+        def stores_foreign_key?
+          false
+        end
 
         # The primary key
         #
@@ -129,20 +134,18 @@ module Mongoid
           @relation_complements ||= [ Embedded::EmbeddedIn ].freeze
         end
 
-        def polymorphic_inverses(other = nil)
+        def polymorphic_inverses(_other = nil)
           [ as ]
         end
 
-        def determine_inverses(other)
+        def determine_inverses(_other)
           matches = relation_class.relations.values.select do |rel|
             relation_complements.include?(rel.class) &&
               # https://jira.mongodb.org/browse/MONGOID-4882
               rel.relation_class_name.sub(/\A::/, '') == inverse_class_name
-
-          end
-          if matches.size > 1
-            raise Errors::AmbiguousRelationship.new(relation_class, @owner_class, name, matches)
           end
+          raise Errors::AmbiguousRelationship.new(relation_class, @owner_class, name, matches) if matches.size > 1
+
           matches.collect { |m| m.name } unless matches.blank?
         end
       end

data/lib/mongoid/association/embedded.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 require 'mongoid/association/embedded/cyclic'
 require 'mongoid/association/embedded/eager'

data/lib/mongoid/association/macros.rb

@@ -149,8 +149,6 @@ module Mongoid
           define_association!(__method__, name, options, &block)
         end
 
-        # rubocop:disable Naming/PredicateName
-
         # Adds a referenced association from a parent Document to many
         # Documents in another database or collection.
         #
@@ -169,7 +167,7 @@ module Mongoid
         # @param [ Symbol ] name The name of the association.
         # @param [ Hash ] options The association options.
         # @param &block Optional block for defining extensions.
-        def has_many(name, options = {}, &block)
+        def has_many(name, options = {}, &block) # rubocop:disable Naming/PredicatePrefix
           define_association!(__method__, name, options, &block)
         end
 
@@ -191,7 +189,7 @@ module Mongoid
         # @param [ Symbol ] name The name of the association.
         # @param [ Hash ] options The association options.
         # @param &block Optional block for defining extensions.
-        def has_and_belongs_to_many(name, options = {}, &block)
+        def has_and_belongs_to_many(name, options = {}, &block) # rubocop:disable Naming/PredicatePrefix
           define_association!(__method__, name, options, &block)
         end
 
@@ -213,16 +211,26 @@ module Mongoid
         # @param [ Symbol ] name The name of the association.
         # @param [ Hash ] options The association options.
         # @param &block Optional block for defining extensions.
-        def has_one(name, options = {}, &block)
+        def has_one(name, options = {}, &block) # rubocop:disable Naming/PredicatePrefix
           define_association!(__method__, name, options, &block)
         end
 
-        # rubocop:enable Naming/PredicateName
-
         private
 
         def define_association!(macro_name, name, options = {}, &block)
-          Association::MACRO_MAPPING[macro_name].new(self, name, options, &block).tap do |assoc|
+          klass = if options[:through]
+                    Association::THROUGH_MACRO_MAPPING[macro_name] ||
+                      raise(
+                        Errors::InvalidRelationOption.new(
+                          self, name, :through,
+                          Association::THROUGH_MACRO_MAPPING.keys
+                        )
+                      )
+                  else
+                    Association::MACRO_MAPPING[macro_name]
+                  end
+
+          klass.new(self, name, options, &block).tap do |assoc|
             assoc.setup!
             self.relations = relations.merge(name => assoc)
             if assoc.embedded? && assoc.respond_to?(:store_as) && assoc.store_as != name

data/lib/mongoid/association/many.rb

@@ -1,16 +1,22 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   module Association
-
     # This is the superclass for all many to one and many to many association
     # proxies.
     class Many < Association::Proxy
       extend Forwardable
       include ::Enumerable
 
-      def_delegators :criteria, :avg, :max, :min, :sum
+      %i[avg max min sum].each do |method|
+        define_method(method) do |*args, &block|
+          if _target.respond_to?(:_loaded?) && _target._loaded?
+            _target.public_send(method, *args, &block)
+          else
+            criteria.public_send(method, *args, &block)
+          end
+        end
+      end
       def_delegators :_target, :length, :size, :any?
 
       # Is the association empty?
@@ -178,6 +184,19 @@ module Mongoid
         criteria.unscoped
       end
 
+      # For compatibility with Rails' caching. Returns a string based on the
+      # given timestamp, and includes the number of records in the relation
+      # in the version.
+      #
+      # @param [ String | Symbol ] timestamp_column the timestamp column to
+      #   use when constructing the key.
+      #
+      # @return [ String ] the cache version string
+      def cache_version(timestamp_column = :updated_at)
+        @cache_version ||= {}
+        @cache_version[timestamp_column] ||= compute_cache_version(timestamp_column)
+      end
+
       private
 
       def _session
@@ -198,6 +217,59 @@ module Mongoid
         attrs[klass.discriminator_key] = type.discriminator_value if type
         where(attrs).first || send(method, attrs, type, &block)
       end
+
+      # Computes the cache version for the relation using the given
+      # timestamp colum; see `#cache_version`.
+      #
+      # @param [ String | Symbol ] timestamp_column the timestamp column to
+      #   use when constructing the key.
+      #
+      # @return [ String ] the cache version string
+      def compute_cache_version(timestamp_column)
+        timestamp_column = timestamp_column.to_s
+
+        # has_many
+        loaded = if _target.respond_to?(:_loaded?)
+                   _target._loaded?
+                 else
+                   true
+                 end # embeds_many
+
+        size, timestamp = if loaded
+                            analyze_loaded_target(timestamp_column)
+                          else
+                            analyze_unloaded_target(timestamp_column)
+                          end
+
+        if timestamp
+          "#{size}-#{timestamp.utc.to_formatted_s(klass.cache_timestamp_format)}"
+        else
+          size.to_s
+        end
+      end
+
+      # Return a 2-tuple of the number of elements in the relation, and the
+      # largest timestamp value.
+      def analyze_loaded_target(timestamp_column)
+        newest = _target.select { |elem| elem.respond_to?(timestamp_column) }
+                        .max { |a, b| a[timestamp_column] <=> b[timestamp_column] }
+        [ _target.length, newest ? newest[timestamp_column] : nil ]
+      end
+
+      # Returns a 2-tuple of the number of elements in the relation, and the
+      # largest timestamp value. This will query the database to perform a
+      # $sum and a $max.
+      def analyze_unloaded_target(timestamp_column)
+        pipeline = criteria
+                   .group(_id: nil,
+                          count: { '$sum' => 1 },
+                          latest: { '$max' => "$#{timestamp_column}" })
+                   .pipeline
+
+        result = klass.collection.aggregate(pipeline).to_a.first
+
+        result ? [ result['count'], result['latest'] ] : [ 0 ]
+      end
     end
   end
 end

data/lib/mongoid/association/marshalable.rb

@@ -1,13 +1,10 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   module Association
-
     # Mixin module for Mongoid::Association::Proxy which adds
     # custom Marshal.dump functionality.
     module Marshalable
-
       # Provides the data needed to Marshal.dump an association proxy.
       #
       # @example Dump the proxy.

data/lib/mongoid/association/nested/many.rb

@@ -1,10 +1,8 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   module Association
     module Nested
-
       # Builder class used to perform #accepts_nested_attributes_for
       # attribute assignment on many-to-n associations.
       class Many
@@ -17,6 +15,9 @@ module Mongoid
         # the existing association, a replacement of the association with a new
         # document, or a removal of the association.
         #
+        # It raises an argument error if the attributes are not a Hash or an
+        # Array of key/value pairs.
+        #
         # @example Build the nested attrs.
         #   many.build(person)
         #
@@ -26,14 +27,18 @@ module Mongoid
         # @return [ Array ] The attributes.
         def build(parent, options = {})
           @existing = parent.send(association.name)
-          if over_limit?(attributes)
-            raise Errors::TooManyNestedAttributeRecords.new(existing, options[:limit])
-          end
+          raise Errors::TooManyNestedAttributeRecords.new(existing, options[:limit]) if over_limit?(attributes)
+
           attributes.each do |attrs|
             if attrs.is_a?(::Hash)
               process_attributes(parent, attrs.with_indifferent_access)
-            else
+            elsif attrs.is_a?(Array) && attrs.length > 1 && attrs[1].respond_to?(:with_indifferent_access)
               process_attributes(parent, attrs[1].with_indifferent_access)
+            elsif attrs.is_a?(Array) && attrs.length.even?
+              process_attributes(parent, Hash[*attrs].with_indifferent_access)
+            else
+              raise ArgumentError,
+                    "Attributes for nested association '#{association.name}' must be a Hash or an Array of key/value pairs."
             end
           end
         end
@@ -48,13 +53,13 @@ module Mongoid
         # @param [ Hash ] attributes The attributes hash to attempt to set.
         # @param [ Hash ] options The options defined.
         def initialize(association, attributes, options = {})
-          if attributes.respond_to?(:with_indifferent_access)
-            @attributes = attributes.with_indifferent_access.sort do |a, b|
-              a[0].to_i <=> b[0].to_i
-            end
-          else
-            @attributes = attributes
-          end
+          @attributes = if attributes.respond_to?(:with_indifferent_access)
+                          attributes.with_indifferent_access.sort do |a, b|
+                            a[0].to_i <=> b[0].to_i
+                          end
+                        else
+                          attributes
+                        end
           @association = association
           @options = options
           @class_name = options[:class_name] ? options[:class_name].constantize : association.klass
@@ -174,7 +179,7 @@ module Mongoid
         # @param [ Hash ] attrs The single document attributes to process.
         def update_nested_relation(parent, id, attrs)
           first = existing.first
-          converted = first ? convert_id(first.class, id) : id
+          converted = convert_id(first ? first.class : association.klass, id)
 
           if existing.where(_id: converted).exists?
             # document exists in association
@@ -186,19 +191,48 @@ module Mongoid
             end
           elsif association.embedded?
             raise Errors::DocumentNotFound.new(association.klass, id)
-          elsif association.is_a?(Association::Referenced::HasAndBelongsToMany) || Mongoid.allow_reparenting_via_nested_attributes?
-            Mongoid::Warnings.warn_reparenting_via_nested_attributes if Mongoid.allow_reparenting_via_nested_attributes?
+          elsif destroyable?(attrs)
+            # A destroy of a document that is not in the association is
+            # ignored, rather than reaching for it outside the association.
+            nil
+          elsif Mongoid.allow_reparenting_via_nested_attributes?
+            Mongoid::Warnings.warn_reparenting_via_nested_attributes
 
             # push existing document to association
             doc = association.klass.unscoped.find(converted)
+            # find returns nil instead of raising when
+            # Mongoid.raise_not_found_error is false; a missing document
+            # must still be an error here, consistent with the other
+            # not-found branches.
+            raise Errors::DocumentNotFound.new(association.klass, id) if doc.nil?
+
             update_document(doc, attrs)
-            existing.push(doc) unless destroyable?(attrs)
+            existing.push(doc)
           else
-            raise Errors::DocumentNotFound.new(association.klass, { _id: id, association.foreign_key => parent.id })
+            raise Errors::DocumentNotFound.new(association.klass, not_found_params(parent, id))
           end
 
           parent.children_may_have_changed!
         end
+
+        # The params to report when an id in the nested attributes could not
+        # be resolved within the association.
+        #
+        # @api private
+        #
+        # @param [ Document ] parent The parent document.
+        # @param [ String | BSON::ObjectId ] id of the related document.
+        #
+        # @return [ Hash | Object ] The params for the not found error.
+        def not_found_params(parent, id)
+          if association.is_a?(Association::Referenced::HasAndBelongsToMany)
+            # A many-to-many association has no foreign key on the child, so
+            # the id is only ever resolved within the association itself.
+            id
+          else
+            { _id: id, association.foreign_key => parent.id }
+          end
+        end
       end
     end
   end

data/lib/mongoid/association/nested/nested_buildable.rb

@@ -1,15 +1,12 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   module Association
     module Nested
-
       # Mixin module containing common functionality used to
       # perform #accepts_nested_attributes_for attribute assignment
       # on associations.
       module Buildable
-
         attr_accessor :attributes, :existing, :association, :options
 
         # Determines if destroys are allowed for this document.
@@ -33,12 +30,12 @@ module Mongoid
         # @return [ true | false ] True and call proc or method if rejectable, false if not.
         def reject?(document, attrs)
           case callback = options[:reject_if]
-            when Symbol
-              document.method(callback).arity == 0 ? document.send(callback) : document.send(callback, attrs)
-            when Proc
-              callback.call(attrs)
-            else
-              false
+          when Symbol
+            (document.method(callback).arity == 0) ? document.send(callback) : document.send(callback, attrs)
+          when Proc
+            callback.call(attrs)
+          else
+            false
           end
         end
 
@@ -58,12 +55,26 @@ module Mongoid
         # @example Convert the id.
         #   builder.convert_id(Person, "4d371b444835d98b8b000010")
         #
+        # Ids arriving from a form are always scalars. A Hash or an Array
+        # here means the parameters were crafted, and letting one through
+        # would turn the id into a query operator, so they are rejected.
+        #
         # @param [ Class ] klass The class we're trying to convert for.
         # @param [ String ] id The id, usually coming from the form.
         #
         # @return [ BSON::ObjectId | String | Object ] The converted id.
+        #
+        # @raise [ Errors::DocumentNotFound ] if the id is not a scalar, or
+        #   cannot be converted to the type the class uses for its ids.
+        #   The BSON::Error rescue is defensive: a value that reaches
+        #   BSON::ObjectId.mongoize and raises there must not surface as an
+        #   unhandled BSON error in the caller.
         def convert_id(klass, id)
+          raise Errors::DocumentNotFound.new(klass, id) if id.is_a?(::Hash) || id.is_a?(::Array)
+
           klass.using_object_ids? ? BSON::ObjectId.mongoize(id) : id
+        rescue BSON::Error
+          raise Errors::DocumentNotFound.new(klass, id)
         end
 
         private

data/lib/mongoid/association/nested/one.rb

@@ -1,10 +1,8 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   module Association
     module Nested
-
       # Builder class used to perform #accepts_nested_attributes_for
       # attribute assignment on one-to-n associations.
       class One
@@ -27,7 +25,13 @@ module Mongoid
         # @return [ Document ] The built document.
         def build(parent)
           return if reject?(parent, attributes)
-          @existing = parent.send(association.name)
+
+          @existing =
+            if association.fallback?
+              parent.send(:without_autobuild) { parent.send(association.name) }
+            else
+              parent.send(association.name)
+            end
           if update?
             delete_id(attributes)
             existing.assign_attributes(attributes)
@@ -158,11 +162,9 @@ module Mongoid
 
           # otherwise, an attempt has been made to set the _id of an existing,
           # persisted document.
-          if Mongoid::Config.immutable_ids
-            raise Errors::ImmutableAttribute.new(:_id, id)
-          else
-            Mongoid::Warnings.warn_mutable_ids
-          end
+          raise Errors::ImmutableAttribute.new(:_id, id) if Mongoid::Config.immutable_ids
+
+          Mongoid::Warnings.warn_mutable_ids
         end
       end
     end

data/lib/mongoid/association/nested.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 require 'mongoid/association/nested/nested_buildable'
 require 'mongoid/association/nested/many'
@@ -8,9 +7,8 @@ require 'mongoid/association/nested/one'
 module Mongoid
   module Association
     module Nested
-
       # The flags indicating that an association can be destroyed.
-      DESTROY_FLAGS = [1, "1", true, "true"].freeze
+      DESTROY_FLAGS = [ 1, '1', true, 'true' ].freeze
     end
   end
 end

data/lib/mongoid/association/one.rb

@@ -1,13 +1,10 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   module Association
-
     # This is the superclass for one to one relations and defines the common
     # behavior or those proxies.
     class One < Association::Proxy
-
       # Clear this relation - same as calling #delete on the document.
       #
       # @example Clear the relation.