mongoid 7.0.5 → 8.1.5

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'mongoid/association/embedded/batchable'
 
 module Mongoid
@@ -8,7 +10,7 @@ module Mongoid
         class Proxy < Association::Many
           include Batchable
 
-          # Appends a document or array of documents to the relation. Will set
+          # Appends a document or array of documents to the association. Will set
           # the parent and update the index in the process.
           #
           # @example Append a document.
@@ -17,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
@@ -30,19 +32,17 @@ module Mongoid
 
           alias :push :<<
 
-          # Get this relation as as its representation in the database.
+          # Get this association as as its representation in the database.
           #
-          # @example Convert the relation to an attributes hash.
+          # @example Convert the association to an attributes hash.
           #   person.addresses.as_document
           #
-          # @return [ Array<Hash> ] The relation as stored in the db.
-          #
-          # @since 2.0.0.rc.1
+          # @return [ Array<Hash> ] The association as stored in the db.
           def as_document
             as_attributes.collect { |attrs| BSON::Document.new(attrs) }
           end
 
-          # Appends an array of documents to the relation. Performs a batch
+          # Appends an array of documents to the association. Performs a batch
           # insert of the documents instead of persisting one at a time.
           #
           # @example Concat with other documents.
@@ -51,17 +51,15 @@ module Mongoid
           # @param [ Array<Document> ] docs The docs to add.
           #
           # @return [ Array<Document> ] The documents.
-          #
-          # @since 2.4.0
           def concat(docs)
             batch_insert(docs) unless docs.empty?
             self
           end
 
-          # Builds a new document in the relation and appends it to the target.
+          # Builds a new document in the association and appends it to the target.
           # Takes an optional type if you want to specify a subclass.
           #
-          # @example Build a new document on the relation.
+          # @example Build a new document on the association.
           #   person.people.build(:name => "Bozo")
           #
           # @param [ Hash ] attributes The attributes to build the document with.
@@ -69,26 +67,35 @@ 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_children!
+            _base._reset_memoized_descendants!
             doc
           end
 
           alias :new :build
 
-          # Clear the relation. Will delete the documents from the db if they are
-          # already persisted.
+          # Clear the association. Will delete the documents from the db
+          # if they are already persisted.
+          #
+          # If the host document is not persisted but its _id matches a
+          # persisted document, calling #clear on an association will remove
+          # the association's documents from the database even though the
+          # set of documents in the application (as loaded in the host)
+          # is different from what is in the database, and the host may
+          # not contain any persisted documents in the association either.
           #
-          # @example Clear the relation.
+          # @example Clear the association.
           #   person.addresses.clear
           #
-          # @return [ self ] The empty relation.
+          # @return [ self ] The empty association.
           def clear
             batch_clear(_target.dup)
+            update_attributes_hash
             self
           end
 
@@ -97,49 +104,79 @@ module Mongoid
           #
           # Use #size if you want the total number of documents.
           #
+          # If args or block are present, #count will delegate to the
+          # #count method on +target+ and will include both persisted
+          # and non-persisted documents.
+          #
           # @example Get the count of persisted documents.
           #   person.addresses.count
           #
+          # @example Get the count of all documents matching a block.
+          #   person.addresses.count { |a| a.country == "FR" }
+          #
+          # @example Use #persisted? inside block to count persisted documents.
+          #   person.addresses.count { |a| a.persisted? && a.country == "FR" }
+          #
+          # @param [ Object... ] *args Args to delegate to the target.
+          #
           # @return [ Integer ] The total number of persisted embedded docs, as
           #   flagged by the #persisted? method.
-          def count
+          def count(*args, &block)
+            return _target.count(*args, &block) if args.any? || block
+
             _target.select { |doc| doc.persisted? }.size
           end
 
           # Delete the supplied document from the target. This method is proxied
           # in order to reindex the array after the operation occurs.
           #
-          # @example Delete the document from the relation.
+          # @example Delete the document from the association.
           #   person.addresses.delete(address)
           #
           # @param [ Document ] document The document to be deleted.
           #
-          # @return [ Document, nil ] The deleted document or nil if nothing deleted.
-          #
-          # @since 2.0.0.rc.1
+          # @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.
           #
-          # @example Delete all documents from the relation.
+          # @example Delete all documents from the association.
           #   person.addresses.delete_all
           #
-          # @example Conditionally delete documents from the relation.
+          # @example Conditionally delete documents from the association.
           #   person.addresses.delete_all({ :street => "Bond" })
           #
           # @param [ Hash ] conditions Conditions on which documents to delete.
@@ -156,10 +193,8 @@ module Mongoid
           #     doc.state == "GA"
           #   end
           #
-          # @return [ Many, Enumerator ] The relation or an enumerator if no
+          # @return [ Many | Enumerator ] The association or an enumerator if no
           #   block was provided.
-          #
-          # @since 3.1.0
           def delete_if
             if block_given?
               dup_target = _target.dup
@@ -174,10 +209,10 @@ module Mongoid
 
           # Destroy all the documents in the association whilst running callbacks.
           #
