mongoid 7.1.1 → 8.1.0

data/lib/mongoid/extensions/string.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Extensions
@@ -13,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
@@ -25,9 +22,7 @@ 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
@@ -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
@@ -74,9 +65,7 @@ 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\z/
       end
@@ -87,9 +76,7 @@ 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?
         !!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
@@ -113,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
@@ -137,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
@@ -149,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
@@ -165,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.
         #
@@ -197,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,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Extensions
@@ -10,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.
         #
@@ -41,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,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Extensions
@@ -11,27 +10,17 @@ module Mongoid
       # (which are themselves).
       #
       # @return [ Time ] self.
-      #
-      # @since 3.0.0
       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
       # type.
       #
       # @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
@@ -46,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
@@ -58,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
@@ -78,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)
@@ -92,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,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,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
@@ -56,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,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
@@ -24,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.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
 
@@ -22,6 +34,7 @@ end
 
 require "mongoid/extensions/array"
 require "mongoid/extensions/big_decimal"
+require "mongoid/extensions/binary"
 require "mongoid/extensions/boolean"
 require "mongoid/extensions/date"
 require "mongoid/extensions/date_time"
@@ -38,6 +51,7 @@ require "mongoid/extensions/range"
 require "mongoid/extensions/regexp"
 require "mongoid/extensions/set"
 require "mongoid/extensions/string"
+require "mongoid/stringified_symbol"
 require "mongoid/extensions/symbol"
 require "mongoid/extensions/time"
 require "mongoid/extensions/time_with_zone"

data/lib/mongoid/factory.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
 
@@ -7,30 +6,69 @@ module Mongoid
   module Factory
     extend self
 
-    TYPE = "_type".freeze
-
     # Builds a new +Document+ from the supplied attributes.
     #
+    # 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
+    # discriminator value does not correspond to a descendant of klass then this method
+    # would create an instance of klass.
+    #
     # @example Build the document.
     #   Mongoid::Factory.build(Person, { "name" => "Durran" })
     #
     # @param [ Class ] klass The class to instantiate from if _type is not present.
     # @param [ Hash ] attributes The document attributes.
+    # @param [ true | false ] execute_callbacks Flag specifies whether callbacks
+    #   should be run.
     #
     # @return [ Document ] The instantiated document.
     def build(klass, attributes = nil)
+      # A bug in Ruby 2.x (including 2.7.7) causes the attributes hash to be
+      # interpreted as keyword arguments, because execute_build accepts
+      # a keyword argument. Forcing an empty set of keyword arguments works
+      # around the bug. Once Ruby 2.x support is dropped, this hack can be
+      # removed.
+      # See https://bugs.ruby-lang.org/issues/15753
+      execute_build(klass, attributes)
+    end
+
+    # Execute the build.
+    #
+    # @param [ Class ] klass The class to instantiate from if _type is not present.
+    # @param [ Hash ] attributes The document attributes.
+    # @param [ Hash ] options The options to use.
+    #
+    # @option options [ true | false ] :execute_callbacks Flag specifies
+    #   whether callbacks should be run.
+    #
+    # @note A Ruby 2.x bug prevents the options hash from being keyword
+    #   arguments. Once we drop support for Ruby 2.x, we can reimplement
+    #   the options hash as keyword arguments.
+    #   See https://bugs.ruby-lang.org/issues/15753
+    #
+    # @return [ Document ] The instantiated document.
+    #
+    # @api private
+    def execute_build(klass, attributes = nil, options = {})
       attributes ||= {}
-      type = attributes[TYPE] || attributes[TYPE.to_sym]
-      if type && klass._types.include?(type)
-        type.constantize.new(attributes)
+      dvalue = attributes[klass.discriminator_key] || attributes[klass.discriminator_key.to_sym]
+      type = klass.get_discriminator_mapping(dvalue)
+      if type
+        type.construct_document(attributes, options)
       else
-        klass.new(attributes)
+        klass.construct_document(attributes, options)
       end
     end
 
     # Builds a new +Document+ from the supplied attributes loaded from the
     # database.
     #
+    # If the attributes contain the discriminator key (which is _type by default) and the
+    # discriminator value does not correspond to a descendant of klass then this method
+    # raises an UnknownModel error.
+    #
     # If a criteria object is given, it is used in two ways:
     # 1. If the criteria has a list of fields specified via #only,
     #    only those fields are populated in the returned document.
@@ -51,24 +89,50 @@ module Mongoid
     #
     # @return [ Document ] The instantiated document.
     def from_db(klass, attributes = nil, criteria = nil, selected_fields = nil)
+      execute_from_db(klass, attributes, criteria, selected_fields)
+    end
+
+    # Execute from_db.
+    #
+    # @param [ Class ] klass The class to instantiate from if _type is not present.
+    # @param [ Hash ] attributes The document attributes.
+    # @param [ Criteria ] criteria Optional criteria object.
+    # @param [ Hash ] selected_fields Fields which were retrieved via
+    #   #only. If selected_fields are specified, fields not listed in it
+    #   will not be accessible in the returned document.
+    # @param [ true | false ] execute_callbacks Whether this method should
+    #   invoke the callbacks. If true, the callbacks will be invoked normally.
+    #   If false, the callbacks will be stored in the +pending_callbacks+ list
+    #   and caller is responsible for invoking +run_pending_callbacks+ at a
+    #   later time. Use this option to defer callback execution until the
+    #   entire object graph containing embedded associations is constructed.
+    #
+    # @return [ Document ] The instantiated document.
+    #
+    # @api private
+    def execute_from_db(klass, attributes = nil, criteria = nil, selected_fields = nil, execute_callbacks: Threaded.execute_callbacks?)
       if criteria
         selected_fields ||= criteria.options[:fields]
       end
-      type = (attributes || {})[TYPE]
+      type = (attributes || {})[klass.discriminator_key]
       if type.blank?
-        obj = klass.instantiate(attributes, selected_fields)
+        obj = klass.instantiate_document(attributes, selected_fields, execute_callbacks: execute_callbacks)
         if criteria && criteria.association && criteria.parent_document
           obj.set_relation(criteria.association.inverse, criteria.parent_document)
         end
         obj
       else
-        camelized = type.camelize
+        constantized = klass.get_discriminator_mapping(type)
 
-        # Check if the class exists
-        begin
-          constantized = camelized.constantize
-        rescue NameError
-          raise Errors::UnknownModel.new(camelized, type)
+        unless constantized
+          camelized = type.camelize
+
+          # Check if the class exists
+          begin
+            constantized = camelized.constantize
+          rescue NameError
+            raise Errors::UnknownModel.new(camelized, type)
+          end
         end
 
         # Check if the class is a Document class
@@ -76,7 +140,7 @@ module Mongoid
           raise Errors::UnknownModel.new(camelized, type)
         end
 
-        constantized.instantiate(attributes, selected_fields)
+        constantized.instantiate_document(attributes, selected_fields, execute_callbacks: execute_callbacks)
       end
     end
   end