mongoid 7.4.3 → 8.0.7

data/lib/mongoid/association/referenced/has_many/proxy.rb

@@ -25,7 +25,7 @@ module Mongoid
           # @example Concat with other documents.
           #   person.posts.concat([ post_one, post_two ])
           #
-          # @param [ Document, Array<Document> ] args Any number of documents.
+          # @param [ Document | Array<Document> ] args Any number of documents.
           #
           # @return [ Array<Document> ] The loaded docs.
           def <<(*args)
@@ -71,10 +71,11 @@ module Mongoid
           #
           # @return [ Document ] The new document.
           def build(attributes = {}, type = nil)
-            doc = Factory.build(type || klass, attributes)
+            doc = Factory.execute_build(type || klass, attributes, execute_callbacks: false)
             append(doc)
             doc.apply_post_processed_defaults
             yield(doc) if block_given?
+            doc.run_pending_callbacks
             doc.run_callbacks(:build) { doc }
             doc
           end
@@ -92,16 +93,22 @@ module Mongoid
           #
           # @return [ Document ] The matching document.
           def delete(document)
-            execute_callback :before_remove, document
-            _target.delete(document) do |doc|
-              if doc
-                unbind_one(doc)
-                cascade!(doc) if !_assigning?
+            execute_callbacks_around(:remove, document) do
+              _target.delete(document) do |doc|
+                if doc
+                  unbind_one(doc)
+                  cascade!(doc) if !_assigning?
+                end
+              end.tap do
+                reset_unloaded
               end
-              execute_callback :after_remove, doc
             end
           end
 
+          # Mongoid::Extensions::Array defines Array#delete_one, so we need
+          # to make sure that method behaves reasonably on proxies, too.
+          alias delete_one delete
+
           # Deletes all related documents from the database given the supplied
           # conditions.
           #
@@ -165,7 +172,7 @@ module Mongoid
           # @example Are there persisted documents?
           #   person.posts.exists?
           #
-          # @return [ true, false ] True is persisted documents exist, false if not.
+          # @return [ true | false ] True is persisted documents exist, false if not.
           def exists?
             criteria.exists?
           end
@@ -181,6 +188,9 @@ module Mongoid
           # of those found by the current Criteria object for which the block
           # returns a truthy value.
           #
+          # @note Each argument can be an individual id, an array of ids or
+          #   a nested array. Each array will be flattened.
+          #
           # @example Find by an id.
           #   person.posts.find(BSON::ObjectId.new)
           #
@@ -193,7 +203,7 @@ module Mongoid
           # @note This will keep matching documents in memory for iteration
           #   later.
           #
-          # @param [ BSON::ObjectId, Array<BSON::ObjectId> ] args The ids.
+          # @param [ Object | Array<Object> ] *args The ids.
           # @param [ Proc ] block Optional block to pass.
           #
           # @return [ Document | Array<Document> | nil ] A document or matching documents.
@@ -325,7 +335,7 @@ module Mongoid
           #   relation.with_add_callbacks(document, false)
           #
           # @param [ Document ] document The document to append to the target.
-          # @param [ true, false ] already_related Whether the document is already related
+          # @param [ true | false ] already_related Whether the document is already related
           #   to the target.
           def with_add_callbacks(document, already_related)
             execute_callback :before_add, document unless already_related
@@ -340,7 +350,7 @@ module Mongoid
           #
           # @param [ Document ] document The document to possibly append to the target.
           #
-          # @return [ true, false ] Whether the document is already related to the base and the
+          # @return [ true | false ] Whether the document is already related to the base and the
           #   association is persisted.
           def already_related?(document)
             document.persisted? &&
@@ -388,7 +398,7 @@ module Mongoid
           #
           # @param [ Document ] document The document to cascade on.
           #
-          # @return [ true, false ] If the association is destructive.
+          # @return [ true | false ] If the association is destructive.
           def cascade!(document)
             if persistable?
               case _association.dependent
