mongoid 6.4.4 → 7.1.7

data/lib/mongoid/factory.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
 
   # Instantiates documents that came from the database.
@@ -29,21 +31,52 @@ module Mongoid
     # Builds a new +Document+ from the supplied attributes loaded from the
     # database.
     #
+    # 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)
+    def from_db(klass, attributes = nil, criteria = nil, selected_fields = nil)
+      if criteria
+        selected_fields ||= criteria.options[:fields]
+      end
       type = (attributes || {})[TYPE]
       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)
+        camelized = type.camelize
+
+        # Check if the class exists
+        begin
+          constantized = camelized.constantize
+        rescue NameError
+          raise Errors::UnknownModel.new(camelized, type)
+        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,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Fields
     class ForeignKey < Standard
@@ -63,8 +65,8 @@ module Mongoid
       # @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
@@ -97,7 +99,7 @@ module Mongoid
       # @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
@@ -113,7 +115,7 @@ module Mongoid
       # @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.
@@ -145,7 +147,7 @@ module Mongoid
         serialize_default(default_val[])
       end
 
-      # Get the id field of the relation.
+      # Get the id field of the association.
       #
       # @api private
       #
@@ -156,7 +158,7 @@ module Mongoid
       #
       # @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

data/lib/mongoid/fields/localized.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Fields
     class Localized < Standard

data/lib/mongoid/fields/standard.rb

@@ -1,13 +1,16 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 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.
       #
@@ -26,18 +29,6 @@ module Mongoid
         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.
       #
@@ -124,11 +115,11 @@ module Mongoid
       # @example Get the metadata.
       #   field.metadata
       #
-      # @return [ Metadata ] The relation metadata.
+      # @return [ Metadata ] The association metadata.
       #
       # @since 2.2.0
-      def metadata
-        @metadata ||= options[:metadata]
+      def association
+        @association ||= options[:association]
       end
 
       # Is the field a BSON::ObjectId?

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

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Fields
     module Validators
@@ -7,6 +9,11 @@ module Mongoid
       module Macro
         extend self
 
