mongoid 5.4.1 → 7.4.0

data/lib/mongoid/extensions/object.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Extensions
     module Object
@@ -9,8 +10,6 @@ module Mongoid
       #   object.__evolve_object_id__
       #
       # @return [ Object ] self.
-      #
-      # @since 3.0.0
       def __evolve_object_id__
         self
       end
@@ -22,20 +21,22 @@ 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__
         self
       end
@@ -46,20 +47,16 @@ module Mongoid
       #   object.__setter__
       #
       # @return [ String ] The object as a string plus =.
-      #
-      # @since 3.1.0
       def __setter__
         "#{self}="
       end
 
-      # 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
       def __sortable__
         self
       end
@@ -70,20 +67,20 @@ module Mongoid
       #   1.__to_inc__
       #
       # @return [ Object ] The object.
-      #
-      # @since 3.0.3
       def __to_inc__
         self
       end
 
-      # Check if the object is part of a blank relation criteria.
-      #
-      # @example Is the object blank criteria?
-      #   "".blank_criteria?
+      # Checks whether conditions given in this object are known to be
+      # unsatisfiable, i.e., querying with this object will always return no
+      # documents.
       #
-      # @return [ true, false ] If the object is blank criteria.
+      # This method is deprecated. Mongoid now uses
+      # +_mongoid_unsatisfiable_criteria?+ internally; this method is retained
+      # for backwards compatibility only. It always returns false.
       #
-      # @since 3.1.0
+      # @return [ false ] Always false.
+      # @deprecated
       def blank_criteria?
         false
       end
@@ -98,8 +95,6 @@ module Mongoid
       #
       # @return [ Object, nil ] The result of the method call or nil if the
       #   method does not exist.
-      #
-      # @since 2.0.0.rc.1
       def do_or_do_not(name, *args)
         send(name, *args) if name && respond_to?(name)
       end
@@ -112,8 +107,6 @@ module Mongoid
       # @param [ String ] name The name of the variable.
       #
       # @return [ Object, false ] The value or false.
-      #
-      # @since 2.0.0.rc.1
       def ivar(name)
         var_name = "@_#{name}"
         if instance_variable_defined?(var_name)
@@ -130,8 +123,6 @@ module Mongoid
       #   object.mongoize
       #
       # @return [ Object ] The object.
-      #
-      # @since 3.0.0
       def mongoize
         self
       end
@@ -142,8 +133,6 @@ module Mongoid
       #   object.multi_arged?
       #
       # @return [ false ] false.
-      #
-      # @since 3.0.0
       def multi_arged?
         false
       end
@@ -154,8 +143,6 @@ module Mongoid
       #   object.numeric?
       #
       # @return [ false ] Always false.
-      #
-      # @since 3.0.0
       def numeric?
         false
       end
@@ -168,8 +155,6 @@ module Mongoid
       # @param [ String ] name The name of the variable.
       #
       # @return [ true, false ] If the variable was defined.
-      #
-      # @since 2.1.0
       def remove_ivar(name)
         if instance_variable_defined?("@_#{name}")
           return remove_instance_variable("@_#{name}")
@@ -185,8 +170,6 @@ module Mongoid
       #   object.resizable?
       #
       # @return [ false ] false.
-      #
-      # @since 3.0.0
       def resizable?
         false
       end
@@ -197,8 +180,6 @@ module Mongoid
       #   object.substitutable
       #
       # @return [ Object ] self.
-      #
-      # @since 2.0.0
       def substitutable
         self
       end
@@ -213,8 +194,6 @@ module Mongoid
       #
       # @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
       def you_must(name, *args)
         frozen? ? nil : do_or_do_not(name, *args)
       end
@@ -225,17 +204,15 @@ module Mongoid
         # contstraint.
         #
         # @example Convert the object to a fk.
-        #   Object.__mongoize_fk__(constraint, object)
+        #   Object.__mongoize_fk__(association, object)
         #
-        # @param [ Constraint ] constraint The constraint.
+        # @param [ Association ] association The association metadata.
         # @param [ Object ] object The object to convert.
         #
         # @return [ Object ] The converted object.
-        #
-        # @since 3.0.0
-        def __mongoize_fk__(constraint, object)
+        def __mongoize_fk__(association, object)
           return nil if !object || object == ""
-          constraint.convert(object)
+          association.convert_to_foreign_key(object)
         end
 
         # Convert the object from its mongo friendly ruby type to this type.
@@ -246,8 +223,6 @@ module Mongoid
         # @param [ Object ] object The object to demongoize.
         #
         # @return [ Object ] The object.
