mongoid 9.0.11 → 9.1.0

data/lib/mongoid/config/validators/async_query_executor.rb

@@ -1,10 +1,8 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   module Config
     module Validators
-
       # Validates the async query executor options in the Mongoid
       # configuration. Used during application bootstrapping.
       #
@@ -22,10 +20,9 @@ module Mongoid
         #
         # @api private
         def validate(options)
-          if options.key?(:async_query_executor)
-            if options[:async_query_executor].to_sym == :immediate && !options[:global_executor_concurrency].nil?
-              raise Errors::InvalidGlobalExecutorConcurrency
-            end
+          return unless options.key?(:async_query_executor)
+          if options[:async_query_executor].to_sym == :immediate && !options[:global_executor_concurrency].nil?
+            raise Errors::InvalidGlobalExecutorConcurrency
           end
         end
       end

data/lib/mongoid/config/validators/client.rb

@@ -1,16 +1,14 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   module Config
     module Validators
-
       # Validator for client specific configuration.
       module Client
         extend self
 
         # Standard configuration options.
-        STANDARD = [ :database, :hosts, :username, :password ].freeze
+        STANDARD = %i[database hosts username password].freeze
 
         # Validate the client configuration.
         #
@@ -19,9 +17,8 @@ module Mongoid
         #
         # @param [ Hash ] clients The clients config.
         def validate(clients)
-          unless clients.has_key?(:default)
-            raise Errors::NoDefaultClient.new(clients.keys)
-          end
+          raise Errors::NoDefaultClient.new(clients.keys) unless clients.has_key?(:default)
+
           clients.each_pair do |name, config|
             validate_client_database(name, config)
             validate_client_hosts(name, config)
@@ -41,9 +38,9 @@ module Mongoid
         # @param [ String | Symbol ] name The config key.
         # @param [ Hash ] config The configuration.
         def validate_client_database(name, config)
-          if no_database_or_uri?(config)
-            raise Errors::NoClientDatabase.new(name, config)
-          end
+          return unless no_database_or_uri?(config)
+
+          raise Errors::NoClientDatabase.new(name, config)
         end
 
         # Validate that the client config has hosts.
@@ -56,9 +53,9 @@ module Mongoid
         # @param [ String | Symbol ] name The config key.
         # @param [ Hash ] config The configuration.
         def validate_client_hosts(name, config)
-          if no_hosts_or_uri?(config)
-            raise Errors::NoClientHosts.new(name, config)
-          end
+          return unless no_hosts_or_uri?(config)
+
+          raise Errors::NoClientHosts.new(name, config)
         end
 
         # Validate that not both a uri and standard options are provided for a
@@ -72,9 +69,9 @@ module Mongoid
         # @param [ String | Symbol ] name The config key.
         # @param [ Hash ] config The configuration.
         def validate_client_uri(name, config)
-          if both_uri_and_standard?(config)
-            raise Errors::MixedClientConfiguration.new(name, config)
-          end
+          return unless both_uri_and_standard?(config)
+
+          raise Errors::MixedClientConfiguration.new(name, config)
         end
 
         # Return true if the configuration has no database or uri option

data/lib/mongoid/config/validators/option.rb

@@ -1,10 +1,8 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   module Config
     module Validators
-
       # Validator for configuration options.
       module Option
         extend self
@@ -15,9 +13,9 @@ module Mongoid
         #
         # @param [ String ] option The name of the option.
         def validate(option)
-          unless Config.settings.keys.include?(option.to_sym)
-            raise Errors::InvalidConfigOption.new(option)
-          end
+          return if Config.settings.keys.include?(option.to_sym)
+
+          raise Errors::InvalidConfigOption.new(option)
         end
       end
     end

data/lib/mongoid/config/validators.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
-require "mongoid/config/validators/async_query_executor"
-require "mongoid/config/validators/option"
-require "mongoid/config/validators/client"
+require 'mongoid/config/validators/async_query_executor'
+require 'mongoid/config/validators/option'
+require 'mongoid/config/validators/client'

data/lib/mongoid/config.rb

