mongoid 7.0.13 → 8.0.8

data/lib/mongoid/extensions/array.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Extensions
     module Array
@@ -9,8 +10,6 @@ module Mongoid
       #   [ id ].__evolve_object_id__
       #
       # @return [ Array<BSON::ObjectId> ] The converted array.
-      #
-      # @since 3.0.0
       def __evolve_object_id__
         map!(&:__evolve_object_id__)
         self
@@ -22,8 +21,6 @@ module Mongoid
       #   [ 1, 2, 3 ].__find_args__
       #
       # @return [ Array ] The array of args.
-      #
-      # @since 3.0.0
       def __find_args__
         flat_map{ |a| a.__find_args__ }.uniq{ |a| a.to_s }
       end
@@ -34,8 +31,6 @@ module Mongoid
       #   [ id ].__mongoize_object_id__
       #
       # @return [ Array<BSON::ObjectId> ] The converted array.
-      #
-      # @since 3.0.0
       def __mongoize_object_id__
         map!(&:__mongoize_object_id__).compact!
         self
@@ -43,26 +38,37 @@ module Mongoid
 
       # Converts the array for storing as a time.
       #
+      # @note Returns a local time in the default time zone.
+      #
       # @example Convert the array to a time.
       #   [ 2010, 1, 1 ].__mongoize_time__
+      #   # => 2010-01-01 00:00:00 -0500
       #
-      # @return [ Time ] The time.
-      #
-      # @since 3.0.0
+      # @return [ Time | ActiveSupport::TimeWithZone ] Local time in the
+      #   configured default time zone corresponding to date/time components
+      #   in this array.
       def __mongoize_time__
         ::Time.configured.local(*self)
       end
 
-      # Check if the array is part of a blank relation criteria.
-      #
-      # @example Is the array blank criteria?
-      #   [].blank_criteria?
-      #
-      # @return [ true, false ] If the array is blank criteria.
-      #
-      # @since 3.1.0
+      # 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?
-        any?(&:blank_criteria?)
+        false
       end
 
       # Is the array a set of multiple arguments in a method?
@@ -70,9 +76,7 @@ module Mongoid
       # @example Is this multi args?
       #   [ 1, 2, 3 ].multi_arged?
       #
-      # @return [ true, false ] If the array is multi args.
-      #
-      # @since 3.0.0
+      # @return [ true | false ] If the array is multi args.
       def multi_arged?
         !first.is_a?(Hash) && first.resizable? || size > 1
       end
@@ -83,17 +87,14 @@ module Mongoid
       # @example Mongoize the object.
       #   object.mongoize
       #
-      # @return [ Array ] The object.
-      #
-      # @since 3.0.0
+      # @return [ Array | nil ] The object or nil.
       def mongoize
         ::Array.mongoize(self)
       end
 
       # Delete the first object in the array that is equal to the supplied
       # object and return it. This is much faster than performing a standard
-      # delete for large arrays ince it attempt to delete multiple in the
-      # other.
+      # delete for large arrays since it does not perform multiple deletes.
       #
       # @example Delete the first object.
       #   [ "1", "2", "1" ].delete_one("1")
@@ -101,21 +102,17 @@ module Mongoid
       # @param [ Object ] object The object to delete.
       #
       # @return [ Object ] The deleted object.
-      #
-      # @since 2.1.0
       def delete_one(object)
         position = index(object)
         position ? delete_at(position) : nil
       end
 
-      # Is the object's size changable?
+      # Returns whether the object's size can be changed.
       #
       # @example Is the object resizable?
       #   object.resizable?
       #
       # @return [ true ] true.
-      #
-      # @since 3.0.0
       def resizable?
         true
       end
@@ -131,8 +128,6 @@ module Mongoid
         # @param [ Object ] object The object to convert.
         #
         # @return [ Array ] The array of ids.
-        #
-        # @since 3.0.0
         def __mongoize_fk__(association, object)
           if object.resizable?
             object.blank? ? object : association.convert_to_foreign_key(object)
@@ -149,25 +144,21 @@ module Mongoid
         #
         # @param [ Object ] 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)
