mongoid 8.1.4 → 9.0.0

data/lib/mongoid/extensions/array.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   module Extensions
+    # Adds type-casting behavior to Array class.
     module Array
 
       # Evolve the array into an array of object ids.
@@ -21,9 +23,11 @@ module Mongoid
       #   [ 1, 2, 3 ].__find_args__
       #
       # @return [ Array ] The array of args.
+      # @deprecated
       def __find_args__
         flat_map{ |a| a.__find_args__ }.uniq{ |a| a.to_s }
       end
+      Mongoid.deprecate(self, :__find_args__)
 
       # Mongoize the array into an array of object ids.
       #
@@ -48,27 +52,7 @@ module Mongoid
       #   configured default time zone corresponding to date/time components
       #   in this array.
       def __mongoize_time__
-        ::Time.configured.local(*self)
-      end
-
-      # Checks whether conditions given in this array are known to be
-      # unsatisfiable, i.e., querying with this array will always return no
-      # documents.
-      #
-      # This method used to assume that the array is the list of criteria
-      # to be used with an $and operator. This assumption is no longer made;
-      # therefore, since the interpretation of conditions in the array differs
-      # between $and, $or and $nor operators, this method now always returns
-      # false.
-      #
-      # 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.
-      # @deprecated
-      def blank_criteria?
-        false
+        ::Time.zone.local(*self)
       end
 
       # Is the array a set of multiple arguments in a method?
@@ -77,9 +61,11 @@ module Mongoid
       #   [ 1, 2, 3 ].multi_arged?
       #
       # @return [ true | false ] If the array is multi args.
+      # @deprecated
       def multi_arged?
         !first.is_a?(Hash) && first.resizable? || size > 1
       end
+      Mongoid.deprecate(self, :multi_arged?)
 
       # Turn the object from the ruby type we deal with to a Mongo friendly
       # type.
@@ -124,10 +110,11 @@ module Mongoid
         # @example Mongoize the object.
         #   Array.__mongoize_fk__(constraint, object)
         #
-        # @param [ Association ] association The association metadata.
+        # @param [ Mongoid::Association::Relatable ] association The association metadata.
         # @param [ Object ] object The object to convert.
         #
         # @return [ Array ] The array of ids.
+        # @deprecated
         def __mongoize_fk__(association, object)
           if object.resizable?
             object.blank? ? object : association.convert_to_foreign_key(object)
@@ -135,6 +122,7 @@ module Mongoid
             object.blank? ? [] : association.convert_to_foreign_key(Array(object))
           end
         end
+        Mongoid.deprecate(self, :__mongoize_fk__)
 
         # Turn the object from the ruby type we deal with to a Mongo friendly
         # type.
@@ -169,5 +157,3 @@ 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

@@ -1,8 +1,18 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   module Extensions
+    # Adds type-casting behavior to BigDecimal class.
     module BigDecimal
+      # Behavior to be invoked when the module is included.
+      #
+      # @param [ Module ] base the class or module doing the including
+      #
+      # @api private
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
 
       # Convert the big decimal to an $inc-able value.
       #
@@ -10,9 +20,11 @@ module Mongoid
       #   bd.__to_inc__
       #
       # @return [ Float ] The big decimal as a float.
+      # @deprecated
       def __to_inc__
         to_f
       end
+      Mongoid.deprecate(self, :__to_inc__)
 
       # Turn the object from the ruby type we deal with to a Mongo friendly
       # type.
@@ -36,7 +48,6 @@ module Mongoid
       end
 
       module ClassMethods
-
         # Convert the object from its mongo friendly ruby type to this type.
         #
         # @param [ Object ] object The object to demongoize.
@@ -46,8 +57,6 @@ module Mongoid
           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
@@ -79,7 +88,7 @@ module Mongoid
             if object.is_a?(BSON::Decimal128) || object.numeric?
               object.to_s
             elsif !object.is_a?(String)
-              object.try(:to_d)
+              object.try(:to_d)&.to_s
             end
           end
         end
@@ -88,5 +97,4 @@ module Mongoid
   end
 end
 
-::BigDecimal.__send__(:include, Mongoid::Extensions::BigDecimal)
-::BigDecimal.extend(Mongoid::Extensions::BigDecimal::ClassMethods)
+BigDecimal.include Mongoid::Extensions::BigDecimal

data/lib/mongoid/extensions/binary.rb

@@ -1,7 +1,10 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   module Extensions
+
+    # Adds type-casting behavior to BSON::Binary class.
     module Binary
 
       # Turn the object from the ruby type we deal with to a Mongo friendly

data/lib/mongoid/extensions/boolean.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
+
+  # Adds type-casting behavior to Mongoid::Boolean class.
   class Boolean
 
     class << self

data/lib/mongoid/extensions/date.rb

@@ -1,7 +1,10 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   module Extensions
+
+    # Adds type-casting behavior to Date class.
     module Date
 
       # Convert the date into a time.
@@ -14,7 +17,7 @@ module Mongoid
       #   configured default time zone corresponding to local midnight of
       #   this date.
       def __mongoize_time__
-        ::Time.configured.local(year, month, day)
+        ::Time.zone.local(year, month, day)
       end
 
       # Turn the object from the ruby type we deal with to a Mongo friendly
@@ -68,8 +71,10 @@ module Mongoid
             if object.is_a?(String)
               # https://jira.mongodb.org/browse/MONGOID-4460
               time = ::Time.parse(object)
-            else
+            elsif object.respond_to?(:__mongoize_time__)
               time = object.__mongoize_time__
+            else
+              nil
             end
           rescue ArgumentError
             nil

data/lib/mongoid/extensions/date_time.rb

