mongoid 7.2.1 → 9.0.0

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

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 require 'mongoid/association/embedded/batchable'
 
@@ -7,10 +6,76 @@ module Mongoid
   module Association
     module Embedded
       class EmbedsMany
-
+        # Transparent proxy for embeds_many associations.
+        # An instance of this class is returned when calling the
+        # association getter method on the parent document. This
+        # class inherits from Mongoid::Association::Proxy and forwards
+        # most of its methods to the target of the association, i.e.
+        # the array of child documents.
         class Proxy < Association::Many
           include Batchable
 
+          # Class-level methods for the Proxy class.
+          module ClassMethods
+            # Returns the eager loader for this association.
+            #
+            # @param [ Array<Mongoid::Association> ] associations The
+            #   associations to be eager loaded
+            # @param [ Array<Mongoid::Document> ] docs The parent documents
+            #   that possess the given associations, which ought to be
+            #   populated by the eager-loaded documents.
+            #
+            # @return [ Mongoid::Association::Embedded::Eager ]
+            def eager_loader(associations, docs)
+              Eager.new(associations, docs)
+            end
+
+            # Returns true if the association is an embedded one. In this case
+            # always true.
+            #
+            # @example Is the association embedded?
+            #   Association::Embedded::EmbedsMany.embedded?
+            #
+            # @return [ true ] true.
+            def embedded?
+              true
+            end
+
+            # Returns the suffix of the foreign key field, either "_id" or "_ids".
+            #
+            # @example Get the suffix for the foreign key.
+            #   Association::Embedded::EmbedsMany.foreign_key_suffix
+            #
+            # @return [ nil ] nil.
+            def foreign_key_suffix
+              nil
+            end
+          end
+
+          extend ClassMethods
+
+          # Instantiate a new embeds_many association.
+          #
+          # @example Create the new association.
+          #   Many.new(person, addresses, association)
+          #
+          # @param [ Document ] base The document this association hangs off of.
+          # @param [ Array<Document> ] target The child documents of the association.
+          # @param [ Mongoid::Association::Relatable ] association The association metadata.
+          #
+          # @return [ Many ] The proxy.
+          def initialize(base, target, association)
+            super do
+              _target.each_with_index do |doc, index|
+                integrate(doc)
+                doc._index = index
+              end
+              update_attributes_hash
+              @_unscoped = _target.dup
+              @_target = scope(_target)
+            end
+          end
+
           # Appends a document or array of documents to the association. Will set
           # the parent and update the index in the process.
           #
@@ -20,18 +85,21 @@ 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 unless docs.any?
             return concat(docs) if docs.size > 1
-            if doc = docs.first
+
+            docs.first.tap do |doc|
               append(doc)
               doc.save if persistable? && !_assigning?
             end
+
             self
           end
 
-          alias :push :<<
+          alias push <<
 
           # Get this association as as its representation in the database.
           #
@@ -39,8 +107,6 @@ module Mongoid
           #   person.addresses.as_document
           #
           # @return [ Array<Hash> ] The association as stored in the db.
-          #
-          # @since 2.0.0.rc.1
           def as_document
             as_attributes.collect { |attrs| BSON::Document.new(attrs) }
           end
@@ -54,8 +120,6 @@ 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
@@ -72,19 +136,27 @@ module Mongoid
           #
           # @return [ Document ] The new document.
           def build(attributes = {}, type = nil)
-            doc = Factory.build(type || _association.klass, attributes)
-            append(doc)
-            doc.apply_post_processed_defaults
-            yield(doc) if block_given?
-            doc.run_callbacks(:build) { doc }
-            _base._reset_memoized_children!
-            doc
+            Factory.execute_build(type || _association.klass, attributes, execute_callbacks: false).tap do |doc|
+              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!
+            end
           end
 
-          alias :new :build
+          alias new build
 
-          # Clear the association. 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 association.
           #   person.addresses.clear
@@ -92,6 +164,7 @@ module Mongoid
           # @return [ self ] The empty association.
           def clear
             batch_clear(_target.dup)
+            update_attributes_hash
             self
           end
 
