mongoid 7.5.4 → 8.1.9

data/lib/mongoid/association/builders.rb

@@ -27,7 +27,7 @@ module Mongoid
       # @example Parse the args.
       #   doc.parse_args(:name => "Joe")
       #
-      # @param [ Array ] args The arguments.
+      # @param [ Hash... ] *args The arguments.
       #
       # @return [ Array<Hash> ] The attributes and options.
       def parse_args(*args)
@@ -46,9 +46,10 @@ module Mongoid
         association.inverse_class.tap do |klass|
           klass.re_define_method("build_#{association.name}") do |*args|
             attributes, _options = parse_args(*args)
-            document = Factory.build(association.relation_class, attributes)
+            document = Factory.execute_build(association.relation_class, attributes, execute_callbacks: false)
             _building do
               child = send("#{association.name}=", document)
+              child.run_pending_callbacks
               child.run_callbacks(:build)
               child
             end
@@ -69,10 +70,11 @@ module Mongoid
         association.inverse_class.tap do |klass|
           klass.re_define_method("create_#{association.name}") do |*args|
             attributes, _options = parse_args(*args)
-            document = Factory.build(association.relation_class, attributes)
+            document = Factory.execute_build(association.relation_class, attributes, execute_callbacks: false)
             doc = _assigning do
               send("#{association.name}=", document)
             end
+            doc.run_pending_callbacks
             doc.save
             save if new_record? && association.stores_foreign_key?
             doc

data/lib/mongoid/association/constrainable.rb

@@ -5,7 +5,6 @@ module Mongoid
 
     # Used for converting foreign key values to the correct type based on the
     # types of ids that the document stores.
-    #
     module Constrainable
 
       # Convert the supplied object to the appropriate type to set as the

data/lib/mongoid/association/eager_loadable.rb

@@ -20,13 +20,38 @@ module Mongoid
         end
       end
 
-      def preload(relations, docs)
-        relations.group_by(&:inverse_class_name)
-            .values
-            .each do |associations|
-          associations.group_by(&:relation)
-              .each do |relation, association|
-            relation.eager_loader(association, docs).run
+      # Load the associations for the given documents. This will be done
+      # recursively to load the associations of the given documents'
+      # subdocuments.
+      #
+      # @param [ Array<Association> ] associations The associations to load.
+      # @param [ Array<Document> ] document The documents.
+      def preload(associations, docs)
+        assoc_map = associations.group_by(&:inverse_class_name)
+        docs_map = {}
+        queue = [ klass.to_s ]
+
+        # account for single-collection inheritance
+        queue.push(klass.root_class.to_s) if klass != klass.root_class
+
+        while klass = queue.shift
+          if as = assoc_map.delete(klass)
+            as.each do |assoc|
+              queue << assoc.class_name
+
+              # If this class is nested in the inclusion tree, only load documents
+              # for the association above it. If there is no parent association,
+              # we will include documents from the documents passed to this method.
+              ds = docs
+              if assoc.parent_inclusions.length > 0
+                ds = assoc.parent_inclusions.map{ |p| docs_map[p].to_a }.flatten
+              end
+
+              res = assoc.relation.eager_loader([assoc], ds).run
+
+              docs_map[assoc.name] ||= [].to_set
+              docs_map[assoc.name].merge(res)
+            end
           end
         end
       end

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

@@ -50,7 +50,7 @@ module Mongoid
           _unscoped.clear
         end
 
-        # Batch remove the provided documents as a $pullAll.
+        # Batch remove the provided documents as a $pullAll or $pull.
         #
         # @example Batch remove the documents.
         #   batchable.batch_remove([ doc_one, doc_two ])
@@ -58,13 +58,36 @@ module Mongoid
         # @param [ Array<Document> ] docs The docs to remove.
         # @param [ Symbol ] method Delete or destroy.
         def batch_remove(docs, method = :delete)
+          # If the _id is nil, we cannot use $pull and delete by searching for
+          # the id. Therefore we have to use pullAll with the documents'
+          # attributes.
           removals = pre_process_batch_remove(docs, method)
