mongoid 7.0.2 → 8.1.1

data/lib/mongoid/extensions/range.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Extensions
     module Range
@@ -9,8 +10,6 @@ module Mongoid
       #   range.__find_args__
       #
       # @return [ Array ] The range as an array.
-      #
-      # @since 3.0.0
       def __find_args__
         to_a
       end
@@ -21,9 +20,7 @@ module Mongoid
       # @example Mongoize the object.
       #   range.mongoize
       #
-      # @return [ Hash ] The object mongoized.
-      #
-      # @since 3.0.0
+      # @return [ Hash | nil ] The object mongoized or nil.
       def mongoize
         ::Range.mongoize(self)
       end
@@ -34,8 +31,6 @@ module Mongoid
       #   range.resizable?
       #
       # @return [ true ] True.
-      #
-      # @since 3.0.0
       def resizable?
         true
       end
@@ -49,11 +44,23 @@ module Mongoid
         #
         # @param [ Hash ] object The object to demongoize.
         #
-        # @return [ Range ] The range.
+        # @return [ Range | nil ] The range, or nil if object cannot be represented as range.
         #
-        # @since 3.0.0
+        # @note Ruby 2.6 and lower do not support endless ranges that Ruby 2.7+ support.
         def demongoize(object)
-          object.nil? ? nil : ::Range.new(object["min"], object["max"], object["exclude_end"])
+          return if object.nil?
+          if object.is_a?(Hash)
+            hash = object.slice('min', 'max', 'exclude_end', :min, :max, :exclude_end)
+            unless hash.blank?
+              begin
+                ::Range.new(hash["min"] || hash[:min],
+                            hash["max"] || hash[:max],
+                            hash["exclude_end"] || hash[:exclude_end])
+              rescue ArgumentError # can be removed when Ruby version >= 2.7
+                nil
+              end
+            end
+          end
         end
 
         # Turn the object from the ruby type we deal with to a Mongo friendly
@@ -62,18 +69,33 @@ module Mongoid
         # @example Mongoize the object.
         #   Range.mongoize(1..3)
         #
-        # @param [ Range ] object The object to mongoize.
-        #
-        # @return [ Hash ] The object mongoized.
+        # @param [ Object ] object The object to mongoize.
         #
-        # @since 3.0.0
+        # @return [ Hash | nil ] The object mongoized or nil.
         def mongoize(object)
-          return nil if object.nil?
-          return object if object.is_a?(::Hash)
-          return object if object.is_a?(String)
-          hash = { "min" => object.first, "max" => object.last }
+          return if object.nil?
+          case object
+          when Hash then __mongoize_hash__(object)
+          when Range then __mongoize_range__(object)
+          end
+        end
+
+        private
+
+        def __mongoize_hash__(object)
+          hash = object.stringify_keys
+          hash.slice!('min', 'max', 'exclude_end')
+          hash.compact!
+          hash.transform_values!(&:mongoize)
+          hash.blank? ? nil : hash
+        end
+
+        def __mongoize_range__(object)
+          hash = {}
+          hash['min'] = object.begin.mongoize if object.begin
+          hash['max'] = object.end.mongoize if object.end
           if object.respond_to?(:exclude_end?) && object.exclude_end?
-            hash.merge!("exclude_end" => true)
+            hash['exclude_end'] = true
           end
           hash
         end

data/lib/mongoid/extensions/regexp.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Extensions
     module Regexp
@@ -9,16 +10,22 @@ module Mongoid
         # type.
         #
         # @example Mongoize the object.
-        #   Regexp.mongoize(/^[abc]/)
-        #
-        # @param [ Regexp, String ] object The object to mongoize.
+        #   Regexp.mongoize(/\A[abc]/)
         #
-        # @return [ Regexp ] The object mongoized.
+        # @param [ Object ] object The object to mongoize.
         #
-        # @since 3.0.0
+        # @return [ Regexp | nil ] The object mongoized or nil.
         def mongoize(object)
-          ::Regexp.new(object)
+          return if object.nil?
+          case object
+          when String then ::Regexp.new(object)
+          when ::Regexp then object
+          when BSON::Regexp::Raw then object.compile
+          end
+        rescue RegexpError
+          nil
         end
+        alias :demongoize :mongoize
       end
     end
   end

data/lib/mongoid/extensions/set.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Extensions
     module Set
@@ -9,9 +10,7 @@ module Mongoid
       # @example Mongoize the object.
       #   set.mongoize
       #
-      # @return [ Array ] The object mongoized.
-      #
-      # @since 3.0.0
+      # @return [ Array | nil ] The object mongoized or nil.
       def mongoize
         ::Set.mongoize(self)
       end