@@ -100,13 +173,27 @@ 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
-            _target.select { |doc| doc.persisted? }.size
+          def count(*args, &block)
+            return _target.count(*args, &block) if args.any? || block
+
+            _target.count(&:persisted?)
           end
 
           # Delete the supplied document from the target. This method is proxied
@@ -117,24 +204,40 @@ module Mongoid
           #
           # @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
+              _target.delete_one(document).tap do |doc|
+                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
               end
             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.
@@ -159,20 +262,14 @@ module Mongoid
           #     doc.state == "GA"
           #   end
           #
-          # @return [ Many, Enumerator ] The association or an enumerator if no
-          #   block was provided.
-          #
-          # @since 3.1.0
+          # @return [ EmbedsMany::Proxy | Enumerator ] The proxy or an
+          #   enumerator if no block was provided.
           def delete_if
-            if block_given?
-              dup_target = _target.dup
-              dup_target.each do |doc|
-                delete(doc) if yield(doc)
-              end
-              self
-            else
-              super
-            end
+            return super unless block_given?
+
+            _target.dup.each { |doc| delete(doc) if yield doc }
+
+            self
           end
 
           # Destroy all the documents in the association whilst running callbacks.
@@ -195,46 +292,53 @@ 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
           # 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.
-          #
-          # @return [ Array<Document>, Document ] A single or multiple documents.
-          def find(*args)
-            criteria.find(*args)
-          end
-
-          # Instantiate a new embeds_many association.
-          #
-          # @example Create the new association.
-          #   Many.new(person, addresses, association)
+          # @example Finds the first matching document using a block.
+          #   person.addresses.find { |addr| addr.state == 'CA' }
           #
-          # @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
+          # @param [ Object... ] *args Various arguments.
+          # @param &block Optional block to pass.
+          # @yield [ Object ] Yields each enumerable element to the block.
           #
-          # @return [ Many ] The proxy.
-          def initialize(base, target, association)
-            init(base, target, association) do
-              _target.each_with_index do |doc, index|
-                integrate(doc)
-                doc._index = index
-              end
-              @_unscoped = _target.dup
-              @_target = scope(_target)
-            end
+          # @return [ Document | Array<Document> | nil ] A document or matching documents.
+          def find(...)
+            criteria.find(...)
           end
 
           # Get all the documents in the association that are loaded into memory.
@@ -243,11 +347,7 @@ module Mongoid
           #   relation.in_memory
           #
           # @return [ Array<Document> ] The documents in memory.
-          #
-          # @since 2.1.0
-          def in_memory
-            _target
-          end
+          alias in_memory _target
 
           # Pop documents off the association. This can be a single document or
           # multiples, and will automatically persist the changes.
@@ -261,17 +361,12 @@ 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> | nil ] The popped document(s).
           def pop(count = nil)
-            if count
-              if docs = _target[_target.size - count, _target.size]
-                docs.each { |doc| delete(doc) }
-              end
-            else
-              delete(_target[-1])
-            end
+            return [] if count&.zero?
+
+            docs = _target.last(count || 1).each { |doc| delete(doc) }
+            (count.nil? || docs.empty?) ? docs.first : docs
           end
 
           # Shift documents off the association. This can be a single document or
@@ -286,15 +381,12 @@ 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> | nil ] The shifted document(s).
           def shift(count = nil)
-            if count
-              if _target.size > 0 && docs = _target[0, count]
-                docs.each { |doc| delete(doc) }
-              end
-            else
-              delete(_target[0])
-            end
+            return [] if count&.zero?
+
+            docs = _target.first(count || 1).each { |doc| delete(doc) }
+            (count.nil? || docs.empty?) ? docs.first : docs
           end
 
           # Substitutes the supplied target documents for the existing documents
@@ -303,13 +395,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.
-          #
-          # @since 2.0.0.rc.1
           def substitute(docs)
             batch_replace(docs)
+            update_attributes_hash
             self
           end
 
@@ -320,8 +411,6 @@ module Mongoid
           #   person.addresses.unscoped
           #
           # @return [ Criteria ] The unscoped association.
-          #
-          # @since 2.4.0
           def unscoped
             criterion = klass.unscoped
             criterion.embedded = true
@@ -331,8 +420,10 @@ module Mongoid
 
           private
 
+          attr_accessor :_unscoped
+
           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
