mongoid 7.0.13 → 8.0.8

data/lib/mongoid/association/builders.rb

@@ -1,10 +1,10 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module Mongoid
   module Association
 
     # This module is responsible for defining the build and create methods used
-    # in one to one relations.
+    # in one to one associations.
     #
     # @example Methods that get created.
     #
@@ -16,8 +16,6 @@ module Mongoid
     #   # The following methods get created:
     #   person.build_name({ :first_name => "Durran" })
     #   person.create_name({ :first_name => "Durran" })
-    #
-    # @since 2.0.0.rc.1
     module Builders
       extend ActiveSupport::Concern
 
@@ -32,8 +30,6 @@ module Mongoid
       # @param [ Array ] args The arguments.
       #
       # @return [ Array<Hash> ] The attributes and options.
-      #
-      # @since 2.3.4
       def parse_args(*args)
         [ args.first || {}, args.size > 1 ? args[1] : {} ]
       end
@@ -43,18 +39,17 @@ module Mongoid
       # @example
       #   Person.define_builder!(association)
       #
-      # @param [ Association ] association The association metadata for the relation.
+      # @param [ Association ] association The association metadata for the association.
       #
       # @return [ Class ] The class being set up.
-      #
-      # @since 2.0.0.rc.1
       def self.define_builder!(association)
         association.inverse_class.tap do |klass|
           klass.re_define_method("build_#{association.name}") do |*args|
             attributes, _options = parse_args(*args)
-            document = Factory.build(association.relation_class, attributes)
+            document = Factory.execute_build(association.relation_class, attributes, execute_callbacks: false)
             _building do
               child = send("#{association.name}=", document)
+              child.run_pending_callbacks
               child.run_callbacks(:build)
               child
             end
@@ -68,19 +63,18 @@ module Mongoid
       # @example
       #   Person.define_creator!(association)
       #
-      # @param [ Association ] association The association metadata for the relation.
+      # @param [ Association ] association The association metadata for the association.
       #
       # @return [ Class ] The class being set up.
-      #
-      # @since 2.0.0.rc.1
       def self.define_creator!(association)
         association.inverse_class.tap do |klass|
           klass.re_define_method("create_#{association.name}") do |*args|
             attributes, _options = parse_args(*args)
-            document = Factory.build(association.relation_class, attributes)
+            document = Factory.execute_build(association.relation_class, attributes, execute_callbacks: false)
             doc = _assigning do
               send("#{association.name}=", document)
             end
+            doc.run_pending_callbacks
             doc.save
             save if new_record? && association.stores_foreign_key?
             doc

data/lib/mongoid/association/constrainable.rb

@@ -1,14 +1,14 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Association
 
     # Used for converting foreign key values to the correct type based on the
     # types of ids that the document stores.
-    #
     module Constrainable
 
       # Convert the supplied object to the appropriate type to set as the
-      # foreign key for a relation.
+      # foreign key for an association.
       #
       # @example Convert the object.
       #   constraint.convert("12345")
@@ -16,8 +16,6 @@ module Mongoid
       # @param [ Object ] object The object to convert.
       #
       # @return [ Object ] The object cast to the correct type.
-      #
-      # @since 2.0.0.rc.7
       def convert_to_foreign_key(object)
         return convert_polymorphic(object) if polymorphic?
         field = relation_class.fields["_id"]
@@ -31,10 +29,10 @@ module Mongoid
       end
 
       private
-      
+
       def convert_polymorphic(object)
         if object.is_a?(Mongoid::Document)
-          object.id
+          object._id
         else
           BSON::ObjectId.mongoize(object)
         end

data/lib/mongoid/association/depending.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module Mongoid
   module Association
 
-    # This module defines the behaviour for setting up cascading deletes and
-    # nullifies for relations, and how to delegate to the appropriate strategy.
+    # This module defines the behavior for setting up cascading deletes and
+    # nullifies for associations, and how to delegate to the appropriate strategy.
     module Depending
       extend ActiveSupport::Concern
 
