mongoid 7.1.1 → 8.1.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'
 
@@ -20,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
@@ -39,8 +38,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 +51,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 +67,27 @@ 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 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 +95,7 @@ module Mongoid
           # @return [ self ] The empty association.
           def clear
             batch_clear(_target.dup)
+            update_attributes_hash
             self
           end
 
@@ -100,12 +104,26 @@ 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
 
@@ -117,24 +135,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
+              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.
@@ -159,10 +193,8 @@ 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.
-          #
-          # @since 3.1.0
           def delete_if
             if block_given?
               dup_target = _target.dup
@@ -195,25 +227,37 @@ 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?
-            count > 0
+            _target.any? { |doc| doc.persisted? }
           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 association.
@@ -232,6 +276,7 @@ module Mongoid
                 integrate(doc)
                 doc._index = index
               end
+              update_attributes_hash
               @_unscoped = _target.dup
               @_target = scope(_target)
             end
@@ -243,8 +288,6 @@ module Mongoid
           #   relation.in_memory
           #
           # @return [ Array<Document> ] The documents in memory.
-          #
-          # @since 2.1.0
           def in_memory
             _target
           end
@@ -261,9 +304,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]
@@ -271,6 +312,8 @@ module Mongoid
               end
             else
               delete(_target[-1])
+            end.tap do
+              update_attributes_hash
             end
           end
 
@@ -286,7 +329,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]
@@ -294,6 +337,8 @@ module Mongoid
               end
             else
               delete(_target[0])
+            end.tap do
+              update_attributes_hash
             end
           end
 
@@ -303,13 +348,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 +364,6 @@ module Mongoid
           #   person.addresses.unscoped
           #
           # @return [ Criteria ] The unscoped association.
-          #
-          # @since 2.4.0
           def unscoped
             criterion = klass.unscoped
             criterion.embedded = true
@@ -332,7 +374,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
@@ -342,8 +384,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)
@@ -351,6 +391,7 @@ module Mongoid
             end
             _unscoped.push(document)
             integrate(document)
+            update_attributes_hash
             document._index = _unscoped.size - 1
             execute_callback :after_add, document
           end
@@ -361,8 +402,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 +414,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 +421,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,12 +431,12 @@ 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)
@@ -427,9 +448,7 @@ module Mongoid
           # @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 +459,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,8 +474,6 @@ 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
@@ -477,13 +492,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
 
@@ -493,8 +509,6 @@ module Mongoid
           #   relation._unscoped
           #
           # @return [ Array<Document> ] The unscoped documents.
-          #
-          # @since 2.4.0
           def _unscoped
             @_unscoped ||= []
           end
@@ -507,18 +521,26 @@ 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
@@ -530,8 +552,6 @@ module Mongoid
             #   Association::Embedded::EmbedsMany.embedded?
             #
             # @return [ true ] true.
-            #
-            # @since 2.0.0.rc.1
             def embedded?
               true
             end
@@ -542,8 +562,6 @@ module Mongoid
             #   Association::Embedded::EmbedsMany.foreign_key_suffix
             #
             # @return [ nil ] nil.
-            #
-            # @since 3.0.0
             def foreign_key_suffix
               nil
             end

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

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 require 'mongoid/association/embedded/embeds_many/binding'
 require 'mongoid/association/embedded/embeds_many/buildable'
@@ -10,8 +9,6 @@ module Mongoid
     module Embedded
 
       # The EmbedsMany type association.
-      #
-      # @since 7.0
       class EmbedsMany
         include Relatable
         include Buildable
@@ -20,8 +17,6 @@ module Mongoid
         # common ones.
         #
         # @return [ Array<Symbol> ] The extra valid options.
