mongoid 7.2.1 → 9.0.0

data/lib/mongoid/extensions/hash.rb

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 module Mongoid
   module Extensions
+
+    # Adds type-casting behavior to Hash class.
     module Hash
 
       # Evolves each value in the hash to an object id if it is convertable.
@@ -11,10 +13,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,90 +23,29 @@ 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
 
       # Consolidate the key/values in the hash under an atomic $set.
+      # DEPRECATED. This was never intended to be a public API and
+      # the functionality will no longer be exposed once this method
+      # is eventually removed.
       #
       # @example Consolidate the hash.
       #   { name: "Placebo" }.__consolidate__
       #
       # @return [ Hash ] A new consolidated hash.
       #
-      # @since 3.0.0
+      # @deprecated
       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)
-            end
-            consolidated[key] ||= {}
-            consolidated[key].update(value)
-          else
-            consolidated["$set"] ||= {}
-            consolidated["$set"].update(key => mongoize_for(key, klass, key, value))
-          end
-        end
-        consolidated
+        Mongoid::AtomicUpdatePreparer.prepare(self, klass)
       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 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.
-      #
-      # @since 3.1.0
-      # @deprecated
-      alias :blank_criteria? :_mongoid_unsatisfiable_criteria?
+      Mongoid.deprecate(self, :__consolidate__)
 
       # Deletes an id value from the hash.
       #
@@ -114,11 +53,11 @@ module Mongoid
       #   {}.delete_id
       #
       # @return [ Object ] The deleted value, or nil.
-      #
-      # @since 3.0.2
+      # @deprecated
       def delete_id
-        delete("_id") || delete("id") || delete(:id) || delete(:_id)
+        delete("_id") || delete(:_id) || delete("id") || delete(:id)
       end
+      Mongoid.deprecate(self, :delete_id)
 
       # Get the id attribute from this hash, whether it's prefixed with an
       # underscore or is a symbol.
@@ -127,35 +66,11 @@ module Mongoid
       #   { :_id => 1 }.extract_id
       #
       # @return [ Object ] The value of the id.
-      #
-      # @since 2.3.2
+      # @deprecated
       def extract_id
-        self["_id"] || self["id"] || self[:id] || self[:_id]
-      end
-
-      # Fetch a nested value via dot syntax.
-      #
-      # @example Fetch a nested value via dot syntax.
-      #   { "name" => { "en" => "test" }}.__nested__("name.en")
-      #
-      # @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?
-          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
+        self["_id"] || self[:_id] || self["id"] || self[:id]
       end
+      Mongoid.deprecate(self, :extract_id)
 
       # Turn the object from the ruby type we deal with to a Mongo friendly
       # type.
@@ -163,9 +78,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
@@ -176,8 +89,6 @@ module Mongoid
       #   {}.resizable?
       #
       # @return [ true ] true.
-      #
-      # @since 3.0.0
       def resizable?
         true
       end
@@ -190,46 +101,14 @@ module Mongoid
       #   { klass: Band, where: { name: "Depeche Mode" }.to_criteria
       #
       # @return [ Criteria ] The criteria.
-      #
-      # @since 3.0.7
+      # @deprecated
       def to_criteria
-        criteria = Criteria.new(delete(:klass) || delete("klass"))
-        each_pair do |method, args|
-          criteria = criteria.__send__(method, args)
-        end
-        criteria
+        Criteria.from_hash(self)
       end
+      Mongoid.deprecate(self, :to_criteria)
 
       private
 
-      # Mongoize for the klass, key and value.
-      #
-      # @api private
-      #
-      # @example Mongoize for the klass, field and value.
-      #   {}.mongoize_for("$push", Band, "name", "test")
-      #
-      # @param [ String ] operator The operator.
-      # @param [ Class ] klass The model class.
-      # @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
-          val = field.mongoize(value)
-          if Mongoid::Persistable::LIST_OPERATIONS.include?(operator) && field.resizable?
-            val = val.first if !value.is_a?(Array)
-          end
-          val
-        else
-          value
-        end
-      end
-
       module ClassMethods
 
         # Turn the object from the ruby type we deal with to a Mongo friendly
