mongoid 8.1.6 → 9.0.0

data/lib/mongoid/persistable/maxable.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+# rubocop:todo all
+
+module Mongoid
+  module Persistable
+
+    # Defines behavior for setting a field (or fields) to the larger of
+    # either it's current value, or a given value.
+    module Maxable
+      extend ActiveSupport::Concern
+
+      # Set the given field or fields to the larger of either it's current
+      # value, or a given value.
+      #
+      # @example Set a field to be no less than 100.
+      #   document.set_max(field: 100)
+      #
+      # @param [ Hash<Symbol | String, Comparable> ] fields The fields to
+      #   set, with corresponding minimum values.
+      #
+      # @return [ Document ] The document.
+      def set_max(fields)
+        prepare_atomic_operation do |ops|
+          process_atomic_operations(fields) do |field, value|
+            current_value = attributes[field]
+            if value > current_value
+              process_attribute field, value
+              ops[atomic_attribute_name(field)] = value
+            end
+          end
+          { "$max" => ops } unless ops.empty?
+        end
+      end
+      alias :clamp_lower_bound :set_max
+    end
+  end
+end

data/lib/mongoid/persistable/minable.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+# rubocop:todo all
+
+module Mongoid
+  module Persistable
+
+    # Defines behavior for setting a field (or fields) to the smaller of
+    # either it's current value, or a given value.
+    module Minable
+      extend ActiveSupport::Concern
+
+      # Set the given field or fields to the smaller of either it's current
+      # value, or a given value.
+      #
+      # @example Set a field to be no more than 100.
+      #   document.min(field: 100)
+      #
+      # @param [ Hash<Symbol | String, Comparable> ] fields The fields to
+      #   set, with corresponding maximum values.
+      #
+      # @return [ Document ] The document.
+      def set_min(fields)
+        prepare_atomic_operation do |ops|
+          process_atomic_operations(fields) do |field, value|
+            current_value = attributes[field]
+            if value < current_value
+              process_attribute field, value
+              ops[atomic_attribute_name(field)] = value
+            end
+          end
+          { "$min" => ops } unless ops.empty?
+        end
+      end
+      alias :clamp_upper_bound :set_min
+    end
+  end
+end

data/lib/mongoid/persistable/multipliable.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+# rubocop:todo all
+
+module Mongoid
+  module Persistable
+
+    # Defines behavior for $mul operations.
+    module Multipliable
+      extend ActiveSupport::Concern
+
+      # Multiply the provided fields by the corresponding values. Values can
+      # be positive or negative, and if no value exists for the field it will
+      # be set to zero.
+      #
+      # @example Multiply the fields.
+      #   document.mul(score: 10, place: 1, lives: -10)
+      #
+      # @param [ Hash ] factors The field/factor multiplier pairs.
+      #
+      # @return [ Document ] The document.
+      def mul(factors)
+        prepare_atomic_operation do |ops|
+          process_atomic_operations(factors) do |field, value|
+            factor = value.is_a?(BigDecimal) ? value.to_f : value
+            current = attributes[field]
+            new_value = (current || 0) * factor
+            process_attribute field, new_value if executing_atomically?
+            attributes[field] = new_value
+            ops[atomic_attribute_name(field)] = factor
+          end
+          { "$mul" => ops } unless ops.empty?
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/persistable/poppable.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   module Persistable

data/lib/mongoid/persistable/pullable.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   module Persistable

data/lib/mongoid/persistable/pushable.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   module Persistable

data/lib/mongoid/persistable/renamable.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   module Persistable

data/lib/mongoid/persistable/savable.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   module Persistable

data/lib/mongoid/persistable/settable.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   module Persistable

data/lib/mongoid/persistable/unsettable.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   module Persistable

data/lib/mongoid/persistable/updatable.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   module Persistable
@@ -98,23 +99,17 @@ module Mongoid
       def prepare_update(options = {})
         raise Errors::ReadonlyDocument.new(self.class) if readonly? && !Mongoid.legacy_readonly
         enforce_immutability_of_id_field!
+        ensure_client_compatibility!
         return false if performing_validations?(options) &&
           invalid?(options[:context] || :update)
         process_flagged_destroys
         update_children = cascadable_children(:update)
-        process_touch_option(options, update_children)
-        run_callbacks(:save, with_children: false) do
-          run_callbacks(:update, with_children: false) do
-            run_callbacks(:persist_parent, with_children: false) do
-              _mongoid_run_child_callbacks(:save) do
-                _mongoid_run_child_callbacks(:update, children: update_children) do
-                  result = yield(self)
-                  self.previously_new_record = false
-                  post_process_persist(result, options)
-                  true
-                end
-              end
-            end
+        process_touch_option(options, update_children) do
+          run_all_callbacks_for_update(update_children) do
+            result = yield(self)
+            self.previously_new_record = false
+            post_process_persist(result, options)
+            true
           end
         end
       end