@@ -407,11 +417,11 @@ module Mongoid
           #
           # If the method exists on the array, use the default proxy behavior.
           #
-          # @param [ Symbol, String ] name The name of the method.
+          # @param [ Symbol | String ] name The name of the method.
           # @param [ Array ] args The method args
           # @param [ Proc ] block Optional block to pass.
           #
-          # @return [ Criteria, Object ] A Criteria or return value from the target.
+          # @return [ Criteria | Object ] A Criteria or return value from the target.
           ruby2_keywords def method_missing(name, *args, &block)
             if _target.respond_to?(name)
               _target.send(name, *args, &block)
@@ -447,7 +457,7 @@ module Mongoid
           # @example Can we persist the association?
           #   relation.persistable?
           #
-          # @return [ true, false ] If the association is persistable.
+          # @return [ true | false ] If the association is persistable.
           def persistable?
             !_binding? && (_creating? || _base.persisted? && !_building?)
           end

data/lib/mongoid/association/referenced/has_many.rb

@@ -118,7 +118,7 @@ module Mongoid
         #
         # @note Only relevant for polymorphic associations.
         #
-        # @return [ String, nil ] The type field.
+        # @return [ String | nil ] The type field.
         def type
           @type ||= "#{as}_type" if polymorphic?
         end
@@ -140,7 +140,7 @@ module Mongoid
 
         # Is this association polymorphic?
         #
-        # @return [ true, false ] Whether this association is polymorphic.
+        # @return [ true | false ] Whether this association is polymorphic.
         def polymorphic?
           @polymorphic ||= !!as
         end
@@ -150,7 +150,7 @@ module Mongoid
         #
         # @param [ Document ] doc The document to be bound.
         #
-        # @return [ true, false ] Whether the document can be bound.
+        # @return [ true | false ] Whether the document can be bound.
         def bindable?(doc)
           forced_nil_inverse? || (!!inverse && doc.fields.keys.include?(foreign_key))
         end

data/lib/mongoid/association/referenced/has_one/buildable.rb

@@ -53,7 +53,7 @@ module Mongoid
           end
 
           def execute_query(object, base)
-            query_criteria(object, base).limit(1).first(id_sort: :none)
+            query_criteria(object, base).take
           end
 
           def with_polymorphic_criterion(criteria, base)

data/lib/mongoid/association/referenced/has_one/nested_builder.rb

@@ -60,7 +60,7 @@ module Mongoid
           # @example Is the id acceptable?
           #   one.acceptable_id?
           #
-          # @return [ true, false ] If the id part of the logic will allow an update.
+          # @return [ true | false ] If the id part of the logic will allow an update.
           def acceptable_id?
             id = convert_id(existing.class, attributes[:_id])
             existing._id == id || id.nil? || (existing._id != id && update_only?)
@@ -71,7 +71,7 @@ module Mongoid
           # @example Can the existing object be deleted?
           #   one.delete?
           #
-          # @return [ true, false ] If the association should be deleted.
+          # @return [ true | false ] If the association should be deleted.
           def delete?
             destroyable? && !attributes[:_id].nil?
           end
@@ -81,7 +81,7 @@ module Mongoid
           # @example Is the object destroyable?
           #   one.destroyable?({ :_destroy => "1" })
           #
-          # @return [ true, false ] If the association can potentially be
+          # @return [ true | false ] If the association can potentially be
           #   destroyed.
           def destroyable?
             [ 1, "1", true, "true" ].include?(destroy) && allow_destroy?
@@ -92,7 +92,7 @@ module Mongoid
           # @example Is the document to be replaced?
           #   one.replace?
           #
-          # @return [ true, false ] If the document should be replaced.
+          # @return [ true | false ] If the document should be replaced.
           def replace?
             !existing && !destroyable? && !attributes.blank?
           end
@@ -102,7 +102,7 @@ module Mongoid
           # @example Should the document be updated?
           #   one.update?
           #
-          # @return [ true, false ] If the object should have its attributes updated.
+          # @return [ true | false ] If the object should have its attributes updated.
           def update?
             existing && !destroyable? && acceptable_id?
           end