@@ -26,10 +25,11 @@ module Mongoid
         # @param [ Array ] object The object to demongoize.
         #
         # @return [ Set ] The set.
-        #
-        # @since 3.0.0
         def demongoize(object)
-          ::Set.new(object)
+          case object
+          when ::Set then object
+          when ::Array then ::Set.new(object)
+          end
         end
 
         # Turn the object from the ruby type we deal with to a Mongo friendly
@@ -40,11 +40,13 @@ module Mongoid
         #
         # @param [ Set ] 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)
-          object.to_a
+          return if object.nil?
+          case object
+          when ::Set then ::Array.mongoize(object.to_a).uniq
+          when ::Array then ::Array.mongoize(object).uniq
+          end
         end
       end
     end

data/lib/mongoid/extensions/string.rb

@@ -1,9 +1,10 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Extensions
     module String
 
-      # @attribute [rw] unconvertable_to_bson If the document is unconvetable.
+      # @attribute [rw] unconvertable_to_bson If the document is unconvertable.
       attr_accessor :unconvertable_to_bson
 
       # Evolve the string into an object id if possible.
@@ -11,9 +12,7 @@ module Mongoid
       # @example Evolve the string.
       #   "test".__evolve_object_id__
       #
-      # @return [ String, BSON::ObjectId ] The evolved string.
-      #
-      # @since 3.0.0
+      # @return [ String | BSON::ObjectId ] The evolved string.
       def __evolve_object_id__
         convert_to_object_id
       end
@@ -23,29 +22,32 @@ module Mongoid
       # @example Evolve the string.
       #   "test".__mongoize_object_id__
       #
-      # @return [ String, BSON::ObjectId, nil ] The mongoized string.
-      #
-      # @since 3.0.0
+      # @return [ String | BSON::ObjectId | nil ] The mongoized string.
       def __mongoize_object_id__
         convert_to_object_id unless blank?
       end
 
       # Mongoize the string for storage.
       #
+      # @note Returns a local time in the default time zone.
+      #
       # @example Mongoize the string.
       #   "2012-01-01".__mongoize_time__
+      #   # => 2012-01-01 00:00:00 -0500
       #
-      # @note The extra parse from Time is because ActiveSupport::TimeZone
-      #   either returns nil or Time.now if the string is empty or invalid,
-      #   which is a regression from pre-3.0 and also does not agree with
-      #   the core Time API.
-      #
-      # @return [ Time ] The time.
-      #
-      # @since 3.0.0
+      # @return [ Time | ActiveSupport::TimeWithZone ] Local time in the
+      #   configured default time zone corresponding to this string.
       def __mongoize_time__
-        ::Time.parse(self)
-        ::Time.configured.parse(self)
+        # This extra parse from Time is because ActiveSupport::TimeZone
+        # either returns nil or Time.now if the string is empty or invalid,
+        # which is a regression from pre-3.0 and also does not agree with
+        # the core Time API.
+        parsed = ::Time.parse(self)
+        if ::Time == ::Time.configured
+          parsed
+        else
+          ::Time.configured.parse(self)
+        end
       end
 
       # Convert the string to a collection friendly name.
@@ -54,8 +56,6 @@ module Mongoid
       #   "namespace/model".collectionize
       #
       # @return [ String ] The string in collection friendly form.
-      #
-      # @since 1.0.0
       def collectionize
         tableize.gsub("/", "_")
       end
@@ -65,11 +65,9 @@ module Mongoid
       # @example Is the string an id value?
       #   "_id".mongoid_id?
       #
-      # @return [ true, false ] If the string is id or _id.
-      #
-      # @since 2.3.1
+      # @return [ true | false ] If the string is id or _id.
       def mongoid_id?
-        self =~ /\A(|_)id$/
+        self =~ /\A(|_)id\z/
       end
 
       # Is the string a number? The literals "NaN", "Infinity", and "-Infinity"
@@ -78,11 +76,11 @@ module Mongoid
       # @example Is the string a number.
       #   "1234.23".numeric?
       #
-      # @return [ true, false ] If the string is a number.
-      #
-      # @since 3.0.0
+      # @return [ true | false ] If the string is a number.
       def numeric?
-        true if Float(self) rescue (self =~ /^NaN|\-?Infinity$/)
+        !!Float(self)
+      rescue ArgumentError
+        (self =~ /\A(?:NaN|-?Infinity)\z/) == 0
       end
 
       # Get the string as a getter string.
@@ -91,10 +89,8 @@ module Mongoid
       #   "model=".reader
       #
       # @return [ String ] The string stripped of "=".
-      #
-      # @since 1.0.0
       def reader
-        delete("=").sub(/\_before\_type\_cast$/, '')
+        delete("=").sub(/\_before\_type\_cast\z/, '')
       end
 
       # Is this string a writer?
