mongoid 5.4.1 → 7.4.0

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,15 +1,22 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 class BSON::ObjectId
-  def as_json(options = nil)
-    { "$oid" => to_s }
-  end
-  def to_xml(options = nil)
-    ActiveSupport::XmlMini.to_tag(options[:root], self.to_s, options)
-  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
@@ -39,11 +46,11 @@ require "mongoid/extensions/module"
 require "mongoid/extensions/nil_class"
 require "mongoid/extensions/object"
 require "mongoid/extensions/object_id"
-require "mongoid/extensions/origin/regexp_raw"
 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" })
     #
@@ -17,9 +26,11 @@ module Mongoid
     #
     # @return [ Document ] The instantiated document.
     def build(klass, attributes = nil)
-      type = (attributes || {})[TYPE]
-      if type && klass._types.include?(type)
-        type.constantize.new(attributes)
+      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
@@ -28,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
 

data/lib/mongoid/fields/standard.rb

@@ -1,13 +1,15 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Fields
     class Standard
+      extend Forwardable
 
-      # Defines the behaviour for defined fields in the document.
+      # Defines the behavior for defined fields in the document.
       # Set readers for the instance variables.
       attr_accessor :default_val, :label, :name, :options
 
-      delegate :demongoize, :evolve, :mongoize, to: :type
+      def_delegators :type, :demongoize, :evolve, :mongoize
 
       # Adds the atomic changes for this type of resizable field.
       #
@@ -20,24 +22,10 @@ module Mongoid
       # @param [ Hash ] mods The current modifications.
       # @param [ Array ] new The new elements to add.
       # @param [ Array ] old The old elements getting removed.
-      #
-      # @since 2.4.0
       def add_atomic_changes(document, name, key, mods, new, old)
         mods[key] = new
       end
 
-      # Get the constraint from the metadata once.
-      #
-      # @example Get the constraint.
-      #   field.constraint
-      #
-      # @return [ Constraint ] The relation's contraint.
-      #
-      # @since 2.1.0
-      def constraint
-        @constraint ||= metadata.constraint
-      end
-
       # Evaluate the default value and return it. Will handle the
       # serialization, proc calls, and duplication if necessary.
       #
@@ -47,8 +35,6 @@ module Mongoid
       # @param [ Document ] doc The document the field belongs to.
       #
       # @return [ Object ] The serialized default value.
-      #
-      # @since 2.1.8
       def eval_default(doc)
         if fields = doc.__selected_fields
           evaluated_default(doc) if included?(fields)
@@ -63,8 +49,6 @@ module Mongoid
       #   field.foreign_key?
       #
       # @return [ true, false ] If the field is a foreign key.
-      #
-      # @since 2.4.0
       def foreign_key?
         false
       end
@@ -79,8 +63,6 @@ module Mongoid
       # @option options [ Class ] :type The class of the field.
       # @option options [ Object ] :default The default value for the field.
       # @option options [ String ] :label The field's label.
-      #
-      # @since 3.0.0
       def initialize(name, options = {})
         @name = name
         @options = options
@@ -101,8 +83,6 @@ module Mongoid
       #   field.lazy?
       #
       # @return [ true, false ] If the field is lazy.
-      #
-      # @since 3.1.0
       def lazy?
         false
       end
@@ -113,8 +93,6 @@ module Mongoid
       #   field.localized?
       #
       # @return [ true, false ] If the field is localized.
-      #
-      # @since 2.3.0
       def localized?
         false
       end
@@ -124,11 +102,9 @@ module Mongoid
       # @example Get the metadata.
       #   field.metadata
       #
-      # @return [ Metadata ] The relation metadata.
-      #
-      # @since 2.2.0
-      def metadata
-        @metadata ||= options[:metadata]
+      # @return [ Metadata ] The association metadata.
+      def association
+        @association ||= options[:association]
       end
 
       # Is the field a BSON::ObjectId?
@@ -137,8 +113,6 @@ 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 ||= (type == BSON::ObjectId)
       end
@@ -149,8 +123,6 @@ module Mongoid
       #   field.pre_processed?
       #
       # @return [ true, false ] If the field's default is pre-processed.
-      #
-      # @since 3.0.0
       def pre_processed?
         @pre_processed ||=
           (options[:pre_processed] || (default_val && !default_val.is_a?(::Proc)))
@@ -162,8 +134,6 @@ module Mongoid
       #   field.type
       #
       # @return [ Class ] The name of the class.
-      #
-      # @since 2.1.0
       def type
         @type ||= options[:type] || Object
       end
@@ -178,8 +148,6 @@ module Mongoid
       #   field.default_name
       #
       # @return [ String ] The method name.
-      #
-      # @since 3.0.0
       def default_name
         @default_name ||= "__#{name}_default__"
       end
@@ -195,8 +163,6 @@ module Mongoid
       #
       # @param [ Class, Module ] object The class or module the field is
       #   defined on.
-      #
-      # @since 3.0.0
       def define_default_method(object)
         object.__send__(:define_method, default_name, default_val)
       end