data/lib/mongoid/association/referenced/has_one/proxy.rb

@@ -49,17 +49,14 @@ module Mongoid
           #
           # @return [ One ] The association.
           def substitute(replacement)
-            # If the same object currently associated is being assigned,
-            # rebind the association and save the target but do not destroy
-            # the target.
-
-            unbind_one
-            if persistable?
-              # TODO can this entire method be skipped if self == replacement?
-              if _association.destructive? && self != replacement
-                send(_association.dependent)
-              else
-                save if persisted?
+            if self != replacement
+              unbind_one
+              if persistable?
+                if _association.destructive?
+                  send(_association.dependent)
+                else
+                  save if persisted?
+                end
               end
             end
             HasOne::Proxy.new(_base, replacement, _association) if replacement
@@ -82,7 +79,7 @@ module Mongoid
           # @example Can we persist the association?
           #   relation.persistable?
           #
-          # @return [ true, false ] If the association is persistable.
+          # @return [ true | false ] If the association is persistable.
           def persistable?
             _base.persisted? && !_binding? && !_building?
           end

data/lib/mongoid/association/referenced/has_one.rb

@@ -92,7 +92,7 @@ module Mongoid
 
         # Is this association polymorphic?
         #
-        # @return [ true, false ] Whether this association is polymorphic.
+        # @return [ true | false ] Whether this association is polymorphic.
         def polymorphic?
           @polymorphic ||= !!as
         end
@@ -101,7 +101,7 @@ module Mongoid
         #
         # @note Only relevant for polymorphic associations.
         #
-        # @return [ String, nil ] The type field.
+        # @return [ String | nil ] The type field.
         def type
           @type ||= "#{as}_type" if polymorphic?
         end
@@ -111,7 +111,7 @@ module Mongoid
         #
         # @param [ Document ] doc The document to be bound.
         #
-        # @return [ true, false ] Whether the document can be bound.
+        # @return [ true | false ] Whether the document can be bound.
         def bindable?(doc)
           forced_nil_inverse? || (!!inverse && doc.fields.keys.include?(foreign_key))
         end

data/lib/mongoid/association/referenced/syncable.rb

@@ -16,7 +16,7 @@ module Mongoid
         #
         # @param [ Association ] association The association metadata.
         #
-        # @return [ true, false ] If we can sync.
+        # @return [ true | false ] If we can sync.
         def _syncable?(association)
           !_synced?(association.foreign_key) && send(association.foreign_key_check)
         end
@@ -38,7 +38,7 @@ module Mongoid
         #
         # @param [ String ] foreign_key The foreign key.
         #
-        # @return [ true, false ] If we can sync.
+        # @return [ true | false ] If we can sync.
         def _synced?(foreign_key)
           !!_synced[foreign_key]
         end
@@ -67,8 +67,8 @@ module Mongoid
         #
         # @return [ Object ] The updated values.
         def update_inverse_keys(association)
-          if changes.has_key?(association.foreign_key)
-            old, new = changes[association.foreign_key]
+          if previous_changes.has_key?(association.foreign_key)
+            old, new = previous_changes[association.foreign_key]
             adds, subs = new - (old || []), (old || []) - new
 
             # If we are autosaving we don't want a duplicate to get added - the

data/lib/mongoid/association/reflections.rb

@@ -13,7 +13,7 @@ module Mongoid
       # @example Find association metadata by name.
       #   person.reflect_on_association(:addresses)
       #
-      # @param [ String, Symbol ] name The name of the association to find.
+      # @param [ String | Symbol ] name The name of the association to find.
       #
       # @return [ Association ] The matching association metadata.
       def reflect_on_association(name)
@@ -39,7 +39,7 @@ module Mongoid
         # @example Find association metadata by name.
         #   Person.reflect_on_association(:addresses)
         #
-        # @param [ String, Symbol ] name The name of the association to find.
+        # @param [ String | Symbol ] name The name of the association to find.
         #
         # @return [ Association ] The matching association metadata.
         def reflect_on_association(name)

