mongoid 6.4.8 → 7.5.4

data/lib/mongoid/persistable/deletable.rb

@@ -1,10 +1,9 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Persistable
 
-    # Defines behaviour for persistence operations that delete documents.
-    #
-    # @since 4.0.0
+    # Defines behavior for persistence operations that delete documents.
     module Deletable
       extend ActiveSupport::Concern
 
@@ -16,15 +15,15 @@ module Mongoid
       # @param [ Hash ] options Options to pass to remove.
       #
       # @return [ TrueClass ] True.
-      #
-      # @since 1.0.0
       def delete(options = {})
         raise Errors::ReadonlyDocument.new(self.class) if readonly?
         prepare_delete do
-          if embedded?
-            delete_as_embedded(options)
-          else
-            delete_as_root
+          unless options[:persist] == false
+            if embedded?
+              delete_as_embedded(options)
+            else
+              delete_as_root
+            end
           end
         end
       end
@@ -40,10 +39,8 @@ module Mongoid
       #   document.atomic_deletes
       #
       # @return [ Hash ] The atomic deletes.
-      #
-      # @since 4.0.0
       def atomic_deletes
-        { atomic_delete_modifier => { atomic_path => _index ? { "_id" => id } : true }}
+        { atomic_delete_modifier => { atomic_path => _index ? { "_id" => _id } : true }}
       end
 
       # Delete the embedded document.
@@ -56,8 +53,6 @@ module Mongoid
       # @param [ Hash ] options The deletion options.
       #
       # @return [ true ] If the operation succeeded.
-      #
-      # @since 4.0.0
       def delete_as_embedded(options = {})
         _parent.remove_child(self) if notifying_parent?(options)
         if _parent.persisted?
@@ -77,8 +72,6 @@ module Mongoid
       #   document.delete_as_root
       #
       # @return [ true ] If the document was removed.
-      #
-      # @since 4.0.0
       def delete_as_root
         collection.find(atomic_selector).delete_one(session: _session)
         true
@@ -94,8 +87,6 @@ module Mongoid
       # @param [ Hash ] options The delete options.
       #
       # @return [ true, false ] If the parent should be notified.
-      #
-      # @since 4.0.0
       def notifying_parent?(options = {})
         !options.delete(:suppress)
       end
@@ -110,14 +101,10 @@ module Mongoid
       #   end
       #
       # @return [ Object ] The result of the block.
-      #
-      # @since 4.0.0
       def prepare_delete
-        cascade!
         yield(self)
         freeze
         self.destroyed = true
-        true
       end
 
       module ClassMethods
@@ -135,10 +122,8 @@ module Mongoid
         # @param [ Hash ] conditions Optional conditions to delete by.
         #
         # @return [ Integer ] The number of documents deleted.
-        #
-        # @since 1.0.0
         def delete_all(conditions = {})
-          selector = hereditary? ? conditions.merge(_type: name) : conditions
+          selector = hereditary? ? conditions.merge(discriminator_key.to_sym => discriminator_value) : conditions
           where(selector).delete
         end
       end

data/lib/mongoid/persistable/destroyable.rb

@@ -1,10 +1,9 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Persistable
 
-    # Defines behaviour for persistence operations that destroy documents.
-    #
-    # @since 4.0.0
+    # Defines behavior for persistence operations that destroy documents.
     module Destroyable
       extend ActiveSupport::Concern
 
@@ -16,18 +15,22 @@ module Mongoid
       # @param [ Hash ] options Options to pass to destroy.
       #
       # @return [ true, false ] True if successful, false if not.
-      #
-      # @since 1.0.0
       def destroy(options = nil)
         raise Errors::ReadonlyDocument.new(self.class) if readonly?
         self.flagged_for_destroy = true
-        result = run_callbacks(:destroy) { delete(options || {}) }
+        result = run_callbacks(:destroy) do
+          if catch(:abort) { apply_destroy_dependencies! }
+            delete(options || {})
+          else
+            false
+          end
+        end
         self.flagged_for_destroy = false
         result
       end
 
       def destroy!(options = {})
-        destroy || raise(Errors::DocumentNotDestroyed.new(id, self.class))
+        destroy || raise(Errors::DocumentNotDestroyed.new(_id, self.class))
       end
 
       module ClassMethods