@@ -1,15 +1,13 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
-require "mongoid/config/defaults"
-require "mongoid/config/environment"
-require "mongoid/config/options"
-require "mongoid/config/validators"
-require "mongoid/config/introspection"
-require "mongoid/config/encryption"
+require 'mongoid/config/defaults'
+require 'mongoid/config/environment'
+require 'mongoid/config/options'
+require 'mongoid/config/validators'
+require 'mongoid/config/introspection'
+require 'mongoid/config/encryption'
 
 module Mongoid
-
   # This module defines all the configuration options for Mongoid, including
   # the database connections.
   module Config
@@ -39,7 +37,7 @@ module Mongoid
     option :belongs_to_required_by_default, default: true
 
     # Set the global discriminator key.
-    option :discriminator_key, default: "_type"
+    option :discriminator_key, default: '_type'
 
     # Raise an exception when a field is redefined.
     option :duplicate_fields_exception, default: false
@@ -81,23 +79,23 @@ module Mongoid
     option :map_big_decimal_to_decimal128, default: true
 
     # Allow BSON::Decimal128 to be parsed and returned directly in
-    # field values. When BSON 5 is present and the this option is set to false
+    # field values. When BSON 5 is present and this option is set to false
     # (the default), BSON::Decimal128 values in the database will be returned
     # as BigDecimal.
     #
     # @note this option only has effect when BSON 5+ is present. Otherwise,
     #   the setting is ignored.
-    option :allow_bson5_decimal128, default: false, on_change: -> (allow) do
-        if BSON::VERSION >= '5.0.0'
-          if allow
-            BSON::Registry.register(BSON::Decimal128::BSON_TYPE, BSON::Decimal128)
-          else
-            BSON::Registry.register(BSON::Decimal128::BSON_TYPE, BigDecimal)
-          end
+    option :allow_bson5_decimal128, default: false, on_change: lambda { |allow|
+      if BSON::VERSION >= '5.0.0'
+        if allow
+          BSON::Registry.register(BSON::Decimal128::BSON_TYPE, BSON::Decimal128)
+        else
+          BSON::Registry.register(BSON::Decimal128::BSON_TYPE, BigDecimal)
         end
       end
+    }
 
-    # Sets the async_query_executor for the application. By default the thread pool executor
+    # Sets the async_query_executor for the application. By default, the thread pool executor
     #   is set to `:immediate. Options are:
     #
     #   - :immediate - Initializes a single +Concurrent::ImmediateExecutor+
@@ -110,6 +108,28 @@ module Mongoid
     # to `:global_thread_pool`.
     option :global_executor_concurrency, default: nil
 
+    VALID_ISOLATION_LEVELS = %i[ rails thread fiber ].freeze
+
+    # Defines the isolation level that Mongoid uses to store its internal
+    # state.
+    #
+    # Valid values are:
+    # - `:rails` - Uses the isolation level that Rails currently has
+    #  configured. (This is the default.)
+    # - `:thread` - Uses thread-local storage.
+    # - `:fiber` - Uses fiber-local storage (only supported in Ruby 3.2+).
+    #
+    # If set to `:fiber`, Mongoid will use fiber-local storage instead. This
+    # may be necessary if you are using libraries like Falcon, which use
+    # fibers to manage concurrency.
+    #
+    # Note that the `:fiber` isolation level is only supported in Ruby 3.2
+    # and later, due to semantic differences in how fiber storage is handled
+    # in earlier Ruby versions.
+    option :isolation_level, default: :rails, on_change: lambda { |level|
+      validate_isolation_level!(level)
+    }
+
     # When this flag is true, it will be possible to change the parent of a
     # record in a "has_many" association by passing the child record's id in the
     # nested attributes for another parent record.
@@ -117,23 +137,69 @@ module Mongoid
     # When this flag is false, attempting to change the parent of a record in a
     # "has-many" association via nested attributes will raise an error.
     #
-    # The default is `true`. Note that allowing reparenting via nested attributes
+    # The default is `false`. Note that allowing reparenting via nested attributes
     # is a potential security risk, since it could allow a malicious user to move
     # records that they do not own to a parent record that they do own.
     #
