mongoid 7.2.1 → 9.0.0

data/lib/mongoid/extensions/big_decimal.rb

@@ -1,9 +1,18 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# 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.
       #
@@ -11,11 +20,11 @@ module Mongoid
       #   bd.__to_inc__
       #
       # @return [ Float ] The big decimal as a float.
-      #
-      # @since 3.0.3
+      # @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.
@@ -23,11 +32,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?
@@ -36,45 +43,58 @@ module Mongoid
       #   object.numeric?
       #
       # @return [ true ] Always true.
-      #
-      # @since 6.0.0
       def numeric?
         true
       end
 
       module ClassMethods
-
         # 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?
+            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)&.to_s
+            end
+          end
         end
       end
     end
   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

@@ -0,0 +1,45 @@
+# 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
+      # 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,7 +1,9 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 module Mongoid
+
+  # Adds type-casting behavior to Mongoid::Boolean class.
   class Boolean
 
     class << self
@@ -12,13 +14,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,15 +1,11 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 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)
+    # Adds type-casting behavior to Date class.
+    module Date
 
       # Convert the date into a time.
       #
@@ -20,10 +16,8 @@ module Mongoid
       # @return [ Time | ActiveSupport::TimeWithZone ] Local time in the
       #   configured default time zone corresponding to local midnight of
       #   this date.
-      #
-      # @since 3.0.0
       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
@@ -33,8 +27,6 @@ module Mongoid
       #   date.mongoize
       #
       # @return [ Time ] The object mongoized.
-      #
-      # @since 3.0.0
       def mongoize
         ::Date.mongoize(self)
       end
@@ -48,11 +40,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
@@ -63,22 +64,23 @@ 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
-              if object.is_a?(String)
-                # https://jira.mongodb.org/browse/MONGOID-4460
-                time = ::Time.parse(object)
-              else
-                time = object.__mongoize_time__
-              end
-              ::Time.utc(time.year, time.month, time.day)
-            rescue ArgumentError
+          return if object.blank?
+          begin
+            if object.is_a?(String)
+              # https://jira.mongodb.org/browse/MONGOID-4460
+              time = ::Time.parse(object)
+            elsif object.respond_to?(:__mongoize_time__)
+              time = object.__mongoize_time__
+            else
               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,8 +1,10 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 module Mongoid
   module Extensions
+
+    # Adds type-casting behavior to Time class.
     module DateTime
 
       # Mongoize the date time into a time.
@@ -11,15 +13,8 @@ module Mongoid
       #   date_time.__mongoize_time__
       #
       # @return [ Time | ActiveSupport::TimeWithZone ] The mongoized time.
-      #
-      # @since 3.0.0
       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
@@ -29,8 +24,6 @@ module Mongoid
       #   date_time.mongoize
       #
       # @return [ Time ] The object mongoized.
-      #
-      # @since 3.0.0
       def mongoize
         ::DateTime.mongoize(self)
       end
@@ -44,9 +37,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
@@ -60,8 +51,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,8 +1,10 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 module Mongoid
   module Extensions
+
+    # Adds type-casting behavior to BSON::Decimal128 class.
     module Decimal128
 
       # Evolve the decimal128.
@@ -11,8 +13,6 @@ module Mongoid
       #   decimal128.__evolve_decimal128__
       #
       # @return [ BSON::Decimal128 ] self.
-      #
-      # @since 6.1.0
       def __evolve_decimal128__
         self
       end
@@ -27,8 +27,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,21 +1,21 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 module Mongoid
   module Extensions
+    # Adds type-casting behavior to FalseClass.
     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
+      # @deprecated
       def __sortable__
         0
       end
+      Mongoid.deprecate(self, :__sortable__)
 
       # Is the passed value a boolean?
       #
@@ -24,11 +24,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)
@@ -37,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,8 +1,10 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# 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,10 +13,8 @@ module Mongoid
       #   1335532685.117847.__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 float a number?
@@ -23,8 +23,6 @@ module Mongoid
       #   object.numeric?
       #
       # @return [ true ] Always true.
-      #
-      # @since 3.0.0
       def numeric?
         true
       end
@@ -39,14 +37,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