@@ -28,8 +30,6 @@ module Mongoid
       end
 
       # The valid dependent strategies.
-      #
-      # @since 7.0
       STRATEGIES = [
           :delete_all,
           :destroy,
@@ -38,11 +38,6 @@ module Mongoid
           :restrict_with_error
       ]
 
-      # The error message when a strategy cannot delete objects because there are associated objects.
-      #
-      # @since 7.0
-      RESTRICT_ERROR_MSG = 'Cannot delete record because associated objects exist.'.freeze
-
       # Attempt to add the cascading information for the document to know how
       # to handle associated documents on a removal.
       #
@@ -52,8 +47,6 @@ module Mongoid
       # @param [ Association ] association The association metadata.
       #
       # @return [ Class ] The class of the document.
-      #
-      # @since 2.0.0.rc.1
       def self.define_dependency!(association)
         validate!(association)
         association.inverse_class.tap do |klass|
@@ -80,13 +73,11 @@ module Mongoid
       # the appropriate strategy to perform the operation.
       #
       # @example Execute cascades.
-      #   document.apply_delete_dependencies!
-      #
-      # @since 2.0.0.rc.1
-      def apply_delete_dependencies!
+      #   document.apply_destroy_dependencies!
+      def apply_destroy_dependencies!
         self.class._all_dependents.each do |association|
-          if association.try(:dependent)
-            send("_dependent_#{association.dependent}!", association)
+          if dependent = association.try(:dependent)
+            send("_dependent_#{dependent}!", association)
           end
         end
       end
@@ -128,7 +119,7 @@ module Mongoid
 
       def _dependent_restrict_with_error!(association)
         if (relation = send(association.name)) && !relation.blank?
-          errors.add(association.name, RESTRICT_ERROR_MSG)
+          errors.add(association.name, :destroy_restrict_with_error_dependencies_exist)
           throw(:abort, false)
         end
       end

data/lib/mongoid/association/eager_loadable.rb

@@ -1,12 +1,11 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 require "mongoid/association/referenced/eager"
 
 module Mongoid
   module Association
 
     # This module defines the eager loading behavior for criteria.
-    #
-    # @since 7.0
     module EagerLoadable
 
       def eager_loadable?
@@ -21,13 +20,35 @@ module Mongoid
         end
       end
 
-      def preload(relations, docs)
-        relations.group_by(&:inverse_class_name)
-            .values
-            .each do |associations|
-          associations.group_by(&:relation)
-              .each do |relation, association|
-            relation.eager_loader(association, docs).run
+      # Load the associations for the given documents. This will be done
+      # recursively to load the associations of the given documents'
+      # subdocuments.
+      #
+      # @param [ Array<Association> ] associations The associations to load.
+      # @param [ Array<Document> ] document The documents.
+      def preload(associations, docs)
+        assoc_map = associations.group_by(&:inverse_class_name)
+        docs_map = {}
+        queue = [ klass.to_s ]
+
+        while klass = queue.shift
+          if as = assoc_map.delete(klass)
+            as.each do |assoc|
+              queue << assoc.class_name
+
+              # If this class is nested in the inclusion tree, only load documents
+              # for the association above it. If there is no parent association,
+              # we will include documents from the documents passed to this method.
+              ds = docs
+              if assoc.parent_inclusions.length > 0
+                ds = assoc.parent_inclusions.map{ |p| docs_map[p].to_a }.flatten
+              end
+
+              res = assoc.relation.eager_loader([assoc], ds).run
+
+              docs_map[assoc.name] ||= [].to_set
+              docs_map[assoc.name].merge(res)
+            end
           end
         end
       end

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

@@ -1,9 +1,10 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Association
     module Embedded
 
-      # Contains behaviour for executing operations in batch on embedded
+      # Contains behavior for executing operations in batch on embedded
       # documents.
       module Batchable
         include Positional