-    # This option will default to `false` in Mongoid 9.1, and will be removed
-    # in Mongoid 10.
-    option :allow_reparenting_via_nested_attributes, default: true
+    # This option will be removed in Mongoid 10, and the only behavior will be
+    # as if this option were set to false.
+    option :allow_reparenting_via_nested_attributes, default: false
+
+    # When this flag is true, Mongoid will skip sending queries to the database
+    # for criteria that are guaranteed to return no results, such as those with
+    # an empty $in array (e.g. Band.in(name: [])). The default is false.
+    option :allow_short_circuit_queries, default: false
 
     # When this flag is true, any documents in associations with `autosave: true`
     # will be saved even if they have not been changed. When this flag is false,
     # only autosaved documents that have been changed will be saved. The default
-    # is `true`.
+    # is false.
+    #
+    # This option will be removed in Mongoid 10, with the only behavior at that
+    # point being as if this option were set to false.
+    option :autosave_saves_unchanged_documents, default: false
+
+    # Returns the (potentially-dereferenced) isolation level that Mongoid
+    # will use to store its internal state. If `isolation_level` is set to
+    # `:rails`, this will return the isolation level that Rails is current
+    # configured to use (`ActiveSupport::IsolatedExecutionState.isolation_level`).
+    #
+    # If using an older version of Rails that does not support
+    # ActiveSupport::IsolatedExecutionState, this will return `:thread`
+    # instead.
+    #
+    # @api private
+    def real_isolation_level
+      return isolation_level unless isolation_level == :rails
+
+      if defined?(ActiveSupport::IsolatedExecutionState)
+        ActiveSupport::IsolatedExecutionState.isolation_level.tap do |level|
+          # We can't guarantee that Rails will always support the same
+          # isolation levels as Mongoid, so we check here to make sure
+          # it's something we can work with.
+          validate_isolation_level!(level)
+        end
+      else
+        # The default, if Rails does not support IsolatedExecutionState,
+        :thread
+      end
+    end
+
+    # Checks to see if the provided isolation level is something that Mongoid
+    # supports. Raises Errors::UnsupportedIsolationLevel if it is not.
     #
-    # This option will default to `false` in Mongoid 9.1, and will be removed
-    # in Mongoid 10, with the only behavior at that point being as if this
-    # option were set to `false`.
-    option :autosave_saves_unchanged_documents, default: true
+    # This will also raise an error if the isolation level is set to `:fiber`
+    # and the Ruby version is less than 3.2, since fiber-local storage
+    # is not supported in earlier Ruby versions.
+    #
+    # @api private
+    def validate_isolation_level!(level)
+      raise Errors::UnsupportedIsolationLevel.new(level) unless VALID_ISOLATION_LEVELS.include?(level)
+
+      return unless level == :fiber && RUBY_VERSION < '3.2'
+
+      raise Errors::UnsupportedIsolationLevel.new(level)
+    end
 
     # When this flag is false, a document will become read-only only once the
     # #readonly! method is called, and an error will be raised on attempting
@@ -191,7 +257,7 @@ module Mongoid
     #
     # Setting this flag to true restores the pre-9.0 behavior, where callbacks
     # for embedded documents are called. This may lead to stack overflow errors
-    # if there are more than cicrca 1000 embedded documents in the root
+    # if there are more than circa 1000 embedded documents in the root
     # document's dependencies graph.
     # See https://jira.mongodb.org/browse/MONGOID-5658 for more details.
     option :around_callbacks_for_embeds, default: false
@@ -205,6 +271,29 @@ module Mongoid
     # See https://jira.mongodb.org/browse/MONGOID-5785 for more details.
     option :allow_scopes_to_unset_default_scope, default: false
 
