mongoid 7.1.1 → 8.1.0

data/lib/mongoid/extensions/hash.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Extensions
@@ -11,10 +10,8 @@ module Mongoid
       #   { field: id }.__evolve_object_id__
       #
       # @return [ Hash ] The converted hash.
-      #
-      # @since 3.0.0
       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.
@@ -23,13 +20,11 @@ module Mongoid
       #   { field: id }.__mongoize_object_id__
       #
       # @return [ Hash ] The converted hash.
-      #
-      # @since 3.0.0
       def __mongoize_object_id__
         if id = self['$oid']
           BSON::ObjectId.from_string(id)
         else
-          update_values(&:__mongoize_object_id__)
+          transform_values!(&:__mongoize_object_id__)
         end
       end
 
@@ -39,8 +34,6 @@ module Mongoid
       #   { name: "Placebo" }.__consolidate__
       #
       # @return [ Hash ] A new consolidated hash.
-      #
-      # @since 3.0.0
       def __consolidate__(klass)
         consolidated = {}
         each_pair do |key, value|
@@ -48,9 +41,11 @@ module Mongoid
             value.each_pair do |_key, _value|
               value[_key] = (key == "$rename") ? _value.to_s : mongoize_for(key, klass, _key, _value)
             end
-            (consolidated[key] ||= {}).merge!(value)
+            consolidated[key] ||= {}
+            consolidated[key].update(value)
           else
-            (consolidated["$set"] ||= {}).merge!(key => mongoize_for(key, klass, key, value))
+            consolidated["$set"] ||= {}
+            consolidated["$set"].update(key => mongoize_for(key, klass, key, value))
           end
         end
         consolidated
@@ -101,8 +96,6 @@ module Mongoid
       #
       # @return [ true | false ] Whether hash contains known unsatisfiable
       #   conditions.
-      #
-      # @since 3.1.0
       # @deprecated
       alias :blank_criteria? :_mongoid_unsatisfiable_criteria?
 
@@ -112,10 +105,8 @@ module Mongoid
       #   {}.delete_id
       #
       # @return [ Object ] The deleted value, or nil.
-      #
-      # @since 3.0.2
       def delete_id
-        delete("_id") || delete("id") || delete(:id) || delete(:_id)
+        delete("_id") || delete(:_id) || delete("id") || delete(:id)
       end
 
       # Get the id attribute from this hash, whether it's prefixed with an
@@ -125,10 +116,8 @@ module Mongoid
       #   { :_id => 1 }.extract_id
       #
       # @return [ Object ] The value of the id.
-      #
-      # @since 2.3.2
       def extract_id
-        self["_id"] || self["id"] || self[:id] || self[:_id]
+        self["_id"] || self[:_id] || self["id"] || self[:id]
       end
 
       # Fetch a nested value via dot syntax.
@@ -139,8 +128,6 @@ module Mongoid
       # @param [ String ] string the dot syntax string.
       #
       # @return [ Object ] The matching value.
-      #
-      # @since 3.0.15
       def __nested__(string)
         keys = string.split(".")
         value = self
@@ -161,9 +148,7 @@ module Mongoid
       # @example Mongoize the object.
       #   object.mongoize
       #
-      # @return [ Hash ] The object.
-      #
-      # @since 3.0.0
+      # @return [ Hash | nil ] The object mongoized or nil.
       def mongoize
         ::Hash.mongoize(self)
       end
@@ -174,8 +159,6 @@ module Mongoid
       #   {}.resizable?
       #
       # @return [ true ] true.
-      #
-      # @since 3.0.0
       def resizable?
         true
       end
@@ -188,8 +171,6 @@ module Mongoid
       #   { klass: Band, where: { name: "Depeche Mode" }.to_criteria
       #
       # @return [ Criteria ] The criteria.
-      #
-      # @since 3.0.7
       def to_criteria
         criteria = Criteria.new(delete(:klass) || delete("klass"))
         each_pair do |method, args|
@@ -209,12 +190,10 @@ 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.
-      #
-      # @since 3.1.0
       def mongoize_for(operator, klass, key, value)
         field = klass.fields[key.to_s]
         if field
@@ -238,12 +217,15 @@ module Mongoid
         #
         # @param [ Object ] object The object to mongoize.
         #
-        # @return [ Hash ] The object mongoized.
-        #
-        # @since 3.0.0
+        # @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?
@@ -252,8 +234,6 @@ module Mongoid
         #   {}.resizable?
         #
         # @return [ true ] true.
-        #
-        # @since 3.0.0
         def resizable?
           true
         end
@@ -264,3 +244,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

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Extensions
@@ -11,8 +10,6 @@ module Mongoid
       #   1335532685.__mongoize_time__
       #
       # @return [ Time | ActiveSupport::TimeWithZone ] The time.
-      #
-      # @since 3.0.0
       def __mongoize_time__
         ::Time.configured.at(self)
       end
