mongoid 6.4.8 → 7.5.4

data/lib/mongoid/extensions/hash.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Extensions
     module Hash
@@ -9,8 +10,6 @@ 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__)
       end
@@ -21,8 +20,6 @@ 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)
@@ -37,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|
@@ -46,36 +41,72 @@ 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
       end
 
-      # Check if the hash is part of a blank relation criteria.
+      # Checks whether conditions given in this hash are known to be
+      # unsatisfiable, i.e., querying with this hash will always return no
+      # documents.
+      #
+      # This method only handles condition shapes that Mongoid itself uses when
+      # it builds association queries. It does not guarantee that a false
+      # return value means the condition can produce a non-empty document set -
+      # only that if the return value is true, the condition always produces
+      # an empty document set.
+      #
+      # @example Unsatisfiable conditions
+      #   {'_id' => {'$in' => []}}._mongoid_unsatisfiable_criteria?
+      #   # => true
       #
-      # @example Is the hash blank criteria?
-      #   {}.blank_criteria?
+      # @example Conditions which could be satisfiable
+      #   {'_id' => '123'}._mongoid_unsatisfiable_criteria?
+      #   # => false
       #
-      # @return [ true, false ] If the hash is blank criteria.
+      # @example Conditions which are unsatisfiable that this method does not handle
+      #   {'foo' => {'$in' => []}}._mongoid_unsatisfiable_criteria?
+      #   # => false
       #
-      # @since 3.1.0
-      def blank_criteria?
-        self == { "_id" => { "$in" => [] }}
+      # @return [ true | false ] Whether hash contains known unsatisfiable
+      #   conditions.
+      # @api private
+      def _mongoid_unsatisfiable_criteria?
+        unsatisfiable_criteria = { "_id" => { "$in" => [] }}
+        return true if self == unsatisfiable_criteria
+        return false unless length == 1 && keys == %w($and)
+        value = values.first
+        value.is_a?(Array) && value.any? do |sub_v|
+          sub_v.is_a?(Hash) && sub_v._mongoid_unsatisfiable_criteria?
+        end
       end
 
+      # Checks whether conditions given in this hash are known to be
+      # unsatisfiable, i.e., querying with this hash will always return no
+      # documents.
+      #
+      # This method is deprecated. Mongoid now uses
+      # +_mongoid_unsatisfiable_criteria?+ internally; this method is retained
+      # for backwards compatibility only.
+      #
+      # @return [ true | false ] Whether hash contains known unsatisfiable
+      #   conditions.
+      # @deprecated
+      alias :blank_criteria? :_mongoid_unsatisfiable_criteria?
+
       # Deletes an id value from the hash.
       #
       # @example Delete an id value.
       #   {}.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
@@ -85,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.
@@ -99,15 +128,16 @@ 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
         keys.each do |key|
           return nil if value.nil?
-          nested = value[key] || value[key.to_i]
-          value = nested
+          value_for_key = value[key]
+          if value_for_key.nil? && key.to_i.to_s == key
+            value_for_key = value[key.to_i]
+          end
+          value = value_for_key
         end
         value
       end
@@ -119,8 +149,6 @@ module Mongoid
       #   object.mongoize
       #
       # @return [ Hash ] The object.
-      #
-      # @since 3.0.0
       def mongoize
         ::Hash.mongoize(self)
       end
@@ -131,8 +159,6 @@ module Mongoid
       #   {}.resizable?
       #
       # @return [ true ] true.
-      #
-      # @since 3.0.0
       def resizable?
         true
       end
@@ -145,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|
@@ -170,8 +194,6 @@ module Mongoid
       # @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
@@ -196,8 +218,6 @@ module Mongoid
         # @param [ Object ] object The object to mongoize.
         #
         # @return [ Hash ] The object mongoized.
-        #
-        # @since 3.0.0
         def mongoize(object)
           return if object.nil?
           evolve(object.dup).update_values { |value| value.mongoize }
@@ -209,8 +229,6 @@ module Mongoid
         #   {}.resizable?
         #
         # @return [ true ] true.
-        #
-        # @since 3.0.0
         def resizable?
           true
         end

data/lib/mongoid/extensions/integer.rb

@@ -1,18 +1,17 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Extensions
     module Integer
 