@@ -240,12 +119,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 }
+          case object
+          when BSON::Document
+            object.dup.transform_values!(&:mongoize)
+          when Hash
+            BSON::Document.new(object.transform_values(&:mongoize))
+          end
         end
 
         # Can the size of this object change?
@@ -254,8 +136,6 @@ module Mongoid
         #   {}.resizable?
         #
         # @return [ true ] true.
-        #
-        # @since 3.0.0
         def resizable?
           true
         end

data/lib/mongoid/extensions/integer.rb

@@ -1,8 +1,10 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 module Mongoid
   module Extensions
+
+    # Adds type-casting behavior to Integer class.
     module Integer
 
       # Converts the integer into a time as the number of seconds since the epoch.
@@ -11,10 +13,8 @@ module Mongoid
       #   1335532685.__mongoize_time__
       #
       # @return [ Time | ActiveSupport::TimeWithZone ] The time.
-      #
-      # @since 3.0.0
       def __mongoize_time__
-        ::Time.configured.at(self)
+        ::Time.zone.at(self)
       end
 
       # Is the integer a number?
@@ -23,8 +23,6 @@ module Mongoid
       #   object.numeric?
       #
       # @return [ true ] Always true.
-      #
-      # @since 3.0.0
       def numeric?
         true
       end
@@ -35,11 +33,11 @@ module Mongoid
       #   object.unconvertable_to_bson?
       #
       # @return [ true ] If the object is unconvertable.
-      #
-      # @since 2.2.1
+      # @deprecated
       def unconvertable_to_bson?
         true
       end
+      Mongoid.deprecate(self, :unconvertable_to_bson?)
 
       module ClassMethods
 
@@ -49,14 +47,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,8 +1,10 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 module Mongoid
   module Extensions
+
+    # Adds type-casting behavior to Module class.
     module Module
 
       # Redefine the method. Will undef the method if it exists or simply
@@ -13,12 +15,10 @@ module Mongoid
       #     self
       #   end
       #
-      # @param [ String, Symbol ] name The name of the method.
-      # @param [ Proc ] block The method body.
+      # @param [ String | Symbol ] name The name of the method.
+      # @param &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,21 +1,21 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 module Mongoid
   module Extensions
+    # Adds type-casting behavior to NilClass.
     module NilClass
-
       # Try to form a setter from this object.
       #
       # @example Try to form a setter.
       #   object.__setter__
       #
       # @return [ nil ] Always nil.
-      #
-      # @since 3.1.0
+      # @deprecated
       def __setter__
         self
       end
+      Mongoid.deprecate(self, :__setter__)
 
       # Get the name of a nil collection.
       #
@@ -23,8 +23,6 @@ module Mongoid
       #   nil.collectionize
       #
       # @return [ String ] A blank string.
-      #
-      # @since 1.0.0
       def collectionize
         to_s.collectionize
       end
@@ -32,4 +30,4 @@ module Mongoid
   end
 end
 
-::NilClass.__send__(:include, Mongoid::Extensions::NilClass)
+NilClass.include Mongoid::Extensions::NilClass

data/lib/mongoid/extensions/object.rb

@@ -1,9 +1,13 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 module Mongoid
   module Extensions
+    # Adds type-casting behavior to Object class.
     module Object
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
 
       # Evolve a plain object into an object id.
       #
@@ -11,8 +15,6 @@ module Mongoid
       #   object.__evolve_object_id__
       #
       # @return [ Object ] self.
-      #
-      # @since 3.0.0
       def __evolve_object_id__
         self
       end
@@ -24,29 +26,11 @@ 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__
+      def __find_args__
         self
       end
+      Mongoid.deprecate(self, :__find_args__)
 
       # Try to form a setter from this object.
       #
@@ -54,23 +38,23 @@ module Mongoid
       #   object.__setter__
       #
       # @return [ String ] The object as a string plus =.