@@ -45,8 +48,6 @@ module Mongoid
         # @param [ Hash ] conditions Optional conditions to destroy by.
         #
         # @return [ Integer ] The number of documents destroyed.
-        #
-        # @since 1.0.0
         def destroy_all(conditions = nil)
           where(conditions || {}).destroy
         end

data/lib/mongoid/persistable/incrementable.rb

@@ -1,10 +1,9 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Persistable
 
-    # Defines behaviour for $inc operations.
-    #
-    # @since 4.0.0
+    # Defines behavior for $inc operations.
     module Incrementable
       extend ActiveSupport::Concern
 
@@ -18,17 +17,17 @@ module Mongoid
       # @param [ Hash ] increments The field/inc increment pairs.
       #
       # @return [ Document ] The document.
-      #
-      # @since 4.0.0
       def inc(increments)
         prepare_atomic_operation do |ops|
           process_atomic_operations(increments) do |field, value|
             increment = value.__to_inc__
             current = attributes[field]
-            attributes[field] = (current || 0) + increment
+            new_value = (current || 0) + increment
+            process_attribute field, new_value if executing_atomically?
+            attributes[field] = new_value
             ops[atomic_attribute_name(field)] = increment
           end
-          { "$inc" => ops }
+          { "$inc" => ops } unless ops.empty?
         end
       end
     end

data/lib/mongoid/persistable/logical.rb

@@ -1,10 +1,9 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Persistable
 
-    # Defines behaviour for logical bitwise operations.
-    #
-    # @since 4.0.0
+    # Defines behavior for logical bitwise operations.
     module Logical
       extend ActiveSupport::Concern
 
@@ -17,8 +16,6 @@ module Mongoid
       # @param [ Hash ] operations The bitwise operations.
       #
       # @return [ Document ] The document.
-      #
-      # @since 4.0.0
       def bit(operations)
         prepare_atomic_operation do |ops|
           process_atomic_operations(operations) do |field, values|
@@ -27,10 +24,11 @@ module Mongoid
               value = value & val if op.to_s == "and"
               value = value | val if op.to_s == "or"
             end
+            process_attribute field, value if executing_atomically?
             attributes[field] = value
             ops[atomic_attribute_name(field)] = values
           end
-          { "$bit" => ops }
+          { "$bit" => ops } unless ops.empty?
         end
       end
     end

data/lib/mongoid/persistable/poppable.rb

@@ -1,10 +1,9 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Persistable
 
-    # Defines behaviour for $pop operations.
-    #
-    # @since 4.0.0
+    # Defines behavior for $pop operations.
     module Poppable
       extend ActiveSupport::Concern
 
@@ -22,8 +21,6 @@ module Mongoid
       # @param [ Hash ] pops The field/value pop operations.
       #
       # @return [ Document ] The document.
-      #
-      # @since 4.0.0
       def pop(pops)
         prepare_atomic_operation do |ops|
           process_atomic_operations(pops) do |field, value|

data/lib/mongoid/persistable/pullable.rb

@@ -1,10 +1,9 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Persistable
 
-    # Defines behaviour for $pull and $pullAll operations.
-    #
-    # @since 4.0.0
+    # Defines behavior for $pull and $pullAll operations.
     module Pullable
       extend ActiveSupport::Concern
 
@@ -18,8 +17,6 @@ module Mongoid
       # @param [ Hash ] pulls The field/value pull pairs.
       #
       # @return [ Document ] The document.
-      #
-      # @since 4.0.0
       def pull(pulls)
         prepare_atomic_operation do |ops|
           process_atomic_operations(pulls) do |field, value|
@@ -38,8 +35,6 @@ module Mongoid
       # @param [ Hash ] pulls The pull all operations.
       #
       # @return [ Document ] The document.
-      #
-      # @since 4.0.0
       def pull_all(pulls)
         prepare_atomic_operation do |ops|
           process_atomic_operations(pulls) do |field, value|

data/lib/mongoid/persistable/pushable.rb

@@ -1,10 +1,9 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Persistable
 
-    # Defines behaviour for $push and $addToSet operations.
-    #
-    # @since 4.0.0
+    # Defines behavior for $push and $addToSet operations.
     module Pushable
       extend ActiveSupport::Concern
 
@@ -17,12 +16,16 @@ module Mongoid
       # @param [ Hash ] adds The field/value pairs to add.
       #
       # @return [ Document ] The document.