@@ -102,21 +98,17 @@ module Mongoid
       # @example Is the string a setter method?
       #   "model=".writer?
       #
-      # @return [ true, false ] If the string contains "=".
-      #
-      # @since 1.0.0
+      # @return [ true | false ] If the string contains "=".
       def writer?
         include?("=")
       end
 
       # Is this string a valid_method_name?
       #
-      # @example Is the string a valid Ruby idenfier for use as a method name
+      # @example Is the string a valid Ruby identifier for use as a method name
       #   "model=".valid_method_name?
       #
-      # @return [ true, false ] If the string contains a valid Ruby identifier.
-      #
-      # @since 3.0.15
+      # @return [ true | false ] If the string contains a valid Ruby identifier.
       def valid_method_name?
         /[@$"-]/ !~ self
       end
@@ -126,9 +118,7 @@ module Mongoid
       # @example Is the string a setter method?
       #   "price_before_type_cast".before_type_cast?
       #
-      # @return [ true, false ] If the string ends with "_before_type_cast"
-      #
-      # @since 3.1.0
+      # @return [ true | false ] If the string ends with "_before_type_cast"
       def before_type_cast?
         ends_with?("_before_type_cast")
       end
@@ -138,9 +128,7 @@ module Mongoid
       # @example Is the object unconvertable?
       #   object.unconvertable_to_bson?
       #
-      # @return [ true, false ] If the object is unconvertable.
-      #
-      # @since 2.2.1
+      # @return [ true | false ] If the object is unconvertable.
       def unconvertable_to_bson?
         @unconvertable_to_bson ||= false
       end
@@ -154,29 +142,13 @@ module Mongoid
       # @example Convert to the object id.
       #   string.convert_to_object_id
       #
-      # @return [ String, BSON::ObjectId ] The string or the id.
-      #
-      # @since 3.0.0
+      # @return [ String | BSON::ObjectId ] The string or the id.
       def convert_to_object_id
         BSON::ObjectId.legal?(self) ? BSON::ObjectId.from_string(self) : self
       end
 
       module ClassMethods
 
-        # Convert the object from its mongo friendly ruby type to this type.
-        #
-        # @example Demongoize the object.
-        #   String.demongoize(object)
-        #
-        # @param [ Object ] object The object to demongoize.
-        #
-        # @return [ String ] The object.
-        #
-        # @since 3.0.0
-        def demongoize(object)
-          object.try(:to_s)
-        end
-
         # Turn the object from the ruby type we deal with to a Mongo friendly
         # type.
         #
@@ -186,11 +158,10 @@ module Mongoid
         # @param [ Object ] object The object to mongoize.
         #
         # @return [ String ] The object mongoized.
-        #
-        # @since 3.0.0
         def mongoize(object)
-          demongoize(object)
+          object.try(:to_s)
         end
+        alias :demongoize :mongoize
       end
     end
   end

data/lib/mongoid/extensions/symbol.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Extensions
     module Symbol
@@ -8,29 +9,13 @@ module Mongoid
       # @example Is the string an id value?
       #   :_id.mongoid_id?
       #
-      # @return [ true, false ] If the symbol is :id or :_id.
-      #
-      # @since 2.3.1
+      # @return [ true | false ] If the symbol is :id or :_id.
       def mongoid_id?
         to_s.mongoid_id?
       end
 
       module ClassMethods
 
-        # Convert the object from its mongo friendly ruby type to this type.
-        #
-        # @example Demongoize the object.
-        #   Symbol.demongoize(object)
-        #
-        # @param [ Object ] object The object to demongoize.
-        #
-        # @return [ Symbol ] The object.
-        #
-        # @since 3.0.0
-        def demongoize(object)
-          object.try(:to_sym)
-        end
-
         # Turn the object from the ruby type we deal with to a Mongo friendly
         # type.
         #
@@ -39,12 +24,11 @@ module Mongoid
         #
         # @param [ Object ] object The object to mongoize.
         #
-        # @return [ Symbol ] The object mongoized.
-        #
-        # @since 3.0.0
+        # @return [ Symbol | nil ] The object mongoized or nil.
         def mongoize(object)
-          demongoize(object)
+          object.try(:to_sym)
         end
+        alias :demongoize :mongoize
       end
     end
   end

data/lib/mongoid/extensions/time.rb

@@ -1,13 +1,18 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Extensions
     module Time
 
-      # Constant for epoch - used when passing invalid times.
+      # Mongoizes a Time into a time.
+      #
+      # Time always mongoize into Time instances
+      # (which are themselves).
       #
-      # @deprecated No longer used as a return value from #mongoize passed
-      #   an invalid time string.
-      EPOCH = ::Time.utc(1970, 1, 1, 0, 0, 0)
+      # @return [ Time ] self.
+      def __mongoize_time__
+        self
+      end
 
       # Turn the object from the ruby type we deal with to a Mongo friendly
       # type.
@@ -15,9 +20,7 @@ module Mongoid
       # @example Mongoize the object.
       #   time.mongoize
       #
-      # @return [ Time ] The object mongoized.
-      #
-      # @since 3.0.0
+      # @return [ Time | nil ] The object mongoized or nil.
       def mongoize
         ::Time.mongoize(self)
       end
@@ -32,7 +35,7 @@ module Mongoid
         #
         # @return [ Time ] The configured time.
         #
-        # @since 3.0.0
+        # @deprecated
         def configured
           Mongoid.use_activesupport_time_zone? ? (::Time.zone || ::Time) : ::Time
         end
@@ -44,16 +47,28 @@ module Mongoid
         #
         # @param [ Time ] object The time from Mongo.
         #
-        # @return [ Time ] The object as a date.
-        #
-        # @since 3.0.0
+        # @return [ Time | nil ] The object as a time.
         def demongoize(object)
-          return nil if object.blank?
-          object = object.getlocal unless Mongoid::Config.use_utc?
+          return if object.blank?
+          time = if object.acts_like?(:time)
+            Mongoid::Config.use_utc? ? object : object.getlocal
+          elsif object.acts_like?(:date)
+            ::Date.demongoize(object).to_time
+          elsif object.is_a?(String)
+            begin
+              object.__mongoize_time__
+            rescue ArgumentError
+              nil
+            end
+          end
+
+          return if time.nil?
+
           if Mongoid::Config.use_activesupport_time_zone?
-            object = object.in_time_zone(Mongoid.time_zone)
+            time.in_time_zone(Mongoid.time_zone)
+          else
+            time
           end
-          object
         end
 
         # Turn the object from the ruby type we deal with to a Mongo friendly
@@ -64,13 +79,16 @@ 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)
-          return nil if object.blank?
+          return if object.blank?
           begin
             time = object.__mongoize_time__