+          pulls, pull_alls = removals.partition { |o| !o["_id"].nil? }
+
+          if !_base.persisted?
+            post_process_batch_remove(docs, method) unless docs.empty?
+            return reindex
+          end
+
           if !docs.empty?
-            collection.find(selector).update_one(
-                positionally(selector, "$pullAll" => { path => removals }),
+            if !pulls.empty?
+              collection.find(selector).update_one(
+                positionally(selector, "$pull" => { path => { "_id" => { "$in" => pulls.pluck("_id") } } }),
                 session: _session
-            )
+              )
+            end
+            if !pull_alls.empty?
+              collection.find(selector).update_one(
+                positionally(selector, "$pullAll" => { path => pull_alls }),
+                session: _session
+              )
+            end
             post_process_batch_remove(docs, method)
+          else
+            collection.find(selector).update_one(
+              positionally(selector, "$set" => { path => [] }),
+              session: _session
+            )
           end
           reindex
         end
@@ -74,7 +97,7 @@ module Mongoid
         # @example Batch replace the documents.
         #   batchable.batch_replace([ doc_one, doc_two ])
         #
-        # @param [ Array<Document> ] docs The docs to replace with.
+        # @param [ Array<Document> | Array<Hash> ] docs The docs to replace with.
         #
         # @return [ Array<Hash> ] The inserts.
         def batch_replace(docs)
@@ -90,7 +113,7 @@ module Mongoid
               batch_remove(_target.dup)
             end
           elsif _target != docs
-            _base.delayed_atomic_sets.clear unless _assigning?
+            _base.delayed_atomic_sets.delete(path) unless _assigning?
             docs = normalize_docs(docs).compact
             _target.clear and _unscoped.clear
             _base.delayed_atomic_unsets.delete(path)
@@ -173,7 +196,7 @@ module Mongoid
         # @example Can inserts be performed?
         #   batchable.insertable?
         #
-        # @return [ true, false ] If inserts can be performed.
+        # @return [ true | false ] If inserts can be performed.
         def insertable?
           persistable? && !_assigning? && inserts_valid
         end
@@ -185,7 +208,7 @@ module Mongoid
         # @example Are the inserts currently valid.
         #   batchable.inserts_valid
         #
-        # @return [ true, false ] If inserts are currently valid.
+        # @return [ true | false ] If inserts are currently valid.
         def inserts_valid
           @inserts_valid
         end
@@ -197,9 +220,9 @@ module Mongoid
         # @example Set the flag.
         #   batchable.inserts_valid = true
         #
-        # @param [ true, false ] value The flag.
+        # @param [ true | false ] value The flag.
         #
-        # @return [ true, false ] The flag.
+        # @return [ true | false ] The flag.
         def inserts_valid=(value)
           @inserts_valid = value
         end
@@ -212,7 +235,7 @@ module Mongoid
         # @example Normalize the docs.
         #   batchable.normalize_docs(docs)
         #
-        # @param [ Array<Hash, Document> ] docs The docs to normalize.
+        # @param [ Array<Document> | Array<Hash> ] docs The docs to normalize.
         #
         # @return [ Array<Document> ] The docs.
         def normalize_docs(docs)

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

@@ -88,7 +88,7 @@ module Mongoid
           # @example Determine the child name.
           #   Role.cyclic_child_name
           #
-          # @param [ true, false ] many Is the a many association?
+          # @param [ true | false ] many Is the a many association?
           #
           # @return [ String ] "child_" plus the class name underscored in
           #   singular or plural form.

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

@@ -19,12 +19,14 @@ module Mongoid
           #   name.person.bind(:continue => true)
           #   name.person = Person.new
           def bind_one
-            _base._association = _association.inverse_association(_target) unless _base._association
-            _base.parentize(_target)
             binding do
+              check_polymorphic_inverses!(_target)
+              _base._association = _association.inverse_association(_target) unless _base._association
+              _base.parentize(_target)
               if _base.embedded_many?
                 _target.do_or_do_not(_association.inverse(_target)).push(_base)
               else
+                remove_associated(_target)
                 _target.do_or_do_not(_association.inverse_setter(_target), _base)
               end
             end
@@ -45,6 +47,26 @@ module Mongoid
               end
             end
           end
