mongoid 7.0.13 → 7.1.0.rc0

data/lib/mongoid/matchable/eq.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Matchable
 

data/lib/mongoid/matchable/exists.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Matchable
 

data/lib/mongoid/matchable/gt.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Matchable
 

data/lib/mongoid/matchable/gte.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Matchable
 

data/lib/mongoid/matchable/in.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Matchable
 

data/lib/mongoid/matchable/lt.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Matchable
 

data/lib/mongoid/matchable/lte.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Matchable
 

data/lib/mongoid/matchable/ne.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Matchable
 

data/lib/mongoid/matchable/nin.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Matchable
 

data/lib/mongoid/matchable/nor.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Matchable
 
@@ -18,7 +19,7 @@ module Mongoid
       #
       # @return [ true, false ] True if matches, false if not.
       #
-      # @since 6.4.2/7.0.2/7.1.0
+      # @since 7.1.0
       def _matches?(conditions)
         if conditions.length == 0
           # MongoDB does not allow $nor array to be empty, but

data/lib/mongoid/matchable/or.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Matchable
 

data/lib/mongoid/matchable/regexp.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 module Mongoid
   module Matchable
 
@@ -7,8 +10,8 @@ module Mongoid
       # Does the supplied query match the attribute?
       #
       # @example Does this match?
-      #   matcher._matches?(/\AEm/)
-      #   matcher._matches?(BSON::Regex::Raw.new("\\AEm"))
+      #   matcher._matches?(/^Em/)
+      #   matcher._matches?(BSON::Regex::Raw.new("^Em"))
       #
       # @param [ BSON::Regexp::Raw, Regexp ] regexp The regular expression object.
       #

data/lib/mongoid/matchable/size.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Matchable
 

data/lib/mongoid/persistable.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 require "mongoid/persistable/creatable"
 require "mongoid/persistable/deletable"
 require "mongoid/persistable/destroyable"
@@ -16,7 +18,7 @@ require "mongoid/persistable/unsettable"
 
 module Mongoid
 
-  # Contains general behaviour for persistence operations.
+  # Contains general behavior for persistence operations.
   #
   # @since 2.0.0
   module Persistable
@@ -43,24 +45,80 @@ module Mongoid
     LIST_OPERATIONS = [ "$addToSet", "$push", "$pull", "$pullAll" ].freeze
 
     # Execute operations atomically (in a single database call) for everything
-    # that would happen inside the block.
+    # that would happen inside the block. This method supports nesting further
+    # calls to atomically, which will behave according to the options described
+    # below.
+    #
+    # An option join_context can be given which, when true, will merge the
+    # operations declared by the given block with the atomically block wrapping
+    # the current invocation for the same document, if one exists. If this
+    # block or any other block sharing the same context raises before
+    # persisting, then all the operations of that context will not be
+    # persisted, and will also be reset in memory.
+    #
+    # When join_context is false, the given block of operations will be
+    # persisted independently of other contexts. Failures in other contexts will
+    # not affect this one, so long as this block was able to run and persist
+    # changes.
+    #
+    # The default value of join_context is set by the global configuration
+    # option join_contexts, whose own default is false.
     #
     # @example Execute the operations atomically.
     #   document.atomically do
     #     document.set(name: "Tool").inc(likes: 10)
     #   end
     #
+    # @example Execute some inner operations atomically, but independently from the outer operations.
+    #
+    #   document.atomically do
+    #     document.inc likes: 10
+    #     document.atomically join_context: false do
+    #       # The following is persisted to the database independently.
+    #       document.unset :origin
+    #     end
+    #     document.atomically join_context: true do
+    #       # The following is persisted along with the other outer operations.
+    #       document.inc member_count: 3
+    #     end
+    #     document.set name: "Tool"
+    #   end
+    #
+    # @param [ true, false ] join_context Join the context (i.e. merge
+    #   declared atomic operations) of the atomically block wrapping this one
+    #   for the same document, if one exists.
+    #
     # @return [ true, false ] If the operation succeeded.
     #
     # @since 4.0.0
-    def atomically
-      begin
-        @atomic_updates_to_execute = @atomic_updates_to_execute || {}
-        yield(self) if block_given?
-        persist_atomic_operations(@atomic_updates_to_execute)
-        true
-      ensure
-        @atomic_updates_to_execute = nil
+    def atomically(join_context: nil)
+      join_context = Mongoid.join_contexts if join_context.nil?
+      call_depth = @atomic_depth ||= 0
+      has_own_context = call_depth.zero? || !join_context
+      @atomic_updates_to_execute_stack ||= []
+      _mongoid_push_atomic_context if has_own_context
+
+      if block_given?
+        @atomic_depth += 1
+        yield(self)
+        @atomic_depth -= 1
+      end
+
+      if has_own_context
+        persist_atomic_operations @atomic_context
+        _mongoid_remove_atomic_context_changes
+      end
+
+      true
+    rescue Exception => e
+      _mongoid_reset_atomic_context_changes! if has_own_context
+      raise e
+    ensure
+      _mongoid_pop_atomic_context if has_own_context
+
+      if call_depth.zero?
+        @atomic_depth = nil
+        @atomic_updates_to_execute_stack = nil
       end
     end
 
@@ -103,7 +161,7 @@ module Mongoid
     #
     # @since 4.0.0
     def executing_atomically?
-      !@atomic_updates_to_execute.nil?
+      !@atomic_updates_to_execute_stack.nil?
     end
 
     # Post process the persistence operation.
@@ -144,7 +202,7 @@ module Mongoid
       self
     end
 