-      #
-      # @since 3.1.0
+      # @deprecated
       def __setter__
         "#{self}="
       end
+      Mongoid.deprecate(self, :__setter__)
 
-      # 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
+      # @deprecated
       def __sortable__
         self
       end
+      Mongoid.deprecate(self, :__sortable__)
 
       # Conversion of an object to an $inc-able value.
       #
@@ -78,43 +62,28 @@ module Mongoid
       #   1.__to_inc__
       #
       # @return [ Object ] The object.
-      #
-      # @since 3.0.3
+      # @deprecated
       def __to_inc__
         self
       end
+      Mongoid.deprecate(self, :__to_inc__)
 
-      # Checks whether conditions given in this object are known to be
-      # unsatisfiable, i.e., querying with this object will always return no
-      # documents.
-      #
-      # This method is deprecated. Mongoid now uses
-      # +_mongoid_unsatisfiable_criteria?+ internally; this method is retained
-      # for backwards compatibility only. It always returns false.
-      #
-      # @return [ false ] Always false.
-      #
-      # @since 3.1.0
-      # @deprecated
-      def blank_criteria?
-        false
-      end
 
       # Do or do not, there is no try. -- Yoda.
       #
       # @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
+      # @deprecated
       def do_or_do_not(name, *args)
         send(name, *args) if name && respond_to?(name)
       end
+      Mongoid.deprecate(self, :do_or_do_not)
 
       # Get the value for an instance variable or false if it doesn't exist.
       #
@@ -123,9 +92,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 +109,6 @@ module Mongoid
       #   object.mongoize
       #
       # @return [ Object ] The object.
-      #
-      # @since 3.0.0
       def mongoize
         self
       end
@@ -154,11 +119,11 @@ module Mongoid
       #   object.multi_arged?
       #
       # @return [ false ] false.
-      #
-      # @since 3.0.0
+      # @deprecated
       def multi_arged?
         false
       end
+      Mongoid.deprecate(self, :multi_arged?)
 
       # Is the object a number?
       #
@@ -166,8 +131,6 @@ module Mongoid
       #   object.numeric?
       #
       # @return [ false ] Always false.
-      #
-      # @since 3.0.0
       def numeric?
         false
       end
@@ -179,9 +142,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 +158,6 @@ module Mongoid
       #   object.resizable?
       #
       # @return [ false ] false.
-      #
-      # @since 3.0.0
       def resizable?
         false
       end
@@ -209,8 +168,6 @@ module Mongoid
       #   object.substitutable
       #
       # @return [ Object ] self.
-      #
-      # @since 2.0.0
       def substitutable
         self
       end
@@ -220,35 +177,34 @@ 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
+      # @deprecated
       def you_must(name, *args)
         frozen? ? nil : do_or_do_not(name, *args)
       end
+      Mongoid.deprecate(self, :you_must)
 
       module ClassMethods
-
         # Convert the provided object to a foreign key, given the metadata key
         # contstraint.
         #
         # @example Convert the object to a fk.
         #   Object.__mongoize_fk__(association, object)
         #
-        # @param [ Association ] association The association metadata.
+        # @param [ Mongoid::Association::Relatable ] association The association metadata.
         # @param [ Object ] object The object to convert.
         #
         # @return [ Object ] The converted object.
-        #
-        # @since 3.0.0
+        # @deprecated
         def __mongoize_fk__(association, object)
           return nil if !object || object == ""
           association.convert_to_foreign_key(object)
         end
+        Mongoid.deprecate(self, :__mongoize_fk__)
 
         # Convert the object from its mongo friendly ruby type to this type.
         #
@@ -258,8 +214,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 +227,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
@@ -283,5 +235,4 @@ module Mongoid
   end
 end
 
-::Object.__send__(:include, Mongoid::Extensions::Object)
-::Object.extend(Mongoid::Extensions::Object::ClassMethods)
+Object.include Mongoid::Extensions::Object