-          if object.is_a?(::Array)
-            evolve(object).collect{ |obj| obj.class.mongoize(obj) }
-          else
-            evolve(object)
+          return if object.nil?
+          case object
+          when ::Array, ::Set
+            object.map(&:mongoize)
           end
         end
 
-        # Is the object's size changable?
+        # Returns whether the object's size can be changed.
         #
         # @example Is the object resizable?
         #   Array.resizable?
         #
         # @return [ true ] true.
-        #
-        # @since 3.0.0
         def resizable?
           true
         end
@@ -178,3 +169,5 @@ 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,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Extensions
     module BigDecimal
@@ -9,8 +10,6 @@ module Mongoid
       #   bd.__to_inc__
       #
       # @return [ Float ] The big decimal as a float.
-      #
-      # @since 3.0.3
       def __to_inc__
         to_f
       end
@@ -21,11 +20,9 @@ module Mongoid
       # @example Mongoize the object.
       #   object.mongoize
       #
-      # @return [ Object ] The object.
-      #
-      # @since 3.0.0
+      # @return [ String | BSON::Decimal128 | nil ] The object or nil.
       def mongoize
-        to_s
+        ::BigDecimal.mongoize(self)
       end
 
       # Is the BigDecimal a number?
@@ -34,8 +31,6 @@ module Mongoid
       #   object.numeric?
       #
       # @return [ true ] Always true.
-      #
-      # @since 6.0.0
       def numeric?
         true
       end
@@ -44,30 +39,49 @@ module Mongoid
 
         # Convert the object from its mongo friendly ruby type to this type.
         #
-        # @example Demongoize the object.
-        #   Object.demongoize(object)
-        #
         # @param [ Object ] object The object to demongoize.
         #
-        # @return [ BigDecimal, nil ] A BigDecimal derived from the object or nil.
-        #
-        # @since 3.0.0
+        # @return [ BigDecimal | nil ] A BigDecimal derived from the object or nil.
         def demongoize(object)
-          object && object.numeric? ? BigDecimal(object.to_s) : nil
+          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
         end
 
-        # Mongoize an object of any type to how it's stored in the db as a String.
+        # Mongoize an object of any type to how it's stored in the db.
         #
         # @example Mongoize the object.
         #   BigDecimal.mongoize(123)
         #
         # @param [ Object ] object The object to Mongoize
         #
-        # @return [ String, nil ] A String representing the object or nil.
-        #
-        # @since 3.0.7
+        # @return [ String | BSON::Decimal128 | nil ] A String or Decimal128
+        #   representing the object or nil. String if Mongoid.map_big_decimal_to_decimal128
+        #   is false, BSON::Decimal128 otherwise.
         def mongoize(object)
-          object && object.numeric? ? object.to_s : nil
+          return if object.blank?
+          if Mongoid.map_big_decimal_to_decimal128
+            if object.is_a?(BSON::Decimal128)
+              object
+            elsif object.is_a?(BigDecimal)
+              BSON::Decimal128.new(object)
+            elsif object.numeric?
+              BSON::Decimal128.new(object.to_s)
+            elsif !object.is_a?(String)
+              object.try(:to_d)
+            end
+          else
+            if object.is_a?(BSON::Decimal128) || object.numeric?
+              object.to_s
+            elsif !object.is_a?(String)
+              object.try(:to_d)
+            end
+          end
         end
       end
     end

data/lib/mongoid/extensions/binary.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Mongoid
+  module Extensions
+    module Binary
+
+      # Turn the object from the ruby type we deal with to a Mongo friendly
+      # type.
+      #
+      # @example Mongoize the object.
+      #   object.mongoize
+      #
+      # @return [ BSON::Binary | nil ] The object.
+      def mongoize
+        BSON::Binary.mongoize(self)
+      end
+
+      module ClassMethods
+
+        # Mongoize an object of any type to how it's stored in the db.
+        #
+        # @example Mongoize the object.
+        #   BigDecimal.mongoize(123)
+        #
+        # @param [ Object ] object The object to Mongoize
+        #
+        # @return [ BSON::Binary | nil ] A Binary representing the object or nil.
+        def mongoize(object)
+          return if object.nil?
+          case object
+          when BSON::Binary then object
+          when String, Symbol then BSON::Binary.new(object.to_s)
+          end
+        end
+        alias :demongoize :mongoize
+      end
+    end
+  end
+end
+
+BSON::Binary.__send__(:include, Mongoid::Extensions::Binary)
+BSON::Binary.extend(Mongoid::Extensions::Binary::ClassMethods)

