mongoid 7.3.5 → 7.4.0

data/lib/mongoid/config/environment.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Config
@@ -23,8 +22,6 @@ module Mongoid
       #   determined because none of the sources was set.
       #
       # @return [ String ] The name of the current environment.
-      #
-      # @since 2.3.0
       # @api public
       def env_name
         if defined?(::Rails)
@@ -47,8 +44,6 @@ module Mongoid
       #   override the current Mongoid environment.
       #
       # @return [ Hash ] The settings.
-      #
-      # @since 2.3.0
       # @api private
       def load_yaml(path, environment = nil)
         env = environment ? environment.to_s : env_name
@@ -56,7 +51,11 @@ module Mongoid
         if contents.empty?
           raise Mongoid::Errors::EmptyConfigFile.new(path)
         end
-        data = YAML.load(ERB.new(contents).result)
+        data = if RUBY_VERSION.start_with?("2.5")
+          YAML.safe_load(ERB.new(contents).result, [Symbol], [], true)
+        else
+          YAML.safe_load(ERB.new(contents).result, permitted_classes: [Symbol], aliases: true)
+        end
         unless data.is_a?(Hash)
           raise Mongoid::Errors::InvalidConfigFile.new(path)
         end

data/lib/mongoid/config/options.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Config
@@ -13,8 +12,6 @@ module Mongoid
       #   options.defaults
       #
       # @return [ Hash ] The default options.
-      #
-      # @since 2.3.0
       def defaults
         @defaults ||= {}
       end
@@ -28,8 +25,6 @@ module Mongoid
       # @param [ Hash ] options Extras for the option.
       #
       # @option options [ Object ] :default The default value.
-      #
-      # @since 2.0.0.rc.1
       def option(name, options = {})
         defaults[name] = settings[name] = options[:default]
 
@@ -57,8 +52,6 @@ module Mongoid
       #   config.reset
       #
       # @return [ Hash ] The defaults.
-      #
-      # @since 2.3.0
       def reset
         settings.replace(defaults)
       end
@@ -69,8 +62,6 @@ module Mongoid
       #   options.settings
       #
       # @return [ Hash ] The setting options.
-      #
-      # @since 2.3.0
       def settings
         @settings ||= {}
       end
@@ -81,8 +72,6 @@ module Mongoid
       #   config.log_level
       #
       # @return [ Integer ] The log level.
-      #
-      # @since 5.1.0
       def log_level
         if level = settings[:log_level]
           unless level.is_a?(Integer)

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

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Config
@@ -10,8 +9,6 @@ module Mongoid
         extend self
 
         # Standard configuration options.
-        #
-        # @since 3.0.0
         STANDARD = [ :database, :hosts, :username, :password ].freeze
 
         # Validate the client configuration.
@@ -20,8 +17,6 @@ module Mongoid
         #   Client.validate({ default: { hosts: [ "localhost:27017" ] }})
         #
         # @param [ Hash ] clients The clients config.
-        #
-        # @since 3.0.0
         def validate(clients)
           unless clients.has_key?(:default)
             raise Errors::NoDefaultClient.new(clients.keys)
@@ -44,8 +39,6 @@ module Mongoid
         #
         # @param [ String, Symbol ] name The config key.
         # @param [ Hash ] config The configuration.
-        #
-        # @since 3.0.0
         def validate_client_database(name, config)
           if no_database_or_uri?(config)
             raise Errors::NoClientDatabase.new(name, config)
@@ -61,8 +54,6 @@ module Mongoid
         #
         # @param [ String, Symbol ] name The config key.
         # @param [ Hash ] config The configuration.
-        #
-        # @since 3.0.0
         def validate_client_hosts(name, config)
           if no_hosts_or_uri?(config)
             raise Errors::NoClientHosts.new(name, config)
@@ -79,8 +70,6 @@ module Mongoid
         #
         # @param [ String, Symbol ] name The config key.
         # @param [ Hash ] config The configuration.
-        #
-        # @since 3.0.0
         def validate_client_uri(name, config)
           if both_uri_and_standard?(config)
             raise Errors::MixedClientConfiguration.new(name, config)
