mongoid 7.0.10 → 7.4.0

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?

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,15 +31,20 @@ 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
@@ -53,8 +57,6 @@ module Mongoid
         #
         # @param [ Array<Document> ] docs The docs to remove.
         # @param [ Symbol ] method Delete or destroy.
-        #
-        # @since 3.0.0
         def batch_remove(docs, method = :delete)
           removals = pre_process_batch_remove(docs, method)
           if !docs.empty?
@@ -75,11 +77,10 @@ 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.clear
               _base.add_atomic_unset(first)
               target_duplicate = _target.dup
               pre_process_batch_remove(target_duplicate, :delete)
@@ -91,6 +92,7 @@ module Mongoid
             _base.delayed_atomic_sets.clear unless _assigning?
             docs = normalize_docs(docs).compact
             _target.clear and _unscoped.clear
+            _base.delayed_atomic_unsets.clear
             inserts = execute_batch_set(docs)
             add_atomic_sets(inserts)
           end
@@ -106,8 +108,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 +128,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 +151,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)
@@ -176,8 +172,6 @@ module Mongoid
         #   batchable.insertable?
         #
         # @return [ true, false ] If inserts can be performed.
-        #
-        # @since 3.0.0
         def insertable?
           persistable? && !_assigning? && inserts_valid
         end
@@ -190,8 +184,6 @@ module Mongoid
         #   batchable.inserts_valid
         #
         # @return [ true, false ] If inserts are currently valid.
-        #
-        # @since 3.0.0
         def inserts_valid
           @inserts_valid
         end
@@ -206,8 +198,6 @@ module Mongoid
         # @param [ true, false ] value The flag.
         #
         # @return [ true, false ] The flag.
-        #
-        # @since 3.0.0
         def inserts_valid=(value)
           @inserts_valid = value
         end
@@ -223,8 +213,6 @@ module Mongoid
         # @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,8 +233,6 @@ module Mongoid
         #   batchable.path
         #
         # @return [ String ] The atomic path.
-        #
-        # @since 3.0.0
         def path
           @path ||= _unscoped.first.atomic_path
         end
@@ -261,8 +247,6 @@ module Mongoid
         # @param [ String ] value The path.
         #
         # @return [ String ] The path.
-        #
-        # @since 3.0.0
         def path=(value)
           @path = value
         end
@@ -275,8 +259,6 @@ module Mongoid
         #   batchable.selector
         #
         # @return [ Hash ] The atomic selector.
-        #
-        # @since 3.0.0
         def selector
           @selector ||= _base.atomic_selector
         end
@@ -291,8 +273,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 +300,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 +326,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 +345,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,8 +18,6 @@ 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)
@@ -38,8 +36,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?

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

@@ -1,11 +1,11 @@
+# frozen_string_literal: true
+
 module Mongoid
   module Association
     module Embedded
       class EmbeddedIn
 
         # The Builder behavior for embedded_in associations.
-        #
-        # @since 7.0
         module Buildable
           include Threaded::Lifecycle
 
@@ -18,12 +18,15 @@ module Mongoid
           # @param [ Object ] base The object.
           # @param [ Object ] 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
+          #   will not be accessible in the built document.
           #
           # @return [ Document ] A single document.
-          def build(base, object, type = nil)
+          def build(base, object, type = nil, selected_fields = nil)
             return object unless object.is_a?(Hash)
             if _loading?
-              Factory.from_db(klass, object)
+              Factory.from_db(klass, object, nil, selected_fields)
             else
               Factory.build(klass, object)
             end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mongoid
   module Association
     module Embedded
@@ -5,13 +7,13 @@ module Mongoid
 
         class Proxy < Association::One
 
-          # Instantiate a new embedded_in relation.
+          # Instantiate a new embedded_in association.
           #
-          # @example Create the new relation.
+          # @example Create the new association.
           #   Association::Embedded::EmbeddedIn.new(person, address, association)
           #
-          # @param [ Document ] base The document the relation hangs off of.
-          # @param [ Document ] target The target (parent) of the relation.
+          # @param [ Document ] base The document the association hangs off of.
+          # @param [ Document ] target The target (parent) of the association.
           # @param [ Association ] association The association metadata.
           #
           # @return [ In ] The proxy.
@@ -23,16 +25,14 @@ module Mongoid
           end
 
           # Substitutes the supplied target documents for the existing document
-          # in the relation.
+          # in the association.
           #
           # @example Substitute the new document.
           #   person.name.substitute(new_name)
           #
           # @param [ Document ] replacement A document to replace the target.
           #
-          # @return [ Document, nil ] The relation or nil.
-          #
-          # @since 2.0.0.rc.1
+          # @return [ Document, nil ] The association or nil.
           def substitute(replacement)
             unbind_one
             unless replacement
@@ -47,14 +47,12 @@ module Mongoid
 
           private
 
-          # Instantiate the binding associated with this relation.
+          # Instantiate the binding associated with this association.
           #
           # @example Get the binding.
           #   binding([ address ])
           #
           # @return [ Binding ] A binding object.
-          #
-          # @since 2.0.0.rc.1
           def binding
             Binding.new(_base, _target, _association)
           end
@@ -65,37 +63,31 @@ 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)
             end
           end
 
-          # Are we able to persist this relation?
+          # Are we able to persist this association?
           #
-          # @example Can we persist the relation?
+          # @example Can we persist the association?
           #   relation.persistable?
           #
-          # @return [ true, false ] If the relation is persistable.
-          #
-          # @since 2.1.0
+          # @return [ true, false ] If the association is persistable.
           def persistable?
             _target.persisted? && !_binding? && !_building?
           end
 
           class << self
 
-            # Returns true if the relation is an embedded one. In this case
+            # Returns true if the association is an embedded one. In this case
             # always true.
             #
-            # @example Is this relation embedded?
+            # @example Is this association embedded?
             #   Association::Embedded::EmbeddedIn.embedded?
             #
             # @return [ true ] true.
-            #
-            # @since 2.0.0.rc.1
             def embedded?
               true
             end
@@ -108,8 +100,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,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'mongoid/association/embedded/embedded_in/binding'
 require 'mongoid/association/embedded/embedded_in/buildable'
 require 'mongoid/association/embedded/embedded_in/proxy'
@@ -7,8 +9,6 @@ module Mongoid
     module Embedded
 
       # The EmbeddedIn type association.
-      #
-      # @since 7.0
       class EmbeddedIn
         include Relatable
         include Buildable
@@ -17,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
@@ -48,43 +42,33 @@ module Mongoid
         # Is this association type embedded?
         #
         # @return [ true ] Always true.
-        #
-        # @since 7.0
         def embedded?; true; end
 
         # The primary key
         #
-        # @return [ nil ] Not relevant for this relation
+        # @return [ nil ] Not relevant for this association
         def primary_key; end
 
         # 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 relation.
-        #
-        # @since 7.0
+        # @return [ String ] The name of the association.
         def key
           @key ||= name.to_s
         end
 
-        # Get the relation proxy class for this association type.
+        # Get the association proxy class for this association type.
         #
         # @return [ Association::Embedded::EmbeddedIn::Proxy ] The proxy class.
-        #
-        # @since 7.0
         def relation
           Proxy
         end
@@ -92,8 +76,6 @@ module Mongoid
         # Is this association polymorphic?
         #
         # @return [ true, false ] Whether this association is polymorphic.
-        #
-        # @since 7.0
         def polymorphic?
           !!@options[:polymorphic]
         end
@@ -104,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