mongoid 7.5.4 → 8.1.6

data/lib/mongoid/errors/no_client_hosts.rb

@@ -11,7 +11,7 @@ module Mongoid
       # @example Create the new error.
       #   NoClientHosts.new(:default, {}})
       #
-      # @param [ Symbol, String ] name The db config key.
+      # @param [ Symbol | String ] name The db config key.
       # @param [ Hash ] config The hash configuration options.
       def initialize(name, config)
         super(

data/lib/mongoid/errors/readonly_attribute.rb

@@ -12,7 +12,7 @@ module Mongoid
       # @example Create the new error.
       #   ReadonlyAttribute.new(:title, "mr")
       #
-      # @param [ Symbol, String ] name The name of the attribute.
+      # @param [ Symbol | String ] name The name of the attribute.
       # @param [ Object ] value The attempted set value.
       def initialize(name, value)
         super(

data/lib/mongoid/errors/too_many_nested_attribute_records.rb

@@ -3,7 +3,7 @@
 module Mongoid
   module Errors
 
-    # This error is raised when trying to create set nested records above the
+    # This error is raised when trying to create set nested documents above the
     # specified :limit
     #
     # @example Create the error.

data/lib/mongoid/errors/unknown_attribute.rb

@@ -13,7 +13,7 @@ module Mongoid
       #   UnknownAttribute.new(Person, "gender")
       #
       # @param [ Class ] klass The model class.
-      # @param [ String, Symbol ] name The name of the attribute.
+      # @param [ String | Symbol ] name The name of the attribute.
       def initialize(klass, name)
         super(
           compose_message("unknown_attribute", { klass: klass.name, name: name })

data/lib/mongoid/errors.rb

@@ -3,19 +3,23 @@
 require "mongoid/errors/mongoid_error"
 require "mongoid/errors/ambiguous_relationship"
 require "mongoid/errors/callback"
+require "mongoid/errors/create_collection_failure"
 require "mongoid/errors/criteria_argument_required"
 require "mongoid/errors/document_not_destroyed"
 require "mongoid/errors/document_not_found"
-require "mongoid/errors/eager_load"
 require "mongoid/errors/empty_config_file"
+require "mongoid/errors/immutable_attribute"
 require "mongoid/errors/in_memory_collation_not_supported"
+require "mongoid/errors/invalid_async_query_executor"
 require "mongoid/errors/invalid_collection"
 require "mongoid/errors/invalid_config_file"
 require "mongoid/errors/invalid_config_option"
 require "mongoid/errors/invalid_dependent_strategy"
 require "mongoid/errors/invalid_field"
 require "mongoid/errors/invalid_field_option"
+require "mongoid/errors/invalid_field_type"
 require "mongoid/errors/invalid_find"
+require "mongoid/errors/invalid_global_executor_concurrency"
 require "mongoid/errors/invalid_includes"
 require "mongoid/errors/invalid_index"
 require "mongoid/errors/invalid_options"
@@ -24,6 +28,7 @@ require "mongoid/errors/invalid_persistence_option"
 require "mongoid/errors/invalid_query"
 # Must be after invalid_query.
 require "mongoid/errors/invalid_discriminator_key_target"
+require "mongoid/errors/invalid_dot_dollar_assignment"
 require "mongoid/errors/invalid_elem_match_operator"
 require "mongoid/errors/invalid_estimated_count_criteria"
 require "mongoid/errors/invalid_expression_operator"
@@ -34,9 +39,7 @@ require "mongoid/errors/invalid_scope"
 require "mongoid/errors/invalid_session_use"
 require "mongoid/errors/invalid_set_polymorphic_relation"
 require "mongoid/errors/invalid_storage_options"
-require "mongoid/errors/invalid_storage_parent"
 require "mongoid/errors/invalid_time"
-require "mongoid/errors/invalid_value"
 require "mongoid/errors/inverse_not_found"
 require "mongoid/errors/mixed_relations"
 require "mongoid/errors/mixed_client_configuration"

data/lib/mongoid/extensions/array.rb

@@ -76,7 +76,7 @@ module Mongoid
       # @example Is this multi args?
       #   [ 1, 2, 3 ].multi_arged?
       #
-      # @return [ true, false ] If the array is multi args.
+      # @return [ true | false ] If the array is multi args.
       def multi_arged?
         !first.is_a?(Hash) && first.resizable? || size > 1
       end
@@ -87,7 +87,7 @@ module Mongoid
       # @example Mongoize the object.
       #   object.mongoize
       #
-      # @return [ Array ] The object.
+      # @return [ Array | nil ] The object or nil.
       def mongoize
         ::Array.mongoize(self)
       end
@@ -144,12 +144,12 @@ module Mongoid
         #
         # @param [ Object ] object The object to mongoize.
         #
-        # @return [ Array ] The object mongoized.
+        # @return [ Array | nil ] The object mongoized or nil.
         def mongoize(object)
-          if object.is_a?(::Array)
-            evolve(object).collect{ |obj| obj.class.mongoize(obj) }
-          else
-            evolve(object)
+          return if object.nil?
+          case object
+          when ::Array, ::Set
+            object.map(&:mongoize)
           end
         end
 
@@ -169,3 +169,5 @@ end
 
 ::Array.__send__(:include, Mongoid::Extensions::Array)
 ::Array.extend(Mongoid::Extensions::Array::ClassMethods)
+
+::Mongoid.deprecate(Array, :blank_criteria)

data/lib/mongoid/extensions/big_decimal.rb

@@ -20,9 +20,9 @@ module Mongoid
       # @example Mongoize the object.
       #   object.mongoize
       #
-      # @return [ Object ] The object.
+      # @return [ String | BSON::Decimal128 | nil ] The object or nil.
       def mongoize
-        to_s
+        ::BigDecimal.mongoize(self)
       end
 
       # Is the BigDecimal a number?
@@ -39,26 +39,49 @@ module Mongoid
 
         # Convert the object from its mongo friendly ruby type to this type.
         #
-        # @example Demongoize the object.
-        #   Object.demongoize(object)
-        #
         # @param [ Object ] object The object to demongoize.
         #
-        # @return [ BigDecimal, nil ] A BigDecimal derived from the object or nil.
+        # @return [ BigDecimal | nil ] A BigDecimal derived from the object or nil.
         def demongoize(object)
-          object && object.numeric? ? BigDecimal(object.to_s) : nil
+          return if object.blank?
+          if object.is_a?(BSON::Decimal128)
+            object.to_big_decimal
+          elsif object.numeric?
+            BigDecimal(object.to_s)
+          elsif object.numeric?
+            object.to_d
+          end
         end
 
-        # Mongoize an object of any type to how it's stored in the db as a String.
+        # Mongoize an object of any type to how it's stored in the db.
         #
         # @example Mongoize the object.
         #   BigDecimal.mongoize(123)
         #
         # @param [ Object ] object The object to Mongoize
         #
-        # @return [ String, nil ] A String representing the object or nil.
+        # @return [ String | BSON::Decimal128 | nil ] A String or Decimal128
+        #   representing the object or nil. String if Mongoid.map_big_decimal_to_decimal128
+        #   is false, BSON::Decimal128 otherwise.
         def mongoize(object)
-          object && object.numeric? ? object.to_s : nil
+          return if object.blank?
+          if Mongoid.map_big_decimal_to_decimal128
+            if object.is_a?(BSON::Decimal128)
+              object
+            elsif object.is_a?(BigDecimal)
+              BSON::Decimal128.new(object)
+            elsif object.numeric?
+              BSON::Decimal128.new(object.to_s)
+            elsif !object.is_a?(String)
+              object.try(:to_d)
+            end
+          else
+            if object.is_a?(BSON::Decimal128) || object.numeric?
+              object.to_s
+            elsif !object.is_a?(String)
+              object.try(:to_d)
+            end
+          end
         end
       end
     end

data/lib/mongoid/extensions/binary.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Mongoid
+  module Extensions
+    module Binary
+
+      # Turn the object from the ruby type we deal with to a Mongo friendly
+      # type.
+      #
+      # @example Mongoize the object.
+      #   object.mongoize
+      #
+      # @return [ BSON::Binary | nil ] The object.
+      def mongoize
+        BSON::Binary.mongoize(self)
+      end
+
+      module ClassMethods
+
+        # Mongoize an object of any type to how it's stored in the db.
+        #
+        # @example Mongoize the object.
+        #   BigDecimal.mongoize(123)
+        #
+        # @param [ Object ] object The object to Mongoize
+        #
+        # @return [ BSON::Binary | nil ] A Binary representing the object or nil.
+        def mongoize(object)
+          return if object.nil?
+          case object
+          when BSON::Binary then object
+          when String, Symbol then BSON::Binary.new(object.to_s)
+          end
+        end
+        alias :demongoize :mongoize
+      end
+    end
+  end
+end
+
+BSON::Binary.__send__(:include, Mongoid::Extensions::Binary)
+BSON::Binary.extend(Mongoid::Extensions::Binary::ClassMethods)

data/lib/mongoid/extensions/boolean.rb

@@ -11,10 +11,16 @@ module Mongoid
       # @example Mongoize the object.
       #   Boolean.mongoize("123.11")
       #
-      # @return [ String ] The object mongoized.
+      # @return [ true | false | nil ] The object mongoized or nil.
       def mongoize(object)
-        evolve(object)
+        return if object.nil?
+        if object.to_s =~ (/\A(true|t|yes|y|on|1|1.0)\z/i)
+          true
+        elsif object.to_s =~ (/\A(false|f|no|n|off|0|0.0)\z/i)
+          false
+        end
       end
+      alias :demongoize :mongoize
     end
   end
 end

data/lib/mongoid/extensions/date.rb

@@ -4,12 +4,6 @@ module Mongoid
   module Extensions
     module Date
 
-      # Constant for epoch - used when passing invalid times.
-      #
-      # @deprecated No longer used as a return value from #mongoize passed
-      #   an invalid date string.
-      EPOCH = ::Date.new(1970, 1, 1)
-
       # Convert the date into a time.
       #
       # @example Convert the date to a time.
@@ -43,9 +37,20 @@ module Mongoid
         #
         # @param [ Time ] object The time from Mongo.
         #
-        # @return [ Date ] The object as a date.
+        # @return [ Date | nil ] The object as a date or nil.
         def demongoize(object)
-          ::Date.new(object.year, object.month, object.day) if object
+          return if object.nil?
+          if object.is_a?(String)
+            object = begin
+              object.__mongoize_time__
+            rescue ArgumentError
+              nil
+            end
+          end
+
+          if object.acts_like?(:time) || object.acts_like?(:date)
+            ::Date.new(object.year, object.month, object.day)
+          end
         end
 
         # Turn the object from the ruby type we deal with to a Mongo friendly
@@ -56,20 +61,21 @@ module Mongoid
         #
         # @param [ Object ] object The object to mongoize.
         #
-        # @return [ Time ] The object mongoized.
+        # @return [ Time | nil ] The object mongoized or nil.
         def mongoize(object)
-          unless object.blank?
-            begin
-              if object.is_a?(String)
-                # https://jira.mongodb.org/browse/MONGOID-4460
-                time = ::Time.parse(object)
-              else
-                time = object.__mongoize_time__
-              end
-              ::Time.utc(time.year, time.month, time.day)
-            rescue ArgumentError
-              nil
+          return if object.blank?
+          begin
+            if object.is_a?(String)
+              # https://jira.mongodb.org/browse/MONGOID-4460
+              time = ::Time.parse(object)
+            else
+              time = object.__mongoize_time__
             end
+          rescue ArgumentError
+            nil
+          end
+          if time.acts_like?(:time)
+            ::Time.utc(time.year, time.month, time.day)
           end
         end
       end

data/lib/mongoid/extensions/date_time.rb

@@ -39,7 +39,7 @@ module Mongoid
         #
         # @param [ Time ] object The time from Mongo.
         #
-        # @return [ DateTime ] The object as a date.
+        # @return [ DateTime | nil ] The object as a datetime or nil.
         def demongoize(object)
           ::Time.demongoize(object).try(:to_datetime)
         end

data/lib/mongoid/extensions/false_class.rb

@@ -21,7 +21,7 @@ module Mongoid
       #
       # @param [ Class ] other The class to check.
       #
-      # @return [ true, false ] If the other is a boolean.
+      # @return [ true | false ] If the other is a boolean.
       def is_a?(other)
         if other == Mongoid::Boolean || other.class == Mongoid::Boolean
           return true

data/lib/mongoid/extensions/float.rb

@@ -34,12 +34,15 @@ module Mongoid
         #
         # @param [ Object ] object The object to mongoize.
         #
-        # @return [ String ] The object mongoized.
+        # @return [ Float | nil ] The object mongoized or nil.
         def mongoize(object)
-          unless object.blank?
-            __numeric__(object).to_f rescue 0.0
+          return if object.blank?
+          if object.is_a?(String)
+            if object.numeric?
+              object.to_f
+            end
           else
-            nil
+            object.try(:to_f)
           end
         end
         alias :demongoize :mongoize

data/lib/mongoid/extensions/hash.rb

@@ -11,7 +11,7 @@ module Mongoid
       #
       # @return [ Hash ] The converted hash.
       def __evolve_object_id__
-        update_values(&:__evolve_object_id__)
+        transform_values!(&:__evolve_object_id__)
       end
 
       # Mongoizes each value in the hash to an object id if it is convertable.
@@ -24,7 +24,7 @@ module Mongoid
         if id = self['$oid']
           BSON::ObjectId.from_string(id)
         else
-          update_values(&:__mongoize_object_id__)
+          transform_values!(&:__mongoize_object_id__)
         end
       end
 
@@ -38,14 +38,18 @@ module Mongoid
         consolidated = {}
         each_pair do |key, value|
           if key =~ /\$/
-            value.each_pair do |_key, _value|
-              value[_key] = (key == "$rename") ? _value.to_s : mongoize_for(key, klass, _key, _value)
+            value.keys.each do |key2|
+              value2 = value[key2]
+              real_key = klass.database_field_name(key2)
+
+              value.delete(key2) if real_key != key2
+              value[real_key] = value_for(key, klass, real_key, value2)
             end
             consolidated[key] ||= {}
             consolidated[key].update(value)
           else
             consolidated["$set"] ||= {}
-            consolidated["$set"].update(key => mongoize_for(key, klass, key, value))
+            consolidated["$set"].update(key => mongoize_for("$set", klass, key, value))
           end
         end
         consolidated
@@ -148,7 +152,7 @@ module Mongoid
       # @example Mongoize the object.
       #   object.mongoize
       #
-      # @return [ Hash ] The object.
+      # @return [ Hash | nil ] The object mongoized or nil.
       def mongoize
         ::Hash.mongoize(self)
       end
@@ -181,6 +185,24 @@ module Mongoid
 
       private
 
+      # Get the value for the provided operator, klass, key and value.
+      #
+      # This is necessary for special cases like $rename, $addToSet, $push, $pull and $pop.
+      #
+      # @param [ String ] operator The operator.
+      # @param [ Class ] klass The model class.
+      # @param [ String | Symbol ] key The field key.
+      # @param [ Object ] value The original value.
+      #
+      # @return [ Object ] Value prepared for the provided operator.
+      def value_for(operator, klass, key, value)
+        case operator
+        when "$rename" then value.to_s
+        when "$addToSet", "$push", '$pull', '$pop' then value.mongoize
+        else mongoize_for(operator, klass, key, value)
+        end
+      end
+
       # Mongoize for the klass, key and value.
       #
       # @api private
@@ -190,7 +212,7 @@ module Mongoid
       #
       # @param [ String ] operator The operator.
       # @param [ Class ] klass The model class.
-      # @param [ String, Symbol ] key The field key.
+      # @param [ String | Symbol ] key The field key.
       # @param [ Object ] value The value to mongoize.
       #
       # @return [ Object ] The mongoized value.
@@ -217,10 +239,15 @@ module Mongoid
         #
         # @param [ Object ] object The object to mongoize.
         #
-        # @return [ Hash ] The object mongoized.
+        # @return [ Hash | nil ] The object mongoized or nil.
         def mongoize(object)
           return if object.nil?
-          evolve(object.dup).update_values { |value| value.mongoize }
+          if object.is_a?(Hash)
+            # Need to use transform_values! which maintains the BSON::Document
+            # instead of transform_values which always returns a hash. To do this,
+            # we first need to dup the hash.
+            object.dup.transform_values!(&:mongoize)
+          end
         end
 
         # Can the size of this object change?
@@ -239,3 +266,5 @@ end
 
 ::Hash.__send__(:include, Mongoid::Extensions::Hash)
 ::Hash.extend(Mongoid::Extensions::Hash::ClassMethods)
+
+::Mongoid.deprecate(Hash, :blank_criteria)

data/lib/mongoid/extensions/integer.rb

@@ -42,12 +42,15 @@ module Mongoid
         # @example Mongoize the object.
         #   BigDecimal.mongoize("123.11")
         #
-        # @return [ String ] The object mongoized.
+        # @return [ Integer | nil ] The object mongoized or nil.
         def mongoize(object)
-          unless object.blank?
-            __numeric__(object).to_i rescue 0
+          return if object.blank?
+          if object.is_a?(String)
+            if object.numeric?
+              object.to_i
+            end
           else
-            nil
+            object.try(:to_i)
           end
         end
         alias :demongoize :mongoize

data/lib/mongoid/extensions/module.rb

@@ -12,7 +12,7 @@ module Mongoid
       #     self
       #   end
       #
-      # @param [ String, Symbol ] name The name of the method.
+      # @param [ String | Symbol ] name The name of the method.
       # @param [ Proc ] block The method body.
       #
       # @return [ Method ] The new method.

data/lib/mongoid/extensions/object.rb

@@ -90,10 +90,10 @@ module Mongoid
       # @example Do or do not.
       #   object.do_or_do_not(:use, "The Force")
       #
-      # @param [ String, Symbol ] name The method name.
-      # @param [ Array ] args The arguments.
+      # @param [ String | Symbol ] name The method name.
+      # @param [ Object... ] *args The arguments.
       #
-      # @return [ Object, nil ] The result of the method call or nil if the
+      # @return [ Object | nil ] The result of the method call or nil if the
       #   method does not exist.
       def do_or_do_not(name, *args)
         send(name, *args) if name && respond_to?(name)
@@ -106,7 +106,7 @@ module Mongoid
       #
       # @param [ String ] name The name of the variable.
       #
-      # @return [ Object, false ] The value or false.
+      # @return [ Object | false ] The value or false.
       def ivar(name)
         var_name = "@_#{name}"
         if instance_variable_defined?(var_name)
@@ -154,7 +154,7 @@ module Mongoid
       #
       # @param [ String ] name The name of the variable.
       #
-      # @return [ true, false ] If the variable was defined.
+      # @return [ true | false ] If the variable was defined.
       def remove_ivar(name)
         if instance_variable_defined?("@_#{name}")
           return remove_instance_variable("@_#{name}")
@@ -189,10 +189,10 @@ module Mongoid
       # @example You must perform this execution.
       #   object.you_must(:use, "The Force")
       #
-      # @param [ String, Symbol ] name The method name.
-      # @param [ Array ] args The arguments.
+      # @param [ String | Symbol ] name The method name.
+      # @param [ Object... ] *args The arguments.
       #
-      # @return [ Object, nil ] The result of the method call or nil if the
+      # @return [ Object | nil ] The result of the method call or nil if the
       #   method does not exist. Nil if the object is frozen.
       def you_must(name, *args)
         frozen? ? nil : do_or_do_not(name, *args)
@@ -246,3 +246,5 @@ end
 
 ::Object.__send__(:include, Mongoid::Extensions::Object)
 ::Object.extend(Mongoid::Extensions::Object::ClassMethods)
+
+::Mongoid.deprecate(Object, :blank_criteria)

data/lib/mongoid/extensions/range.rb

@@ -20,7 +20,7 @@ module Mongoid
       # @example Mongoize the object.
       #   range.mongoize
       #
-      # @return [ Hash ] The object mongoized.
+      # @return [ Hash | nil ] The object mongoized or nil.
       def mongoize
         ::Range.mongoize(self)
       end
@@ -44,9 +44,23 @@ module Mongoid
         #
         # @param [ Hash ] object The object to demongoize.
         #
-        # @return [ Range ] The range.
+        # @return [ Range | nil ] The range, or nil if object cannot be represented as range.
+        #
+        # @note Ruby 2.6 and lower do not support endless ranges that Ruby 2.7+ support.
         def demongoize(object)
-          object.nil? ? nil : ::Range.new(object["min"], object["max"], object["exclude_end"])
+          return if object.nil?
+          if object.is_a?(Hash)
+            hash = object.slice('min', 'max', 'exclude_end', :min, :max, :exclude_end)
+            unless hash.blank?
+              begin
+                ::Range.new(hash["min"] || hash[:min],
+                            hash["max"] || hash[:max],
+                            hash["exclude_end"] || hash[:exclude_end])
+              rescue ArgumentError # can be removed when Ruby version >= 2.7
+                nil
+              end
+            end
+          end
         end
 
         # Turn the object from the ruby type we deal with to a Mongo friendly
@@ -55,16 +69,33 @@ module Mongoid
         # @example Mongoize the object.
         #   Range.mongoize(1..3)
         #
-        # @param [ Range ] object The object to mongoize.
+        # @param [ Object ] object The object to mongoize.
         #
-        # @return [ Hash ] The object mongoized.
+        # @return [ Hash | nil ] The object mongoized or nil.
         def mongoize(object)
-          return nil if object.nil?
-          return object if object.is_a?(::Hash)
-          return object if object.is_a?(String)
-          hash = { "min" => object.first, "max" => object.last }
+          return if object.nil?
+          case object
+          when Hash then __mongoize_hash__(object)
+          when Range then __mongoize_range__(object)
+          end
+        end
+
+        private
+
+        def __mongoize_hash__(object)
+          hash = object.stringify_keys
+          hash.slice!('min', 'max', 'exclude_end')
+          hash.compact!
+          hash.transform_values!(&:mongoize)
+          hash.blank? ? nil : hash
+        end
+
+        def __mongoize_range__(object)
+          hash = {}
+          hash['min'] = object.begin.mongoize if object.begin
+          hash['max'] = object.end.mongoize if object.end
           if object.respond_to?(:exclude_end?) && object.exclude_end?
-            hash.merge!("exclude_end" => true)
+            hash['exclude_end'] = true
           end
           hash
         end

data/lib/mongoid/extensions/regexp.rb

@@ -12,13 +12,20 @@ module Mongoid
         # @example Mongoize the object.
         #   Regexp.mongoize(/\A[abc]/)
         #
-        # @param [ Regexp, String ] object The object to mongoize.
+        # @param [ Object ] object The object to mongoize.
         #
-        # @return [ Regexp ] The object mongoized.
+        # @return [ Regexp | nil ] The object mongoized or nil.
         def mongoize(object)
-          return nil if object.nil?
-          ::Regexp.new(object)
+          return if object.nil?
+          case object
+          when String then ::Regexp.new(object)
+          when ::Regexp then object
+          when BSON::Regexp::Raw then object.compile
+          end
+        rescue RegexpError
+          nil
         end
+        alias :demongoize :mongoize
       end
     end
   end