-      #
-      # @since 4.0.0
       def add_to_set(adds)
         prepare_atomic_operation do |ops|
           process_atomic_operations(adds) do |field, value|
-            existing = send(field) || (attributes[field] ||= [])
+            existing = send(field) || attributes[field]
+            if existing.nil?
+              attributes[field] = []
+              # Read the value out of attributes:
+              # https://jira.mongodb.org/browse/MONGOID-4874
+              existing = attributes[field]
+            end
             values = [ value ].flatten(1)
             values.each do |val|
               existing.push(val) unless existing.include?(val)
@@ -44,12 +47,13 @@ module Mongoid
       # @param [ Hash ] pushes The $push operations.
       #
       # @return [ Document ] The document.
-      #
-      # @since 4.0.0
       def push(pushes)
         prepare_atomic_operation do |ops|
           process_atomic_operations(pushes) do |field, value|
-            existing = send(field) || (attributes[field] ||= [])
+            existing = send(field) || begin
+              attributes[field] ||= []
+              attributes[field]
+            end
             values = [ value ].flatten(1)
             values.each{ |val| existing.push(val) }
             ops[atomic_attribute_name(field)] = { "$each" => values }

data/lib/mongoid/persistable/renamable.rb

@@ -1,10 +1,9 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Persistable
 
-    # Defines behaviour for $rename operations.
-    #
-    # @since 4.0.0
+    # Defines behavior for $rename operations.
     module Renamable
       extend ActiveSupport::Concern
 
@@ -13,18 +12,21 @@ module Mongoid
       # @example Rename the fields.
       #   document.rename(title: "salutation", name: "nombre")
       #
-      # @note This does not work for fields in embeds many relations.
+      # @note This does not work for fields in embeds many associations.
       #
       # @param [ Hash ] renames The rename pairs of old name/new name.
       #
       # @return [ Document ] The document.
-      #
-      # @since 4.0.0
       def rename(renames)
         prepare_atomic_operation do |ops|
           process_atomic_operations(renames) do |old_field, new_field|
             new_name = new_field.to_s
-            attributes[new_name] = attributes.delete(old_field)
+            if executing_atomically?
+              process_attribute new_name, attributes[old_field]
+              process_attribute old_field, nil
+            else
+              attributes[new_name] = attributes.delete(old_field)
+            end
             ops[atomic_attribute_name(old_field)] = atomic_attribute_name(new_name)
           end
           { "$rename" => ops }

data/lib/mongoid/persistable/savable.rb

@@ -1,10 +1,9 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Persistable
 
-    # Defines behaviour for persistence operations that save documents.
-    #
-    # @since 4.0.0
+    # Defines behavior for persistence operations that save documents.
     module Savable
 
       # Save the document - will perform an insert if the document is new, and
@@ -16,8 +15,6 @@ module Mongoid
       # @param [ Hash ] options Options to pass to the save.
       #
       # @return [ true, false ] True is success, false if not.
-      #
-      # @since 1.0.0
       def save(options = {})
         if new_record?
           !insert(options).new_record?
@@ -38,8 +35,6 @@ module Mongoid
       # @raise [ Errors::Callback ] If a callback returns false.
       #
       # @return [ true, false ] True if validation passed.
-      #
-      # @since 1.0.0
       def save!(options = {})
         unless save(options)
           fail_due_to_validation! unless errors.empty?

data/lib/mongoid/persistable/settable.rb

@@ -1,10 +1,9 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Persistable
 
-    # Defines behaviour for $set operations.
-    #
-    # @since 4.0.0
+    # Defines behavior for $set operations.
     module Settable
       extend ActiveSupport::Concern
 
@@ -14,25 +13,73 @@ module Mongoid
       # @example Set the values.
       #   document.set(title: "sir", dob: Date.new(1970, 1, 1))
       #