-          # @example Destroy all documents from the relation.
+          # @example Destroy all documents from the association.
           #   person.addresses.destroy_all
           #
-          # @example Conditionally destroy documents from the relation.
+          # @example Conditionally destroy documents from the association.
           #   person.addresses.destroy_all({ :street => "Bond" })
           #
           # @param [ Hash ] conditions Conditions on which documents to destroy.
@@ -187,39 +222,66 @@ module Mongoid
             remove_all(conditions, :destroy)
           end
 
-          # Determine if any documents in this relation exist in the database.
+          # Determine if any documents in this association exist in the database.
           #
           # @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
           # methods.
           #
+          # This method delegates to +Mongoid::Criteria#find+. If this method is
+          # not given a block, it returns one or many documents for the provided
+          # _id values.
+          #
+          # If this method is given a block, it returns the first document
+          # of those found by the current Criteria object for which the block
+          # returns a truthy value.
+          #
           # @example Find a document by its id.
           #   person.addresses.find(BSON::ObjectId.new)
           #
           # @example Find documents for multiple ids.
           #   person.addresses.find([ BSON::ObjectId.new, BSON::ObjectId.new ])
           #
-          # @param [ Array<Object> ] args Various arguments.
+          # @example Finds the first matching document using a block.
+          #   person.addresses.find { |addr| addr.state == 'CA' }
+          #
+          # @param [ Object... ] *args Various arguments.
+          # @param [ Proc ] block Optional block to pass.
           #
-          # @return [ Array<Document>, Document ] A single or multiple documents.
-          def find(*args)
-            criteria.find(*args)
+          # @return [ Document | Array<Document> | nil ] A document or matching documents.
+          def find(*args, &block)
+            criteria.find(*args, &block)
           end
 
-          # Instantiate a new embeds_many relation.
+          # Instantiate a new embeds_many association.
           #
-          # @example Create the new relation.
+          # @example Create the new association.
           #   Many.new(person, addresses, association)
           #
-          # @param [ Document ] base The document this relation hangs off of.
-          # @param [ Array<Document> ] target The child documents of the relation.
+          # @param [ Document ] base The document this association hangs off of.
+          # @param [ Array<Document> ] target The child documents of the association.
           # @param [ Association ] association The association metadata
           #
           # @return [ Many ] The proxy.
@@ -229,24 +291,23 @@ module Mongoid
                 integrate(doc)
                 doc._index = index
               end
+              update_attributes_hash
               @_unscoped = _target.dup
               @_target = scope(_target)
             end
           end
 
-          # Get all the documents in the relation that are loaded into memory.
+          # Get all the documents in the association that are loaded into memory.
           #
           # @example Get the in memory documents.
           #   relation.in_memory
           #
           # @return [ Array<Document> ] The documents in memory.
-          #
-          # @since 2.1.0
           def in_memory
             _target
           end
 
-          # Pop documents off the relation. This can be a single document or
+          # Pop documents off the association. This can be a single document or
           # multiples, and will automatically persist the changes.
           #
           # @example Pop a single document.
@@ -258,9 +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).
-          #
-          # @since 3.0.0
+          # @return [ Document | Array<Document> ] The popped document(s).
           def pop(count = nil)
             if count
               if docs = _target[_target.size - count, _target.size]
@@ -268,10 +327,12 @@ module Mongoid
               end
             else
               delete(_target[-1])
+            end.tap do
+              update_attributes_hash
             end
           end
 
-          # Shift documents off the relation. This can be a single document or
+          # Shift documents off the association. This can be a single document or
           # multiples, and will automatically persist the changes.
           #
           # @example Shift a single document.
@@ -283,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]
@@ -291,34 +352,33 @@ module Mongoid
               end
             else
               delete(_target[0])
+            end.tap do
+              update_attributes_hash
             end
           end
 
           # Substitutes the supplied target documents for the existing documents
           # in the relation.
           #
-          # @example Substitute the relation's target.
+          # @example Substitute the association's target.
           #   person.addresses.substitute([ address ])
           #
-          # @param [ Array<Document> ] docs The replacement docs.
-          #
-          # @return [ Many ] The proxied relation.
+          # @param [ Array<Document> | Array<Hash> ] docs The replacement docs.
           #
-          # @since 2.0.0.rc.1
+          # @return [ Many ] The proxied association.
           def substitute(docs)
             batch_replace(docs)
+            update_attributes_hash
             self
           end
 
-          # Return the relation with all previous scoping removed. This is the
+          # Return the association with all previous scoping removed. This is the
           # exact representation of the docs in the database.
           #
           # @example Get the unscoped documents.
           #   person.addresses.unscoped
           #
-          # @return [ Criteria ] The unscoped relation.
-          #
-          # @since 2.4.0
+          # @return [ Criteria ] The unscoped association.
           def unscoped
             criterion = klass.unscoped
             criterion.embedded = true
@@ -329,7 +389,7 @@ module Mongoid
           private
 
           def object_already_related?(document)
