mongoid 6.4.8 → 7.5.4

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,10 +66,8 @@ 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? The literals "NaN", "Infinity", and "-Infinity"
@@ -79,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
@@ -93,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?
@@ -105,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
@@ -129,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
@@ -141,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
@@ -157,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
@@ -173,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
@@ -188,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,8 +1,19 @@
-# 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
@@ -16,8 +27,6 @@ module Mongoid
       #   time.mongoize
       #
       # @return [ Time ] The object mongoized.
-      #
-      # @since 3.0.0
       def mongoize
         ::Time.mongoize(self)
       end
@@ -31,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
@@ -45,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?
@@ -65,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,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

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
@@ -23,10 +22,8 @@ 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 == ::Boolean || other.class == ::Boolean
+        if other == Mongoid::Boolean || other.class == Mongoid::Boolean
           return true
         end
         super(other)

data/lib/mongoid/extensions.rb

@@ -1,12 +1,22 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 class BSON::ObjectId
-  def as_json(options = nil)
-    { "$oid" => to_s }
-  end
-end
+  alias :bson_ruby_as_json :as_json
 
-class Symbol
-  remove_method :size if instance_methods.include? :size # temporal fix for ruby 1.9
+  # 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
 
 class BSON::Document
@@ -40,6 +50,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,14 +1,23 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
 
   # Instantiates documents that came from the database.
   module Factory
     extend self
 
+    # @deprecated
     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" })
     #
@@ -18,9 +27,10 @@ module Mongoid
     # @return [ Document ] The instantiated document.
     def build(klass, attributes = nil)
       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.new(attributes)
       else
         klass.new(attributes)
       end
@@ -29,21 +39,60 @@ module Mongoid
     # 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.
+    # 2. If the criteria has a referencing association (i.e., this document
+    #    is being instantiated as an association of another document),
+    #    the other document is also populated in the returned document's
+    #    reverse association, if one exists.
+    #
     # @example Build the document.
     #   Mongoid::Factory.from_db(Person, { "name" => "Durran" })
     #
     # @param [ Class ] klass The class to instantiate from if _type is not present.
     # @param [ Hash ] attributes The document attributes.
-    # @param [ Array ] selected_fields If instantiated from a criteria using
-    #   #only we give the document a list of the selected fields.
+    # @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.
     #
     # @return [ Document ] The instantiated document.
-    def from_db(klass, attributes = nil, selected_fields = nil)
-      type = (attributes || {})[TYPE]
+    def from_db(klass, attributes = nil, criteria = nil, selected_fields = nil)
+      if criteria
+        selected_fields ||= criteria.options[:fields]
+      end
+      type = (attributes || {})[klass.discriminator_key]
       if type.blank?
-        klass.instantiate(attributes, selected_fields)
+        obj = klass.instantiate(attributes, selected_fields)
+        if criteria && criteria.association && criteria.parent_document
+          obj.set_relation(criteria.association.inverse, criteria.parent_document)
+        end
+        obj
       else
