mongoid 7.0.13 → 8.0.8

data/lib/mongoid/extensions/hash.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Extensions
     module Hash
@@ -9,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.
@@ -21,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
 
@@ -37,14 +34,16 @@ module Mongoid
       #   { name: "Placebo" }.__consolidate__
       #
       # @return [ Hash ] A new consolidated hash.
-      #
-      # @since 3.0.0
       def __consolidate__(klass)
         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)
@@ -56,28 +55,62 @@ module Mongoid
         consolidated
       end
 
-      # Check if the hash is part of a blank relation criteria.
-      #
-      # @example Is the hash blank criteria?
-      #   {}.blank_criteria?
-      #
-      # @return [ true, false ] If the hash is blank criteria.
-      #
-      # @since 3.1.0
-      def blank_criteria?
-        self == { "_id" => { "$in" => [] }}
+      # 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 Conditions which could be satisfiable
+      #   {'_id' => '123'}._mongoid_unsatisfiable_criteria?
+      #   # => false
+      #
+      # @example Conditions which are unsatisfiable that this method does not handle
+      #   {'foo' => {'$in' => []}}._mongoid_unsatisfiable_criteria?
+      #   # => false
+      #
+      # @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
@@ -87,10 +120,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.
@@ -101,8 +132,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
@@ -123,9 +152,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
@@ -136,8 +163,6 @@ module Mongoid
       #   {}.resizable?
       #
       # @return [ true ] true.
-      #
-      # @since 3.0.0
       def resizable?
         true
       end
@@ -150,8 +175,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|
@@ -162,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 and $push.
+      #
+      # @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" then value.mongoize
+        else mongoize_for(operator, klass, operator, value)
+        end
+      end
+
       # Mongoize for the klass, key and value.
       #
       # @api private
@@ -171,12 +212,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
@@ -200,12 +239,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?
@@ -214,8 +256,6 @@ module Mongoid
         #   {}.resizable?
         #
         # @return [ true ] true.
-        #
-        # @since 3.0.0
         def resizable?
           true
         end
@@ -226,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

@@ -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
@@ -47,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,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Extensions
     module Module
@@ -11,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,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
@@ -93,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 [ String | Symbol ] name The method name.
       # @param [ Array ] 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
@@ -111,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)
@@ -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
@@ -167,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}")
@@ -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
@@ -208,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 [ String | Symbol ] name The method name.
       # @param [ Array ] 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
@@ -231,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)
@@ -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
@@ -273,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,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