-            _target.any? { |existing| existing.id && existing === document }
+            _target.any? { |existing| existing._id && existing === document }
           end
 
           # Appends the document to the target array, updating the index on the
@@ -339,8 +399,6 @@ module Mongoid
           #   relation.append(document)
           #
           # @param [ Document ] document The document to append to the target.
-          #
-          # @since 2.0.0.rc.1
           def append(document)
             execute_callback :before_add, document
             unless object_already_related?(document)
@@ -348,58 +406,36 @@ module Mongoid
             end
             _unscoped.push(document)
             integrate(document)
+            update_attributes_hash
             document._index = _unscoped.size - 1
             execute_callback :after_add, document
           end
 
-          # Instantiate the binding associated with this relation.
+          # Instantiate the binding associated with this association.
           #
           # @example Create the binding.
           #   relation.binding([ address ])
           #
           # @return [ Binding ] The many binding.
-          #
-          # @since 2.0.0.rc.1
           def binding
             Binding.new(_base, _target, _association)
           end
 
-          # Returns the "#{criteria}"# object for the target class with its documents set
-          # to target.
-          #
-          # @example Get a criteria for the relation.
-          #   relation.criteria
+          # Returns the +Criteria+ object for the target class with its
+          # documents set to the list of target documents in the association.
           #
           # @return [ Criteria ] A new criteria.
           def criteria
-            @criteria ||= _association.criteria(_base, _target)
+            _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.
-          #
-          # @since 2.4.7
-          def delete_one(document)
-            _target.delete_one(document)
-            _unscoped.delete_one(document)
-            reindex
-          end
-
-          # Integrate the document into the relation. will set its metadata and
+          # Integrate the document into the association. will set its metadata and
           # attempt to bind the inverse.
           #
           # @example Integrate the document.
           #   relation.integrate(document)
           #
           # @param [ Document ] document The document to integrate.
-          #
-          # @since 2.1.0
           def integrate(document)
             characterize_one(document)
             bind_one(document)
@@ -410,26 +446,24 @@ 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.
-          def method_missing(name, *args, &block)
+          # @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
               criteria.public_send(name, *args, &block)
             end
           end
 
-          # Are we able to persist this relation?
+          # Are we able to persist this association?
           #
-          # @example Can we persist the relation?
+          # @example Can we persist the association?
           #   relation.persistable?
           #
-          # @return [ true, false ] If the relation is persistable.
-          #
-          # @since 2.1.0
+          # @return [ true | false ] If the association is persistable.
           def persistable?
             _base.persisted? && !_binding?
           end
@@ -438,18 +472,16 @@ module Mongoid
           # operations on the proxied target directly and the indices need to
           # match that on the database side.
           #
-          # @example Reindex the relation.
+          # @example Reindex the association.
           #   person.addresses.reindex
-          #
-          # @since 2.0.0.rc.1
           def reindex
             _unscoped.each_with_index do |doc, index|
               doc._index = index
             end
           end
 
-          # Apply the association ordering or the default scoping to the provided
-          # documents.
+          # Apply the association ordering and default scoping (defined on
+          # association's target class) to the provided documents.
           #
           # @example Apply scoping.
           #   person.addresses.scope(target)
@@ -457,30 +489,32 @@ module Mongoid
           # @param [ Array<Document> ] docs The documents to scope.
           #
           # @return [ Array<Document> ] The scoped docs.
-          #
-          # @since 2.4.0
           def scope(docs)
-            return docs unless _association.order || _association.klass.default_scoping?
+            unless _association.order || _association.klass.default_scoping?
+              return docs
+            end
+
             crit = _association.klass.order_by(_association.order)
             crit.embedded = true
             crit.documents = docs
             crit.entries
           end
 
-          # Remove all documents from the relation, either with a delete or a
+          # Remove all documents from the association, either with a delete or a
           # destroy depending on what this was called through.
           #
-          # @example Destroy documents from the relation.
+          # @example Destroy documents from the association.
           #   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
 
@@ -490,8 +524,6 @@ module Mongoid
           #   relation._unscoped
           #
           # @return [ Array<Document> ] The unscoped documents.
-          #
-          # @since 2.4.0
           def _unscoped
             @_unscoped ||= []
           end
@@ -504,31 +536,37 @@ module Mongoid
           # @param [ Array<Document> ] docs The documents.
           #
           # @return [ Array<Document ] The unscoped docs.
-          #
-          # @since 2.4.0
           def _unscoped=(docs)
             @_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
 
-            # Returns true if the relation is an embedded one. In this case
+            # Returns true if the association is an embedded one. In this case
             # always true.
             #
-            # @example Is the relation embedded?
+            # @example Is the association embedded?
             #   Association::Embedded::EmbedsMany.embedded?
             #
             # @return [ true ] true.
-            #
-            # @since 2.0.0.rc.1
             def embedded?
               true
             end
@@ -539,8 +577,6 @@ module Mongoid
             #   Association::Embedded::EmbedsMany.foreign_key_suffix
             #
             # @return [ nil ] nil.
-            #
-            # @since 3.0.0
             def foreign_key_suffix
               nil
             end