mongoid 7.0.2 → 8.1.1

data/lib/mongoid/config.rb

@@ -1,33 +1,179 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
+require "mongoid/config/defaults"
 require "mongoid/config/environment"
 require "mongoid/config/options"
 require "mongoid/config/validators"
 
 module Mongoid
 
-  # This module defines all the configuration options for Mongoid, including the
-  # database connections.
+  # This module defines all the configuration options for Mongoid, including
+  # the database connections.
   module Config
-    extend self
+    extend Forwardable
     extend Options
+    extend Defaults
+    extend self
 
-    delegate :logger=, to: ::Mongoid
-    delegate :logger, to: ::Mongoid
+    def_delegators ::Mongoid, :logger, :logger=
 
     LOCK = Mutex.new
 
+    # Application name that is printed to the mongodb logs upon establishing
+    # a connection in server versions >= 3.4. Note that the name cannot
+    # exceed 128 bytes. It is also used as the database name if the
+    # database name is not explicitly defined.
+    option :app_name, default: nil
+
+    # (Deprecated) In MongoDB 4.0 and earlier, set whether to create
+    # indexes in the background by default. (default: false)
+    option :background_indexing, default: false
+
+    # Mark belongs_to associations as required by default, so that saving a
+    # model with a missing belongs_to association will trigger a validation
+    # error.
+    option :belongs_to_required_by_default, default: true
+
+    # Set the global discriminator key.
+    option :discriminator_key, default: "_type"
+
+    # Raise an exception when a field is redefined.
+    option :duplicate_fields_exception, default: false
+
+    # Include the root model name in json serialization.
     option :include_root_in_json, default: false
+
+    # # Include the _type field in serialization.
     option :include_type_for_serialization, default: false
+
+    # Whether to join nested persistence contexts for atomic operations
+    # to parent contexts by default.
+    option :join_contexts, default: false
+
+    # The log level.
+    #
+    # It must be set prior to referencing clients or Mongo.logger,
+    # changes to this option are not be propagated to any clients and
+    # loggers that already exist.
+    #
+    # Additionally, only when the clients are configured via the
+    # configuration file is the log level given by this option honored.
+    option :log_level, default: :info
+
+    # Preload all models in development, needed when models use inheritance.
     option :preload_models, default: false
+
+    # Raise an error when performing a #find and the document is not found.
     option :raise_not_found_error, default: true
+
+    # Raise an error when defining a scope with the same name as an
+    # existing method.
     option :scope_overwrite_exception, default: false
-    option :duplicate_fields_exception, default: false
+
+    # Use ActiveSupport's time zone in time operations instead of the
+    # Ruby default time zone.
+    # @deprecated
     option :use_activesupport_time_zone, default: true
+
+    # Return stored times as UTC.
     option :use_utc, default: false