-    # Process the atomic operations - this handles the common behaviour of
+    # Process the atomic operations - this handles the common behavior of
     # iterating through each op, getting the aliased field name, and removing
     # appropriate dirty changes.
     #
@@ -164,10 +222,70 @@ module Mongoid
       operations.each do |field, value|
         access = database_field_name(field)
         yield(access, value)
-        remove_change(access)
+        remove_change(access) unless executing_atomically?
       end
     end
 
+    # Remove the dirty changes for all fields changed in the current atomic
+    # context.
+    #
+    # @api private
+    #
+    # @example Remove the current atomic context's dirty changes.
+    #   document._mongoid_remove_atomic_context_changes
+    def _mongoid_remove_atomic_context_changes
+      return unless executing_atomically?
+      _mongoid_atomic_context_changed_fields.each { |f| remove_change f }
+    end
+
+    # Reset the attributes for all fields changed in the current atomic
+    # context.
+    #
+    # @api private
+    #
+    # @example Reset the current atomic context's changed attributes.
+    #   document._mongoid_reset_atomic_context_changes!
+    def _mongoid_reset_atomic_context_changes!
+      return unless executing_atomically?
+      _mongoid_atomic_context_changed_fields.each { |f| reset_attribute! f }
+    end
+
+    # Push a new atomic context onto the stack.
+    #
+    # @api private
+    #
+    # @example Push a new atomic context onto the stack.
+    #   document._mongoid_push_atomic_context
+    def _mongoid_push_atomic_context
+      return unless executing_atomically?
+      @atomic_context = {}
+      @atomic_updates_to_execute_stack << @atomic_context
+    end
+
+    # Pop an atomic context off the stack.
+    #
+    # @api private
+    #
+    # @example Pop an atomic context off the stack.
+    #   document._mongoid_pop_atomic_context
+    def _mongoid_pop_atomic_context
+      return unless executing_atomically?
+      @atomic_updates_to_execute_stack.pop
+      @atomic_context = @atomic_updates_to_execute_stack.last
+    end
+
+    # Return the current atomic context's changed fields.
+    #
+    # @api private
+    #
+    # @example Return the current atomic context's changed fields.
+    #   document._mongoid_atomic_context_changed_fields
+    #
+    # @return [ Array ] The changed fields.
+    def _mongoid_atomic_context_changed_fields
+      @atomic_context.values.flat_map(&:keys)
+    end
+
     # If we are in an atomically block, add the operations to the delayed group,
     # otherwise persist immediately.
     #
@@ -182,8 +300,8 @@ module Mongoid
     def persist_or_delay_atomic_operation(operation)
       if executing_atomically?
         operation.each do |(name, hash)|
-          @atomic_updates_to_execute[name] ||= {}
-          @atomic_updates_to_execute[name].merge!(hash)
+          @atomic_context[name] ||= {}
+          @atomic_context[name].merge!(hash)
         end
       else
         persist_atomic_operations(operation)

data/lib/mongoid/persistable/creatable.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Persistable
 
-    # Defines behaviour for persistence operations that create new documents.
+    # Defines behavior for persistence operations that create new documents.
     #
     # @since 4.0.0
     module Creatable

data/lib/mongoid/persistable/deletable.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Persistable
 
-    # Defines behaviour for persistence operations that delete documents.
+    # Defines behavior for persistence operations that delete documents.
     #
     # @since 4.0.0
     module Deletable

data/lib/mongoid/persistable/destroyable.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Persistable
 
-    # Defines behaviour for persistence operations that destroy documents.
+    # Defines behavior for persistence operations that destroy documents.
     #
     # @since 4.0.0
     module Destroyable

data/lib/mongoid/persistable/incrementable.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Persistable
 
-    # Defines behaviour for $inc operations.
+    # Defines behavior for $inc operations.
     #
     # @since 4.0.0
     module Incrementable
@@ -25,7 +27,9 @@ module Mongoid
           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 } unless ops.empty?

data/lib/mongoid/persistable/logical.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Persistable
 
-    # Defines behaviour for logical bitwise operations.
+    # Defines behavior for logical bitwise operations.
     #
     # @since 4.0.0
     module Logical
@@ -27,6 +29,7 @@ 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

data/lib/mongoid/persistable/poppable.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Persistable
 
-    # Defines behaviour for $pop operations.
+    # Defines behavior for $pop operations.
     #
     # @since 4.0.0
     module Poppable

data/lib/mongoid/persistable/pullable.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Persistable
 
-    # Defines behaviour for $pull and $pullAll operations.
+    # Defines behavior for $pull and $pullAll operations.
     #
     # @since 4.0.0
     module Pullable

data/lib/mongoid/persistable/pushable.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Persistable
 
-    # Defines behaviour for $push and $addToSet operations.
+    # Defines behavior for $push and $addToSet operations.
     #
     # @since 4.0.0
     module Pushable
@@ -22,13 +24,7 @@ module Mongoid
       def add_to_set(adds)
         prepare_atomic_operation do |ops|
           process_atomic_operations(adds) do |field, value|
-            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
+            existing = send(field) || (attributes[field] ||= [])
             values = [ value ].flatten(1)
             values.each do |val|
               existing.push(val) unless existing.include?(val)
@@ -55,10 +51,7 @@ module Mongoid
       def push(pushes)
         prepare_atomic_operation do |ops|
           process_atomic_operations(pushes) do |field, value|
-            existing = send(field) || begin
-              attributes[field] ||= []
-              attributes[field]
-            end
+            existing = send(field) || (attributes[field] ||= [])
             values = [ value ].flatten(1)
             values.each{ |val| existing.push(val) }
             ops[atomic_attribute_name(field)] = { "$each" => values }