mongoid 8.0.8 → 8.1.0

data/lib/mongoid/errors/immutable_attribute.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Mongoid
+  module Errors
+
+    # This error is raised when attempting the change the value of an
+    # immutable attribute. For example, the _id attribute is immutable,
+    # and attempting to change it on a document that has already been
+    # persisted will result in this error.
+    class ImmutableAttribute < MongoidError
+
+      # Create the new error.
+      #
+      # @example Create the new error.
+      #   ImmutableAttribute.new(:_id, "1234")
+      #
+      # @param [ Symbol | String ] name The name of the attribute.
+      # @param [ Object ] value The attempted set value.
+      def initialize(name, value)
+        super(
+          compose_message("immutable_attribute", { name: name, value: value })
+        )
+      end
+    end
+  end
+end

data/lib/mongoid/errors/invalid_async_query_executor.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Mongoid
+  module Errors
+
+    # This error is raised when a bad async query executor option is attempted
+    # to be set.
+    class InvalidQueryExecutor < MongoidError
+
+      # Create the new error.
+      #
+      # @param [ Symbol | String ] executor The attempted async query executor.
+      #
+      # @api private
+      def initialize(executor)
+        super(
+          compose_message(
+            "invalid_async_query_executor",
+            { executor: executor, options: [:immediate, :global_thread_pool] }
+          )
+        )
+      end
+    end
+  end
+end

data/lib/mongoid/errors/invalid_global_executor_concurrency.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Mongoid
+  module Errors
+
+    # This error is raised when a bad global executor concurrency option is attempted
+    # to be set.
+    class InvalidGlobalExecutorConcurrency < MongoidError
+
+      # Create the new error.
+      #
+      # @api private
+      def initialize
+        super(
+          compose_message(
+            "invalid_global_executor_concurrency"
+          )
+        )
+      end
+    end
+  end
+end

data/lib/mongoid/errors/invalid_storage_parent.rb

@@ -4,6 +4,8 @@ module Mongoid
   module Errors
 
     # Raised when calling store_in in a sub-class of Mongoid::Document
+    #
+    # @deprecated
     class InvalidStorageParent < MongoidError
 
       # Create the new error.

data/lib/mongoid/errors.rb

@@ -3,11 +3,14 @@
 require "mongoid/errors/mongoid_error"
 require "mongoid/errors/ambiguous_relationship"
 require "mongoid/errors/callback"
+require "mongoid/errors/create_collection_failure"
 require "mongoid/errors/criteria_argument_required"
 require "mongoid/errors/document_not_destroyed"
 require "mongoid/errors/document_not_found"
 require "mongoid/errors/empty_config_file"
+require "mongoid/errors/immutable_attribute"
 require "mongoid/errors/in_memory_collation_not_supported"
+require "mongoid/errors/invalid_async_query_executor"
 require "mongoid/errors/invalid_collection"
 require "mongoid/errors/invalid_config_file"
 require "mongoid/errors/invalid_config_option"
@@ -16,6 +19,7 @@ require "mongoid/errors/invalid_field"
 require "mongoid/errors/invalid_field_option"
 require "mongoid/errors/invalid_field_type"
 require "mongoid/errors/invalid_find"
+require "mongoid/errors/invalid_global_executor_concurrency"
 require "mongoid/errors/invalid_includes"
 require "mongoid/errors/invalid_index"
 require "mongoid/errors/invalid_options"
@@ -35,7 +39,6 @@ require "mongoid/errors/invalid_scope"
 require "mongoid/errors/invalid_session_use"
 require "mongoid/errors/invalid_set_polymorphic_relation"
 require "mongoid/errors/invalid_storage_options"
-require "mongoid/errors/invalid_storage_parent"
 require "mongoid/errors/invalid_time"
 require "mongoid/errors/inverse_not_found"
 require "mongoid/errors/mixed_relations"

data/lib/mongoid/extensions/hash.rb

@@ -38,12 +38,8 @@ module Mongoid
         consolidated = {}
         each_pair do |key, value|
           if key =~ /\$/