@@ -135,16 +130,15 @@ module Mongoid
           unless updates.empty?
             coll = collection(_root)
             selector = atomic_selector
+
+            # TODO: DRIVERS-716: If a new "Bulk Write" API is introduced, it may
+            # become possible to handle the writes for conflicts in the following call.
             coll.find(selector).update_one(positionally(selector, updates), 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
@@ -180,9 +174,12 @@ module Mongoid
       # @option options [ true | false ] :touch Whether or not the updated_at
       #   attribute will be updated with the current time.
       def process_touch_option(options, children)
-        unless options.fetch(:touch, true)
+        if options.fetch(:touch, true)
+          yield
+        else
           timeless
           children.each(&:timeless)
+          suppress_touch_callbacks { yield }
         end
       end
 
@@ -210,6 +207,28 @@ module Mongoid
           end
         end
       end
+
+      # Consolidates all the callback invocations into a single place, to
+      # avoid cluttering the logic in #prepare_update.
+      #
+      # @param [ Array<Document> ] update_children The children that the
+      #   :update callbacks will be executed on.
+      def run_all_callbacks_for_update(update_children)
+        run_callbacks(:commit, with_children: true, skip_if: -> { in_transaction? }) do
+          run_callbacks(:save, with_children: false) do
+            run_callbacks(:update, with_children: false) do
+              run_callbacks(:persist_parent, with_children: false) do
+                _mongoid_run_child_callbacks(:save) do
+                  _mongoid_run_child_callbacks(:update, children: update_children) do
+                    yield
+                  end # _mongoid_run_child_callbacks :update
+                end # _mongoid_run_child_callbacks :save
+              end # :persist_parent
+            end # :update
+          end # :save
+        end # :commit
+      end
+
     end
   end
 end

data/lib/mongoid/persistable/upsertable.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   module Persistable
@@ -12,29 +13,41 @@ module Mongoid
       #
       # If the replace option is true, unspecified attributes will be dropped,
       # and if it is false, unspecified attributes will be maintained. The
-      # replace option defaults to true in Mongoid 8.1 and earlier. The default
-      # will be flipped to false in Mongoid 9.
+      # replace option defaults to false in Mongoid 9.
       #
       # @example Upsert the document.
       #   document.upsert
       #
-      # @example Upsert the document without replace.
-      #   document.upsert(replace: false)
+      # @example Upsert the document with replace.
+      #   document.upsert(replace: true)
+      #
+      # @example Upsert with extra attributes to use when inserting.
+      #   document.upsert(set_on_insert: { created_at: DateTime.now })
       #
       # @param [ Hash ] options The validation options.
       #
       # @option options [ true | false ] :validate Whether or not to validate.
-      # @option options [ true | false ] :replace Whether or not to replace the document on upsert.
+      # @option options [ true | false ] :replace Whether or not to replace
+      #   the document on upsert.
+      # @option options [ Hash ] :set_on_insert The attributes to include if
+      #   the document does not already exist.
       #
       # @return [ true ] True.
       def upsert(options = {})
         prepare_upsert(options) do
-          if options.fetch(:replace, true)
+          if options[:replace]
+            if options[:set_on_insert]
+              raise ArgumentError, "cannot specify :set_on_insert with `replace: true`"
+            end
+
             collection.find(atomic_selector).replace_one(
               as_attributes, upsert: true, session: _session)
           else
+            attrs = { "$set" => as_attributes }
+            attrs["$setOnInsert"] = options[:set_on_insert] if options[:set_on_insert]
+
             collection.find(atomic_selector).update_one(
-              { "$set" => as_attributes }, upsert: true, session: _session)
+              attrs, upsert: true, session: _session)
           end
         end
       end

data/lib/mongoid/persistable.rb

@@ -1,10 +1,14 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 require "mongoid/persistable/creatable"
 require "mongoid/persistable/deletable"
 require "mongoid/persistable/destroyable"
 require "mongoid/persistable/incrementable"
 require "mongoid/persistable/logical"
+require "mongoid/persistable/maxable"
+require "mongoid/persistable/minable"
+require "mongoid/persistable/multipliable"
 require "mongoid/persistable/poppable"
 require "mongoid/persistable/pullable"
 require "mongoid/persistable/pushable"
@@ -25,6 +29,9 @@ module Mongoid
     include Destroyable
     include Incrementable
     include Logical
+    include Maxable
+    include Minable
+    include Multipliable
     include Poppable
     include Positional
     include Pullable
@@ -103,7 +110,7 @@ module Mongoid
       end
 
       true
-    rescue Exception => e
+    rescue StandardError => e
       _mongoid_reset_atomic_context_changes! if has_own_context
       raise e
     ensure