+
+          private
+
+          # Check for problems with multiple inverse definitions.
+          #
+          # @api private
+          #
+          # @example Check for inverses errors.
+          #   binding.check_inverses!(doc)
+          #
+          # @param [ Document ] doc The document to check.
+          def check_polymorphic_inverses!(doc)
+            if inverses = _association.inverses(doc)
+              if inverses.length > 1
+                raise Errors::InvalidSetPolymorphicRelation.new(
+                    _association.name, _base.class.name, _target.class.name
+                )
+              end
+            end
+          end
         end
       end
     end

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

@@ -15,8 +15,8 @@ module Mongoid
           # @example Build the document.
           #   Builder.new(meta, attrs).build
           #
-          # @param [ Object ] base The object.
-          # @param [ Object ] object The parent hash or document.
+          # @param [ Document ] base The object.
+          # @param [ Document | Hash ] object The parent hash or document.
           # @param [ String ] type Not used in this context.
           # @param [ Hash ] selected_fields Fields which were retrieved via
           #   #only. If selected_fields are specified, fields not listed in it

data/lib/mongoid/association/embedded/embedded_in/proxy.rb

@@ -30,9 +30,9 @@ module Mongoid
           # @example Substitute the new document.
           #   person.name.substitute(new_name)
           #
-          # @param [ Document ] replacement A document to replace the target.
+          # @param [ Document | Hash ] replacement A document to replace the target.
           #
-          # @return [ Document, nil ] The association or nil.
+          # @return [ Document | nil ] The association or nil.
           def substitute(replacement)
             unbind_one
             unless replacement
@@ -40,6 +40,7 @@ module Mongoid
               return nil
             end
             _base.new_record = true
+            replacement = Factory.build(klass, replacement) if replacement.is_a?(::Hash)
             self._target = replacement
             bind_one
             self
@@ -74,7 +75,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?
             _target.persisted? && !_binding? && !_building?
           end

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

@@ -75,7 +75,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?
           !!@options[:polymorphic]
         end
@@ -114,7 +114,8 @@ module Mongoid
                   rel.as == name &&
                   rel.relation_class_name == inverse_class_name
             end
-            matches.collect { |m| m.name }
+
+            matches.map { |m| m.name }
           end
         end
 

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

@@ -19,6 +19,7 @@ module Mongoid
           def bind_one(doc)
             doc.parentize(_base)
             binding do
+              remove_associated(doc)
               doc.do_or_do_not(_association.inverse_setter(_target), _base)
             end
           end

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

@@ -17,8 +17,9 @@ module Mongoid
           # @example Build the documents.
           #   Builder.new(meta, attrs).build
           #
-          # @param [ Object ] base The base object.
-          # @param [ Object ] object The object to use to build the association.
+          # @param [ Document ] base The base object.
+          # @param [ Array<Document> | Array<Hash> ] object The object to use
+          #   to build the association.
           # @param [ String ] type Not used in this context.
           # @param [ Hash ] selected_fields Fields which were retrieved via
           #   #only. If selected_fields are specified, fields not listed in it
@@ -31,7 +32,7 @@ module Mongoid
             docs = []
             object.each do |attrs|
               if _loading? && base.persisted?
-                docs.push(Factory.from_db(klass, attrs, nil, selected_fields))
+                docs.push(Factory.execute_from_db(klass, attrs, nil, selected_fields, execute_callbacks: false))
               else
                 docs.push(Factory.build(klass, attrs))
               end

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

@@ -19,7 +19,7 @@ module Mongoid
           # @example Push a document.
           #   person.addresses.push(address)
           #
-          # @param [ Document, Array<Document> ] args Any number of documents.
+          # @param [ Document... ] *args Any number of documents.
           def <<(*args)
             docs = args.flatten
             return concat(docs) if docs.size > 1
@@ -67,10 +67,11 @@ module Mongoid
           #
           # @return [ Document ] The new document.
           def build(attributes = {}, type = nil)
-            doc = Factory.build(type || _association.klass, attributes)
+            doc = Factory.execute_build(type || _association.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 }
             _base._reset_memoized_descendants!
             doc
@@ -94,6 +95,7 @@ module Mongoid
           # @return [ self ] The empty association.
           def clear
             batch_clear(_target.dup)