@@ -23,8 +20,6 @@ module Mongoid
       #   object.numeric?
       #
       # @return [ true ] Always true.
-      #
-      # @since 3.0.0
       def numeric?
         true
       end
@@ -35,8 +30,6 @@ module Mongoid
       #   object.unconvertable_to_bson?
       #
       # @return [ true ] If the object is unconvertable.
-      #
-      # @since 2.2.1
       def unconvertable_to_bson?
         true
       end
@@ -49,14 +42,15 @@ module Mongoid
         # @example Mongoize the object.
         #   BigDecimal.mongoize("123.11")
         #
-        # @return [ String ] The object mongoized.
-        #
-        # @since 3.0.0
+        # @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

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Extensions
@@ -13,12 +12,10 @@ 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.
-      #
-      # @since 3.0.0
       def re_define_method(name, &block)
         undef_method(name) if method_defined?(name)
         define_method(name, &block)

data/lib/mongoid/extensions/nil_class.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Extensions
@@ -11,8 +10,6 @@ module Mongoid
       #   object.__setter__
       #
       # @return [ nil ] Always nil.
-      #
-      # @since 3.1.0
       def __setter__
         self
       end
@@ -23,8 +20,6 @@ module Mongoid
       #   nil.collectionize
       #
       # @return [ String ] A blank string.
-      #
-      # @since 1.0.0
       def collectionize
         to_s.collectionize
       end

data/lib/mongoid/extensions/object.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Extensions
@@ -11,8 +10,6 @@ module Mongoid
       #   object.__evolve_object_id__
       #
       # @return [ Object ] self.
-      #
-      # @since 3.0.0
       def __evolve_object_id__
         self
       end
@@ -24,8 +21,6 @@ module Mongoid
       #   object.__find_args__
       #
       # @return [ Object ] self.
-      #
-      # @since 3.0.0
       def __find_args__
         self
       end
@@ -41,8 +36,6 @@ module Mongoid
       #   object.__mongoize_time__
       #
       # @return [ Object ] self.
-      #
-      # @since 3.0.0
       # @deprecated
       def __mongoize_time__
         self
@@ -54,20 +47,16 @@ module Mongoid
       #   object.__setter__
       #
       # @return [ String ] The object as a string plus =.
-      #
-      # @since 3.1.0
       def __setter__
         "#{self}="
       end
 
-      # Get the value of the object as a mongo friendy sort value.
+      # Get the value of the object as a mongo friendly sort value.
       #
       # @example Get the object as sort criteria.
       #   object.__sortable__
       #
       # @return [ Object ] self.
-      #
-      # @since 3.0.0
       def __sortable__
         self
       end
@@ -78,8 +67,6 @@ module Mongoid
       #   1.__to_inc__
       #
       # @return [ Object ] The object.
-      #
-      # @since 3.0.3
       def __to_inc__
         self
       end
@@ -93,8 +80,6 @@ module Mongoid
       # for backwards compatibility only. It always returns false.
       #
       # @return [ false ] Always false.
-      #
-      # @since 3.1.0
       # @deprecated
       def blank_criteria?
         false
@@ -105,13 +90,11 @@ 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.
-      #
-      # @since 2.0.0.rc.1
       def do_or_do_not(name, *args)
         send(name, *args) if name && respond_to?(name)
       end
@@ -123,9 +106,7 @@ module Mongoid
       #
       # @param [ String ] name The name of the variable.
       #
-      # @return [ Object, false ] The value or false.
-      #
-      # @since 2.0.0.rc.1
+      # @return [ Object | false ] The value or false.
       def ivar(name)
         var_name = "@_#{name}"
         if instance_variable_defined?(var_name)
@@ -142,8 +123,6 @@ module Mongoid
       #   object.mongoize
       #
       # @return [ Object ] The object.
-      #
-      # @since 3.0.0
       def mongoize
         self
       end
@@ -154,8 +133,6 @@ module Mongoid
       #   object.multi_arged?
       #
       # @return [ false ] false.
-      #
-      # @since 3.0.0
       def multi_arged?
         false
       end
@@ -166,8 +143,6 @@ module Mongoid
       #   object.numeric?
       #
       # @return [ false ] Always false.
-      #
-      # @since 3.0.0
       def numeric?
         false
       end
@@ -179,9 +154,7 @@ module Mongoid
       #
       # @param [ String ] name The name of the variable.
       #
-      # @return [ true, false ] If the variable was defined.
-      #
-      # @since 2.1.0
+      # @return [ true | false ] If the variable was defined.
       def remove_ivar(name)
         if instance_variable_defined?("@_#{name}")
           return remove_instance_variable("@_#{name}")
@@ -197,8 +170,6 @@ module Mongoid
       #   object.resizable?
       #
       # @return [ false ] false.
-      #
-      # @since 3.0.0
       def resizable?
         false
       end
@@ -209,8 +180,6 @@ module Mongoid
       #   object.substitutable
       #
       # @return [ Object ] self.