-            value.keys.each do |key2|
-              value2 = value[key2]
-              real_key = klass.database_field_name(key2)
-
-              value.delete(key2) if real_key != key2
-              value[real_key] = value_for(key, klass, real_key, value2)
+            value.each_pair do |_key, _value|
+              value[_key] = (key == "$rename") ? _value.to_s : mongoize_for(key, klass, _key, _value)
             end
             consolidated[key] ||= {}
             consolidated[key].update(value)
@@ -185,24 +181,6 @@ module Mongoid
 
       private
 
-      # Get the value for the provided operator, klass, key and value.
-      #
-      # This is necessary for special cases like $rename, $addToSet and $push.
-      #
-      # @param [ String ] operator The operator.
-      # @param [ Class ] klass The model class.
-      # @param [ String | Symbol ] key The field key.
-      # @param [ Object ] value The original value.
-      #
-      # @return [ Object ] Value prepared for the provided operator.
-      def value_for(operator, klass, key, value)
-        case operator
-        when "$rename" then value.to_s
-        when "$addToSet", "$push" then value.mongoize
-        else mongoize_for(operator, klass, operator, value)
-        end
-      end
-
       # Mongoize for the klass, key and value.
       #
       # @api private

data/lib/mongoid/extensions/object.rb

@@ -91,7 +91,7 @@ module Mongoid
       #   object.do_or_do_not(:use, "The Force")
       #
       # @param [ String | Symbol ] name The method name.
-      # @param [ Array ] args The arguments.
+      # @param [ Object... ] *args The arguments.
       #
       # @return [ Object | nil ] The result of the method call or nil if the
       #   method does not exist.
@@ -190,7 +190,7 @@ module Mongoid
       #   object.you_must(:use, "The Force")
       #
       # @param [ String | Symbol ] name The method name.
-      # @param [ Array ] args The arguments.
+      # @param [ Object... ] *args The arguments.
       #
       # @return [ Object | nil ] The result of the method call or nil if the
       #   method does not exist. Nil if the object is frozen.

data/lib/mongoid/extensions/time.rb

@@ -34,6 +34,8 @@ module Mongoid
         #   ::Time.configured
         #
         # @return [ Time ] The configured time.
+        #
+        # @deprecated
         def configured
           Mongoid.use_activesupport_time_zone? ? (::Time.zone || ::Time) : ::Time
         end

data/lib/mongoid/fields/localized.rb

@@ -31,6 +31,16 @@ module Mongoid
         true
       end
 
+      # Is the localized field enforcing values to be present?
+      #
+      # @example Is the localized field enforcing values to be present?
+      #   field.localize_present?
+      #
+      # @return [ true | false ] If the field enforces present.
+      def localize_present?
+        options[:localize] == :present
+      end
+
       # Convert the provided string into a hash for the locale.
       #
       # @example Serialize the value.

data/lib/mongoid/fields/standard.rb

@@ -97,6 +97,16 @@ module Mongoid
         false
       end
 
+      # Is the localized field enforcing values to be present?
+      #
+      # @example Is the localized field enforcing values to be present?
+      #   field.localize_present?
+      #
+      # @return [ true | false ] If the field enforces present.
+      def localize_present?
+        false
+      end
+
       # Get the metadata for the field if its a foreign key.
       #
       # @example Get the metadata.

data/lib/mongoid/fields.rb

@@ -538,6 +538,8 @@ module Mongoid
       #   Model.add_defaults(field)
       #
       # @param [ Field ] field The field to add for.
+      #
+      # @api private
       def add_defaults(field)
         default, name = field.default_val, field.name.to_s
         remove_defaults(name)
@@ -557,6 +559,8 @@ module Mongoid
       #
       # @param [ Symbol ] name The name of the field.
       # @param [ Hash ] options The hash of options.
+      #
+      # @api private
       def add_field(name, options = {})
         aliased = options[:as]
         aliased_fields[aliased.to_s] = name if aliased
@@ -584,6 +588,8 @@ module Mongoid
       #   # => "called"
       #
       # @param [ Field ] field the field to process