+            update_attributes_hash
             self
           end
 
@@ -115,7 +117,7 @@ module Mongoid
           # @example Use #persisted? inside block to count persisted documents.
           #   person.addresses.count { |a| a.persisted? && a.country == "FR" }
           #
-          # @param [ Object, Array<Object> ] args Args to delegate to the target.
+          # @param [ Object... ] *args Args to delegate to the target.
           #
           # @return [ Integer ] The total number of persisted embedded docs, as
           #   flagged by the #persisted? method.
@@ -133,22 +135,40 @@ module Mongoid
           #
           # @param [ Document ] document The document to be deleted.
           #
-          # @return [ Document, nil ] The deleted document or nil if nothing deleted.
+          # @return [ Document | nil ] The deleted document or nil if nothing deleted.
           def delete(document)
-            execute_callback :before_remove, document
-            doc = _target.delete_one(document)
-            if doc && !_binding?
-              _unscoped.delete_one(doc)
-              if _assigning?
-                _base.add_atomic_pull(doc)
-              else
-                doc.delete(suppress: true)
-                unbind_one(doc)
+            execute_callbacks_around(:remove, document) do
+              doc = _target.delete_one(document)
+              if doc && !_binding?
+                _unscoped.delete_one(doc)
+                if _assigning?
+                  _base.add_atomic_pull(doc)
+                else
+                  doc.delete(suppress: true)
+                  unbind_one(doc)
+                end
+                update_attributes_hash
               end
+              reindex
+              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
+
+          # Removes a single document from the collection *in memory only*.
+          # It will *not* persist the change.
+          #
+          # @param [ Document ] document The document to delete.
+          #
+          # @api private
+          def _remove(document)
+            _target.delete_one(document)
+            _unscoped.delete_one(document)
+            update_attributes_hash
             reindex
-            execute_callback :after_remove, document
-            doc
           end
 
           # Delete all the documents in the association without running callbacks.
@@ -173,7 +193,7 @@ module Mongoid
           #     doc.state == "GA"
           #   end
           #
-          # @return [ Many, Enumerator ] The association or an enumerator if no
+          # @return [ Many | Enumerator ] The association or an enumerator if no
           #   block was provided.
           def delete_if
             if block_given?
@@ -207,9 +227,24 @@ module Mongoid
           # @example Are there persisted documents?
           #   person.posts.exists?
           #
-          # @return [ true, false ] True is persisted documents exist, false if not.
-          def exists?
-            count > 0
+          # @param [ :none | nil | false | Hash | Object ] id_or_conditions
+          #   When :none (the default), returns true if any persisted
+          #   documents exist in the association. When nil or false, this
+          #   will always return false. When a Hash is given, this queries
+          #   the documents in the association for those that match the given
+          #   conditions, and returns true if any match which have been
+          #   persisted. Any other argument is interpreted as an id, and
+          #   queries for the existence of persisted documents in the
+          #   association with a matching _id.
+          #
+          # @return [ true | false ] True if persisted documents exist, false if not.
+          def exists?(id_or_conditions = :none)
+            case id_or_conditions
+            when :none then _target.any?(&:persisted?)
+            when nil, false then false
+            when Hash then where(id_or_conditions).any?(&:persisted?)
+            else where(_id: id_or_conditions).any?(&:persisted?)
+            end
           end
 
           # Finds a document in this association through several different
@@ -232,7 +267,7 @@ module Mongoid
           # @example Finds the first matching document using a block.
           #   person.addresses.find { |addr| addr.state == 'CA' }
           #
-          # @param [ Array<Object> ] args Various arguments.
+          # @param [ Object... ] *args Various arguments.
           # @param [ Proc ] block Optional block to pass.
           #
           # @return [ Document | Array<Document> | nil ] A document or matching documents.
@@ -256,6 +291,7 @@ module Mongoid
                 integrate(doc)
                 doc._index = index
               end
+              update_attributes_hash
               @_unscoped = _target.dup
               @_target = scope(_target)
             end
@@ -283,7 +319,7 @@ module Mongoid
           # @param [ Integer ] count The number of documents to pop, or 1 if not
           #   provided.
           #