-      # Returns the integer as a time.
+      # Converts the integer into a time as the number of seconds since the epoch.
       #
       # @example Convert the integer to a time.
       #   1335532685.__mongoize_time__
       #
-      # @return [ Time ] The converted time.
-      #
-      # @since 3.0.0
+      # @return [ Time | ActiveSupport::TimeWithZone ] The time.
       def __mongoize_time__
-        ::Time.at(self)
+        ::Time.configured.at(self)
       end
 
       # Is the integer a number?
@@ -21,8 +20,6 @@ module Mongoid
       #   object.numeric?
       #
       # @return [ true ] Always true.
-      #
-      # @since 3.0.0
       def numeric?
         true
       end
@@ -33,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
@@ -48,8 +43,6 @@ module Mongoid
         #   BigDecimal.mongoize("123.11")
         #
         # @return [ String ] The object mongoized.
-        #
-        # @since 3.0.0
         def mongoize(object)
           unless object.blank?
             __numeric__(object).to_i rescue 0

data/lib/mongoid/extensions/module.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Extensions
     module Module
@@ -15,8 +16,6 @@ module Mongoid
       # @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,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Extensions
     module NilClass
@@ -9,8 +10,6 @@ module Mongoid
       #   object.__setter__
       #
       # @return [ nil ] Always nil.
-      #
-      # @since 3.1.0
       def __setter__
         self
       end
@@ -21,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,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Extensions
     module Object
@@ -9,8 +10,6 @@ module Mongoid
       #   object.__evolve_object_id__
       #
       # @return [ Object ] self.
-      #
-      # @since 3.0.0
       def __evolve_object_id__
         self
       end
@@ -22,20 +21,22 @@ module Mongoid
       #   object.__find_args__
       #
       # @return [ Object ] self.
-      #
-      # @since 3.0.0
       def __find_args__
         self
       end
 
       # Mongoize a plain object into a time.
       #
+      # @note This method should not be used, because it does not
+      #   return correct results for non-Time objects. Override
+      #   __mongoize_time__ in classes that are time-like to return an
+      #   instance of Time or ActiveSupport::TimeWithZone.
+      #
       # @example Mongoize the object.
       #   object.__mongoize_time__
       #
       # @return [ Object ] self.
-      #
-      # @since 3.0.0
+      # @deprecated
       def __mongoize_time__
         self
       end
@@ -46,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
@@ -70,20 +67,20 @@ module Mongoid
       #   1.__to_inc__
       #
       # @return [ Object ] The object.
-      #
-      # @since 3.0.3
       def __to_inc__
         self
       end
 
-      # Check if the object is part of a blank relation criteria.
-      #
-      # @example Is the object blank criteria?
-      #   "".blank_criteria?
+      # Checks whether conditions given in this object are known to be
+      # unsatisfiable, i.e., querying with this object will always return no
+      # documents.
       #
-      # @return [ true, false ] If the object is blank criteria.
+      # This method is deprecated. Mongoid now uses
+      # +_mongoid_unsatisfiable_criteria?+ internally; this method is retained
+      # for backwards compatibility only. It always returns false.
       #
-      # @since 3.1.0
+      # @return [ false ] Always false.
+      # @deprecated
       def blank_criteria?
         false
       end
@@ -98,8 +95,6 @@ module Mongoid
       #
       # @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
@@ -112,8 +107,6 @@ module Mongoid
       # @param [ String ] name The name of the variable.
       #
       # @return [ Object, false ] The value or false.
-      #
-      # @since 2.0.0.rc.1
       def ivar(name)
         var_name = "@_#{name}"
         if instance_variable_defined?(var_name)
@@ -130,8 +123,6 @@ module Mongoid
       #   object.mongoize
       #
       # @return [ Object ] The object.
-      #
-      # @since 3.0.0
       def mongoize
         self
       end
@@ -142,8 +133,6 @@ module Mongoid
       #   object.multi_arged?
       #
       # @return [ false ] false.
-      #
-      # @since 3.0.0
       def multi_arged?
         false
       end
@@ -154,8 +143,6 @@ module Mongoid
       #   object.numeric?
       #
       # @return [ false ] Always false.
-      #
-      # @since 3.0.0
       def numeric?
         false
       end
@@ -168,8 +155,6 @@ module Mongoid
       # @param [ String ] name The name of the variable.
       #
       # @return [ true, false ] If the variable was defined.