+      #
+      # @api private
       def process_options(field)
         field_options = field.options
 
@@ -606,6 +612,8 @@ module Mongoid
       # @param [ Symbol ] name The name of the field.
       # @param [ Symbol ] meth The name of the accessor.
       # @param [ Hash ] options The options.
+      #
+      # @api private
       def create_accessors(name, meth, options = {})
         field = fields[name]
 
@@ -629,6 +637,8 @@ module Mongoid
       # @param [ String ] name The name of the attribute.
       # @param [ String ] meth The name of the method.
       # @param [ Field ] field The field.
+      #
+      # @api private
       def create_field_getter(name, meth, field)
         generated_methods.module_eval do
           re_define_method(meth) do
@@ -651,6 +661,8 @@ module Mongoid
       #
       # @param [ String ] name The name of the attribute.
       # @param [ String ] meth The name of the method.
+      #
+      # @api private
       def create_field_getter_before_type_cast(name, meth)
         generated_methods.module_eval do
           re_define_method("#{meth}_before_type_cast") do
@@ -671,6 +683,8 @@ module Mongoid
       # @param [ String ] name The name of the attribute.
       # @param [ String ] meth The name of the method.
       # @param [ Field ] field The field.
+      #
+      # @api private
       def create_field_setter(name, meth, field)
         generated_methods.module_eval do
           re_define_method("#{meth}=") do |value|
@@ -690,6 +704,8 @@ module Mongoid
       #
       # @param [ String ] name The name of the attribute.
       # @param [ String ] meth The name of the method.
+      #
+      # @api private
       def create_field_check(name, meth)
         generated_methods.module_eval do
           re_define_method("#{meth}?") do
@@ -706,6 +722,8 @@ module Mongoid
       #
       # @param [ String ] name The name of the attribute.
       # @param [ String ] meth The name of the method.
+      #
+      # @api private
       def create_translations_getter(name, meth)
         generated_methods.module_eval do
           re_define_method("#{meth}_translations") do
@@ -724,6 +742,8 @@ module Mongoid
       # @param [ String ] name The name of the attribute.
       # @param [ String ] meth The name of the method.
       # @param [ Field ] field The field.
+      #
+      # @api private
       def create_translations_setter(name, meth, field)
         generated_methods.module_eval do
           re_define_method("#{meth}_translations=") do |value|
@@ -743,6 +763,8 @@ module Mongoid
       #   Person.generated_methods
       #
       # @return [ Module ] The module of generated methods.
+      #
+      # @api private
       def generated_methods
         @generated_methods ||= begin
           mod = Module.new
@@ -757,11 +779,21 @@ module Mongoid
       #   Model.remove_defaults(name)
       #
       # @param [ String ] name The field name.
+      #
+      # @api private
       def remove_defaults(name)
         pre_processed_defaults.delete_one(name)
         post_processed_defaults.delete_one(name)
       end
 
+      # Create a field for the given name and options.
+      #
+      # @param [ Symbol ] name The name of the field.
+      # @param [ Hash ] options The hash of options.
+      #
+      # @return [ Field ] The created field.
+      #
+      # @api private
       def field_for(name, options)
         opts = options.merge(klass: self)
         opts[:type] = retrieve_and_validate_type(name, options[:type])
@@ -782,22 +814,32 @@ module Mongoid
       #
       # @api private
       def retrieve_and_validate_type(name, type)