@@ -98,8 +87,6 @@ module Mongoid
         # @param [ Hash ] config The configuration options.
         #
         # @return [ true, false ] If no database or uri is defined.
-        #
-        # @since 3.0.0
         def no_database_or_uri?(config)
           !config.has_key?(:database) && !config.has_key?(:uri)
         end
@@ -115,8 +102,6 @@ module Mongoid
         # @param [ Hash ] config The configuration options.
         #
         # @return [ true, false ] If no hosts or uri is defined.
-        #
-        # @since 3.0.0
         def no_hosts_or_uri?(config)
           !config.has_key?(:hosts) && !config.has_key?(:uri)
         end
@@ -132,8 +117,6 @@ module Mongoid
         # @param [ Hash ] config The configuration options.
         #
         # @return [ true, false ] If both standard and uri are defined.
-        #
-        # @since 3.0.0
         def both_uri_and_standard?(config)
           config.has_key?(:uri) && config.keys.any? do |key|
             STANDARD.include?(key.to_sym)

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

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Config
@@ -14,8 +13,6 @@ module Mongoid
         # @example Validate a configuration option.
         #
         # @param [ String ] option The name of the option.
-        #
-        # @since 3.0.0
         def validate(option)
           unless Config.settings.keys.include?(option.to_sym)
             raise Errors::InvalidConfigOption.new(option)

data/lib/mongoid/config/validators.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 require "mongoid/config/validators/option"
 require "mongoid/config/validators/client"

data/lib/mongoid/config.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 require "mongoid/config/environment"
 require "mongoid/config/options"
@@ -75,6 +74,43 @@ module Mongoid
     # Return stored times as UTC.
     option :use_utc, default: false
 
+    # 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: true
+
+    # 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: true
+
+    # 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: true
+
+    # Maintain broken behavior of sum over empty result sets for backwards
+    # compatibility.
+    option :broken_aggregables, default: true
+
+    # Ignore aliased fields in embedded documents when performing pluck and
+    # distinct operations, for backwards compatibility.
+    option :broken_alias_handling, default: true
+
+    # Maintain broken `and' behavior when using the same operator on the same
+    # field multiple times for backwards compatibility.
+    option :broken_and, default: true
+
+    # Use millisecond precision when comparing Time objects with the _matches?
+    # function.
+    option :compare_time_by_ms, default: false
+
+    # 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: true
+
+    # Maintain legacy behavior of pluck and distinct, which does not
+    # demongoize the values on returning them.
+    option :legacy_pluck_distinct, default: true
+
     # Has Mongoid been configured? This is checking that at least a valid
     # client config exists.
     #
@@ -82,8 +118,6 @@ module Mongoid
     #   config.configured?
     #
     # @return [ true, false ] If Mongoid is configured.
-    #
-    # @since 3.0.9
     def configured?
       clients.key?(:default)
     end
@@ -96,8 +130,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: {
@@ -127,8 +159,6 @@ module Mongoid
     #
     # @param [ String ] path The path to the file.
     # @param [ String, Symbol ] environment The environment to load.
-    #
-    # @since 2.0.1
     def load!(path, environment = nil)
       settings = Environment.load_yaml(path, environment)
       if settings.present?
@@ -146,8 +176,6 @@ module Mongoid
     #   config.models
     #
     # @return [ Array<Class> ] All the models in the application.
-    #
-    # @since 3.1.0
     def models
       @models ||= []
     end
@@ -158,8 +186,6 @@ 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)
@@ -172,8 +198,6 @@ module Mongoid
     #   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]
@@ -189,8 +213,6 @@ module Mongoid
     # @param [ String, Symbol ] name The name of the database.
     #
     # @return [ String, Symbol ] The global override.
-    #
-    # @since 3.0.0
     def override_database(name)
       Threaded.database_override = name
     end
@@ -203,8 +225,6 @@ module Mongoid
     # @param [ String, Symbol ] name The name of the client.
     #
     # @return [ String, Symbol ] The global override.
-    #
-    # @since 3.0.0
     def override_client(name)
       Threaded.client_override = name ? name.to_s : nil
     end