-    option :log_level, default: :info
-    option :belongs_to_required_by_default, default: true
-    option :app_name, default: nil
-    option :background_indexing, default: false
+
+    # Store BigDecimals as Decimal128s instead of strings in the db.
+    option :map_big_decimal_to_decimal128, default: true
+
+    # Update embedded documents correctly when setting it, unsetting it
+    # and resetting it. See MONGOID-5206 and MONGOID-5240 for more details.
+    option :broken_updates, default: false
+
+    # Maintain legacy behavior of === on Mongoid documents, which returns
+    # true in a number of cases where Ruby's === implementation would
+    # return false.
+    option :legacy_triple_equals, default: false
+
+    # When exiting a nested `with_scope' block, set the current scope to
+    # nil instead of the parent scope for backwards compatibility.
+    option :broken_scoping, default: false
+
+    # Maintain broken behavior of sum over empty result sets for backwards
+    # compatibility.
+    option :broken_aggregables, default: false
+
+    # Ignore aliased fields in embedded documents when performing pluck and
+    # distinct operations, for backwards compatibility.
+    option :broken_alias_handling, default: false
+
+    # Maintain broken `and' behavior when using the same operator on the same
+    # field multiple times for backwards compatibility.
+    option :broken_and, default: false
+
+    # Use millisecond precision when comparing Time objects with the _matches?
+    # function.
+    option :compare_time_by_ms, default: true
+
+    # Use bson-ruby's implementation of as_json for BSON::ObjectId instead of
+    # the one monkey-patched into Mongoid.
+    option :object_id_as_json_oid, default: false
+
+    # Maintain legacy behavior of pluck and distinct, which does not
+    # demongoize the values on returning them.
+    option :legacy_pluck_distinct, default: false
+
+    # Combine chained operators, which use the same field and operator,
+    # using and's instead of overwriting them.
+    option :overwrite_chained_operators, default: false
+
+    # When this flag is true, the attributes method on a document will return
+    # a BSON::Document when that document is retrieved from the database, and
+    # a Hash otherwise. When this flag is false, the attributes method will
+    # always return a Hash.
+    option :legacy_attributes, default: false
+
+    # 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+
+    #   - :global_thread_pool - Initializes a single +Concurrent::ThreadPoolExecutor+
+    #      that uses the +async_query_concurrency+ for the +max_threads+ value.
+    option :async_query_executor, default: :immediate
+
+    # Defines how many asynchronous queries can be executed concurrently.
+    # This option should be set only if `async_query_executor` is set
+    # to `:global_thread_pool`.
+    option :global_executor_concurrency, default: nil
+
+    # 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
+    # to save or update such documents, instead of just on delete. When this
+    # flag is true, a document is only read-only if it has been projected
+    # using #only or #without, and read-only documents will not be
+    # deletable/destroyable, but they will be savable/updatable.
+    # When this feature flag is turned on, the read-only state will be reset on
+    # reload, but when it is turned off, it won't be.
+    option :legacy_readonly, default: true
+
+    # When this flag is true, any attempt to change the _id of a persisted
+    # document will raise an exception (`Errors::ImmutableAttribute`).
+    # This will be the default in 9.0. When this flag is false (the default
+    # in 8.x), changing the _id of a persisted document might be ignored,
+    # or it might work, depending on the situation.
+    option :immutable_ids, default: false
+
+    # When this flag is true, callbacks for every embedded document will be
+    # called only once, even if the embedded document is embedded in multiple
+    # documents in the root document's dependencies graph.
+    # This will be the default in 9.0. Setting this flag to false restores the
+    # pre-9.0 behavior, where callbacks are called for every occurrence of an
+    # embedded document. The pre-9.0 behavior leads to a problem that for multi
+    # level nested documents callbacks are called multiple times.
+    # See https://jira.mongodb.org/browse/MONGOID-5542
+    option :prevent_multiple_calls_of_embedded_callbacks, default: false
+
+    # Returns the Config singleton, for use in the configure DSL.
+    #
+    # @return [ self ] The Config singleton.
+    def config
+      self
+    end
 
     # Has Mongoid been configured? This is checking that at least a valid
     # client config exists.
@@ -35,9 +181,7 @@ module Mongoid
     # @example Is Mongoid configured?
     #   config.configured?
     #
-    # @return [ true, false ] If Mongoid is configured.
-    #
-    # @since 3.0.9
+    # @return [ true | false ] If Mongoid is configured.
     def configured?
       clients.key?(:default)
     end
@@ -50,8 +194,6 @@ module Mongoid
     #   config.connect_to("mongoid_test")
     #
     # @param [ String ] name The database name.
