mongoid 7.1.1 → 8.1.0

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

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Association
@@ -20,8 +19,6 @@ module Mongoid
         # @param [ Array<Document> ] docs The docs to add.
         #
         # @return [ Array<Hash> ] The inserts.
-        #
-        # @since 3.0.0
         def batch_insert(docs)
           execute_batch_push(docs)
         end
@@ -34,37 +31,63 @@ module Mongoid
         # @param [ Array<Document> ] docs The docs to clear.
         #
         # @return [ Array ] The empty array.
-        #
-        # @since 3.0.0
         def batch_clear(docs)
           pre_process_batch_remove(docs, :delete)
           unless docs.empty?
             collection.find(selector).update_one(
-                positionally(selector, "$unset" => { path => true }),
-                session: _session
+              positionally(selector, "$unset" => { path => true }),
+              session: _session
             )
+            unless Mongoid.broken_updates
+              # This solves the case in which a user sets, clears and resets an
+              # embedded document. Previously, since the embedded document was
+              # already marked not a "new_record", it wouldn't be persisted to
+              # the second time. This change fixes that and allows it to be persisted.
+              docs.each { |doc| doc.new_record = true }
+            end
             post_process_batch_remove(docs, :delete)
           end
           _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 ])
         #
         # @param [ Array<Document> ] docs The docs to remove.
         # @param [ Symbol ] method Delete or destroy.
-        #
-        # @since 3.0.0
         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,14 +97,14 @@ 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.
-        #
-        # @since 3.0.0
         def batch_replace(docs)
           if docs.blank?
             if _assigning? && !empty?
+              _base.delayed_atomic_sets.delete(path)
+              clear_atomic_path_cache
               _base.add_atomic_unset(first)
               target_duplicate = _target.dup
               pre_process_batch_remove(target_duplicate, :delete)
@@ -90,9 +113,11 @@ 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)
+            clear_atomic_path_cache
             inserts = execute_batch_set(docs)
             add_atomic_sets(inserts)
           end
@@ -108,8 +133,6 @@ module Mongoid
         #   batchable.add_atomic_sets([{ field: value }])
         #
         # @param [ Array<Hash> ] sets The atomic sets.
-        #
-        # @since 3.0.0
         def add_atomic_sets(sets)
           if _assigning?
             _base.delayed_atomic_sets[path].try(:clear)
@@ -130,8 +153,6 @@ module Mongoid
         # @param [ Array<Document> ] docs The docs to persist.
         #
         # @return [ Array<Hash> ] The inserts.
-        #
-        # @since 7.0.0
         def execute_batch_set(docs)
           self.inserts_valid = true
           inserts = pre_process_batch_insert(docs)
@@ -155,8 +176,6 @@ module Mongoid
         # @param [ Array<Document> ] docs The docs to persist.
         #
         # @return [ Array<Hash> ] The inserts.
-        #
-        # @since 7.0.0
         def execute_batch_push(docs)
           self.inserts_valid = true
           pushes = pre_process_batch_insert(docs)
@@ -177,9 +196,7 @@ module Mongoid
         # @example Can inserts be performed?
         #   batchable.insertable?
         #
-        # @return [ true, false ] If inserts can be performed.
-        #
-        # @since 3.0.0
+        # @return [ true | false ] If inserts can be performed.
         def insertable?
           persistable? && !_assigning? && inserts_valid
         end
@@ -191,9 +208,7 @@ module Mongoid
         # @example Are the inserts currently valid.
         #   batchable.inserts_valid
         #
-        # @return [ true, false ] If inserts are currently valid.
-        #
-        # @since 3.0.0
+        # @return [ true | false ] If inserts are currently valid.
         def inserts_valid
           @inserts_valid
         end
@@ -205,11 +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.
-        #
-        # @since 3.0.0
+        # @return [ true | false ] The flag.
         def inserts_valid=(value)
           @inserts_valid = value
         end
@@ -222,11 +235,9 @@ 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.
-        #
-        # @since 3.0.0
         def normalize_docs(docs)
           if docs.first.is_a?(::Hash)
             docs.map do |doc|
@@ -247,10 +258,23 @@ module Mongoid
         #   batchable.path
         #
         # @return [ String ] The atomic path.
-        #
-        # @since 3.0.0
         def path
-          @path ||= _unscoped.first.atomic_path
+          @path ||= if _unscoped.empty?
+            Mongoid::Atomic::Paths::Embedded::Many.position_without_document(_base, _association)
+          else
+            _unscoped.first.atomic_path
+          end
+        end
+
+        # Clear the cache for path and atomic_paths. This method is used when
+        # the path method is used, and the association has not been set on the
+        # document yet, which can cause path and atomic_paths to be calculated
+        # incorrectly later.
+        #
+        # @api private
+        def clear_atomic_path_cache
+          self.path = nil
+          _base.instance_variable_set("@atomic_paths", nil)
         end
 
         # Set the atomic path.