@@ -1,7 +1,10 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   module Extensions
+
+    # Adds type-casting behavior to Time class.
     module DateTime
 
       # Mongoize the date time into a time.
@@ -11,12 +14,7 @@ module Mongoid
       #
       # @return [ Time | ActiveSupport::TimeWithZone ] The mongoized time.
       def __mongoize_time__
-        if Mongoid.use_activesupport_time_zone?
-          in_time_zone(::Time.zone)
-        else
-          time = to_time
-          time.respond_to?(:getlocal) ? time.getlocal : time
-        end
+        in_time_zone(::Time.zone)
       end
 
       # Turn the object from the ruby type we deal with to a Mongo friendly

data/lib/mongoid/extensions/decimal128.rb

@@ -1,7 +1,10 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   module Extensions
+
+    # Adds type-casting behavior to BSON::Decimal128 class.
     module Decimal128
 
       # Evolve the decimal128.

data/lib/mongoid/extensions/false_class.rb

@@ -1,18 +1,21 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   module Extensions
+    # Adds type-casting behavior to FalseClass.
     module FalseClass
-
       # Get the value of the object as a mongo friendly sort value.
       #
       # @example Get the object as sort criteria.
       #   object.__sortable__
       #
       # @return [ Integer ] 0.
+      # @deprecated
       def __sortable__
         0
       end
+      Mongoid.deprecate(self, :__sortable__)
 
       # Is the passed value a boolean?
       #
@@ -32,4 +35,4 @@ module Mongoid
   end
 end
 
-::FalseClass.__send__(:include, Mongoid::Extensions::FalseClass)
+FalseClass.include Mongoid::Extensions::FalseClass

data/lib/mongoid/extensions/float.rb

@@ -1,7 +1,10 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   module Extensions
+
+    # Adds type-casting behavior to Float class.
     module Float
 
       # Converts the float into a time as the number of seconds since the epoch.
@@ -11,7 +14,7 @@ module Mongoid
       #
       # @return [ Time | ActiveSupport::TimeWithZone ] The time.
       def __mongoize_time__
-        ::Time.configured.at(self)
+        ::Time.zone.at(self)
       end
 
       # Is the float a number?

data/lib/mongoid/extensions/hash.rb

@@ -1,7 +1,10 @@
 # frozen_string_literal: true
+# 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.
@@ -29,79 +32,20 @@ module Mongoid
       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.
-      def __consolidate__(klass)
-        consolidated = {}
-        each_pair do |key, value|
-          if key =~ /\$/
-            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))
-          end
-        end
-        consolidated
-      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.
       # @deprecated
-      alias :blank_criteria? :_mongoid_unsatisfiable_criteria?
+      def __consolidate__(klass)
+        Mongoid::AtomicUpdatePreparer.prepare(self, klass)
+      end
+      Mongoid.deprecate(self, :__consolidate__)
 
       # Deletes an id value from the hash.
       #
@@ -109,9 +53,11 @@ module Mongoid
       #   {}.delete_id
       #
       # @return [ Object ] The deleted value, or nil.
+      # @deprecated
       def 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.
@@ -120,31 +66,11 @@ module Mongoid
       #   { :_id => 1 }.extract_id
       #
       # @return [ Object ] The value of the id.
+      # @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.
-      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
-      end
+      Mongoid.deprecate(self, :extract_id)
 
       # Turn the object from the ruby type we deal with to a Mongo friendly
       # type.
@@ -175,60 +101,14 @@ module Mongoid
       #   { klass: Band, where: { name: "Depeche Mode" }.to_criteria
       #
       # @return [ Criteria ] The criteria.
+      # @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
 
-      # 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
-      #
-      # @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.
-      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
@@ -242,11 +122,11 @@ module Mongoid
         # @return [ Hash | nil ] The object mongoized or nil.
         def mongoize(object)
           return if object.nil?
-          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.
+          case object
+          when BSON::Document
             object.dup.transform_values!(&:mongoize)
+          when Hash
+            BSON::Document.new(object.transform_values(&:mongoize))
           end
         end
 
@@ -266,5 +146,3 @@ 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,7 +1,10 @@
 # frozen_string_literal: true
+# 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,7 +14,7 @@ module Mongoid
       #
       # @return [ Time | ActiveSupport::TimeWithZone ] The time.
       def __mongoize_time__
-        ::Time.configured.at(self)
+        ::Time.zone.at(self)
       end
 
       # Is the integer a number?
@@ -30,9 +33,11 @@ module Mongoid
       #   object.unconvertable_to_bson?
       #
       # @return [ true ] If the object is unconvertable.
+      # @deprecated
       def unconvertable_to_bson?
         true
       end
+      Mongoid.deprecate(self, :unconvertable_to_bson?)
 
       module ClassMethods
 

data/lib/mongoid/extensions/module.rb

@@ -1,7 +1,10 @@
 # frozen_string_literal: true
+# 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,7 +16,7 @@ module Mongoid
       #   end
       #
       # @param [ String | Symbol ] name The name of the method.
-      # @param [ Proc ] block The method body.
+      # @param &block The method body.
       #
       # @return [ Method ] The new method.
       def re_define_method(name, &block)

data/lib/mongoid/extensions/nil_class.rb

@@ -1,18 +1,21 @@
 # frozen_string_literal: true
+# 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.
+      # @deprecated
       def __setter__
         self
       end
+      Mongoid.deprecate(self, :__setter__)
 
       # Get the name of a nil collection.
       #
@@ -27,4 +30,4 @@ module Mongoid
   end
 end
 
-::NilClass.__send__(:include, Mongoid::Extensions::NilClass)
+NilClass.include Mongoid::Extensions::NilClass