@@ -217,8 +237,6 @@ module Mongoid
     # @note This is the fastest way to drop all data.
     #
     # @return [ true ] true.
-    #
-    # @since 2.0.2
     def purge!
       global_client.database.collections.each(&:drop) and true
     end
@@ -231,8 +249,6 @@ module Mongoid
     # @note This will be slower than purge!
     #
     # @return [ true ] true.
-    #
-    # @since 2.0.2
     def truncate!
       global_client.database.collections.each do |collection|
         collection.find.delete_many
@@ -245,8 +261,6 @@ module Mongoid
     #   config.options = { raise_not_found_error: true }
     #
     # @param [ Hash ] options The configuration options.
-    #
-    # @since 3.0.0
     def options=(options)
       if options
         options.each_pair do |option, value|
@@ -262,8 +276,6 @@ module Mongoid
     #   config.clients
     #
     # @return [ Hash ] The clients configuration.
-    #
-    # @since 3.0.0
     def clients
       @clients ||= {}
     end
@@ -274,8 +286,6 @@ module Mongoid
     #   Config.time_zone
     #
     # @return [ String ] The time zone.
-    #
-    # @since 3.0.0
     def time_zone
       use_utc? ? "UTC" : ::Time.zone
     end
@@ -286,8 +296,6 @@ module Mongoid
     #   config.running_with_passenger?
     #
     # @return [ true, false ] If the app is deployed on Passenger.
-    #
-    # @since 3.0.11
     def running_with_passenger?
       @running_with_passenger ||= defined?(PhusionPassenger)
     end

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

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Contextual
@@ -7,6 +6,20 @@ module Mongoid
       # 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.
@@ -15,8 +28,6 @@ module Mongoid
         # @param [ Symbol ] field The field to average.
         #
         # @return [ Float ] The average.
-        #
-        # @since 3.0.0
         def avg(field)
           count > 0 ? sum(field).to_f / count.to_f : nil
         end
@@ -37,8 +48,6 @@ module Mongoid
         #
         # @return [ Float, 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)
         end
@@ -59,8 +68,6 @@ module Mongoid
         #
         # @return [ Float, 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)
         end
@@ -77,8 +84,6 @@ module Mongoid
         # @param [ Symbol ] field The field to sum.
         #
         # @return [ Float ] The sum value.
-        #
-        # @since 3.0.0
         def sum(field = nil)
           if block_given?
             super()
@@ -100,8 +105,6 @@ module Mongoid
         # @param [ Symbol ] method The method (min_by or max_by).
         #
         # @return [ Integer ] The aggregate.
-        #
-        # @since 3.0.0
         def aggregate_by(field, method)
           count > 0 ? send(method) { |doc| doc.public_send(field) }.public_send(field) : nil
         end

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

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
-# encoding: utf-8
+
+require "mongoid/contextual/aggregable"
 
 module Mongoid
   module Contextual
@@ -21,15 +22,17 @@ module Mongoid
         #
         # @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.
-        #
-        # @since 3.0.0
+        # @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
           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
@@ -43,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
@@ -65,8 +66,6 @@ module Mongoid
         #
         # @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
@@ -87,8 +86,6 @@ module Mongoid
         #
         # @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
@@ -105,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
@@ -123,15 +118,15 @@ module Mongoid
         # @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,

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

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+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.
+        #
+        # @param [ String, Symbol ] _field The field name.
+        #
+        # @return [ Hash ] A Hash with count, sum of 0 and max, min, avg of nil.
+        def aggregates(_field)
+          Aggregable::EMPTY_RESULT.dup
+        end
+
+        # Always returns zero.
+        #
+        # @example Get the sum of null context.
+        #
+        # @param [ Symbol ] _field The field to sum.
+        #
+        # @return [ Integer ] Always zero.
+        def sum(_field = nil)
+          0
+        end
+
+        # Always returns nil.
+        #
+        # @example Get the avg of null context.
+        #
+        # @param [ Symbol ] _field The field to avg.
+        #
+        # @return [ nil ] Always nil.
+        def avg(_field)
+          nil
+        end
+
+        # Always returns nil.
+        #
+        # @example Get the min of null context.
+        #
+        # @param [ Symbol ] _field The field to min.
+        #
+        # @return [ nil ] Always nil.
+        def min(_field = nil)
+          nil
+        end
+
+        # Always returns nil.
+        #
+        # @example Get the max of null context.
+        #
+        # @param [ Symbol ] _field The field to max.
+        #
+        # @return [ nil ] Always nil.
+        alias :max :min
+      end
+    end
+  end
+end