-    #
-    # @since 3.0.0
     def connect_to(name, options = { read: { mode: :primary }})
       self.clients = {
         default: {
@@ -80,9 +222,7 @@ module Mongoid
     #   Mongoid.load!("/path/to/mongoid.yml")
     #
     # @param [ String ] path The path to the file.
-    # @param [ String, Symbol ] environment The environment to load.
-    #
-    # @since 2.0.1
+    # @param [ String | Symbol ] environment The environment to load.
     def load!(path, environment = nil)
       settings = Environment.load_yaml(path, environment)
       if settings.present?
@@ -100,8 +240,6 @@ module Mongoid
     #   config.models
     #
     # @return [ Array<Class> ] All the models in the application.
-    #
-    # @since 3.1.0
     def models
       @models ||= []
     end
@@ -112,26 +250,34 @@ module Mongoid
     #   config.register_model(Band)
     #
     # @param [ Class ] klass The model to register.
-    #
-    # @since 3.1.0
     def register_model(klass)
       LOCK.synchronize do
         models.push(klass) unless models.include?(klass)
       end
     end
 
+    # Deregister a model in the application with Mongoid.
+    #
+    # @param [ Class ] klass The model to deregister.
+    #
+    # @api private
+    def deregister_model(klass)
+      LOCK.synchronize do
+        models.delete(klass)
+      end
+    end
+
     # From a hash of settings, load all the configuration.
     #
     # @example Load the configuration.
     #   config.load_configuration(settings)
     #
     # @param [ Hash ] settings The configuration settings.
-    #
-    # @since 3.1.0
     def load_configuration(settings)
       configuration = settings.with_indifferent_access
       self.options = configuration[:options]
       self.clients = configuration[:clients]
+      Mongo.options = configuration[:driver_options] || {}
       set_log_levels
     end
 
@@ -140,11 +286,9 @@ module Mongoid
     # @example Override the database globally.
     #   config.override_database(:optional)
     #
-    # @param [ String, Symbol ] name The name of the database.
-    #
-    # @return [ String, Symbol ] The global override.
+    # @param [ String | Symbol ] name The name of the database.
     #
-    # @since 3.0.0
+    # @return [ String | Symbol ] The global override.
     def override_database(name)
       Threaded.database_override = name
     end
@@ -154,11 +298,9 @@ module Mongoid
     # @example Override the client globally.
     #   config.override_client(:optional)
     #
-    # @param [ String, Symbol ] name The name of the client.
-    #
-    # @return [ String, Symbol ] The global override.
+    # @param [ String | Symbol ] name The name of the client.
     #
-    # @since 3.0.0
+    # @return [ String | Symbol ] The global override.
     def override_client(name)
       Threaded.client_override = name ? name.to_s : nil
     end
@@ -171,10 +313,8 @@ module Mongoid
     # @note This is the fastest way to drop all data.
     #
     # @return [ true ] true.
-    #
-    # @since 2.0.2
     def purge!
-      Clients.default.database.collections.each(&:drop) and true
+      global_client.database.collections.each(&:drop) and true
     end
 
     # Truncate all data in all collections, but not the indexes.
@@ -185,10 +325,8 @@ module Mongoid
     # @note This will be slower than purge!
     #
     # @return [ true ] true.
-    #
-    # @since 2.0.2
     def truncate!
-      Clients.default.database.collections.each do |collection|
+      global_client.database.collections.each do |collection|
         collection.find.delete_many
       end and true
     end
@@ -199,10 +337,9 @@ module Mongoid
     #   config.options = { raise_not_found_error: true }
     #
     # @param [ Hash ] options The configuration options.
-    #
-    # @since 3.0.0
     def options=(options)
       if options
+        Validators::AsyncQueryExecutor.validate(options)
         options.each_pair do |option, value|
           Validators::Option.validate(option)
           send("#{option}=", value)
@@ -216,8 +353,6 @@ module Mongoid
     #   config.clients
     #
     # @return [ Hash ] The clients configuration.
-    #
-    # @since 3.0.0
     def clients
       @clients ||= {}
     end
@@ -228,8 +363,6 @@ module Mongoid
     #   Config.time_zone
     #
     # @return [ String ] The time zone.
-    #
-    # @since 3.0.0
     def time_zone
       use_utc? ? "UTC" : ::Time.zone
     end
@@ -239,9 +372,7 @@ module Mongoid
     # @example Is the application using passenger?
     #   config.running_with_passenger?
     #
-    # @return [ true, false ] If the app is deployed on Passenger.
-    #
-    # @since 3.0.11
+    # @return [ true | false ] If the app is deployed on Passenger.
     def running_with_passenger?
       @running_with_passenger ||= defined?(PhusionPassenger)
     end
@@ -259,5 +390,61 @@ module Mongoid
       Validators::Client.validate(c)
       @clients = c
     end
+
+    # Get database client that respects global overrides
+    # Config.override_database and Config.override_client.
+    #
+    # @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
+      if Threaded.database_override
+        client.use(Threaded.database_override)
+      else
+        client
+      end
+    end
+
+    module DeprecatedOptions
+      OPTIONS = %i[ use_activesupport_time_zone
+                    broken_aggregables
+                    broken_alias_handling
+                    broken_and
+                    broken_scoping
+                    broken_updates
+                    compare_time_by_ms
+                    legacy_attributes
+                    legacy_pluck_distinct
+                    legacy_triple_equals
+                    object_id_as_json_oid
+                    overwrite_chained_operators ]
+
+      if RUBY_VERSION < '3.0'
+        def self.prepended(klass)
+          klass.class_eval do
+            OPTIONS.each do |option|
+              alias_method :"#{option}_without_deprecation=", :"#{option}="
+
+              define_method(:"#{option}=") do |value|
+                Mongoid::Warnings.send(:"warn_#{option}_deprecated")
+                send(:"#{option}_without_deprecation=", value)
+              end
+            end
+          end
+        end
+      else
+        OPTIONS.each do |option|
+          define_method(:"#{option}=") do |value|
+            Mongoid::Warnings.send(:"warn_#{option}_deprecated")
+            super(value)
+          end
+        end
+      end
+    end
+
+    prepend DeprecatedOptions
   end
 end

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

@@ -1,10 +1,25 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Contextual
     module Aggregable
-      # Contains behaviour for aggregating values in memory.
+      # 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.
+        #
+        # @param [ String | Symbol ] field The field name.
+        #
+        # @return [ Hash ] A Hash containing the aggregate values.
+        #   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|
+            hash[method] = send(method, field)
+          end
+        end
+
         # Get the average value of the provided field.
         #
         # @example Get the average of a single field.
@@ -12,11 +27,13 @@ module Mongoid
         #
         # @param [ Symbol ] field The field to average.
         #
-        # @return [ Float ] The average.
-        #
-        # @since 3.0.0
+        # @return [ Numeric ] The average.
         def avg(field)
-          count > 0 ? sum(field).to_f / count.to_f : nil
+          total = count { |doc| !doc.send(field).nil? }
+          return nil unless total > 0
+
+          total = total.to_f if total.is_a?(Integer)
+          sum(field) / total
         end
 
         # Get the max value of the provided field. If provided a block, will
@@ -33,12 +50,12 @@ module Mongoid
         #
         # @param [ Symbol ] field The field to max.
         #
-        # @return [ Float, Document ] The max value or document with the max
+        # @return [ Numeric | Document ] The max value or document with the max
         #   value.
-        #
-        # @since 3.0.0
         def max(field = nil)
-          block_given? ? super() : aggregate_by(field, :max_by)
+          return super() if block_given?
+
+          aggregate_by(field, :max)
         end
 
         # Get the min value of the provided field. If provided a block, will
@@ -55,12 +72,12 @@ module Mongoid
         #
         # @param [ Symbol ] field The field to min.
         #
-        # @return [ Float, Document ] The min value or document with the min
+        # @return [ Numeric | Document ] The min value or document with the min
         #   value.
-        #
-        # @since 3.0.0
         def min(field = nil)
-          block_given? ? super() : aggregate_by(field, :min_by)
+          return super() if block_given?
+
+          aggregate_by(field, :min)
         end
 
         # Get the sum value of the provided field. If provided a block, will
@@ -74,15 +91,11 @@ module Mongoid
         #
         # @param [ Symbol ] field The field to sum.
         #
-        # @return [ Float ] The sum value.
-        #
-        # @since 3.0.0
+        # @return [ Numeric ] The sum value.
         def sum(field = nil)
-          if block_given?
-            super()
-          else
-            count > 0 ? super(0) { |doc| doc.public_send(field) } : 0
-          end
+          return super() if block_given?
+
+          aggregate_by(field, :sum) || 0
         end
 
         private
@@ -92,16 +105,16 @@ module Mongoid
         # @api private
         #
         # @example Aggregate by the field and method.
-        #   aggregable.aggregate_by(:name, :min_by)
+        #   aggregable.aggregate_by(:likes, :min_by)
         #
         # @param [ Symbol ] field The field to aggregate on.
         # @param [ Symbol ] method The method (min_by or max_by).
         #
-        # @return [ Integer ] The aggregate.
-        #
-        # @since 3.0.0
+        # @return [ Numeric | nil ] The aggregate.
         def aggregate_by(field, method)
-          count > 0 ? send(method) { |doc| doc.public_send(field) }.public_send(field) : nil
+          return nil unless any?
+
+          map { |doc| doc.public_send(field) }.compact.public_send(method)
         end
       end
     end

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

@@ -1,31 +1,38 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
+require "mongoid/contextual/aggregable"
+
 module Mongoid
   module Contextual
     module Aggregable
-      # Contains behaviour for aggregating values in Mongo.
+      # Contains behavior for aggregating values in Mongo.
       module Mongo
 
         # Get all the aggregate values for the provided field.
         #
         # @example Get all the aggregate values.
         #   aggregable.aggregates(:likes)
-        #
-        # @param [ String, Symbol ] field The field name.
-        #
-        # @return [ Hash ] count is a number of documents with the provided field. If there're none, then count is 0 and max, min, sum, avg are nil.
-        #   {
-        #     "count" => 2.0,
-        #     "max" => 1000.0,
-        #     "min" => 500.0,
-        #     "sum" => 1500.0,
-        #     "avg" => 750.0
-        #   }
-        #
-        # @since 3.0.0
+        #   # => {
+        #   #   "count" => 2.0,
+        #   #   "max" => 1000.0,
+        #   #   "min" => 500.0,
+        #   #   "sum" => 1500.0,
+        #   #   "avg" => 750.0
+        #   # }
+        #
+        # @param [ String | Symbol ] field The field name.
+        #
+        # @return [ Hash ] A Hash containing the aggregate values.
+        #   If no documents are found, then returned Hash will have
+        #   count, sum of 0 and max, min, avg of nil.
         def aggregates(field)
-          result = collection.find.aggregate(pipeline(field), session: _session).to_a
+          result = collection.aggregate(pipeline(field), session: _session).to_a
           if result.empty?
-            { "count" => 0, "sum" => nil, "avg" => nil, "min" => nil, "max" => nil }
+            if Mongoid.broken_aggregables
+              { "count" => 0, "sum" => nil, "avg" => nil, "min" => nil, "max" => nil }
+            else
+              Aggregable::EMPTY_RESULT.dup
+            end
           else
             result.first
           end
@@ -39,8 +46,6 @@ module Mongoid
         # @param [ Symbol ] field The field to average.
         #
         # @return [ Float ] The average.
-        #
-        # @since 3.0.0
         def avg(field)
           aggregates(field)["avg"]
         end
@@ -59,10 +64,8 @@ module Mongoid
         #
         # @param [ Symbol ] field The field to max.
         #
-        # @return [ Float, Document ] The max value or document with the max
+        # @return [ Float | Document ] The max value or document with the max
         #   value.
-        #
-        # @since 3.0.0
         def max(field = nil)
           block_given? ? super() : aggregates(field)["max"]
         end
@@ -81,10 +84,8 @@ module Mongoid
         #
         # @param [ Symbol ] field The field to min.
         #
-        # @return [ Float, Document ] The min value or document with the min
+        # @return [ Float | Document ] The min value or document with the min
         #   value.
-        #
-        # @since 3.0.0
         def min(field = nil)
           block_given? ? super() : aggregates(field)["min"]
         end
@@ -101,8 +102,6 @@ module Mongoid
         # @param [ Symbol ] field The field to sum.
         #
         # @return [ Float ] The sum value.
-        #
-        # @since 3.0.0
         def sum(field = nil)
           block_given? ? super() : aggregates(field)["sum"] || 0
         end
@@ -116,18 +115,18 @@ module Mongoid
         # @example Get the pipeline.
         #   aggregable.pipeline(:likes)
         #
-        # @param [ String, Symbol ] field The name of the field.
+        # @param [ String | Symbol ] field The name of the field.
         #
         # @return [ Array ] The array of pipeline operators.
-        #
-        # @since 3.1.0
         def pipeline(field)
           db_field = "$#{database_field_name(field)}"
+          sort, skip, limit = criteria.options.values_at(:sort, :skip, :limit)
+
           pipeline = []
           pipeline << { "$match" =>  criteria.exists(field => true).selector }
-          pipeline << { "$sort" => criteria.options[:sort] } if criteria.options[:sort]
-          pipeline << { "$skip" => criteria.options[:skip] } if criteria.options[:skip]
-          pipeline << { "$limit" => criteria.options[:limit] } if criteria.options[:limit]
+          pipeline << { "$sort" => sort } if sort && (skip || limit)
+          pipeline << { "$skip" => skip } if skip
+          pipeline << { "$limit" => limit } if limit
           pipeline << {
             "$group"  => {
               "_id"   => field.to_s,