-      #
-      # @since 2.0.0
       def substitutable
         self
       end
@@ -220,13 +189,11 @@ 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.
-      #
-      # @since 2.2.1
       def you_must(name, *args)
         frozen? ? nil : do_or_do_not(name, *args)
       end
@@ -243,8 +210,6 @@ module Mongoid
         # @param [ Object ] object The object to convert.
         #
         # @return [ Object ] The converted object.
-        #
-        # @since 3.0.0
         def __mongoize_fk__(association, object)
           return nil if !object || object == ""
           association.convert_to_foreign_key(object)
@@ -258,8 +223,6 @@ module Mongoid
         # @param [ Object ] object The object to demongoize.
         #
         # @return [ Object ] The object.
-        #
-        # @since 3.0.0
         def demongoize(object)
           object
         end
@@ -273,8 +236,6 @@ module Mongoid
         # @param [ Object ] object The object to mongoize.
         #
         # @return [ Object ] The object mongoized.
-        #
-        # @since 3.0.0
         def mongoize(object)
           object.mongoize
         end
@@ -285,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/object_id.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Extensions
@@ -11,8 +10,6 @@ module Mongoid
       #   object_id.__evolve_object_id__
       #
       # @return [ BSON::ObjectId ] self.
-      #
-      # @since 3.0.0
       def __evolve_object_id__
         self
       end
@@ -28,8 +25,6 @@ module Mongoid
         # @param [ Object ] object The object to evolve.
         #
         # @return [ BSON::ObjectId ] The object id.
-        #
-        # @since 3.0.0
         def evolve(object)
           object.__evolve_object_id__
         end
@@ -42,8 +37,6 @@ module Mongoid
         # @param [ Object ] object The object to convert.
         #
         # @return [ BSON::ObjectId ] The object id.
-        #
-        # @since 3.0.0
         def mongoize(object)
           object.__mongoize_object_id__
         end

data/lib/mongoid/extensions/range.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Extensions
@@ -11,8 +10,6 @@ module Mongoid
       #   range.__find_args__
       #
       # @return [ Array ] The range as an array.
-      #
-      # @since 3.0.0
       def __find_args__
         to_a
       end
@@ -23,9 +20,7 @@ module Mongoid
       # @example Mongoize the object.
       #   range.mongoize
       #
-      # @return [ Hash ] The object mongoized.
-      #
-      # @since 3.0.0
+      # @return [ Hash | nil ] The object mongoized or nil.
       def mongoize
         ::Range.mongoize(self)
       end
@@ -36,8 +31,6 @@ module Mongoid
       #   range.resizable?
       #
       # @return [ true ] True.
-      #
-      # @since 3.0.0
       def resizable?
         true
       end
@@ -51,11 +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.
         #
-        # @since 3.0.0
+        # @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
@@ -64,18 +69,33 @@ module Mongoid
         # @example Mongoize the object.
         #   Range.mongoize(1..3)
         #
-        # @param [ Range ] object The object to mongoize.
-        #
-        # @return [ Hash ] The object mongoized.
+        # @param [ Object ] object The object to mongoize.
         #
-        # @since 3.0.0
+        # @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

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Extensions
@@ -11,17 +10,22 @@ module Mongoid
         # type.
         #
         # @example Mongoize the object.
-        #   Regexp.mongoize(/^[abc]/)
+        #   Regexp.mongoize(/\A[abc]/)
         #
-        # @param [ Regexp, String ] object The object to mongoize.
+        # @param [ Object ] object The object to mongoize.
         #
-        # @return [ Regexp ] The object mongoized.
-        #
-        # @since 3.0.0
+        # @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

data/lib/mongoid/extensions/set.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Extensions
@@ -11,9 +10,7 @@ module Mongoid
       # @example Mongoize the object.
       #   set.mongoize
       #
-      # @return [ Array ] The object mongoized.
-      #
-      # @since 3.0.0
+      # @return [ Array | nil ] The object mongoized or nil.
       def mongoize
         ::Set.mongoize(self)
       end
@@ -28,10 +25,11 @@ module Mongoid
         # @param [ Array ] object The object to demongoize.
         #
         # @return [ Set ] The set.
-        #
-        # @since 3.0.0
         def demongoize(object)
-          ::Set.new(object)
+          case object
+          when ::Set then object
+          when ::Array then ::Set.new(object)
+          end
         end
 
         # Turn the object from the ruby type we deal with to a Mongo friendly
@@ -42,11 +40,13 @@ module Mongoid
         #
         # @param [ Set ] object The object to mongoize.
         #
-        # @return [ Array ] The object mongoized.
-        #
-        # @since 3.0.0
+        # @return [ Array | nil ] The object mongoized or nil.
         def mongoize(object)
-          object.to_a
+          return if object.nil?
+          case object
+          when ::Set then ::Array.mongoize(object.to_a).uniq
+          when ::Array then ::Array.mongoize(object).uniq
+          end
         end
       end
     end