-        result = TYPE_MAPPINGS[type] || unmapped_type(type)
-        raise Errors::InvalidFieldType.new(self, name, type) if !result.is_a?(Class)
-
-        if unsupported_type?(result)
-          warn_message = "Using #{result} as the field type is not supported. "
-          if result == BSON::Decimal128
-            warn_message += 'In BSON <= 4, the BSON::Decimal128 type will work as expected for both storing and querying, but will return a BigDecimal on query in BSON 5+. To use literal BSON::Decimal128 fields with BSON 5, set Mongoid.allow_bson5_decimal128 to true.'
-          else
-            warn_message += 'Saving values of this type to the database will work as expected, however, querying them will return a value of the native Ruby Integer type.'
+        type_mapping = TYPE_MAPPINGS[type]
+        result = type_mapping || unmapped_type(type)
+        if !result.is_a?(Class)
+          raise Errors::InvalidFieldType.new(self, name, type)
+        else
+          if INVALID_BSON_CLASSES.include?(result)
+            warn_message = "Using #{result} as the field type is not supported. "
+            if result == BSON::Decimal128
+              warn_message += "In BSON <= 4, the BSON::Decimal128 type will work as expected for both storing and querying, but will return a BigDecimal on query in BSON 5+."
+            else
+              warn_message += "Saving values of this type to the database will work as expected, however, querying them will return a value of the native Ruby Integer type."
+            end
+            Mongoid.logger.warn(warn_message)
           end
-          Mongoid.logger.warn(warn_message)
         end
-
         result
       end
 
+      # Returns the type of the field if the type was not in the TYPE_MAPPINGS
+      # hash.
+      #
+      # @param [ Symbol | Class ] type The type of the field.
+      #
+      # @return [ Class ] The type of the field.
+      #
+      # @api private
       def unmapped_type(type)
         if "Boolean" == type.to_s
           Mongoid::Boolean
@@ -805,19 +847,6 @@ module Mongoid
           type || Object
         end
       end
-
-      # Queries whether or not the given type is permitted as a declared field
-      # type.
-      #
-      # @param [ Class ] type The type to query
-      #
-      # @return [ true | false ] whether or not the type is supported
-      #
-      # @api private
-      def unsupported_type?(type)
-        return !Mongoid::Config.allow_bson5_decimal128? if type == BSON::Decimal128
-        INVALID_BSON_CLASSES.include?(type)
-      end
     end
   end
 end

data/lib/mongoid/findable.rb

@@ -22,18 +22,24 @@ module Mongoid
       :each,
       :each_with_index,
       :extras,
+      :fifth,
+      :fifth!,
       :find_one_and_delete,
       :find_one_and_replace,
       :find_one_and_update,
       :find_or_create_by,
       :find_or_create_by!,
       :find_or_initialize_by,
+      :first!,
       :first_or_create,
       :first_or_create!,
       :first_or_initialize,
       :for_js,
+      :fourth,
+      :fourth!,
       :geo_near,
       :includes,
+      :last!,
       :map_reduce,
       :max,
       :min,
@@ -41,11 +47,19 @@ module Mongoid
       :pick,
       :pluck,
       :read,
+      :second,
+      :second!,
+      :second_to_last,
+      :second_to_last!,
       :sum,
       :take,
       :take!,
       :tally,
       :text_search,
+      :third,
+      :third!,
+      :third_to_last,
+      :third_to_last!,
       :update,
       :update_all,
 
@@ -87,9 +101,19 @@ module Mongoid
     # @example Do any documents exist for the conditions?
     #   Person.exists?
     #
+    # @example Do any documents exist for given _id.
+    #   Person.exists?(BSON::ObjectId(...))
+    #
+    # @example Do any documents exist for given conditions.
+    #   Person.exists?(name: "...")
+    #
+    # @param [ Hash | Object | false ] id_or_conditions an _id to
+    #   search for, a hash of conditions, nil or false.
+    #
     # @return [ true | false ] If any documents exist for the conditions.
-    def exists?
-      with_default_scope.exists?
+    #   Always false if passed nil or false.
+    def exists?(id_or_conditions = :none)
+      with_default_scope.exists?(id_or_conditions)
     end
 
     # Finds a +Document+ or multiple documents by their _id values.
@@ -135,7 +159,7 @@ module Mongoid
     # @note Each argument can be an individual id, an array of ids or
     #   a nested array. Each array will be flattened.
     #
-    # @param [ Object | Array<Object> ] *args The _id value(s) to find.
+    # @param [ [ Object | Array<Object> ]... ] *args The id(s) to find.
     #
     # @return [ Document | Array<Document> | nil ] A document or matching documents.
     #