data/lib/mongoid/extensions/boolean.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   class Boolean
 
@@ -10,13 +11,16 @@ module Mongoid
       # @example Mongoize the object.
       #   Boolean.mongoize("123.11")
       #
-      # @return [ String ] The object mongoized.
-      #
-      # @since 3.0.0
+      # @return [ true | false | nil ] The object mongoized or nil.
       def mongoize(object)
-        ::Boolean.evolve(object)
+        return if object.nil?
+        if object.to_s =~ (/\A(true|t|yes|y|on|1|1.0)\z/i)
+          true
+        elsif object.to_s =~ (/\A(false|f|no|n|off|0|0.0)\z/i)
+          false
+        end
       end
-      alias :evolve :mongoize
+      alias :demongoize :mongoize
     end
   end
 end

data/lib/mongoid/extensions/date.rb

@@ -1,22 +1,18 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Extensions
     module Date
 
-      # Constant for epoch - used when passing invalid times.
-      #
-      # @deprecated No longer used as a return value from #mongoize passed
-      #   an invalid date string.
-      EPOCH = ::Date.new(1970, 1, 1)
-
       # Convert the date into a time.
       #
       # @example Convert the date to a time.
-      #   date.__mongoize_time__
-      #
-      # @return [ Time ] The converted time.
+      #   Date.new(2018, 11, 1).__mongoize_time__
+      #   # => Thu, 01 Nov 2018 00:00:00 EDT -04:00
       #
-      # @since 3.0.0
+      # @return [ Time | ActiveSupport::TimeWithZone ] Local time in the
+      #   configured default time zone corresponding to local midnight of
+      #   this date.
       def __mongoize_time__
         ::Time.configured.local(year, month, day)
       end
@@ -28,8 +24,6 @@ module Mongoid
       #   date.mongoize
       #
       # @return [ Time ] The object mongoized.
-      #
-      # @since 3.0.0
       def mongoize
         ::Date.mongoize(self)
       end
@@ -43,11 +37,20 @@ module Mongoid
         #
         # @param [ Time ] object The time from Mongo.
         #
-        # @return [ Date ] The object as a date.
-        #
-        # @since 3.0.0
+        # @return [ Date | nil ] The object as a date or nil.
         def demongoize(object)
-          ::Date.new(object.year, object.month, object.day) if object
+          return if object.nil?
+          if object.is_a?(String)
+            object = begin
+              object.__mongoize_time__
+            rescue ArgumentError
+              nil
+            end
+          end
+
+          if object.acts_like?(:time) || object.acts_like?(:date)
+            ::Date.new(object.year, object.month, object.day)
+          end
         end
 
         # Turn the object from the ruby type we deal with to a Mongo friendly
@@ -58,17 +61,21 @@ module Mongoid
         #
         # @param [ Object ] object The object to mongoize.
         #
-        # @return [ Time ] The object mongoized.
-        #
-        # @since 3.0.0
+        # @return [ Time | nil ] The object mongoized or nil.
         def mongoize(object)
-          unless object.blank?
-            begin
+          return if object.blank?
+          begin
+            if object.is_a?(String)
+              # https://jira.mongodb.org/browse/MONGOID-4460
+              time = ::Time.parse(object)
+            else
               time = object.__mongoize_time__
-              ::Time.utc(time.year, time.month, time.day)
-            rescue ArgumentError
-              nil
             end
+          rescue ArgumentError
+            nil
+          end
+          if time.acts_like?(:time)
+            ::Time.utc(time.year, time.month, time.day)
           end
         end
       end

data/lib/mongoid/extensions/date_time.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Extensions
     module DateTime
@@ -8,13 +9,10 @@ module Mongoid
       # @example Mongoize the date time.
       #   date_time.__mongoize_time__
       #