-          # @return [ Document, Array<Document> ] The popped document(s).
+          # @return [ Document | Array<Document> ] The popped document(s).
           def pop(count = nil)
             if count
               if docs = _target[_target.size - count, _target.size]
@@ -291,6 +327,8 @@ module Mongoid
               end
             else
               delete(_target[-1])
+            end.tap do
+              update_attributes_hash
             end
           end
 
@@ -306,7 +344,7 @@ module Mongoid
           # @param [ Integer ] count The number of documents to shift, or 1 if not
           #   provided.
           #
-          # @return [ Document, Array<Document> ] The shifted document(s).
+          # @return [ Document | Array<Document> ] The shifted document(s).
           def shift(count = nil)
             if count
               if _target.size > 0 && docs = _target[0, count]
@@ -314,6 +352,8 @@ module Mongoid
               end
             else
               delete(_target[0])
+            end.tap do
+              update_attributes_hash
             end
           end
 
@@ -323,11 +363,12 @@ module Mongoid
           # @example Substitute the association's target.
           #   person.addresses.substitute([ address ])
           #
-          # @param [ Array<Document> ] docs The replacement docs.
+          # @param [ Array<Document> | Array<Hash> ] docs The replacement docs.
           #
           # @return [ Many ] The proxied association.
           def substitute(docs)
             batch_replace(docs)
+            update_attributes_hash
             self
           end
 
@@ -365,6 +406,7 @@ module Mongoid
             end
             _unscoped.push(document)
             integrate(document)
+            update_attributes_hash
             document._index = _unscoped.size - 1
             execute_callback :after_add, document
           end
@@ -387,20 +429,6 @@ module Mongoid
             _association.criteria(_base, _target)
           end
 
-          # Deletes one document from the target and unscoped.
-          #
-          # @api private
-          #
-          # @example Delete one document.
-          #   relation.delete_one(doc)
-          #
-          # @param [ Document ] document The document to delete.
-          def delete_one(document)
-            _target.delete_one(document)
-            _unscoped.delete_one(document)
-            reindex
-          end
-
           # Integrate the document into the association. will set its metadata and
           # attempt to bind the inverse.
           #
@@ -418,11 +446,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 [ Array ] args The method args
+          # @param [ Symbol | String ] name The name of the method.
+          # @param [ Object... ] *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)
             return super if _target.respond_to?(name)
             klass.send(:with_scope, criteria) do
@@ -435,7 +463,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?
           end
@@ -479,13 +507,14 @@ module Mongoid
           #   relation.remove_all({ :num => 1 }, true)
           #
           # @param [ Hash ] conditions Conditions to filter by.
-          # @param [ true, false ] method :delete or :destroy.
+          # @param [ true | false ] method :delete or :destroy.
           #
           # @return [ Integer ] The number of documents removed.
           def remove_all(conditions = {}, method = :delete)
             criteria = where(conditions || {})
             removed = criteria.size
             batch_remove(criteria, method)
+            update_attributes_hash
             removed
           end
 
@@ -511,12 +540,22 @@ module Mongoid
             @_unscoped = docs
           end
 
+          # Returns a list of attributes hashes for each document.
+          #
+          # @return [ Array<Hash> ] The list of attributes hashes
           def as_attributes
-            attributes = []
-            _unscoped.each do |doc|
-              attributes.push(doc.as_document)
+            _unscoped.map { |doc| doc.send(:as_attributes) }
+          end
+
+          # Update the _base's attributes hash with the _target's attributes
+          #
+          # @api private
+          def update_attributes_hash
+            if !_target.empty?
+              _base.attributes.merge!(_association.store_as => _target.map(&:attributes))
+            else
+              _base.attributes.delete(_association.store_as)
             end
-            attributes
           end
 
           class << self

data/lib/mongoid/association/embedded/embeds_many.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 ||= !!@options[:as]
         end
@@ -101,7 +101,7 @@ module Mongoid
         #
         # @note Only relevant if the association is polymorphic.
         #
-        # @return [ String, nil ] The field for storing the associated object's type.
+        # @return [ String | nil ] The field for storing the associated object's type.
         def type
           @type ||= "#{as}_type" if polymorphic?
         end