-        #
-        # @since 3.0.0
         def demongoize(object)
           object
         end
@@ -261,8 +236,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

data/lib/mongoid/extensions/object_id.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Extensions
     module ObjectId
@@ -9,8 +10,6 @@ module Mongoid
       #   object_id.__evolve_object_id__
       #
       # @return [ BSON::ObjectId ] self.
-      #
-      # @since 3.0.0
       def __evolve_object_id__
         self
       end
@@ -26,8 +25,6 @@ module Mongoid
         # @param [ Object ] object The object to evolve.
         #
         # @return [ BSON::ObjectId ] The object id.
-        #
-        # @since 3.0.0
         def evolve(object)
           object.__evolve_object_id__
         end
@@ -40,8 +37,6 @@ module Mongoid
         # @param [ Object ] object The object to convert.
         #
         # @return [ BSON::ObjectId ] The object id.
-        #
-        # @since 3.0.0
         def mongoize(object)
           object.__mongoize_object_id__
         end

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
@@ -22,8 +21,6 @@ module Mongoid
       #   range.mongoize
       #
       # @return [ Hash ] The object mongoized.
-      #
-      # @since 3.0.0
       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
@@ -50,8 +45,6 @@ module Mongoid
         # @param [ Hash ] object The object to demongoize.
         #
         # @return [ Range ] The range.
-        #
-        # @since 3.0.0
         def demongoize(object)
           object.nil? ? nil : ::Range.new(object["min"], object["max"], object["exclude_end"])
         end
@@ -65,11 +58,10 @@ module Mongoid
         # @param [ Range ] object The object to mongoize.
         #
         # @return [ Hash ] The object mongoized.
-        #
-        # @since 3.0.0
         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 }
           if object.respond_to?(:exclude_end?) && object.exclude_end?
             hash.merge!("exclude_end" => true)

data/lib/mongoid/extensions/regexp.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Extensions
     module Regexp
@@ -9,14 +10,13 @@ module Mongoid
         # type.
         #
         # @example Mongoize the object.
-        #   Regexp.mongoize(/^[abc]/)
+        #   Regexp.mongoize(/\A[abc]/)
         #
         # @param [ Regexp, String ] object The object to mongoize.
         #
         # @return [ Regexp ] The object mongoized.
-        #
-        # @since 3.0.0
         def mongoize(object)
+          return nil if object.nil?
           ::Regexp.new(object)
         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
@@ -10,8 +11,6 @@ module Mongoid
       #   set.mongoize
       #
       # @return [ Array ] The object mongoized.
-      #
-      # @since 3.0.0
       def mongoize
         ::Set.mongoize(self)
       end
@@ -26,8 +25,6 @@ module Mongoid
         # @param [ Array ] object The object to demongoize.
         #
         # @return [ Set ] The set.
-        #
-        # @since 3.0.0
         def demongoize(object)
           ::Set.new(object)
         end
@@ -41,8 +38,6 @@ module Mongoid
         # @param [ Set ] object The object to mongoize.
         #
         # @return [ Array ] The object mongoized.
-        #
-        # @since 3.0.0
         def mongoize(object)
           object.to_a
         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.
@@ -12,8 +13,6 @@ module Mongoid
       #   "test".__evolve_object_id__
       #
       # @return [ String, BSON::ObjectId ] The evolved string.
-      #
-      # @since 3.0.0
       def __evolve_object_id__
         convert_to_object_id
       end
@@ -24,28 +23,31 @@ module Mongoid
       #   "test".__mongoize_object_id__
       #
       # @return [ String, BSON::ObjectId, nil ] The mongoized string.
-      #
-      # @since 3.0.0
       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
@@ -66,22 +66,21 @@ module Mongoid
       #   "_id".mongoid_id?
       #
       # @return [ true, false ] If the string is id or _id.
-      #
-      # @since 2.3.1
       def mongoid_id?
-        self =~ /\A(|_)id$/
+        self =~ /\A(|_)id\z/
       end
 
-      # Is the string a number?
+      # Is the string a number? The literals "NaN", "Infinity", and "-Infinity"
+      # are counted as numbers.
       #
       # @example Is the string a number.
       #   "1234.23".numeric?
       #
       # @return [ true, false ] If the string is a number.
-      #
-      # @since 3.0.0
       def numeric?
-        true if Float(self) rescue (self == "NaN")
+        !!Float(self)
+      rescue ArgumentError
+        (self =~ /\A(?:NaN|-?Infinity)\z/) == 0
       end
 
       # Get the string as a getter string.