-      # @return [ Time ] The mongoized time.
-      #
-      # @since 3.0.0
+      # @return [ Time | ActiveSupport::TimeWithZone ] The mongoized time.
       def __mongoize_time__
-        return to_time if utc? && Mongoid.use_utc?
         if Mongoid.use_activesupport_time_zone?
-          in_time_zone(::Time.zone).to_time
+          in_time_zone(::Time.zone)
         else
           time = to_time
           time.respond_to?(:getlocal) ? time.getlocal : time
@@ -28,8 +26,6 @@ module Mongoid
       #   date_time.mongoize
       #
       # @return [ Time ] The object mongoized.
-      #
-      # @since 3.0.0
       def mongoize
         ::DateTime.mongoize(self)
       end
@@ -43,9 +39,7 @@ module Mongoid
         #
         # @param [ Time ] object The time from Mongo.
         #
-        # @return [ DateTime ] The object as a date.
-        #
-        # @since 3.0.0
+        # @return [ DateTime | nil ] The object as a datetime or nil.
         def demongoize(object)
           ::Time.demongoize(object).try(:to_datetime)
         end
@@ -59,8 +53,6 @@ module Mongoid
         # @param [ Object ] object The object to convert.
         #
         # @return [ Time ] The object mongoized.
-        #
-        # @since 3.0.0
         def mongoize(object)
           ::Time.mongoize(object)
         end

data/lib/mongoid/extensions/decimal128.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Extensions
     module Decimal128
@@ -9,8 +10,6 @@ module Mongoid
       #   decimal128.__evolve_decimal128__
       #
       # @return [ BSON::Decimal128 ] self.
-      #
-      # @since 6.1.0
       def __evolve_decimal128__
         self
       end
@@ -25,8 +24,6 @@ module Mongoid
         # @param [ Object ] object The object to evolve.
         #
         # @return [ BSON::Decimal128 ] The decimal128.
-        #
-        # @since 6.1.0
         def evolve(object)
           object.__evolve_decimal128__
         end

data/lib/mongoid/extensions/false_class.rb

@@ -1,16 +1,15 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Extensions
     module FalseClass
 
-      # 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 [ Integer ] 0.
-      #
-      # @since 3.0.0
       def __sortable__
         0
       end
@@ -22,11 +21,9 @@ module Mongoid
       #
       # @param [ Class ] other The class to check.
       #
-      # @return [ true, false ] If the other is a boolean.
-      #
-      # @since 1.0.0
+      # @return [ true | false ] If the other is a boolean.
       def is_a?(other)
-        if other == ::Boolean || other.class == ::Boolean
+        if other == Mongoid::Boolean || other.class == Mongoid::Boolean
           return true
         end
         super(other)

data/lib/mongoid/extensions/float.rb

@@ -1,18 +1,17 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Extensions
     module Float
 
-      # Convert the float into a time.
+      # Converts the float into a time as the number of seconds since the epoch.
       #
       # @example Convert the float into a time.
       #   1335532685.117847.__mongoize_time__
       #
-      # @return [ Time ] The float as a time.
-      #
-      # @since 3.0.0
+      # @return [ Time | ActiveSupport::TimeWithZone ] The time.
       def __mongoize_time__
-        ::Time.at(self)
+        ::Time.configured.at(self)
       end
 
       # Is the float a number?
@@ -21,8 +20,6 @@ module Mongoid
       #   object.numeric?
       #
       # @return [ true ] Always true.
-      #
-      # @since 3.0.0
       def numeric?
         true
       end
@@ -37,14 +34,15 @@ module Mongoid
         #
         # @param [ Object ] object The object to mongoize.
         #
-        # @return [ String ] The object mongoized.
-        #
-        # @since 3.0.0
+        # @return [ Float | nil ] The object mongoized or nil.
         def mongoize(object)
-          unless object.blank?
-            __numeric__(object).to_f rescue 0.0
+          return if object.blank?
+          if object.is_a?(String)
+            if object.numeric?
+              object.to_f
+            end
           else
-            nil
+            object.try(:to_f)
           end
         end
         alias :demongoize :mongoize