+          rescue ArgumentError
+            return
+          end
+
+          if time.acts_like?(:time)
             if object.respond_to?(:sec_fraction)
               ::Time.at(time.to_i, object.sec_fraction * 10**6).utc
             elsif time.respond_to?(:subsec)
@@ -78,8 +96,6 @@ module Mongoid
             else
               ::Time.at(time.to_i, time.usec).utc
             end
-          rescue ArgumentError
-            nil
           end
         end
       end

data/lib/mongoid/extensions/time_with_zone.rb

@@ -1,8 +1,19 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Extensions
     module TimeWithZone
 
+      # Mongoizes an ActiveSupport::TimeWithZone into a time.
+      #
+      # TimeWithZone always mongoize into TimeWithZone instances
+      # (which are themselves).
+      #
+      # @return [ ActiveSupport::TimeWithZone ] self.
+      def __mongoize_time__
+        self
+      end
+
       # Turn the object from the ruby type we deal with to a Mongo friendly
       # type.
       #
@@ -10,12 +21,23 @@ module Mongoid
       #   date_time.mongoize
       #
       # @return [ Time ] The object mongoized.
-      #
-      # @since 3.0.0
       def mongoize
         ::ActiveSupport::TimeWithZone.mongoize(self)
       end
 
+      # This code is copied from Time class extension in bson-ruby gem. It
+      # should be removed from here when added to bson-ruby.
+      # See https://jira.mongodb.org/browse/RUBY-2846.
+      def _bson_to_i
+        # Workaround for JRuby's #to_i rounding negative timestamps up
+        # rather than down (https://github.com/jruby/jruby/issues/6104)
+        if BSON::Environment.jruby?
+          (self - usec.to_r/1000000).to_i
+        else
+          to_i
+        end
+      end
+
       module ClassMethods
 
         # Convert the object from its mongo friendly ruby type to this type.
@@ -26,11 +48,8 @@ module Mongoid
         # @param [ Time ] object The time from Mongo.
         #
         # @return [ TimeWithZone ] The object as a date.
-        #
-        # @since 3.0.0
         def demongoize(object)
-          return nil if object.blank?
-          ::Time.demongoize(object).in_time_zone
+          ::Time.demongoize(object).try(:in_time_zone)
         end
 
         # Turn the object from the ruby type we deal with to a Mongo friendly
@@ -42,8 +61,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/true_class.rb

@@ -1,16 +1,15 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Extensions
     module TrueClass
 
-      # 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 ] 1.
-      #
-      # @since 3.0.0
       def __sortable__
         1
       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)