+    # When this flag is false, indexes are (roughly) validated on the client
+    # to prevent duplicate indexes being declared. This validation is
+    # incomplete, however, and can result in some indexes being silently
+    # ignored.
+    #
+    # Setting this to true will allow duplicate indexes to be declared and sent
+    # to the server. The server will then validate the indexes and raise an
+    # exception if duplicates are detected.
+    #
+    # See https://jira.mongodb.org/browse/MONGOID-5827 for an example of the
+    # consequences of duplicate index checking.
+    option :allow_duplicate_index_declarations, default: false
+
+    # When this flag is true, performing a serializable_hash(only: []) will
+    # result in all fields being included. This is the traditional (and default)
+    # behavior in Mongoid 9 and earlier.
+    #
+    # Setting this flag to false will change the behavior to suppress all fields
+    # in the serialized hash. This will be the default in Mongoid 10.
+    #
+    # See https://jira.mongodb.org/browse/MONGOID-5892 for more details.
+    option :serializable_hash_with_legacy_only, default: true
+
     # Returns the Config singleton, for use in the configure DSL.
     #
     # @return [ self ] The Config singleton.
@@ -231,11 +320,11 @@ module Mongoid
     #   config.connect_to("mongoid_test")
     #
     # @param [ String ] name The database name.
-    def connect_to(name, options = { read: { mode: :primary }})
+    def connect_to(name, options = { read: { mode: :primary } })
       self.clients = {
         default: {
           database: name,
-          hosts: [ "localhost:27017" ],
+          hosts: [ 'localhost:27017' ],
           options: options
         }
       }
@@ -375,12 +464,12 @@ module Mongoid
     #
     # @param [ Hash ] options The configuration options.
     def options=(options)
-      if options
-        Validators::AsyncQueryExecutor.validate(options)
-        options.each_pair do |option, value|
-          Validators::Option.validate(option)
-          send("#{option}=", value)
-        end
+      return unless options
+
+      Validators::AsyncQueryExecutor.validate(options)
+      options.each_pair do |option, value|
+        Validators::Option.validate(option)
+        send("#{option}=", value)
       end
     end
 
@@ -401,7 +490,7 @@ module Mongoid
     #
     # @return [ String ] The time zone.
     def time_zone
-      use_utc? ? "UTC" : ::Time.zone
+      use_utc? ? 'UTC' : ::Time.zone
     end
 
     # Is the application running under passenger?
@@ -427,6 +516,7 @@ module Mongoid
 
     def clients=(clients)
       raise Errors::NoClientsConfig.new unless clients
+
       c = clients.with_indifferent_access
       Validators::Client.validate(c)
       @clients = c
@@ -437,11 +527,11 @@ module Mongoid
     #
     # @return [Mongo::Client] Client according to global overrides.
     def global_client
-      client =  if Threaded.client_override
-                  Clients.with_name(Threaded.client_override)
-                else
-                  Clients.default
-                end
+      client = if Threaded.client_override
+                 Clients.with_name(Threaded.client_override)
+               else
+                 Clients.default
+               end
       if Threaded.database_override
         client.use(Threaded.database_override)
       else

data/lib/mongoid/contextual/aggregable/memory.rb

@@ -1,12 +1,10 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   module Contextual
     module Aggregable
       # Contains behavior for aggregating values in memory.
       module Memory
-
         # Get all the aggregate values for the provided field.
         # Provided for interface consistency with Aggregable::Mongo.
         #
@@ -16,7 +14,7 @@ module Mongoid
         #   If no documents are present, then returned Hash will have
         #   count, sum of 0 and max, min, avg of nil.
         def aggregates(field)
-          %w(count sum avg min max).each_with_object({}) do |method, hash|
+          %w[count sum avg min max].each_with_object({}) do |method, hash|
             hash[method] = send(method, field)
           end
         end
@@ -90,7 +88,7 @@ module Mongoid
         # @example Get the sum for the provided block.
         #   aggregable.sum(&:likes)
         #
-        # @param [ Symbol | Numeric ] field The field to sum, or the intial
+        # @param [ Symbol | Numeric ] field The field to sum, or the initial
         #   value of the sum when a block is given.
         #
         # @return [ Numeric ] The sum value.

data/lib/mongoid/contextual/aggregable/mongo.rb

@@ -1,14 +1,12 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
-require "mongoid/contextual/aggregable"
+require 'mongoid/contextual/aggregable'
 
 module Mongoid
   module Contextual
     module Aggregable
       # Contains behavior for aggregating values in Mongo.
       module Mongo
-
         # Get all the aggregate values for the provided field.
         #
         # @example Get all the aggregate values.
