mongoid 7.0.13 → 7.1.0.rc0

data/lib/mongoid/extensions/time.rb

@@ -1,8 +1,22 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Extensions
     module Time
 
+      # Mongoizes a Time into a time.
+      #
+      # Time always mongoize into Time instances
+      # (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

data/lib/mongoid/extensions/time_with_zone.rb

@@ -1,8 +1,22 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 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.
+      #
+      # @since 3.0.0
+      def __mongoize_time__
+        self
+      end
+
       # Turn the object from the ruby type we deal with to a Mongo friendly
       # type.
       #

data/lib/mongoid/extensions/true_class.rb

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

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,17 +31,29 @@ 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, criteria = nil)
-      selected_fields = criteria.options[:fields] if criteria
+    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?
         obj = klass.instantiate(attributes, selected_fields)
@@ -49,11 +63,20 @@ module Mongoid
         obj
       else
         camelized = type.camelize
+
+        # Check if the class exists
         begin
-          camelized.constantize.instantiate(attributes, selected_fields)
+          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.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
 
@@ -498,8 +500,7 @@ module Mongoid
       def create_translations_getter(name, meth)
         generated_methods.module_eval do
           re_define_method("#{meth}_translations") do
-            attributes[name] ||= {}
-            attributes[name].with_indifferent_access
+            (attributes[name] ||= {}).with_indifferent_access
           end
           alias_method :"#{meth}_t", :"#{meth}_translations"
         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
@@ -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
       #

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,9 +1,11 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
   module Fields
     class Standard
 
-      # 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
 
@@ -112,7 +114,7 @@ module Mongoid
       # @example Get the metadata.
       #   field.metadata
       #
-      # @return [ Metadata ] The relation metadata.
+      # @return [ Metadata ] The association metadata.
       #
       # @since 2.2.0
       def association

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/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,
@@ -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,10 @@ 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
+              Mongoid.logger.warn(FIELD_TYPE_IS_SYMBOL)
+            end
           end
         end
       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,9 +8,11 @@ module Mongoid
   #
   # @since 4.0.0
   module Findable
-    extend Mongoid::Criteria::Queryable::Forwardable
 
-    select_with :with_default_scope
+    delegate *(
+      Criteria::Queryable::Selectable.forwardables +
+      Criteria::Queryable::Optional.forwardables
+    ), to: :with_default_scope
 
     # These are methods defined on the criteria that should also be accessible
     # directly from the class level.

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

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/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.
@@ -228,11 +230,9 @@ 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, name = nil)
+    def halted_callback_hook(filter)
       @before_callback_halted = true
     end
 

data/lib/mongoid/loggable.rb

@@ -1,13 +1,15 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Mongoid
 
-  # Contains logging behaviour.
+  # Contains logging behavior.
   module Loggable
 
     # Get the logger.
     #
     # @note Will try to grab Rails' logger first before creating a new logger
-    #   with stdout.
+    #   with stderr.
     #
     # @example Get the logger.
     #   Loggable.logger
@@ -23,7 +25,7 @@ module Mongoid
     # Set the logger.
     #
     # @example Set the logger.
-    #   Loggable.logger = Logger.new($stdout)
+    #   Loggable.logger = Logger.new(STDERR)
     #
     # @param [ Logger ] logger The logger to set.
     #
@@ -36,7 +38,7 @@ module Mongoid
 
     private
 
-    # Gets the default Mongoid logger - stdout.
+    # Gets the default Mongoid logger - stderr.
     #
     # @api private
     #
@@ -47,12 +49,12 @@ module Mongoid
     #
     # @since 3.0.0
     def default_logger
-      logger = Logger.new($stdout)
+      logger = Logger.new(STDERR)
       logger.level = Mongoid::Config.log_level
       logger
     end
 
-    # Get the Rails logger if it's defined.
+    # Get the Rails logger if loaded in a Rails application, otherwise nil.
     #
     # @api private
     #
@@ -63,7 +65,11 @@ module Mongoid
     #
     # @since 3.0.0
     def rails_logger
-      defined?(::Rails) && ::Rails.respond_to?(:logger) && ::Rails.logger
+      if defined?(::Rails)
+        ::Rails.logger
+      else
+        nil
+      end
     end
   end
 end

data/lib/mongoid/matchable.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 require "mongoid/matchable/default"
 require "mongoid/matchable/all"
 require "mongoid/matchable/and"

data/lib/mongoid/matchable/all.rb

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

data/lib/mongoid/matchable/and.rb

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

data/lib/mongoid/matchable/default.rb

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

data/lib/mongoid/matchable/elem_match.rb

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