mongoid 3.1.5 → 8.0.2

data/lib/mongoid/factory.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module Mongoid
 
   # Instantiates documents that came from the database.
@@ -7,39 +8,126 @@ module Mongoid
 
     # 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 [ Hash ] options The mass assignment scoping options.
+    # @param [ true | false ] execute_callbacks Flag specifies whether callbacks
+    #   should be run.
     #
     # @return [ Document ] The instantiated document.
-    def build(klass, attributes = nil, options = {})
-      type = (attributes || {})["_type"]
-      if type && klass._types.include?(type)
-        type.constantize.new(attributes, options)
+    def build(klass, attributes = nil)
+      execute_build(klass, attributes, execute_callbacks: true)
+    end
+
+    # Execute the build.
+    #
+    # @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.
+    #
+    # @api private
+    def execute_build(klass, attributes = nil, execute_callbacks: true)
+      attributes ||= {}
+      dvalue = attributes[klass.discriminator_key] || attributes[klass.discriminator_key.to_sym]
+      type = klass.get_discriminator_mapping(dvalue)
+      if type
+        type.construct_document(attributes, execute_callbacks: execute_callbacks)
       else
-        klass.new(attributes, options)
+        klass.construct_document(attributes, execute_callbacks: execute_callbacks)
       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.
+    # 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 [ 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, criteria_instance_id = nil)
-      type = (attributes || {})["_type"]
+    def from_db(klass, attributes = nil, criteria = nil, selected_fields = nil)
+      execute_from_db(klass, attributes, criteria, selected_fields, execute_callbacks: true)
+    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: true)
+      if criteria
+        selected_fields ||= criteria.options[:fields]
+      end
+      type = (attributes || {})[klass.discriminator_key]
       if type.blank?
-        klass.instantiate(attributes, criteria_instance_id)
+        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
-        type.camelize.constantize.instantiate(attributes, criteria_instance_id)
+        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_document(attributes, selected_fields, execute_callbacks: execute_callbacks)
       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
@@ -14,10 +15,8 @@ module Mongoid
       # @param [ String ] name The name of the field.
       # @param [ String ] key The atomic location of the field.
       # @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
+      # @param [ Array ] new_elements The new elements to add.
+      # @param [ Array ] old_elements The old elements getting removed.
       def add_atomic_changes(document, name, key, mods, new_elements, old_elements)
         old = (old_elements || [])
         new = (new_elements || [])
@@ -44,9 +43,7 @@ module Mongoid
       # @example Is the field a foreign key?
       #   field.foreign_key?
       #
-      # @return [ true, false ] If the field is a foreign key.
-      #
-      # @since 2.4.0
+      # @return [ true | false ] If the field is a foreign key.
       def foreign_key?
         true
       end
@@ -59,11 +56,15 @@ 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)
-          object.__evolve_object_id__
+          if association.polymorphic?
+            association.convert_to_foreign_key(object)
+          elsif object.is_a?(Document) && object.respond_to?(association.primary_key)
+            primary_key_field.evolve(object.send(association.primary_key))
+          else
+            object.__evolve_object_id__
+          end
         else
           related_id_field.evolve(object)
         end
@@ -74,9 +75,7 @@ module Mongoid
       # @example Is the field lazy?
       #   field.lazy?
       #
-      # @return [ true, false ] If the field is lazy.
-      #
-      # @since 3.1.0
+      # @return [ true | false ] If the field is lazy.
       def lazy?
         type.resizable?
       end
@@ -89,27 +88,23 @@ 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
       end
 
-      # Is the field a Moped::BSON::ObjectId?
+      # Is the field a BSON::ObjectId?
       #
-      # @example Is the field a Moped::BSON::ObjectId?
+      # @example Is the field a BSON::ObjectId?
       #   field.object_id_field?
       #
-      # @return [ true, false ] If the field is a Moped::BSON::ObjectId.
-      #
-      # @since 2.2.0
+      # @return [ true | false ] If the field is a BSON::ObjectId.
       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.
@@ -117,9 +112,7 @@ module Mongoid
       # @example Is the field resizable?
       #   field.resizable?
       #
-      # @return [ true, false ] If the field is resizable.
-      #
-      # @since 3.0.2
+      # @return [ true | false ] If the field is resizable.
       def resizable?
         type.resizable?
       end
@@ -135,13 +128,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
       #
@@ -149,12 +140,15 @@ 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
 
+      def primary_key_field
+        @primary_key_field ||= association.klass.fields[association.primary_key]
+      end
+
+
       # This is used when default values need to be serialized. Most of the
       # time just return the object.
       #
@@ -166,8 +160,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))
@@ -25,9 +24,7 @@ module Mongoid
       # @example Is the field localized?
       #   field.localized?
       #