@@ -263,8 +287,6 @@ module Mongoid
         # @param [ String ] value The path.
         #
         # @return [ String ] The path.
-        #
-        # @since 3.0.0
         def path=(value)
           @path = value
         end
@@ -277,8 +299,6 @@ module Mongoid
         #   batchable.selector
         #
         # @return [ Hash ] The atomic selector.
-        #
-        # @since 3.0.0
         def selector
           @selector ||= _base.atomic_selector
         end
@@ -293,8 +313,6 @@ module Mongoid
         # @param [ Array<Document> ] docs The documents.
         #
         # @return [ Array<Hash> ] The documents as an array of hashes.
-        #
-        # @since 3.0.0
         def pre_process_batch_insert(docs)
           docs.map do |doc|
             next unless doc
@@ -322,14 +340,12 @@ module Mongoid
         # @param [ Symbol ] method Delete or destroy.
         #
         # @return [ Array<Hash> ] The documents as hashes.
-        #
-        # @since 3.0.0
         def pre_process_batch_remove(docs, method)
           docs.map do |doc|
             self.path = doc.atomic_path unless path
             execute_callback :before_remove, doc
             unless _assigning?
-              doc.apply_delete_dependencies!
+              doc.apply_destroy_dependencies!
               doc.run_before_callbacks(:destroy) if method == :destroy
             end
             _target.delete_one(doc)
@@ -350,8 +366,6 @@ module Mongoid
         # @param [ Array<Documents> ] docs The inserted docs.
         #
         # @return [ Enumerable ] The document enum.
-        #
-        # @since 3.0.0
         def post_process_batch_insert(docs)
           docs.each do |doc|
             doc.new_record = false
@@ -371,8 +385,6 @@ module Mongoid
         # @param [ Symbol ] method Delete or destroy.
         #
         # @return [ Array<Document> ] The documents.
-        #
-        # @since 3.0.0
         def post_process_batch_remove(docs, method)
           docs.each do |doc|
             doc.run_after_callbacks(:destroy) if method == :destroy

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

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Association
@@ -26,7 +25,7 @@ module Mongoid
           #     recursively_embeds_many
           #   end
           #
-          # @example The previous example is a shorcut for this.
+          # @example The previous example is a shortcut for this.
           #
           #   class Role
           #     include Mongoid::Document
@@ -36,8 +35,6 @@ module Mongoid
           #
           # This provides the default nomenclature for accessing a parent document
           # or its children.