@@ -212,8 +178,6 @@ module Mongoid
       # @param [ Hash ] fields The field limitations.
       #
       # @return [ true, false ] If the field was included.
-      #
-      # @since 2.4.4
       def included?(fields)
         (fields.values.first == 1 && fields[name.to_s] == 1) ||
           (fields.values.first == 0 && !fields.has_key?(name.to_s))
@@ -227,8 +191,6 @@ module Mongoid
       # @param [ Document ] doc The doc being applied to.
       #
       # @return [ Object ] The default value.
-      #
-      # @since 2.4.4
       def evaluated_default(doc)
         if default_val.respond_to?(:call)
           evaluate_default_proc(doc)
@@ -246,8 +208,6 @@ module Mongoid
       # @param [ Document ] doc The document.
       #
       # @return [ Object ] The called proc.
-      #
-      # @since 3.0.0
       def evaluate_default_proc(doc)
         serialize_default(doc.__send__(default_name))
       end
@@ -263,8 +223,6 @@ module Mongoid
       # @param [ Object ] object The default.
       #
       # @return [ Object ] The serialized default.
-      #
-      # @since 3.0.0
       def serialize_default(object)
         mongoize(object)
       end

data/lib/mongoid/fields/validators/macro.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
   module Fields
     module Validators
@@ -7,6 +8,9 @@ module Mongoid
       module Macro
         extend self
 
+        # The warning message to give when a field is of type Symbol.
+        FIELD_TYPE_IS_SYMBOL = 'The BSON symbol type is deprecated; use String instead'.freeze
+
         OPTIONS = [
           :as,
           :default,
@@ -14,7 +18,7 @@ module Mongoid
           :label,
           :localize,
           :fallbacks,
-          :metadata,
+          :association,
           :pre_processed,
           :subtype,
           :type,
@@ -29,35 +33,62 @@ module Mongoid
         # @param [ Class ] klass The model class.
         # @param [ Symbol ] name The field name.
         # @param [ Hash ] options The provided options.
-        #
-        # @since 3.0.0
         def validate(klass, name, options)
-          validate_name(klass, name, options)
+          validate_field_name(klass, name)
+          validate_name_uniqueness(klass, name, options)
           validate_options(klass, name, options)
         end
 
-        private
-
-        # Determine if the field name is allowed, if not raise an error.
+        # Validate the association definition.
         #
-        # @api private
+        # @example Validate the association definition.
+        #   Macro.validate(Model, :name)
+        #
+        # @param [ Class ] klass The model class.
+        # @param [ Symbol ] name The field name.
+        # @param [ Hash ] options The provided options.
+        def validate_relation(klass, name, options = {})
+          [name, "#{name}?".to_sym, "#{name}=".to_sym].each do |n|
+            if Mongoid.destructive_fields.include?(n)
+              raise Errors::InvalidRelation.new(klass, n)
+            end
+          end
+        end
+
+        # Determine if the field name is valid, if not raise an error.
         #
         # @example Check the field name.
-        #   Macro.validate_name(Model, :name)
+        #   Macro.validate_field_name(Model, :name)
         #
         # @param [ Class ] klass The model class.
         # @param [ Symbol ] name The field name.
         #
         # @raise [ Errors::InvalidField ] If the name is not allowed.
         #
-        # @since 3.0.0
-        def validate_name(klass, name, options)
+        # @api private
+        def validate_field_name(klass, name)
           [name, "#{name}?".to_sym, "#{name}=".to_sym].each do |n|
             if Mongoid.destructive_fields.include?(n)
               raise Errors::InvalidField.new(klass, n)
             end
           end
+        end
+
+        private
 
+        # Determine if the field name is unique, if not raise an error.
+        #
+        # @example Check the field name.
+        #   Macro.validate_name_uniqueness(Model, :name, {})
+        #
+        # @param [ Class ] klass The model class.
+        # @param [ Symbol ] name The field name.
+        # @param [ Hash ] options The provided options.
+        #
+        # @raise [ Errors::InvalidField ] If the name is not allowed.
+        #
+        # @api private
+        def validate_name_uniqueness(klass, name, options)
           if !options[:overwrite] && klass.fields.keys.include?(name.to_s)
             if Mongoid.duplicate_fields_exception
               raise Errors::InvalidField.new(klass, name)
@@ -79,13 +110,18 @@ module Mongoid
         # @param [ Hash ] options The provided options.
         #
         # @raise [ Errors::InvalidFieldOption ] If an option is invalid.
-        #
-        # @since 3.0.0
         def validate_options(klass, name, options)
           options.keys.each do |option|
             if !OPTIONS.include?(option) && !Fields.options.include?(option)
               raise Errors::InvalidFieldOption.new(klass, name, option, OPTIONS)
             end
+
+            if option == :type && options[option] == Symbol
+              @field_type_is_symbol_warned ||= begin
+                Mongoid.logger.warn(FIELD_TYPE_IS_SYMBOL)
+                true
+              end
+            end
           end
         end
       end

data/lib/mongoid/fields/validators.rb

@@ -1,2 +1,3 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 require "mongoid/fields/validators/macro"