+      # The key can be a dotted sequence of keys, in which case the
+      # top level field is treated as a nested hash and any missing keys
+      # are created automatically:
+      #
+      # @example Set the values using nested hash semantics.
+      #   document.set('author.title' => 'Sir')
+      #   # => document.author == {'title' => 'Sir'}
+      #
+      # Performing a nested set like this merges values of intermediate keys:
+      #
+      # @example Nested hash value merging.
+      #   document.set('author.title' => 'Sir')
+      #   document.set('author.name' => 'Linus Torvalds')
+      #   # => document.author == {'title' => 'Sir', 'name' => 'Linus Torvalds'}
+      #
+      # If the top level field was not a hash, its original value is discarded
+      # and the field is replaced with a hash.
+      #
+      # @example Nested hash overwriting a non-hash value.
+      #   document.set('author' => 'John Doe')
+      #   document.set('author.title' => 'Sir')
+      #   # => document.author == {'title' => 'Sir'}
+      #
+      # Note that unlike MongoDB's $set, Mongoid's set writes out the entire
+      # field even when setting a subset of the field via the nested hash
+      # semantics. This means performing a $set with nested hash semantics
+      # can overwrite other hash keys within the top level field in the database.
+      #
       # @param [ Hash ] setters The field/value pairs to set.
       #
       # @return [ Document ] The document.
-      #
-      # @since 4.0.0
       def set(setters)
         prepare_atomic_operation do |ops|
           process_atomic_operations(setters) do |field, value|
 
-            field_and_value_hash = hasherizer(field.split('.'), value)
-            field = field_and_value_hash.keys.first.to_s
-            value = field_and_value_hash[field]
+            field_seq = field.to_s.split('.')
+            field = field_seq.shift
+            if field_seq.length > 0
+              # nested hash path
+              old_value = attributes[field]
+
+              # if the old value is not a hash, clobber it
+              unless Hash === old_value
+                old_value = {}
+              end
+
+              # descend into the hash, creating intermediate keys as needed
+              cur_value = old_value
+              while field_seq.length > 1
+                cur_key = field_seq.shift
+                # clobber on each level if type is not a hash
+                unless Hash === cur_value[cur_key]
+                  cur_value[cur_key] = {}
+                end
+                cur_value = cur_value[cur_key]
+              end
 
-            if fields[field] && fields[field].type == Hash && attributes.key?(field) && Hash === value && !value.empty?
-              merger = proc { |key, v1, v2| Hash === v1 && Hash === v2 ? v1.merge(v2, &merger) : v2 }
-              value = (attributes[field] || {}).merge(value, &merger)
+              # now we are on the leaf level, perform the set
+              # and overwrite whatever was on this level before
+              cur_value[field_seq.shift] = value
+
+              # and set value to the value of the top level field
+              # because this is what we pass to $set
+              value = old_value
             end
 
-            process_attribute(field.to_s, value)
+            process_attribute(field, value)
 
             unless relations.include?(field.to_s)
               ops[atomic_attribute_name(field)] = attributes[field]
@@ -42,10 +89,5 @@ module Mongoid
         end
       end
     end
-
-    def hasherizer(keys, value)
-      return value if keys.empty?
-      {}.tap { |hash| hash[keys.shift] = hasherizer(keys, value) }
-    end
   end
 end

data/lib/mongoid/persistable/unsettable.rb

@@ -1,10 +1,9 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Persistable
 
-    # Defines behaviour for $unset operations.
-    #
-    # @since 4.0.0
+    # Defines behavior for $unset operations.
     module Unsettable
       extend ActiveSupport::Concern
 
@@ -18,13 +17,15 @@ module Mongoid
       #   unset.
       #
       # @return [ Document ] The document.
-      #
-      # @since 4.0.0
       def unset(*fields)
         prepare_atomic_operation do |ops|
           fields.flatten.each do |field|
             normalized = database_field_name(field)
-            attributes.delete(normalized)
+            if executing_atomically?
+              process_attribute normalized, nil
+            else
+              attributes.delete(normalized)
+            end
             ops[atomic_attribute_name(normalized)] = true
           end
           { "$unset" => ops }
@@ -33,4 +34,3 @@ module Mongoid
     end
   end
 end
-

data/lib/mongoid/persistable/updatable.rb

@@ -1,11 +1,10 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Persistable
 
-    # Defines behaviour for persistence operations that update existing
+    # Defines behavior for persistence operations that update existing
     # documents.
-    #
-    # @since 4.0.0
     module Updatable
 
       # Update a single attribute and persist the entire document.
@@ -18,11 +17,9 @@ module Mongoid
       # @param [ Object ] value The new value of the attribute.a
       #
       # @raise [ Errors::ReadonlyAttribute ] If the field cannot be changed due