data/lib/mongoid/association/relatable.rb

@@ -69,7 +69,7 @@ module Mongoid
       #
       # @param [ Symbol ] callback_type The type of callback type.
       #
-      # @return [ Array<Proc, Symbol> ] A list of the callbacks, either method
+      # @return [ Array<Proc | Symbol> ] A list of the callbacks, either method
       #   names or Procs.
       def get_callbacks(callback_type)
         Array(options[callback_type])
@@ -88,7 +88,7 @@ module Mongoid
       #
       # @param [ Document ] doc The document to be bound.
       #
-      # @return [ true, false ] Whether the document can be bound.
+      # @return [ true | false ] Whether the document can be bound.
       def bindable?(doc); false; end
 
       # Get the inverse names.
@@ -189,7 +189,7 @@ module Mongoid
       # The foreign key field if this association stores a foreign key.
       # Otherwise, the primary key.
       #
-      # @return [ Symbol, String ] The primary key.
+      # @return [ Symbol | String ] The primary key.
       def key
         stores_foreign_key? ? foreign_key : primary_key
       end
@@ -242,13 +242,13 @@ module Mongoid
       #
       # @return [ String ] The foreign key check.
       def foreign_key_check
-        @foreign_key_check ||= "#{foreign_key}_changed?" if (stores_foreign_key? && foreign_key)
+        @foreign_key_check ||= "#{foreign_key}_previously_changed?" if (stores_foreign_key? && foreign_key)
       end
 
       # Create an association proxy object using the owner and target.
       #
       # @param [ Document ] owner The document this association hangs off of.
-      # @param [ Document, Array<Document> ] target The target (parent) of the
+      # @param [ Document | Array<Document> ] target The target (parent) of the
       #   association.
       #
       # @return [ Proxy ]
@@ -258,7 +258,7 @@ module Mongoid
 
       # Whether the dependent method is destructive.
       #
-      # @return [ true, false ] If the dependent method is destructive.
+      # @return [ true | false ] If the dependent method is destructive.
       def destructive?
         @destructive ||= !!(dependent && (dependent == :delete_all || dependent == :destroy))
       end
@@ -289,7 +289,7 @@ module Mongoid
 
       # Whether the associated object(s) should be validated.
       #
-      # @return [ true, false ] If the associated object(s)
+      # @return [ true | false ] If the associated object(s)
       #   should be validated.
       def validate?
         @validate ||= if @options[:validate].nil?
@@ -299,6 +299,35 @@ module Mongoid
                       end
       end
 
+      # @return [ Array<String> ] The associations above this one in the inclusion tree.
+      attr_accessor :parent_inclusions
+
+      def parent_inclusions
+        @parent_inclusions ||= []
+      end
+
+      # Is this association an embeds_many or has_many association?
+      #
+      # @return [ true | false ] true if it is a *_many association, false if not.
+      def many?
+        [Referenced::HasMany, Embedded::EmbedsMany].any? { |a| self.is_a?(a) }
+      end
+
+      # Is this association an embeds_one or has_one association?
+      #
+      # @return [ true | false ] true if it is a *_one association, false if not.
+      def one?
+        [Referenced::HasOne, Embedded::EmbedsOne].any? { |a| self.is_a?(a) }
+      end
+
+      # Is this association an embedded_in or belongs_to association?
+      #
+      # @return [ true | false ] true if it is an embedded_in or belongs_to
+      #   association, false if not.
+      def in_to?
+        [Referenced::BelongsTo, Embedded::EmbeddedIn].any? { |a| self.is_a?(a) }
+      end
+
       private
 
       # Gets the model classes with inverse associations of this model. This is used to determine
@@ -404,10 +433,15 @@ module Mongoid
       def namespace_hierarchy(mod)
         parent = Object
         hier = [parent]