data/lib/mongoid/interceptable.rb

@@ -140,120 +140,31 @@ module Mongoid
     #
     # @api private
     def _mongoid_run_child_callbacks(kind, children: nil, &block)
-      if Mongoid::Config.around_callbacks_for_embeds
-        _mongoid_run_child_callbacks_with_around(kind, children: children, &block)
-      else
-        _mongoid_run_child_callbacks_without_around(kind, children: children, &block)
-      end
-    end
-
-    # Execute the callbacks of given kind for embedded documents including
-    # around callbacks.
-    #
-    # @note This method is prone to stack overflow errors if the document
-    #   has a large number of embedded documents. It is recommended to avoid
-    #   using around callbacks for embedded documents until a proper solution
-    #   is implemented.
-    #
-    # @param [ Symbol ] kind The type of callback to execute.
-    # @param [ Array<Document> ] children Children to execute callbacks on. If
-    #  nil, callbacks will be executed on all cascadable children of
-    #  the document.
-    #
-    #  @api private
-    def _mongoid_run_child_callbacks_with_around(kind, children: nil, &block)
       child, *tail = (children || cascadable_children(kind))
+      with_children = !Mongoid::Config.prevent_multiple_calls_of_embedded_callbacks
       if child.nil?
         block&.call
       elsif tail.empty?
-        child.run_callbacks(child_callback_type(kind, child), &block)
+        child.run_callbacks(child_callback_type(kind, child), with_children: with_children, &block)
       else
-        child.run_callbacks(child_callback_type(kind, child)) do
-          _mongoid_run_child_callbacks_with_around(kind, children: tail, &block)
-        end
-      end
-    end
-
-    # Execute the callbacks of given kind for embedded documents without
-    # around callbacks.
-    #
-    # @param [ Symbol ] kind The type of callback to execute.
-    # @param [ Array<Document> ] children Children to execute callbacks on. If
-    #   nil, callbacks will be executed on all cascadable children of
-    #   the document.
-    #
-    # @api private
-    def _mongoid_run_child_callbacks_without_around(kind, children: nil, &block)
-      children = (children || cascadable_children(kind))
-      callback_list = _mongoid_run_child_before_callbacks(kind, children: children)
-      return false if callback_list == false
-      value = block&.call
-      callback_list.each do |_next_sequence, env|
-        env.value &&= value
-      end
-      return false if _mongoid_run_child_after_callbacks(callback_list: callback_list) == false
-
-      value
-    end
-
-    # Execute the before callbacks of given kind for embedded documents.
-    #
-    # @param [ Symbol ] kind The type of callback to execute.
-    # @param [ Array<Document> ] children Children to execute callbacks on.
-    # @param [ Array<ActiveSupport::Callbacks::CallbackSequence, ActiveSupport::Callbacks::Filters::Environment> ] callback_list List of
-    #   pairs of callback sequence and environment. This list will be later used
-    #   to execute after callbacks in reverse order.
-    #
-    # @api private
-    def _mongoid_run_child_before_callbacks(kind, children: [], callback_list: [])
-      children.each do |child|
-        chain = child.__callbacks[child_callback_type(kind, child)]
-        env = ActiveSupport::Callbacks::Filters::Environment.new(child, false, nil)
-        next_sequence = compile_callbacks(chain)
-        unless next_sequence.final?
-          Mongoid.logger.warn("Around callbacks are disabled for embedded documents. Skipping around callbacks for #{child.class.name}.")
-          Mongoid.logger.warn("To enable around callbacks for embedded documents, set Mongoid::Config.around_callbacks_for_embeds to true.")
-        end
-        next_sequence.invoke_before(env)
-        return false if env.halted
-        env.value = !env.halted
-        callback_list << [next_sequence, env]
-        if (grandchildren = child.send(:cascadable_children, kind))
-          _mongoid_run_child_before_callbacks(kind, children: grandchildren, callback_list: callback_list)
+        child.run_callbacks(child_callback_type(kind, child), with_children: with_children) do
+          _mongoid_run_child_callbacks(kind, children: tail, &block)
         end
       end
