mongoid 7.3.2 → 7.4.0

data/lib/mongoid/extensions/object.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Extensions
@@ -11,8 +10,6 @@ module Mongoid
       #   object.__evolve_object_id__
       #
       # @return [ Object ] self.
-      #
-      # @since 3.0.0
       def __evolve_object_id__
         self
       end
@@ -24,8 +21,6 @@ module Mongoid
       #   object.__find_args__
       #
       # @return [ Object ] self.
-      #
-      # @since 3.0.0
       def __find_args__
         self
       end
@@ -41,8 +36,6 @@ module Mongoid
       #   object.__mongoize_time__
       #
       # @return [ Object ] self.
-      #
-      # @since 3.0.0
       # @deprecated
       def __mongoize_time__
         self
@@ -54,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
@@ -78,8 +67,6 @@ module Mongoid
       #   1.__to_inc__
       #
       # @return [ Object ] The object.
-      #
-      # @since 3.0.3
       def __to_inc__
         self
       end
@@ -93,8 +80,6 @@ module Mongoid
       # for backwards compatibility only. It always returns false.
       #
       # @return [ false ] Always false.
-      #
-      # @since 3.1.0
       # @deprecated
       def blank_criteria?
         false
@@ -110,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
@@ -124,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)
@@ -142,8 +123,6 @@ module Mongoid
       #   object.mongoize
       #
       # @return [ Object ] The object.
-      #
-      # @since 3.0.0
       def mongoize
         self
       end
@@ -154,8 +133,6 @@ module Mongoid
       #   object.multi_arged?
       #
       # @return [ false ] false.
-      #
-      # @since 3.0.0
       def multi_arged?
         false
       end
@@ -166,8 +143,6 @@ module Mongoid
       #   object.numeric?
       #
       # @return [ false ] Always false.
-      #
-      # @since 3.0.0
       def numeric?
         false
       end
@@ -180,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}")
@@ -197,8 +170,6 @@ module Mongoid
       #   object.resizable?
       #
       # @return [ false ] false.
-      #
-      # @since 3.0.0
       def resizable?
         false
       end
@@ -209,8 +180,6 @@ module Mongoid
       #   object.substitutable
       #
       # @return [ Object ] self.
-      #
-      # @since 2.0.0
       def substitutable
         self
       end
@@ -225,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
@@ -243,8 +210,6 @@ module Mongoid
         # @param [ Object ] object The object to convert.
         #
         # @return [ Object ] The converted object.
-        #
-        # @since 3.0.0
         def __mongoize_fk__(association, object)
           return nil if !object || object == ""
           association.convert_to_foreign_key(object)
@@ -258,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
@@ -273,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,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Extensions
@@ -11,8 +10,6 @@ module Mongoid
       #   object_id.__evolve_object_id__
       #
       # @return [ BSON::ObjectId ] self.
-      #
-      # @since 3.0.0
       def __evolve_object_id__
         self
       end
@@ -28,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
@@ -42,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,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Extensions
@@ -11,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
@@ -24,8 +21,6 @@ module Mongoid
       #   range.mongoize
       #
       # @return [ Hash ] The object mongoized.
-      #
-      # @since 3.0.0
       def mongoize
         ::Range.mongoize(self)
       end
@@ -36,8 +31,6 @@ module Mongoid
       #   range.resizable?
       #
       # @return [ true ] True.
-      #
-      # @since 3.0.0
       def resizable?
         true
       end
@@ -52,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
@@ -67,8 +58,6 @@ 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)

data/lib/mongoid/extensions/regexp.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Extensions
@@ -16,8 +15,6 @@ module Mongoid
         # @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)

data/lib/mongoid/extensions/set.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Extensions
@@ -12,8 +11,6 @@ module Mongoid
       #   set.mongoize
       #
       # @return [ Array ] The object mongoized.
-      #
-      # @since 3.0.0
       def mongoize
         ::Set.mongoize(self)
       end
@@ -28,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
@@ -43,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,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Extensions
@@ -14,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
@@ -26,8 +23,6 @@ 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
@@ -42,8 +37,6 @@ module Mongoid
       #
       # @return [ Time | ActiveSupport::TimeWithZone ] Local time in the
       #   configured default time zone corresponding to this string.
-      #
-      # @since 3.0.0
       def __mongoize_time__
         # This extra parse from Time is because ActiveSupport::TimeZone
         # either returns nil or Time.now if the string is empty or invalid,
@@ -63,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
@@ -75,8 +66,6 @@ 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\z/
       end
@@ -88,8 +77,6 @@ module Mongoid
       #   "1234.23".numeric?
       #
       # @return [ true, false ] If the string is a number.
-      #
-      # @since 3.0.0
       def numeric?
         !!Float(self)
       rescue ArgumentError
@@ -102,8 +89,6 @@ module Mongoid
       #   "model=".reader
       #
       # @return [ String ] The string stripped of "=".
-      #
-      # @since 1.0.0
       def reader
         delete("=").sub(/\_before\_type\_cast\z/, '')
       end
@@ -114,20 +99,16 @@ 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
       end
@@ -138,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
@@ -150,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
@@ -166,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
@@ -182,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
@@ -197,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,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Extensions
@@ -11,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
@@ -27,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
@@ -42,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,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Extensions
@@ -11,8 +10,6 @@ module Mongoid
       # (which are themselves).
       #
       # @return [ Time ] self.
-      #
-      # @since 3.0.0
       def __mongoize_time__
         self
       end
@@ -30,8 +27,6 @@ module Mongoid
       #   time.mongoize
       #
       # @return [ Time ] The object mongoized.
-      #
-      # @since 3.0.0
       def mongoize
         ::Time.mongoize(self)
       end
@@ -45,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
@@ -59,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?
@@ -79,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

data/lib/mongoid/extensions/time_with_zone.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Extensions
@@ -11,8 +10,6 @@ module Mongoid
       # (which are themselves).
       #
       # @return [ ActiveSupport::TimeWithZone ] self.
-      #
-      # @since 3.0.0
       def __mongoize_time__
         self
       end
@@ -24,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.
@@ -40,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
@@ -56,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

data/lib/mongoid/extensions/true_class.rb

@@ -1,18 +1,15 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 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
@@ -25,8 +22,6 @@ module Mongoid
       # @param [ Class ] other The class to check.
       #
       # @return [ true, false ] If the other is a boolean.
-      #
-      # @since 1.0.0
       def is_a?(other)
         if other == Mongoid::Boolean || other.class == Mongoid::Boolean
           return true

data/lib/mongoid/extensions.rb

@@ -1,9 +1,21 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 class BSON::ObjectId
-  def as_json(options = nil)
-    { "$oid" => to_s }
+  alias :bson_ruby_as_json :as_json
+
+  # Return a string representation of the object id for use in
+  # application-level JSON serialization.
+  #
+  # @example Get the object id as a JSON-serializable object.
+  #   object_id.as_json
+  #
+  # @return [ String ] The object id as a string.
+  def as_json(*args)
+    if Mongoid.object_id_as_json_oid
+      { "$oid" => to_s }
+    else
+      bson_ruby_as_json(*args)
+    end
   end
 end
 

data/lib/mongoid/factory.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
 
@@ -12,7 +11,7 @@ module Mongoid
 
     # Builds a new +Document+ from the supplied attributes.
     #
-    # This method either instantiats klass or a descendant of klass if the attributes include
+    # This method either instantiates klass or a descendant of klass if the attributes include
     # klass' discriminator key.
     #
     # If the attributes contain the discriminator key (which is _type by default) and the