-        mod.name.split('::').each do |part|
-          parent = parent.const_get(part)
-          hier << parent
+
+        # name is not present on anonymous modules
+        if mod.name
+          mod.name.split('::').each do |part|
+            parent = parent.const_get(part)
+            hier << parent
+          end
         end
+
         hier.reverse
       end
 

data/lib/mongoid/association.rb

@@ -56,7 +56,7 @@ module Mongoid
     # @example Is the document embedded?
     #   address.embedded?
     #
-    # @return [ true, false ] True if the document has a parent document.
+    # @return [ true | false ] True if the document has a parent document.
     def embedded?
       @embedded ||= (cyclic ? _parent.present? : self.class.embedded?)
     end
@@ -66,7 +66,7 @@ module Mongoid
     # @example Is the document in an embeds many?
     #   address.embedded_many?
     #
-    # @return [ true, false ] True if in an embeds many.
+    # @return [ true | false ] True if in an embeds many.
     def embedded_many?
       _association && _association.is_a?(Association::Embedded::EmbedsMany)
     end
@@ -76,7 +76,7 @@ module Mongoid
     # @example Is the document in an embeds one?
     #   address.embedded_one?
     #
-    # @return [ true, false ] True if in an embeds one.
+    # @return [ true | false ] True if in an embeds one.
     def embedded_one?
       _association && _association.is_a?(Association::Embedded::EmbedsOne)
     end
@@ -100,7 +100,7 @@ module Mongoid
     # @example Is the document in a references many?
     #   post.referenced_many?
     #
-    # @return [ true, false ] True if in a references many.
+    # @return [ true | false ] True if in a references many.
     def referenced_many?
       _association && _association.is_a?(Association::Referenced::HasMany)
     end
@@ -110,7 +110,7 @@ module Mongoid
     # @example Is the document in a references one?
     #   address.referenced_one?
     #
-    # @return [ true, false ] True if in a references one.
+    # @return [ true | false ] True if in a references one.
     def referenced_one?
       _association && _association.is_a?(Association::Referenced::HasOne)
     end

data/lib/mongoid/atomic/modifiers.rb

@@ -153,7 +153,7 @@ module Mongoid
       #
       # @param [ String ] field The field.
       #
-      # @return [ true, false ] If this field is a conflict.
+      # @return [ true | false ] If this field is a conflict.
       def set_conflict?(field)
         name = field.split(".", 2)[0]
         pull_fields.has_key?(name) || push_fields.has_key?(name)
@@ -166,7 +166,7 @@ module Mongoid
       #
       # @param [ String ] field The field.
       #
-      # @return [ true, false ] If this field is a conflict.
+      # @return [ true | false ] If this field is a conflict.
       def push_conflict?(field)
         name = field.split(".", 2)[0]
         set_fields.has_key?(name) || pull_fields.has_key?(name) ||

data/lib/mongoid/atomic.rb

@@ -311,6 +311,13 @@ module Mongoid
 
     private
 
+    # Clears all pending atomic updates.
+    def reset_atomic_updates!
+      Atomic::UPDATES.each do |update|
+        send(update).clear
+      end
+    end
+
     # Generates the atomic updates in the correct order.
     #
     # @example Generate the updates.

data/lib/mongoid/attributes/dynamic.rb

@@ -13,9 +13,9 @@ module Mongoid
       #   person.respond_to?(:title)
       #
       # @param [ Array ] name The name of the method.
-      # @param [ true, false ] include_private
+      # @param [ true | false ] include_private
       #