-      callback_list
-    end
-
-    # Execute the after callbacks.
-    #
-    # @param [ Array<ActiveSupport::Callbacks::CallbackSequence, ActiveSupport::Callbacks::Filters::Environment> ] callback_list List of
-    #   pairs of callback sequence and environment.
-    def _mongoid_run_child_after_callbacks(callback_list: [])
-      callback_list.reverse_each do |next_sequence, env|
-        next_sequence.invoke_after(env)
-        return false if env.halted
-      end
     end
 
-    # Returns the stored callbacks to be executed later.
+    # This is used to store callbacks to be executed later. A good use case for
+    # this is delaying the after_find and after_initialize callbacks until the
+    # associations are set on the document. This can also be used to delay
+    # applying the defaults on a document.
     #
-    # @return [ Array<Symbol> ] Method symbols of the stored pending callbacks.
+    # @return [ Array<Symbol> ] an array of symbols that represent the pending callbacks.
     #
     # @api private
     def pending_callbacks
       @pending_callbacks ||= [].to_set
     end
 
-    # Stores callbacks to be executed later. A good use case for
-    # this is delaying the after_find and after_initialize callbacks until the
-    # associations are set on the document. This can also be used to delay
-    # applying the defaults on a document.
-    #
-    # @param [ Array<Symbol> ] value Method symbols of the pending callbacks to store.
-    #
-    # @return [ Array<Symbol> ] Method symbols of the stored pending callbacks.
-    #
     # @api private
     def pending_callbacks=(value)
       @pending_callbacks = value
@@ -388,7 +299,7 @@ module Mongoid
         end
         self.class.send :define_method, name do
           env = ActiveSupport::Callbacks::Filters::Environment.new(self, false, nil)
-          sequence = compile_callbacks(chain)
+          sequence = chain.compile
           sequence.invoke_before(env)
           env.value = !env.halted
           sequence.invoke_after(env)
@@ -398,24 +309,5 @@ module Mongoid
       end
       send(name)
     end
-
-    # Compile the callback chain.
-    #
-    # This method hides the differences between ActiveSupport implementations
-    # before and after 7.1.
-    #
-    # @param [ ActiveSupport::Callbacks::CallbackChain ] chain The callback chain.
-    # @param [ Symbol | nil ] type The type of callback chain to compile.
-    #
-    # @return [ ActiveSupport::Callbacks::CallbackSequence ] The compiled callback sequence.
-    def compile_callbacks(chain, type = nil)
-      if chain.method(:compile).arity == 0
-        # ActiveSupport < 7.1
-        chain.compile
-      else
-        # ActiveSupport >= 7.1
-        chain.compile(type)
-      end
-    end
   end
 end

data/lib/mongoid/matcher/eq_impl.rb

@@ -46,7 +46,7 @@ module Mongoid
         end
       end
 
-      # Per https://docs.mongodb.com/ruby-driver/current/tutorials/bson-v4/#time-instances,
+      # Per https://www.mongodb.com/docs/ruby-driver/current/tutorials/bson-v4/#time-instances,
       # > Times in BSON (and MongoDB) can only have millisecond precision. When Ruby Time instances
       # are serialized to BSON or Extended JSON, the times are floored to the nearest millisecond.
       #

data/lib/mongoid/matcher/type.rb

@@ -1,7 +1,7 @@
 module Mongoid
   module Matcher
 
-    # @see https://docs.mongodb.com/manual/reference/operator/query/type/
+    # @see https://www.mongodb.com/docs/manual/reference/operator/query/type/
     #
     # @api private
     module Type

data/lib/mongoid/persistable/creatable.rb

@@ -100,6 +100,7 @@ module Mongoid
       #
       # @return [ Document ] The document.
       def prepare_insert(options = {})
+        raise Errors::ReadonlyDocument.new(self.class) if readonly? && !Mongoid.legacy_readonly
         return self if performing_validations?(options) &&
           invalid?(options[:context] || :create)
         run_callbacks(:save, with_children: false) do