@@ -90,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,22 +99,18 @@ module Mongoid
       #   "model=".writer?
       #
       # @return [ true, false ] If the string contains "=".
-      #
-      # @since 1.0.0
       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
       def valid_method_name?
-        /[@$"]/ !~ self
+        /[@$"-]/ !~ self
       end
 
       # Does the string end with _before_type_cast?
@@ -126,8 +119,6 @@ module Mongoid
       #   "price_before_type_cast".before_type_cast?
       #
       # @return [ true, false ] If the string ends with "_before_type_cast"
-      #
-      # @since 3.1.0
       def before_type_cast?
         ends_with?("_before_type_cast")
       end
@@ -138,8 +129,6 @@ module Mongoid
       #   object.unconvertable_to_bson?
       #
       # @return [ true, false ] If the object is unconvertable.
-      #
-      # @since 2.2.1
       def unconvertable_to_bson?
         @unconvertable_to_bson ||= false
       end
@@ -154,8 +143,6 @@ module Mongoid
       #   string.convert_to_object_id
       #
       # @return [ String, BSON::ObjectId ] The string or the id.
-      #
-      # @since 3.0.0
       def convert_to_object_id
         BSON::ObjectId.legal?(self) ? BSON::ObjectId.from_string(self) : self
       end
@@ -170,8 +157,6 @@ module Mongoid
         # @param [ Object ] object The object to demongoize.
         #
         # @return [ String ] The object.
-        #
-        # @since 3.0.0
         def demongoize(object)
           object.try(:to_s)
         end
@@ -185,8 +170,6 @@ module Mongoid
         # @param [ Object ] object The object to mongoize.
         #
         # @return [ String ] The object mongoized.
-        #
-        # @since 3.0.0
         def mongoize(object)
           demongoize(object)
         end

data/lib/mongoid/extensions/symbol.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Extensions
     module Symbol
@@ -9,8 +10,6 @@ module Mongoid
       #   :_id.mongoid_id?
       #
       # @return [ true, false ] If the symbol is :id or :_id.
-      #
-      # @since 2.3.1
       def mongoid_id?
         to_s.mongoid_id?
       end
@@ -25,8 +24,6 @@ module Mongoid
         # @param [ Object ] object The object to demongoize.
         #
         # @return [ Symbol ] The object.
-        #
-        # @since 3.0.0
         def demongoize(object)
           object.try(:to_sym)
         end
@@ -40,8 +37,6 @@ module Mongoid
         # @param [ Object ] object The object to mongoize.
         #
         # @return [ Symbol ] The object mongoized.
-        #
-        # @since 3.0.0
         def mongoize(object)
           demongoize(object)
         end

data/lib/mongoid/extensions/time.rb

@@ -1,9 +1,23 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Extensions
     module Time
 
+      # Mongoizes a Time into a time.
+      #
+      # Time always mongoize into Time instances
+      # (which are themselves).
+      #
+      # @return [ Time ] self.
+      def __mongoize_time__
+        self
+      end
+
       # Constant for epoch - used when passing invalid times.
+      #
+      # @deprecated No longer used as a return value from #mongoize passed
+      #   an invalid time string.
       EPOCH = ::Time.utc(1970, 1, 1, 0, 0, 0)
 
       # Turn the object from the ruby type we deal with to a Mongo friendly
@@ -13,8 +27,6 @@ module Mongoid
       #   time.mongoize
       #
       # @return [ Time ] The object mongoized.
-      #
-      # @since 3.0.0
       def mongoize
         ::Time.mongoize(self)
       end
@@ -28,8 +40,6 @@ module Mongoid
         #   ::Time.configured
         #
         # @return [ Time ] The configured time.
-        #
-        # @since 3.0.0
         def configured
           Mongoid.use_activesupport_time_zone? ? (::Time.zone || ::Time) : ::Time
         end
@@ -42,8 +52,6 @@ module Mongoid
         # @param [ Time ] object The time from Mongo.
         #
         # @return [ Time ] The object as a date.
-        #
-        # @since 3.0.0
         def demongoize(object)
           return nil if object.blank?
           object = object.getlocal unless Mongoid::Config.use_utc?
@@ -62,8 +70,6 @@ module Mongoid
         # @param [ Object ] object The object to mongoize.
         #
         # @return [ Time ] The object mongoized.
-        #
-        # @since 3.0.0
         def mongoize(object)
           return nil if object.blank?
           begin
@@ -76,7 +82,7 @@ module Mongoid
               ::Time.at(time.to_i, time.usec).utc
             end
           rescue ArgumentError
-            EPOCH
+            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,8 +48,6 @@ 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
@@ -42,8 +62,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