-      # @return [ true, false ] True if it does, false if not.
+      # @return [ true | false ] True if it does, false if not.
       def respond_to?(name, include_private = false)
         super || (
           attributes &&
@@ -114,7 +114,7 @@ module Mongoid
       # @example Call through method_missing.
       #   document.method_missing(:test)
       #
-      # @param [ String, Symbol ] name The name of the method.
+      # @param [ String | Symbol ] name The name of the method.
       # @param [ Array ] args The arguments to the method.
       #
       # @return [ Object ] The result of the method call.

data/lib/mongoid/attributes/nested.rb

@@ -33,15 +33,15 @@ module Mongoid
         #     accepts_nested_attributes_for :addresses, :game, :posts
         #   end
         #
-        # @param [ Array<Symbol>, Hash ] args A list of association names, followed
+        # @param [ Array<Symbol> | Hash ] args A list of association names, followed
         #   by a hash of options.
         #
-        # @option *args [ true, false ] :allow_destroy Can deletion occur?
-        # @option *args [ Proc, Symbol ] :reject_if Block or symbol pointing
+        # @option *args [ true | false ] :allow_destroy Can deletion occur?
+        # @option *args [ Proc | Symbol ] :reject_if Block or symbol pointing
         #   to a class method to reject documents with.
         # @option *args [ Integer ] :limit The max number to create.
-        # @option *args [ true, false ] :update_only Only update existing docs.
-        # @options *args [ true, false ] :autosave Whether autosave should be enabled on the
+        # @option *args [ true | false ] :update_only Only update existing docs.
+        # @option *args [ true | false ] :autosave Whether autosave should be enabled on the
         #   association. Note that since the default is true, setting autosave to nil will still
         #   enable it.
         def accepts_nested_attributes_for(*args)

data/lib/mongoid/attributes/processing.rb

@@ -40,18 +40,49 @@ module Mongoid
       # @param [ Symbol ] key The name of the attribute.
       # @param [ Object ] value The value of the attribute.
       #
-      # @return [ true, false ] True if pending, false if not.
+      # @return [ true | false ] True if pending, false if not.
       def pending_attribute?(key, value)
         name = key.to_s
-        if relations.has_key?(name)
-          pending_relations[name] = value
+        aliased = if aliased_associations.key?(name)
+          aliased_associations[name]
+        else
+          name
+        end
+        if relations.has_key?(aliased)
+          set_pending_relation(name, aliased, value)
           return true
         end
-        if nested_attributes.has_key?(name)
-          pending_nested[name] = value
+        if nested_attributes.has_key?(aliased)
+          set_pending_nested(name, aliased, value)
           return true
         end
-        return false
+        false
+      end
+
+      # Set value of the pending relation.
+      #
+      # @param [ Symbol ] name The name of the relation.
+      # @param [ Symbol ] aliased The aliased name of the relation.
+      # @param [ Object ] value The value of the relation.
+      def set_pending_relation(name, aliased, value)
+        if stored_as_associations.include?(name)
+          pending_relations[aliased] = value
+        else
+          pending_relations[name] = value
+        end
+      end
+
+      # Set value of the pending nested attribute.
+      #
+      # @param [ Symbol ] name The name of the nested attribute.
+      # @param [ Symbol ] aliased The aliased name of the nested attribute.
+      # @param [ Object ] value The value of the nested attribute.
+      def set_pending_nested(name, aliased, value)
+        if stored_as_associations.include?(name)
+          pending_nested[aliased] = value
+        else
+          pending_nested[name] = value
+        end
       end
 
       # Get all the pending associations that need to be set.

data/lib/mongoid/attributes/projector.rb

@@ -41,7 +41,7 @@ module Mongoid
       #
       # @param [ String ] name The name of the attribute or a dot notation path.
       #
-      # @return [ true, false ] Whether the attribute is allowed by projection.
+      # @return [ true | false ] Whether the attribute is allowed by projection.
       #
       # @api private
       def attribute_or_path_allowed?(name)

data/lib/mongoid/attributes/readonly.rb

@@ -17,9 +17,9 @@ module Mongoid
       # @example Can we write the attribute?
       #   model.attribute_writable?(:title)
       #
-      # @param [ String, Symbol ] name The name of the field.
+      # @param [ String | Symbol ] name The name of the field.
       #
-      # @return [ true, false ] If the document is new, or if the field is not
+      # @return [ true | false ] If the document is new, or if the field is not
       #   readonly.
       def attribute_writable?(name)
         new_record? || (!readonly_attributes.include?(name) && _loaded?(name))