+        # The warning message to give when a field is of type Symbol.
+        #
+        # @since 7.0.0
+        FIELD_TYPE_IS_SYMBOL = 'The BSON symbol type is deprecated; use String instead'.freeze
+
         OPTIONS = [
           :as,
           :default,
@@ -14,7 +21,7 @@ module Mongoid
           :label,
           :localize,
           :fallbacks,
-          :metadata,
+          :association,
           :pre_processed,
           :subtype,
           :type,
@@ -36,9 +43,9 @@ module Mongoid
           validate_options(klass, name, options)
         end
 
-        # Validate the relation definition.
+        # Validate the association definition.
         #
-        # @example Validate the relation definition.
+        # @example Validate the association definition.
         #   Macro.validate(Model, :name)
         #
         # @param [ Class ] klass The model class.
@@ -104,6 +111,13 @@ module Mongoid
             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,4 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 require "mongoid/fields/validators/macro"

data/lib/mongoid/fields.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 require "mongoid/fields/standard"
 require "mongoid/fields/foreign_key"
 require "mongoid/fields/localized"
@@ -6,7 +8,7 @@ require "mongoid/fields/validators"
 
 module Mongoid
 
-  # This module defines behaviour for fields.
+  # This module defines behavior for fields.
   module Fields
     extend ActiveSupport::Concern
 
@@ -411,7 +413,7 @@ module Mongoid
       def create_field_getter(name, meth, field)
         generated_methods.module_eval do
           re_define_method(meth) do
-            raw = read_attribute(name)
+            raw = read_raw_attribute(name)
             if lazy_settable?(field, raw)
               write_attribute(name, field.eval_default(self))
             else
@@ -461,7 +463,7 @@ module Mongoid
           re_define_method("#{meth}=") do |value|
             val = write_attribute(name, value)
             if field.foreign_key?
-              remove_ivar(field.metadata.name)
+              remove_ivar(field.association.name)
             end
             val
           end
@@ -480,7 +482,7 @@ module Mongoid
       def create_field_check(name, meth)
         generated_methods.module_eval do
           re_define_method("#{meth}?") do
-            value = read_attribute(name)
+            value = read_raw_attribute(name)
             lookup_attribute_presence(name, value)
           end
         end
@@ -498,7 +500,8 @@ module Mongoid
       def create_translations_getter(name, meth)
         generated_methods.module_eval do
           re_define_method("#{meth}_translations") do
-            (attributes[name] ||= {}).with_indifferent_access
+            attributes[name] ||= {}
+            attributes[name].with_indifferent_access
           end
           alias_method :"#{meth}_t", :"#{meth}_translations"
         end

data/lib/mongoid/findable.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
 
   # This module defines the finder methods that hang off the document at the
@@ -6,13 +8,16 @@ module Mongoid
   #
   # @since 4.0.0
   module Findable
-    extend Mongoid::Criteria::Queryable::Forwardable
+    extend Forwardable
 
-    select_with :with_default_scope
+    def_delegators :with_default_scope, *(
+      Criteria::Queryable::Selectable.forwardables +
+      Criteria::Queryable::Optional.forwardables
+    )
 
     # These are methods defined on the criteria that should also be accessible
     # directly from the class level.
-    delegate \
+    def_delegators :with_default_scope,
       :aggregates,
       :avg,
       :create_with,
@@ -41,7 +46,7 @@ module Mongoid
       :sum,
       :text_search,
       :update,
-      :update_all, to: :with_default_scope
+      :update_all
 
     # Returns a count of records in the database.
     # If you want to specify conditions use where.

data/lib/mongoid/indexable/specification.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Indexable
 
-    # Encapsulates behaviour around an index specification.
+    # Encapsulates behavior around an index specification.
     #
     # @since 4.0.0
     class Specification

data/lib/mongoid/indexable/validators/options.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Indexable
     module Validators

data/lib/mongoid/indexable.rb

@@ -1,11 +1,13 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 require "mongoid/indexable/specification"
 require "mongoid/indexable/validators/options"
 require "ostruct"
 
 module Mongoid
 
-  # Encapsulates behaviour around defining indexes.
+  # Encapsulates behavior around defining indexes.
   #
   # @since 4.0.0
   module Indexable
@@ -28,8 +30,11 @@ module Mongoid
       # @since 1.0.0
       def create_indexes
         return unless index_specifications
+
+        default_options = {background: Config.background_indexing}
+
         index_specifications.each do |spec|
-          key, options = spec.key, spec.options
+          key, options = spec.key, default_options.merge(spec.options)
           if database = options[:database]
             with(database: database) do |klass|
               klass.collection.indexes(session: _session).create_one(key, options.except(:database))

data/lib/mongoid/inspectable.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
 
-  # Contains the bahviour around inspecting documents via inspect.
+  # Contains the bahvior around inspecting documents via inspect.
   #
   # @since 4.0.0
   module Inspectable

data/lib/mongoid/interceptable.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
 
   # This module contains all the callback hooks for Mongoid.
@@ -72,7 +74,7 @@ module Mongoid
 
     # Run only the after callbacks for the specific event.
     #
-    # @note ActiveSupport does not allow this type of behaviour by default, so
+    # @note ActiveSupport does not allow this type of behavior by default, so
     #   Mongoid has to get around it and implement itself.
     #
     # @example Run only the after save callbacks.
@@ -91,7 +93,7 @@ module Mongoid
 
     # Run only the before callbacks for the specific event.
     #
-    # @note ActiveSupport does not allow this type of behaviour by default, so
+    # @note ActiveSupport does not allow this type of behavior by default, so
     #   Mongoid has to get around it and implement itself.
     #
     # @example Run only the before save callbacks.
@@ -129,7 +131,11 @@ module Mongoid
           return false
         end
       end
-      callback_executable?(kind) ? super(kind, *args, &block) : true
+      if callback_executable?(kind)
+        super(kind, *args, &block)
+      else
+        true
+      end
     end
 
     private
@@ -160,8 +166,8 @@ module Mongoid
     #
     # @since 2.3.0
     def cascadable_children(kind, children = Set.new)
-      embedded_relations.each_pair do |name, metadata|
-        next unless metadata.cascading_callbacks?
+      embedded_relations.each_pair do |name, association|
+        next unless association.cascading_callbacks?
         without_autobuild do
           delayed_pulls = delayed_atomic_pulls[name]
           delayed_unsets = delayed_atomic_unsets[name]
@@ -170,7 +176,7 @@ module Mongoid
           relation = send(name)
           Array.wrap(relation).each do |child|
             next if children.include?(child)
-            children.add(child) if cascadable_child?(kind, child, metadata)
+            children.add(child) if cascadable_child?(kind, child, association)
             child.send(:cascadable_children, kind, children)
           end
         end
@@ -189,9 +195,9 @@ module Mongoid
     # @return [ true, false ] If the child should fire the callback.
     #
     # @since 2.3.0
-    def cascadable_child?(kind, child, metadata)
+    def cascadable_child?(kind, child, association)
       return false if kind == :initialize || kind == :find || kind == :touch
-      return false if kind == :validate && metadata.validate?
+      return false if kind == :validate && association.validate?
       child.callback_executable?(kind) ? child.in_callback_state?(kind) : false
     end
 
@@ -228,9 +234,11 @@ module Mongoid
     #   document.halted_callback_hook(filter)
     #
     # @param [ Symbol ] filter The callback that halted.
+    # @param [ Symbol ] name The name of the callback that was halted
+    #   (requires Rails 6.1+)
     #
     # @since 3.0.3
-    def halted_callback_hook(filter)
+    def halted_callback_hook(filter, name = nil)
       @before_callback_halted = true
     end