@@ -342,15 +433,12 @@ 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)
-              _target.push(*scope([document]))
-            end
+            _target.push(*scope([ document ])) unless object_already_related?(document)
             _unscoped.push(document)
             integrate(document)
+            update_attributes_hash
             document._index = _unscoped.size - 1
             execute_callback :after_add, document
           end
@@ -361,8 +449,6 @@ module Mongoid
           #   relation.binding([ address ])
           #
           # @return [ Binding ] The many binding.
-          #
-          # @since 2.0.0.rc.1
           def binding
             Binding.new(_base, _target, _association)
           end
@@ -375,22 +461,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.
-          #
-          # @since 2.4.7
-          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.
           #
@@ -398,8 +468,6 @@ module Mongoid
           #   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 +478,30 @@ 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 [ Proc ] block Optional block to pass.
+          # @param [ Symbol | String ] name The name of the method.
+          # @param [ Object... ] *args The method args.
+          # @param &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.
+          #
+          # TODO: make sure we are consistingly using respond_to_missing
+          #   anywhere we define method_missing.
+          # rubocop:disable Style/MissingRespondToMissing
+          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
+          # rubocop:enable Style/MissingRespondToMissing
 
           # Are we able to persist this association?
           #
           # @example Can we persist the association?
           #   relation.persistable?
           #
-          # @return [ true, false ] If the association is persistable.
-          #
-          # @since 2.1.0
+          # @return [ true | false ] If the association is persistable.
           def persistable?
             _base.persisted? && !_binding?
           end
@@ -440,8 +512,6 @@ module Mongoid
           #
           # @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
@@ -457,12 +527,8 @@ module Mongoid
           # @param [ Array<Document> ] docs The documents to scope.
           #
           # @return [ Array<Document> ] The scoped docs.
-          #
-          # @since 2.4.0
           def scope(docs)
-            unless _association.order || _association.klass.default_scoping?
-              return docs
-            end
+            return docs unless _association.order || _association.klass.default_scoping?
 
             crit = _association.klass.order_by(_association.order)
             crit.embedded = true
@@ -477,75 +543,32 @@ 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)
-            removed
-          end
-
-          # Get the internal unscoped documents.
-          #
-          # @example Get the unscoped documents.
-          #   relation._unscoped
-          #
-          # @return [ Array<Document> ] The unscoped documents.
-          #
-          # @since 2.4.0
-          def _unscoped
-            @_unscoped ||= []
+            criteria.size.tap do
+              batch_remove(criteria, method)
+              update_attributes_hash
+            end
           end
 
-          # Set the internal unscoped documents.
+          # Returns a list of attributes hashes for each document.
           #
-          # @example Set the unscoped documents.
-          #   relation._unscoped = docs
-          #
-          # @param [ Array<Document> ] docs The documents.
-          #
-          # @return [ Array<Document ] The unscoped docs.
-          #
-          # @since 2.4.0
-          def _unscoped=(docs)
-            @_unscoped = docs
-          end
-
+          # @return [ Array<Hash> ] The list of attributes hashes
           def as_attributes
-            attributes = []
-            _unscoped.each do |doc|
-              attributes.push(doc.as_document)
-            end
-            attributes
+            _unscoped.map { |doc| doc.send(:as_attributes) }
           end
 
-          class << self
-
-            # Returns true if the association is an embedded one. In this case
-            # always true.
-            #
-            # @example Is the association embedded?
-            #   Association::Embedded::EmbedsMany.embedded?
-            #
-            # @return [ true ] true.
-            #
-            # @since 2.0.0.rc.1
-            def embedded?
-              true
-            end
-
-            # Returns the suffix of the foreign key field, either "_id" or "_ids".
-            #
-            # @example Get the suffix for the foreign key.
-            #   Association::Embedded::EmbedsMany.foreign_key_suffix
-            #
-            # @return [ nil ] nil.
-            #
-            # @since 3.0.0
-            def foreign_key_suffix
-              nil
+          # Update the _base's attributes hash with the _target's attributes
+          #
+          # @api private
+          def update_attributes_hash
+            if _target.empty?
+              _base.attributes.delete(_association.store_as)
+            else
+              _base.attributes.merge!(_association.store_as => _target.map(&:attributes))
             end
           end
         end