@@ -18,13 +19,11 @@ 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
 
-        # Clear all of the docs out of the relation in a single swipe.
+        # Clear all of the docs out of the association in a single swipe.
         #
         # @example Clear all docs.
         #   batchable.batch_clear(docs)
@@ -32,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
@@ -75,11 +100,11 @@ module Mongoid
         # @param [ Array<Document> ] 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)
@@ -88,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
@@ -106,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)
@@ -128,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)
@@ -153,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)
@@ -175,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
@@ -189,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
@@ -203,11 +220,9 @@ module Mongoid
         # @example Set the flag.
         #   batchable.inserts_valid = true
         #
-        # @param [ true, false ] value The flag.
-        #
-        # @return [ true, false ] The flag.
+        # @param [ true | false ] value The flag.
         #
-        # @since 3.0.0
+        # @return [ true | false ] The flag.
         def inserts_valid=(value)
           @inserts_valid = value
         end
@@ -220,11 +235,9 @@ module Mongoid
         # @example Normalize the docs.
         #   batchable.normalize_docs(docs)
         #
-        # @param [ Array<Hash, Document> ] docs The docs to normalize.
+        # @param [ Array<Hash | Document> ] 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|
@@ -245,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.
@@ -261,8 +287,6 @@ module Mongoid
         # @param [ String ] value The path.
         #
         # @return [ String ] The path.
-        #
-        # @since 3.0.0
         def path=(value)
           @path = value
         end
@@ -275,8 +299,6 @@ module Mongoid
         #   batchable.selector
         #
         # @return [ Hash ] The atomic selector.
-        #
-        # @since 3.0.0
         def selector
           @selector ||= _base.atomic_selector
         end
@@ -291,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
@@ -320,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)
@@ -348,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
@@ -369,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,10 +1,11 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Association
     module Embedded
 
       # This module provides convenience macros for using cyclic embedded
-      # relations.
+      # associations.
       module Cyclic
         extend ActiveSupport::Concern
 
@@ -14,7 +15,7 @@ module Mongoid
 
         module ClassMethods
 
-          # Create a cyclic embedded relation that creates a tree hierarchy for
+          # Create a cyclic embedded association that creates a tree hierarchy for
           # the document and many embedded child documents.
           #
           # @example Set up a recursive embeds many.
@@ -24,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
@@ -34,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,
@@ -44,7 +43,7 @@ module Mongoid
             embedded_in cyclic_parent_name, class_name: self.name, cyclic: true
           end
 
-          # Create a cyclic embedded relation that creates a single self
+          # Create a cyclic embedded association that creates a single self
           # referencing relationship for a parent and a single child.
           #
           # @example Set up a recursive embeds one.
@@ -54,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
@@ -64,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),
@@ -82,10 +79,8 @@ 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
+            ("parent_#{self.name.demodulize.underscore.singularize}").to_sym
           end
 
           # Determines the child name given the class.
@@ -93,14 +88,12 @@ module Mongoid
           # @example Determine the child name.
           #   Role.cyclic_child_name
           #
-          # @param [ true, false ] many Is the a many relation?
+          # @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
+            ("child_#{self.name.demodulize.underscore.send(many ? :pluralize : :singularize)}").to_sym
           end
         end
       end

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

@@ -1,15 +1,15 @@
+# frozen_string_literal: true
+
 module Mongoid
   module Association
     module Embedded
       class EmbeddedIn
 
         # The Binding object for embedded_in associations.
-        #
-        # @since 7.0
         class Binding
           include Bindable
 
-          # Binds the base object to the inverse of the relation. This is so we
+          # Binds the base object to the inverse of the association. This is so we
           # are referenced to the actual objects themselves on both sides.
           #
           # This case sets the association metadata on the inverse object as well as the
@@ -18,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
@@ -38,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?
@@ -49,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