data/lib/mongoid/contextual/aggregable.rb

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

data/lib/mongoid/contextual/atomic.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Contextual
@@ -13,8 +12,6 @@ module Mongoid
       # @param [ Hash ] adds The operations.
       #
       # @return [ nil ] Nil.
-      #
-      # @since 3.0.0
       def add_to_set(adds)
         view.update_many("$addToSet" => collect_operations(adds))
       end
@@ -27,8 +24,6 @@ module Mongoid
       # @param [ Hash ] adds The operations.
       #
       # @return [ nil ] Nil.
-      #
-      # @since 7.0.0
       def add_each_to_set(adds)
         view.update_many("$addToSet" => collect_each_operations(adds))
       end
@@ -41,8 +36,6 @@ module Mongoid
       # @param [ Hash ] bits The operations.
       #
       # @return [ nil ] Nil.
-      #
-      # @since 3.0.0
       def bit(bits)
         view.update_many("$bit" => collect_operations(bits))
       end
@@ -55,8 +48,6 @@ module Mongoid
       # @param [ Hash ] incs The operations.
       #
       # @return [ nil ] Nil.
-      #
-      # @since 3.0.0
       def inc(incs)
         view.update_many("$inc" => collect_operations(incs))
       end
@@ -72,8 +63,6 @@ module Mongoid
       # @param [ Hash ] pops The operations.
       #
       # @return [ nil ] Nil.
-      #
-      # @since 3.0.0
       def pop(pops)
         view.update_many("$pop" => collect_operations(pops))
       end
@@ -88,8 +77,6 @@ module Mongoid
       # @param [ Hash ] pulls The operations.
       #
       # @return [ nil ] Nil.
-      #
-      # @since 3.0.0
       def pull(pulls)
         view.update_many("$pull" => collect_operations(pulls))
       end
@@ -102,8 +89,6 @@ module Mongoid
       # @param [ Hash ] pulls The operations.
       #
       # @return [ nil ] Nil.
-      #
-      # @since 3.0.0
       def pull_all(pulls)
         view.update_many("$pullAll" => collect_operations(pulls))
       end
@@ -116,8 +101,6 @@ module Mongoid
       # @param [ Hash ] pushes The operations.
       #
       # @return [ nil ] Nil.
-      #
-      # @since 3.0.0
       def push(pushes)
         view.update_many("$push" => collect_operations(pushes))
       end
@@ -130,8 +113,6 @@ module Mongoid
       # @param [ Hash ] pushes The operations.
       #
       # @return [ nil ] Nil.
-      #
-      # @since 3.0.0
       def push_all(pushes)
         view.update_many("$push" => collect_each_operations(pushes))
       end
@@ -144,8 +125,6 @@ module Mongoid
       # @param [ Hash ] renames The operations.
       #
       # @return [ nil ] Nil.
-      #
-      # @since 3.0.0
       def rename(renames)
         operations = renames.inject({}) do |ops, (old_name, new_name)|
           ops[old_name] = new_name.to_s
@@ -162,8 +141,6 @@ module Mongoid
       # @param [ Hash ] sets The operations.
       #
       # @return [ nil ] Nil.
-      #
-      # @since 3.0.0
       def set(sets)
         view.update_many("$set" => collect_operations(sets))
       end
@@ -179,8 +156,6 @@ module Mongoid
       #   each key's value is, even if the value is nil or false.
       #
       # @return [ nil ] Nil.
-      #
-      # @since 3.0.0
       def unset(*args)
         fields = args.map { |a| a.is_a?(Hash) ? a.keys : a }
                      .__find_args__