@@ -28,10 +26,10 @@ module Mongoid
         #   count, sum of 0 and max, min, avg of nil.
         def aggregates(field)
           result = collection.aggregate(
-                    pipeline(field),
-                    session: _session,
-                    hint: view.hint
-                  ).to_a
+            pipeline(field),
+            session: _session,
+            hint: view.hint
+          ).to_a
 
           if result.empty?
             Aggregable::EMPTY_RESULT.dup
@@ -49,7 +47,7 @@ module Mongoid
         #
         # @return [ Float ] The average.
         def avg(field)
-          aggregates(field)["avg"]
+          aggregates(field)['avg']
         end
 
         # Get the max value of the provided field. If provided a block, will
@@ -69,7 +67,7 @@ module Mongoid
         # @return [ Float | Document ] The max value or document with the max
         #   value.
         def max(field = nil)
-          block_given? ? super() : aggregates(field)["max"]
+          block_given? ? super() : aggregates(field)['max']
         end
 
         # Get the min value of the provided field. If provided a block, will
@@ -89,7 +87,7 @@ module Mongoid
         # @return [ Float | Document ] The min value or document with the min
         #   value.
         def min(field = nil)
-          block_given? ? super() : aggregates(field)["min"]
+          block_given? ? super() : aggregates(field)['min']
         end
 
         # Get the sum value of the provided field. If provided a block, will
@@ -108,7 +106,7 @@ module Mongoid
         def sum(field = nil)
           return super(field || 0) if block_given?
 
-          aggregates(field)["sum"] || 0
+          aggregates(field)['sum'] || 0
         end
 
         private
@@ -128,18 +126,18 @@ module Mongoid
           sort, skip, limit = criteria.options.values_at(:sort, :skip, :limit)
 
           pipeline = []
-          pipeline << { "$match" =>  criteria.exists(field => true).selector }
-          pipeline << { "$sort" => sort } if sort && (skip || limit)
-          pipeline << { "$skip" => skip } if skip
-          pipeline << { "$limit" => limit } if limit
+          pipeline << { '$match' => criteria.exists(field => true).selector }
+          pipeline << { '$sort' => sort } if sort && (skip || limit)
+          pipeline << { '$skip' => skip } if skip
+          pipeline << { '$limit' => limit } if limit
           pipeline << {
-            "$group"  => {
-              "_id"   => field.to_s,
-              "count" => { "$sum" => 1 },
-              "max"   => { "$max" => db_field },
-              "min"   => { "$min" => db_field },
-              "sum"   => { "$sum" => db_field },
-              "avg"   => { "$avg" => db_field }
+            '$group' => {
+              '_id' => field.to_s,
+              'count' => { '$sum' => 1 },
+              'max' => { '$max' => db_field },
+              'min' => { '$min' => db_field },
+              'sum' => { '$sum' => db_field },
+              'avg' => { '$avg' => db_field }
             }
           }
         end

data/lib/mongoid/contextual/aggregable/none.rb

@@ -1,14 +1,12 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
-require "mongoid/contextual/aggregable"
+require 'mongoid/contextual/aggregable'
 
 module Mongoid
   module Contextual
     module Aggregable
       # Contains behavior for aggregating values in null context.
       module None
-
         # Get all the aggregate values for the provided field in null context.
         # Provided for interface consistency with Aggregable::Mongo.
         #
@@ -59,7 +57,7 @@ module Mongoid
         # @param [ Symbol ] _field The field to max.
         #
         # @return [ nil ] Always nil.
-        alias :max :min
+        alias max min
       end
     end
   end

data/lib/mongoid/contextual/aggregable.rb

@@ -1,17 +1,15 @@
 # frozen_string_literal: true
-# rubocop:todo all
 
 module Mongoid
   module Contextual
     module Aggregable
-
       # @api private
       EMPTY_RESULT = {
-        "count" => 0,
-        "sum" => 0,
-        "avg" => nil,
-        "min" => nil,
-        "max" => nil,
+        'count' => 0,
+        'sum' => 0,
+        'avg' => nil,
+        'min' => nil,
+        'max' => nil
       }.freeze
     end
   end