-      #
-      # @since 2.1.0
       def remove_ivar(name)
         if instance_variable_defined?("@_#{name}")
           return remove_instance_variable("@_#{name}")
@@ -185,8 +170,6 @@ module Mongoid
       #   object.resizable?
       #
       # @return [ false ] false.
-      #
-      # @since 3.0.0
       def resizable?
         false
       end
@@ -197,8 +180,6 @@ module Mongoid
       #   object.substitutable
       #
       # @return [ Object ] self.
-      #
-      # @since 2.0.0
       def substitutable
         self
       end
@@ -213,8 +194,6 @@ module Mongoid
       #
       # @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
@@ -225,17 +204,15 @@ module Mongoid
         # contstraint.
         #
         # @example Convert the object to a fk.
-        #   Object.__mongoize_fk__(constraint, object)
+        #   Object.__mongoize_fk__(association, object)
         #
-        # @param [ Constraint ] constraint The constraint.
+        # @param [ Association ] association The association metadata.
         # @param [ Object ] object The object to convert.
         #
         # @return [ Object ] The converted object.
-        #
-        # @since 3.0.0
-        def __mongoize_fk__(constraint, object)
+        def __mongoize_fk__(association, object)
           return nil if !object || object == ""
-          constraint.convert(object)
+          association.convert_to_foreign_key(object)
         end
 
         # Convert the object from its mongo friendly ruby type to this type.
@@ -246,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
@@ -261,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

data/lib/mongoid/extensions/object_id.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Extensions
     module ObjectId
@@ -9,8 +10,6 @@ module Mongoid
       #   object_id.__evolve_object_id__
       #
       # @return [ BSON::ObjectId ] self.
-      #
-      # @since 3.0.0
       def __evolve_object_id__
         self
       end
@@ -26,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
@@ -40,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,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Extensions
     module Range
@@ -9,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
@@ -22,8 +21,6 @@ module Mongoid
       #   range.mongoize
       #
       # @return [ Hash ] The object mongoized.
-      #
-      # @since 3.0.0
       def mongoize
         ::Range.mongoize(self)
       end
@@ -34,8 +31,6 @@ module Mongoid
       #   range.resizable?
       #
       # @return [ true ] True.
-      #
-      # @since 3.0.0
       def resizable?
         true
       end
@@ -50,8 +45,6 @@ module Mongoid
         # @param [ Hash ] object The object to demongoize.
         #
         # @return [ Range ] The range.
-        #
-        # @since 3.0.0
         def demongoize(object)
           object.nil? ? nil : ::Range.new(object["min"], object["max"], object["exclude_end"])
         end
@@ -65,11 +58,10 @@ module Mongoid
         # @param [ Range ] object The object to mongoize.
         #
         # @return [ Hash ] The object mongoized.
-        #
-        # @since 3.0.0
         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 }
           if object.respond_to?(:exclude_end?) && object.exclude_end?
             hash.merge!("exclude_end" => true)

data/lib/mongoid/extensions/regexp.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Extensions
     module Regexp
@@ -9,13 +10,11 @@ module Mongoid
         # type.
         #
         # @example Mongoize the object.
-        #   Regexp.mongoize(/^[abc]/)
+        #   Regexp.mongoize(/\A[abc]/)
         #
         # @param [ Regexp, String ] object The object to mongoize.
         #
         # @return [ Regexp ] The object mongoized.
-        #
-        # @since 3.0.0
         def mongoize(object)
           return nil if object.nil?
           ::Regexp.new(object)

data/lib/mongoid/extensions/set.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Extensions
     module Set
@@ -10,8 +11,6 @@ module Mongoid
       #   set.mongoize
       #
       # @return [ Array ] The object mongoized.
-      #
-      # @since 3.0.0
       def mongoize
         ::Set.mongoize(self)
       end
@@ -26,8 +25,6 @@ module Mongoid
         # @param [ Array ] object The object to demongoize.
         #
         # @return [ Set ] The set.
-        #
-        # @since 3.0.0
         def demongoize(object)
           ::Set.new(object)
         end
@@ -41,8 +38,6 @@ module Mongoid
         # @param [ Set ] object The object to mongoize.
         #
         # @return [ Array ] The object mongoized.
-        #
-        # @since 3.0.0
         def mongoize(object)
           object.to_a
         end