-      # @return [ true, false ] If the field is localized.
-      #
-      # @since 2.3.0
+      # @return [ true | false ] If the field is localized.
       def localized?
         true
       end
@@ -40,14 +37,25 @@ 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
 
       private
 
+      # Are fallbacks being used for this localized field.
+      #
+      # @api private
+      #
+      # @example Should fallbacks be used.
+      #   field.fallbacks?
+      #
+      # @return [ true | false ] If fallbacks should be used.
+      def fallbacks?
+        return true if options[:fallbacks].nil?
+        !!options[:fallbacks]
+      end
+
       # Lookup the value from the provided object.
       #
       # @api private
@@ -58,14 +66,17 @@ 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
-        if ::I18n.respond_to?(:fallbacks)
-          object[::I18n.fallbacks[locale].map(&:to_s).find{ |loc| object[loc] }]
-        else
+
+        value = if object.key?(locale.to_s)
           object[locale.to_s]
+        elsif object.key?(locale)
+          object[locale]
+        end
+        return value unless value.nil?
+        if fallbacks? && ::I18n.respond_to?(:fallbacks)
+          object[::I18n.fallbacks[locale].map(&:to_s).find{ |loc| object.has_key?(loc) }]
         end
       end
     end

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,10 +35,8 @@ 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 = Threaded.selection(doc.criteria_instance_id)
+        if fields = doc.__selected_fields
           evaluated_default(doc) if included?(fields)
         else
           evaluated_default(doc)
@@ -62,9 +48,7 @@ module Mongoid
       # @example Is the field a foreign key?
       #   field.foreign_key?
       #
-      # @return [ true, false ] If the field is a foreign key.
-      #
-      # @since 2.4.0
+      # @return [ true | false ] If the field is a foreign key.
       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
@@ -100,9 +82,7 @@ module Mongoid
       # @example Is the field lazy?
       #   field.lazy?
       #
-      # @return [ true, false ] If the field is lazy.
-      #
-      # @since 3.1.0
+      # @return [ true | false ] If the field is lazy.
       def lazy?
         false
       end
@@ -112,9 +92,7 @@ module Mongoid
       # @example Is the field localized?
       #   field.localized?
       #
-      # @return [ true, false ] If the field is localized.
-      #
-      # @since 2.3.0
+      # @return [ true | false ] If the field is localized.
       def localized?
         false
       end
@@ -124,23 +102,19 @@ 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 Moped::BSON::ObjectId?
+      # Is the field a BSON::ObjectId?
       #
-      # @example Is the field a Moped::BSON::ObjectId?
+      # @example Is the field a BSON::ObjectId?
       #   field.object_id_field?
       #
-      # @return [ true, false ] If the field is a Moped::BSON::ObjectId.
-      #
-      # @since 2.2.0
+      # @return [ true | false ] If the field is a BSON::ObjectId.
       def object_id_field?
-        @object_id_field ||= (type == Moped::BSON::ObjectId)
+        @object_id_field ||= (type == BSON::ObjectId)
       end
 
       # Does the field pre-process its default value?
@@ -148,9 +122,7 @@ module Mongoid
       # @example Does the field pre-process the default?
       #   field.pre_processed?
       #
-      # @return [ true, false ] If the field's default is pre-processed.
-      #
-      # @since 3.0.0
+      # @return [ true | false ] If the field's default is pre-processed.
       def pre_processed?
         @pre_processed ||=
           (options[:pre_processed] || (default_val && !default_val.is_a?(::Proc)))
@@ -162,24 +134,10 @@ module Mongoid
       #   field.type
       #
       # @return [ Class ] The name of the class.
-      #
-      # @since 2.1.0
       def type
         @type ||= options[:type] || Object
       end
 
-      # Is this field included in versioned attributes?
-      #
-      # @example Is the field versioned?
-      #   field.versioned?
-      #
-      # @return [ true, false ] If the field is included in versioning.
-      #
-      # @since 2.1.0
-      def versioned?
-        @versioned ||= (options[:versioned].nil? ? true : options[:versioned])
-      end
-
       private
 
       # Get the name of the default method for this field.
@@ -190,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
@@ -205,10 +161,8 @@ module Mongoid
       #
       # @note Ruby's instance_exec was just too slow.
       #
-      # @param [ Class, Module ] object The class or module the field is
+      # @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
@@ -223,9 +177,7 @@ module Mongoid
       #
       # @param [ Hash ] fields The field limitations.
       #
-      # @return [ true, false ] If the field was included.
-      #
-      # @since 2.4.4
+      # @return [ true | false ] If the field was included.
       def included?(fields)
         (fields.values.first == 1 && fields[name.to_s] == 1) ||
           (fields.values.first == 0 && !fields.has_key?(name.to_s))
@@ -239,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)
@@ -258,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
@@ -275,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