-      #   to being flagged as reaodnly.
-      #
-      # @return [ true, false ] True if save was successfull, false if not.
+      #   to being flagged as read-only.
       #
-      # @since 2.0.0
+      # @return [ true, false ] True if save was successful, false if not.
       def update_attribute(name, value)
         as_writable_attribute!(name, value) do |access|
           normalized = name.to_s
@@ -39,8 +36,6 @@ module Mongoid
       # @param [ Hash ] attributes The attributes to update.
       #
       # @return [ true, false ] True if validation passed, false if not.
-      #
-      # @since 1.0.0
       def update(attributes = {})
         assign_attributes(attributes)
         save
@@ -59,8 +54,6 @@ module Mongoid
       # @raise [ Errors::Callbacks ] If a callback returns false.
       #
       # @return [ true, false ] True if validation passed.
-      #
-      # @since 1.0.0
       def update!(attributes = {})
         result = update_attributes(attributes)
         unless result
@@ -81,8 +74,6 @@ module Mongoid
       #   document.init_atomic_updates
       #
       # @return [ Array<Hash> ] The updates and conflicts.
-      #
-      # @since 4.0.0
       def init_atomic_updates
         updates = atomic_updates
         conflicts = updates.delete(:conflicts) || {}
@@ -101,8 +92,6 @@ module Mongoid
       # @param [ Hash ] options The options.
       #
       # @return [ true, false ] The result of the update.
-      #
-      # @since 4.0.0
       def prepare_update(options = {})
         return false if performing_validations?(options) &&
           invalid?(options[:context] || :update)
@@ -126,8 +115,6 @@ module Mongoid
       # @option options [ true, false ] :validate Whether or not to validate.
       #
       # @return [ true, false ] True if succeeded, false if not.
-      #
-      # @since 1.0.0
       def update_document(options = {})
         prepare_update(options) do
           updates, conflicts = init_atomic_updates
@@ -135,8 +122,33 @@ module Mongoid
             coll = collection(_root)
             selector = atomic_selector
             coll.find(selector).update_one(positionally(selector, updates), session: _session)
-            conflicts.each_pair do |key, value|
-              coll.find(selector).update_one(positionally(selector, { key => value }), session: _session)
+
+            # The following code applies updates which would cause
+            # path conflicts in MongoDB, for example when changing attributes
+            # of foo.0.bars while adding another foo. Each conflicting update
+            # is applied using its own write.
+            #
+            # TODO: MONGOID-5026: reduce the number of writes performed by
+            # more intelligently combining the writes such that there are
+            # fewer conflicts.
+            conflicts.each_pair do |modifier, changes|
+
+              # Group the changes according to their root key which is
+              # the top-level association name.
+              # This handles at least the cases described in MONGOID-4982.
+              conflicting_change_groups = changes.group_by do |key, _|
+                key.split(".", 2).first
+              end.values
+
+              # Apply changes in batches. Pop one change from each
+              # field-conflict group round-robin until all changes
+              # have been applied.
+              while batched_changes = conflicting_change_groups.map(&:pop).compact.to_h.presence
+                coll.find(selector).update_one(
+                  positionally(selector, modifier => batched_changes),
+                  session: _session,
+                )
+              end
             end
           end
         end

data/lib/mongoid/persistable/upsertable.rb

@@ -1,10 +1,9 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Persistable
 
-    # Defines behaviour for persistence operations that upsert documents.
-    #
-    # @since 4.0.0
+    # Defines behavior for persistence operations that upsert documents.
     module Upsertable
 
       # Perform an upsert of the document. If the document does not exist in the
@@ -17,11 +16,9 @@ module Mongoid
       # @param [ Hash ] options The validation options.
       #
       # @return [ true ] True.
-      #
-      # @since 3.0.0
       def upsert(options = {})
         prepare_upsert(options) do
-          collection.find(atomic_selector).update_one(
+          collection.find(atomic_selector).replace_one(
               as_attributes, upsert: true, session: _session)
         end
       end
@@ -40,8 +37,6 @@ module Mongoid
       # @param [ Hash ] options The options hash.
       #
       # @return [ true, false ] If the operation succeeded.
-      #
-      # @since 4.0.0
       def prepare_upsert(options = {})
         return false if performing_validations?(options) && invalid?(:upsert)
         result = run_callbacks(:upsert) do