-        type.camelize.constantize.instantiate(attributes, selected_fields)
+        constantized = klass.get_discriminator_mapping(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
+        if !constantized.respond_to?(:instantiate)
+          raise Errors::UnknownModel.new(camelized, type)
+        end
+
+        constantized.instantiate(attributes, selected_fields)
       end
     end
   end

data/lib/mongoid/fields/foreign_key.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Fields
     class ForeignKey < Standard
@@ -16,8 +17,6 @@ module Mongoid
       # @param [ Hash ] mods The current modifications.
       # @param [ Array ] new_elements The new elements to add.
       # @param [ Array ] old_elements The old elements getting removed.
-      #
-      # @since 2.4.0
       def add_atomic_changes(document, name, key, mods, new_elements, old_elements)
         old = (old_elements || [])
         new = (new_elements || [])
@@ -45,8 +44,6 @@ module Mongoid
       #   field.foreign_key?
       #
       # @return [ true, false ] If the field is a foreign key.
-      #
-      # @since 2.4.0
       def foreign_key?
         true
       end
@@ -59,12 +56,10 @@ module Mongoid
       # @param [ Object ] object The object to evolve.
       #
       # @return [ Object ] The evolved object.
-      #
-      # @since 3.0.0
       def evolve(object)
         if object_id_field? || object.is_a?(Document)
-          if metadata.polymorphic? && constraint
-            constraint.convert(object)
+          if association.polymorphic?
+            association.convert_to_foreign_key(object)
           else
             object.__evolve_object_id__
           end
@@ -79,8 +74,6 @@ module Mongoid
       #   field.lazy?
       #
       # @return [ true, false ] If the field is lazy.
-      #
-      # @since 3.1.0
       def lazy?
         type.resizable?
       end
@@ -93,11 +86,9 @@ module Mongoid
       # @param [ Object ] object The object to Mongoize.
       #
       # @return [ Object ] The mongoized object.
-      #
-      # @since 3.0.0
       def mongoize(object)
         if type.resizable? || object_id_field?
-          type.__mongoize_fk__(constraint, object)
+          type.__mongoize_fk__(association, object)
         else
           related_id_field.mongoize(object)
         end
@@ -109,11 +100,9 @@ module Mongoid
       #   field.object_id_field?
       #
       # @return [ true, false ] If the field is a BSON::ObjectId.
-      #
-      # @since 2.2.0
       def object_id_field?
         @object_id_field ||=
-          metadata.polymorphic? ? true : metadata.klass.using_object_ids?
+            association.polymorphic? ? true : association.klass.using_object_ids?
       end
 
       # Returns true if an array, false if not.
@@ -122,8 +111,6 @@ module Mongoid
       #   field.resizable?
       #
       # @return [ true, false ] If the field is resizable.
-      #
-      # @since 3.0.2
       def resizable?
         type.resizable?
       end
@@ -139,13 +126,11 @@ module Mongoid
       # @param [ Document ] doc The document.
       #
       # @return [ Object ] The called proc.
-      #
-      # @since 3.0.0
       def evaluate_default_proc(doc)
         serialize_default(default_val[])
       end
 
-      # Get the id field of the relation.
+      # Get the id field of the association.
       #
       # @api private
       #
@@ -153,10 +138,8 @@ module Mongoid
       #   field.related_id_field
       #
       # @return [ Fields::Standard ] The field.
-      #
-      # @since 3.0.0
       def related_id_field
-        @related_id_field ||= metadata.klass.fields["_id"]
+        @related_id_field ||= association.klass.fields["_id"]
       end
 
       # This is used when default values need to be serialized. Most of the
@@ -170,8 +153,6 @@ module Mongoid
       # @param [ Object ] object The default.
       #
       # @return [ Object ] The serialized default.
-      #
-      # @since 3.0.0
       def serialize_default(object); object; end
     end
   end

data/lib/mongoid/fields/localized.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Fields
     class Localized < Standard
@@ -12,8 +13,6 @@ module Mongoid
       # @param [ Hash ] object The hash of translations.
       #
       # @return [ Object ] The value for the current locale.
-      #
-      # @since 2.3.0
       def demongoize(object)
         if object
           type.demongoize(lookup(object))
@@ -26,8 +25,6 @@ module Mongoid
       #   field.localized?
       #
       # @return [ true, false ] If the field is localized.
-      #
-      # @since 2.3.0
       def localized?
         true
       end
@@ -40,8 +37,6 @@ module Mongoid
       # @param [ String ] object The string to convert.
       #
       # @return [ Hash ] The locale with string translation.
-      #
-      # @since 2.3.0
       def mongoize(object)
         { ::I18n.locale.to_s => type.mongoize(object) }
       end
@@ -56,8 +51,6 @@ module Mongoid
       #   field.fallbacks?
       #
       # @return [ true, false ] If fallbacks should be used.
-      #
-      # @since 5.1.0
       def fallbacks?
         return true if options[:fallbacks].nil?
         !!options[:fallbacks]
@@ -73,8 +66,6 @@ module Mongoid
       # @param [ Hash ] object The localized object.
       #
       # @return [ Object ] The object for the locale.
-      #
-      # @since 3.0.0
       def lookup(object)
         locale = ::I18n.locale