-        #
-        # @since 7.0
         ASSOCIATION_OPTIONS = [
             :as,
             :cascade_callbacks,
@@ -38,15 +33,11 @@ module Mongoid
         # the shared ones.
         #
         # @return [ Array<Symbol> ] The valid options.
-        #
-        # @since 7.0
         VALID_OPTIONS = (ASSOCIATION_OPTIONS + SHARED_OPTIONS).freeze
 
         # Setup the instance methods, fields, etc. on the association owning class.
         #
         # @return [ self ]
-        #
-        # @since 7.0
         def setup!
           setup_instance_methods!
           @owner_class.embedded_relations = @owner_class.embedded_relations.merge(name => self)
@@ -57,8 +48,6 @@ module Mongoid
         # The field key used to store the list of association objects.
         #
         # @return [ String ] The field name.
-        #
-        # @since 7.0
         def store_as
           @store_as ||= (@options[:store_as].try(:to_s) || name.to_s)
         end
@@ -66,8 +55,6 @@ module Mongoid
         # The key that is used to get the attributes for the associated object.
         #
         # @return [ String ] The name of the field used to store the association.
-        #
-        # @since 7.0
         def key
           store_as.to_s
         end
@@ -75,8 +62,6 @@ module Mongoid
         # Is this association type embedded?
         #
         # @return [ true ] Always true.
-        #
-        # @since 7.0
         def embedded?; true; end
 
         # Get the default validation setting for the association. Determines if
@@ -86,15 +71,11 @@ module Mongoid
         #   Proxy.validation_default
         #
         # @return [ true ] Always true.
-        #
-        # @since 2.1.9
         def validation_default; true; end
 
         # Does this association type store the foreign key?
         #
         # @return [ false ] Always false.
-        #
-        # @since 7.0
         def stores_foreign_key?; false; end
 
         # The primary key
@@ -105,17 +86,13 @@ module Mongoid
         # Get the association proxy class for this association type.
         #
         # @return [ Association::Embedded::EmbedsMany::Proxy ] The proxy class.
-        #
-        # @since 7.0
         def relation
           Proxy
         end
 
         # Is this association polymorphic?
         #
-        # @return [ true, false ] Whether this association is polymorphic.
-        #
-        # @since 7.0
+        # @return [ true | false ] Whether this association is polymorphic.
         def polymorphic?
           @polymorphic ||= !!@options[:as]
         end
@@ -124,9 +101,7 @@ module Mongoid
         #
         # @note Only relevant if the association is polymorphic.
         #
-        # @return [ String, nil ] The field for storing the associated object's type.
-        #
-        # @since 7.0
+        # @return [ String | nil ] The field for storing the associated object's type.
         def type
           @type ||= "#{as}_type" if polymorphic?
         end
@@ -137,8 +112,6 @@ module Mongoid
         # @param [ Hash ] options The options for the association.
         #
         # @return [ Association::Nested::Many ] The Nested Builder object.
-        #
-        # @since 7.0
         def nested_builder(attributes, options)
           Nested::Many.new(self, attributes, options)
         end
@@ -152,8 +125,6 @@ module Mongoid
         #
         # @return [ Mongoid::Atomic::Paths::Embedded::Many ]
         #   The embedded many atomic path calculator.
-        #
-        # @since 2.1.0
         def path(document)
           Mongoid::Atomic::Paths::Embedded::Many.new(document)
         end
@@ -162,8 +133,6 @@ module Mongoid
         #
         # @param [ Document ] base The base document.
         # @param [ Document ] target The children documents.
-        #
-        # @since 7.0
         def criteria(base, target)
           criterion = klass.scoped
           criterion.embedded = true
@@ -200,7 +169,8 @@ module Mongoid
         def determine_inverses(other)
           matches = relation_class.relations.values.select do |rel|
             relation_complements.include?(rel.class) &&
-                rel.relation_class_name == inverse_class_name
+              # https://jira.mongodb.org/browse/MONGOID-4882
+              rel.relation_class_name.sub(/\A::/, '') == inverse_class_name
           end
           if matches.size > 1
             raise Errors::AmbiguousRelationship.new(relation_class, @owner_class, name, matches)

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

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Association
@@ -7,8 +6,6 @@ module Mongoid
       class EmbedsOne
 
         # Binding class for all embeds_one associations.
-        #
-        # @since 7.0
         class Binding
           include Bindable
 
@@ -21,8 +18,6 @@ module Mongoid
           # @example Bind the document.
           #   person.name.bind(:continue => true)
           #   person.name = Name.new
-          #
-          # @since 2.0.0.rc.1
           def bind_one
             _target.parentize(_base)
             binding do
@@ -36,8 +31,6 @@ module Mongoid
           # @example Unbind the document.
           #   person.name.unbind(:continue => true)
           #   person.name = nil
-          #
-          # @since 2.0.0.rc.1
           def unbind_one
             binding do
               _target.do_or_do_not(_association.inverse_setter(_target), nil)

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

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Association
@@ -7,8 +6,6 @@ module Mongoid
       class EmbedsOne
 
         # Builder class for embeds_one associations.
-        #
-        # @since 7.0
         module Buildable
           include Threaded::Lifecycle
 
@@ -20,7 +17,7 @@ module Mongoid
           #   Builder.new(meta, attrs).build
           #
           # @param [ Document ] base The document this association hangs off of.
-          # @param [ Document ] object The related document.
+          # @param [ Document | Hash ] object The related 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
@@ -28,11 +25,25 @@ module Mongoid
           #
           # @return [ Document ] A single document.
           def build(base, object, _type = nil, selected_fields = nil)
-            return object unless object.is_a?(Hash)
-            if _loading? && base.persisted?
-              Factory.from_db(klass, object, nil, selected_fields)
+            if object.is_a?(Hash)
+              if _loading? && base.persisted?
+                Factory.execute_from_db(klass, object, nil, selected_fields, execute_callbacks: false)
+              else
+                Factory.build(klass, object)
+              end
             else
-              Factory.build(klass, object)
+              clear_associated(object)
+              object
+            end
+          end
+
+          private
+
+          def clear_associated(doc)
+            if doc && (inv = inverse(doc))
+              if associated = doc.ivar(inv)
+                associated.substitute(nil)
+              end
             end
           end
         end