@@ -167,6 +174,9 @@ module Mongoid
     def post_process_persist(result, options = {})
       post_persist unless result == false
       errors.clear unless performing_validations?(options)
+      if in_transaction?
+        Threaded.add_modified_document(_session, self)
+      end
       true
     end
 

data/lib/mongoid/persistence_context.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
 
@@ -10,7 +11,7 @@ module Mongoid
     # Delegate the cluster method to the client.
     def_delegators :client, :cluster
 
-    # Delegate the storage options method to the object.
+    # Delegate the storage_options method to the object.
     def_delegators :@object, :storage_options
 
     # The options defining this persistence context.
@@ -46,6 +47,26 @@ module Mongoid
       set_options!(opts)
     end
 
+    # Returns a new persistence context that is consistent with the given
+    # child document, inheriting most appropriate settings.
+    #
+    # @param [ Mongoid::Document | Class ] document the child document
+    #
+    # @return [ PersistenceContext ] the new persistence context
+    #
+    # @api private
+    def for_child(document)
+      if document.is_a?(Class)
+        return self if document == (@object.is_a?(Class) ? @object : @object.class)
+      elsif document.is_a?(Mongoid::Document)
+        return self if document.class == (@object.is_a?(Class) ? @object : @object.class)
+      else
+        raise ArgumentError, 'must specify a class or a document instance'
+      end
+
+      PersistenceContext.new(document, options.merge(document.storage_options))
+    end
+
     # Get the collection for this persistence context.
     #
     # @example Get the collection for this persistence context.
@@ -68,7 +89,7 @@ module Mongoid
     #   context.collection_name
     #
     # @return [ String ] The collection name for this persistence
-    #  context.
+    #   context.
     def collection_name
       @collection_name ||= (__evaluate__(options[:collection] ||
                              storage_options[:collection]))
@@ -80,7 +101,7 @@ module Mongoid
     #   context.database_name
     #
     # @return [ String ] The database name for this persistence
-    #  context.
+    #   context.
     def database_name
       __evaluate__(database_name_option) || client.database.name
     end
@@ -91,7 +112,7 @@ module Mongoid
     #   context.client
     #
     # @return [ Mongo::Client ] The client for this persistence
-    #  context.
+    #   context.
     def client
       @client ||= begin
         client = Clients.with_name(client_name)
@@ -105,10 +126,17 @@ module Mongoid
       end
     end
 
+    # Get the client name for this persistence context.
+    #
+    # @example Get the client name for this persistence context.
+    #   context.client_name
+    #
+    # @return [ Symbol ] The client name for this persistence
+    #   context.
     def client_name
       @client_name ||= options[:client] ||
                          Threaded.client_override ||
-                         storage_options && __evaluate__(storage_options[:client])
+                         __evaluate__(storage_options[:client])
     end
 
     # Determine if this persistence context is equal to another.
@@ -139,6 +167,18 @@ module Mongoid
       @options.keys == [:client]
     end
 
+    # The subset of provided options that may be used as storage
+    # options.
+    #
+    # @return [ Hash | nil ] the requested storage options, or nil if
+    #   none were specified.
+    #
+    # @api private
+    def requested_storage_options
+      slice = @options.slice(*Mongoid::Clients::Validators::Storage::VALID_OPTIONS)
+      slice.any? ? slice : nil
+    end
+
     private
 
     def set_options!(opts)
@@ -170,7 +210,7 @@ module Mongoid
     def database_name_option
       @database_name_option ||= options[:database] ||
                                   Threaded.database_override ||
-                                  storage_options && storage_options[:database]
+                                  storage_options[:database]
     end
 
     class << self

data/lib/mongoid/positional.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
 

data/lib/mongoid/railtie.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 require "rails"
 require "rails/mongoid"
@@ -9,6 +10,13 @@ module Rails
     # Hooks Mongoid into Rails 3 and higher.
     class Railtie < Rails::Railtie
 
+      console do |app|
+        if app.sandbox?
+          require "mongoid/railties/console_sandbox"
+          start_sandbox
+        end
+      end
+
       # Mapping of rescued exceptions to HTTP responses
       #
       # @example
@@ -44,7 +52,11 @@ module Rails
 
       # Initialize Mongoid. This will look for a mongoid.yml in the config
       # directory and configure mongoid appropriately.
-      initializer "mongoid.load-config" do
+      #
+      # It runs after all config/initializers have loaded, so that the YAML
+      # options can override options specified in
+      # (e.g.) config/initializers/mongoid.rb.
+      initializer "mongoid.load-config", after: :load_config_initializers do
         config_file = Rails.root.join("config", "mongoid.yml")
         if config_file.file?
           begin
@@ -106,6 +118,17 @@ module Rails
             ::Mongoid::Railties::ControllerRuntime::Collector.new
       end
 