-          #
-          # @since 2.0.0.rc.1
           def recursively_embeds_many(options = {})
             embeds_many(
                 cyclic_child_name,
@@ -56,7 +53,7 @@ module Mongoid
           #     recursively_embeds_one
           #   end
           #
-          # @example The previous example is a shorcut for this.
+          # @example The previous example is a shortcut for this.
           #
           #   class Role
           #     include Mongoid::Document
@@ -66,8 +63,6 @@ module Mongoid
           #
           # This provides the default nomenclature for accessing a parent document
           # or its children.
-          #
-          # @since 2.0.0.rc.1
           def recursively_embeds_one(options = {})
             embeds_one(
                 cyclic_child_name(false),
@@ -84,8 +79,6 @@ module Mongoid
           #   Role.cyclic_parent_name
           #
           # @return [ String ] "parent_" plus the class name underscored.
-          #
-          # @since 2.0.0.rc.1
           def cyclic_parent_name
             ("parent_#{self.name.demodulize.underscore.singularize}").to_sym
           end
@@ -95,12 +88,10 @@ 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.
-          #
-          # @since 2.0.0.rc.1
           def cyclic_child_name(many = true)
             ("child_#{self.name.demodulize.underscore.send(many ? :pluralize : :singularize)}").to_sym
           end

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

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Association
@@ -7,8 +6,6 @@ module Mongoid
       class EmbeddedIn
 
         # The Binding object for embedded_in associations.
-        #
-        # @since 7.0
         class Binding
           include Bindable
 
@@ -21,15 +18,15 @@ module Mongoid
           # @example Bind the documents.
           #   name.person.bind(:continue => true)
           #   name.person = Person.new
-          #
-          # @since 2.0.0.rc.1
           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
@@ -41,8 +38,6 @@ module Mongoid
           # @example Unbind the document.
           #   name.person.unbind(:continue => true)
           #   name.person = nil
-          #
-          # @since 2.0.0.rc.1
           def unbind_one
             binding do
               if _base.embedded_many?
@@ -52,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

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Association
@@ -7,8 +6,6 @@ module Mongoid
       class EmbeddedIn
 
         # The Builder behavior for embedded_in associations.
-        #
-        # @since 7.0
         module Buildable
           include Threaded::Lifecycle
 
@@ -18,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

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Association
@@ -31,11 +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.
-          #
-          # @since 2.0.0.rc.1
+          # @return [ Document | nil ] The association or nil.
           def substitute(replacement)
             unbind_one
             unless replacement
@@ -43,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
@@ -56,8 +54,6 @@ module Mongoid
           #   binding([ address ])
           #
           # @return [ Binding ] A binding object.
-          #
-          # @since 2.0.0.rc.1
           def binding
             Binding.new(_base, _target, _association)
           end
@@ -68,8 +64,6 @@ module Mongoid
           #   object.characterize_one(document)
           #
           # @param [ Document ] document The document to set the association metadata on.
-          #
-          # @since 2.1.0
           def characterize_one(document)
             unless _base._association
               _base._association = _association.inverse_association(document)
@@ -81,9 +75,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?
             _target.persisted? && !_binding? && !_building?
           end
@@ -97,8 +89,6 @@ module Mongoid
             #   Association::Embedded::EmbeddedIn.embedded?
             #
             # @return [ true ] true.
-            #
-            # @since 2.0.0.rc.1
             def embedded?
               true
             end
@@ -111,8 +101,6 @@ module Mongoid
             # @param [ Document ] document The document to calculate on.
             #
             # @return [ Root ] The root atomic path calculator.
-            #
-            # @since 2.1.0
             def path(document)
               Mongoid::Atomic::Paths::Root.new(document)
             end

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

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 require 'mongoid/association/embedded/embedded_in/binding'
 require 'mongoid/association/embedded/embedded_in/buildable'
@@ -10,8 +9,6 @@ module Mongoid
     module Embedded
 
       # The EmbeddedIn type association.
-      #
-      # @since 7.0
       class EmbeddedIn
         include Relatable
         include Buildable
@@ -20,28 +17,22 @@ module Mongoid
         # common ones.
         #
         # @return [ Array<Symbol> ] The extra valid options.
-        #
-        # @since 7.0
         ASSOCIATION_OPTIONS = [
             :autobuild,
             :cyclic,
             :polymorphic,
-            :touch
+            :touch,
         ].freeze
 
         # The complete list of valid options for this association, including
         # 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 = true
@@ -51,8 +42,6 @@ module Mongoid
         # Is this association type embedded?
         #
         # @return [ true ] Always true.
-        #
-        # @since 7.0
         def embedded?; true; end
 
         # The primary key
@@ -63,22 +52,16 @@ module Mongoid
         # Does this association type store the foreign key?
         #
         # @return [ false ] Always false.
-        #
-        # @since 7.0
         def stores_foreign_key?; false; end
 
         # The default for validating the association object.
         #
         # @return [ false ] Always false.
-        #
-        # @since 7.0
         def validation_default; false; end
 
         # The key that is used to get the attributes for the associated object.
         #
         # @return [ String ] The name of the association.
-        #
-        # @since 7.0
         def key
           @key ||= name.to_s
         end
@@ -86,17 +69,13 @@ module Mongoid
         # Get the association proxy class for this association type.
         #
         # @return [ Association::Embedded::EmbeddedIn::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?
           !!@options[:polymorphic]
         end
@@ -107,8 +86,6 @@ module Mongoid
         # @param [ Hash ] options The options for the association.
         #
         # @return [ Association::Nested::One ] The Nested Builder object.
-        #
-        # @since 7.0
         def nested_builder(attributes, options)
           Nested::One.new(self, attributes, options)
         end
@@ -137,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

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Association
@@ -7,8 +6,6 @@ module Mongoid
       class EmbedsMany
 
         # Binding class for all embeds_many associations.
-        #
-        # @since 7.0
         class Binding
           include Bindable
 
@@ -19,11 +16,10 @@ module Mongoid
           #   person.addresses.bind_one(address)
           #
           # @param [ Document ] doc The single document to bind.
-          #
-          # @since 2.0.0.rc.1
           def bind_one(doc)
             doc.parentize(_base)
             binding do
+              remove_associated(doc)
               doc.do_or_do_not(_association.inverse_setter(_target), _base)
             end
           end
@@ -34,8 +30,6 @@ module Mongoid
           #   person.addresses.unbind_one(document)
           #
           # @param [ Document ] doc The single document to unbind.
-          #
-          # @since 2.0.0.rc.1
           def unbind_one(doc)
             binding do
               doc.do_or_do_not(_association.inverse_setter(_target), nil)

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

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Association
@@ -7,8 +6,6 @@ module Mongoid
       class EmbedsMany
 
         # Builder class for embeds_many associations.
-        #
-        # @since 7.0
         module Buildable
           include Threaded::Lifecycle
 
@@ -20,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
@@ -34,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