+      # Add custom serializers for BSON::ObjectId
+      initializer 'mongoid.active_job.custom_serializers' do
+        ActiveSupport.on_load :active_job do
+          require 'mongoid/railties/bson_object_id_serializer'
+
+          ActiveJob::Serializers.add_serializers(
+            [::Mongoid::Railties::ActiveJobSerializers::BsonObjectIdSerializer]
+          )
+        end
+      end
+
     end
   end
 end

data/lib/mongoid/railties/bson_object_id_serializer.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Mongoid
+  module Railties
+    module ActiveJobSerializers
+      # This class provides serialization and deserialization of BSON::ObjectId
+      # for ActiveJob.
+      #
+      # It is important that this class is loaded only when Rails is available
+      # since it depends on Rails' ActiveJob::Serializers::ObjectSerializer.
+      class BsonObjectIdSerializer < ActiveJob::Serializers::ObjectSerializer
+        #  Returns whether the argument can be serialized by this serializer.
+        #
+        #  @param [ Object ] argument The argument to check.
+        #
+        #  @return [ true | false ] Whether the argument can be serialized.
+        def serialize?(argument)
+          argument.is_a?(BSON::ObjectId)
+        end
+
+        # Serializes the argument to be passed to the job.
+        #
+        # @param [ BSON::ObjectId ] object The object to serialize.
+        def serialize(object)
+          object.to_s
+        end
+
+        # Deserializes the argument back into a BSON::ObjectId.
+        #
+        # @param [ String ] string The string to deserialize.
+        #
+        # @return [ BSON::ObjectId ] The deserialized object.
+        def deserialize(string)
+          BSON::ObjectId.from_string(string)
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/railties/console_sandbox.rb

@@ -0,0 +1,42 @@
+# rubocop:todo all
+require "mongoid/threaded"
+require "mongoid/errors/transactions_not_supported"
+
+# This method raises an error if the cluster the client is connected to
+# does not support transactions in any case. At the moment this is the case
+# of the standalone topology.
+#
+# Please note that if this method did not raise, it does not guarantee that
+# transactions are available for the cluster.
+#
+# @param [ Mongo::Client ] client Client connected to a cluster to be tested.
+#
+# @raise [ Mongoid::Errors::TransactionsNotSupported ] If the cluster
+#   definitely does not support transactions.
+def check_if_transactions_might_be_available!(client)
+  if client.cluster.single?
+    raise Mongoid::Errors::TransactionsNotSupported
+  end
+end
+
+# Starts a transaction that should include all the operations inside
+# the sandboxed console session. This transaction should not be ever committed.
+# When a user end the console session, the client will disconnect, and
+# the transaction will be automatically aborted therefore.
+#
+# @param [ Mongo::Client ] client Client to start the transaction.
+def start_sandbox_transaction(client)
+  session = client.start_session
+  ::Mongoid::Threaded.set_session(session, client: client)
+  session.start_transaction
+end
+
+# Prepares console sandbox mode. This method should be called when
+# a user starts rails console with '--sandbox' flag.
+def start_sandbox
+  Mongoid.persistence_context.client.tap do |client|
+    check_if_transactions_might_be_available!(client)
+    start_sandbox_transaction(client)
+  end
+end
+

data/lib/mongoid/railties/controller_runtime.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   module Railties
@@ -46,9 +47,7 @@ module Mongoid
             messages << ("MongoDB: %.1fms" % mongoid_runtime.to_f) if mongoid_runtime
             messages
           end
-
         end
-
       end
 
       # The Collector of MongoDB runtime metric, that subscribes to Mongo
@@ -59,30 +58,47 @@ module Mongoid
 
         VARIABLE_NAME = "Mongoid.controller_runtime".freeze
 
+        # Call when event started. Does nothing.
+        #
+        # @return [ nil ] Nil.
         def started _; end
 
+        # Call when event completed. Updates the runtime value.
+        #
+        # @param [ Mongo::Event::Base ] e The monitoring event.
+        #
+        # @return [ Integer ] The current runtime value.
         def _completed e
           Collector.runtime += e.duration * 1000
         end
         alias :succeeded :_completed
         alias :failed :_completed
 
+        # Get the runtime value on the current thread.
+        #
+        # @return [ Integer ] The runtime value.
         def self.runtime
           Thread.current[VARIABLE_NAME] ||= 0
         end
 
+        # Set the runtime value on the current thread.
+        #
+        # @param [ Integer ] value The runtime value.
+        #
+        # @return [ Integer ] The runtime value.
         def self.runtime= value
           Thread.current[VARIABLE_NAME] = value
         end
 
+        # Reset the runtime value to zero the current thread.
+        #
+        # @return [ Integer ] The previous runtime value.
         def self.reset_runtime
           to_now = runtime
           self.runtime = 0
           to_now
         end
-
       end
-
     end
   end
 end