mongoid 7.2.1 → 9.0.0

data/lib/mongoid/errors/no_default_client.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 module Mongoid
   module Errors
@@ -13,8 +13,6 @@ module Mongoid
       #   NoDefaultClient.new([ :analytics ])
       #
       # @param [ Array<Symbol> ] keys The defined clients.
-      #
-      # @since 3.0.0
       def initialize(keys)
         super(
           compose_message("no_default_client", { keys: keys.join(", ") })

data/lib/mongoid/errors/no_environment.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 module Mongoid
   module Errors
@@ -11,8 +11,6 @@ module Mongoid
       #
       # @example Create the new no environment error.
       #   NoEnvironment.new
-      #
-      # @since 2.4.0
       def initialize
         super(compose_message("no_environment", {}))
       end

data/lib/mongoid/errors/no_map_reduce_output.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 module Mongoid
   module Errors
@@ -14,8 +14,6 @@ module Mongoid
       #   NoMapReduceOutput.new({ map: "" })
       #
       # @param [ Hash ] command The map/reduce command.
-      #
-      # @since 3.0.0
       def initialize(command)
         super(
           compose_message("no_map_reduce_output", { command: command })

data/lib/mongoid/errors/no_metadata.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 module Mongoid
   module Errors
@@ -13,8 +13,6 @@ module Mongoid
       #   NoMetadata.new(Address)
       #
       # @param [ Class ] klass The document class.
-      #
-      # @since 3.0.0
       def initialize(klass)
         super(compose_message("no_metadata", { klass: klass }))
       end

data/lib/mongoid/errors/no_parent.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 module Mongoid
   module Errors
@@ -14,8 +14,6 @@ module Mongoid
       #   NoParent.new(klass)
       #
       # @param [ Class ] klass The class of the embedded document.
-      #
-      # @since 3.0.0
       def initialize(klass)
         super(
           compose_message("no_parent", { klass: klass })

data/lib/mongoid/errors/readonly_attribute.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 module Mongoid
   module Errors
@@ -13,10 +13,8 @@ module Mongoid
       # @example Create the new error.
       #   ReadonlyAttribute.new(:title, "mr")
       #
-      # @param [ Symbol, String ] name The name of the attribute.
+      # @param [ Symbol | String ] name The name of the attribute.
       # @param [ Object ] value The attempted set value.
-      #
-      # @since 3.0.0
       def initialize(name, value)
         super(
           compose_message("readonly_attribute", { name: name, value: value })

data/lib/mongoid/errors/readonly_document.rb

@@ -1,23 +1,19 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 module Mongoid
   module Errors
 
     # Raised when attempting to persist a document that was loaded from the
     # database with partial fields.
-    #
-    # @since 4.0.0
     class ReadonlyDocument < MongoidError
 
-      # Instnatiate the exception.
+      # Instantiate the exception.
       #
       # @example Create the error.
       #   ReadonlyDocument.new(Band)
       #
       # @param [ Class ] klass The document class.
-      #
-      # @since 4.0.0
       def initialize(klass)
         super(compose_message("readonly_document", { klass: klass }))
       end

data/lib/mongoid/errors/rollback.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+# rubocop:todo all
+
+module Mongoid
+  module Errors
+
+    # This error should be raised to deliberately rollback a transaction without
+    # passing on an exception.
+    # Normally, raising an exception inside a Mongoid transaction causes rolling
+    # the MongoDB transaction back, and the exception is passed on.
+    # If Mongoid::Error::Rollback exception is raised, then the MongoDB
+    # transaction will be rolled back, without passing on the exception.
+    class Rollback < MongoidError; end
+  end
+end

data/lib/mongoid/errors/scope_overwrite.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 module Mongoid
   module Errors

data/lib/mongoid/errors/sessions_not_supported.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+# rubocop:todo all
+
+module Mongoid
+  module Errors
+
+    # This error is raised when a session is attempted to be used with a model whose client cannot use it since
+    # the mongodb deployment doesn't support sessions.
+    class SessionsNotSupported < MongoidError
+
+      # Create the error.
+      def initialize
+        super('sessions_not_supported')
+      end
+    end
+  end
+end

data/lib/mongoid/errors/too_many_nested_attribute_records.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 module Mongoid
   module Errors
 
-    # This error is raised when trying to create set nested records above the
+    # This error is raised when trying to create set nested documents above the
     # specified :limit
     #
     # @example Create the error.

data/lib/mongoid/errors/transaction_error.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+# rubocop:todo all
+
+module Mongoid
+  module Errors
+
+    # This error is raised when a transaction failed because
+    # of an unexpected error.
+    class TransactionError < MongoidError
+
+      # Creates the exception.
+      #
+      # @param [ StandardError ] error Error that caused the
+      #   transaction failure.
+      def initialize(error)
+        super(
+          compose_message(
+            'transaction_error',
+            { error: "#{error.class}: #{error.message}" }
+          )
+        )
+      end
+    end
+  end
+end

data/lib/mongoid/errors/transactions_not_supported.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+# rubocop:todo all
+
+module Mongoid
+  module Errors
+
+    # This error is raised when a transaction is attempted to be used with a model whose client cannot use it since
+    # the mongodb deployment doesn't support transactions.
+    class TransactionsNotSupported < MongoidError
+
+      # Create the error.
+      def initialize
+        super('transactions_not_supported')
+      end
+    end
+  end
+end

data/lib/mongoid/errors/unknown_attribute.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 module Mongoid
   module Errors
@@ -14,9 +14,7 @@ module Mongoid
       #   UnknownAttribute.new(Person, "gender")
       #
       # @param [ Class ] klass The model class.
-      # @param [ String, Symbol ] name The name of the attribute.
-      #
-      # @since 3.0.0
+      # @param [ String | Symbol ] name The name of the attribute.
       def initialize(klass, name)
         super(
           compose_message("unknown_attribute", { klass: klass.name, name: name })

data/lib/mongoid/errors/unknown_model.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 module Mongoid
   module Errors
@@ -15,8 +15,6 @@ module Mongoid
       #
       # @param [ String ] klass The model class.
       # @param [ String ] value The value used to determine the (invalid) class.
-      #
-      # @since 7.0.0
       def initialize(klass, value)
         super(
             compose_message("unknown_model", { klass: klass, value: value })

data/lib/mongoid/errors/unsaved_document.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 module Mongoid
   module Errors
 
     # Raised when attempting to call create or create! through a
     # references_many when the parent document has not been saved. This
-    # prevents the child from getting presisted and immediately being orphaned.
+    # prevents the child from getting persisted and immediately being orphaned.
     class UnsavedDocument < MongoidError
       def initialize(base, document)
         super(

data/lib/mongoid/errors/unsupported_javascript.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 module Mongoid
   module Errors
@@ -14,8 +14,6 @@ module Mongoid
       #
       # @param [ Class ] klass The embedded document class.
       # @param [ String ] javascript The javascript expression.
-      #
-      # @since 3.0.0
       def initialize(klass, javascript)
         super(
           compose_message(

data/lib/mongoid/errors/validations.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 module Mongoid
   module Errors

data/lib/mongoid/errors.rb

@@ -1,20 +1,28 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 require "mongoid/errors/mongoid_error"
 require "mongoid/errors/ambiguous_relationship"
+require "mongoid/errors/attribute_not_loaded"
 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/eager_load"
+require "mongoid/errors/empty_config_file"
+require "mongoid/errors/immutable_attribute"
 require "mongoid/errors/in_memory_collation_not_supported"
+require "mongoid/errors/invalid_auto_encryption_configuration"
+require "mongoid/errors/invalid_async_query_executor"
 require "mongoid/errors/invalid_collection"
+require "mongoid/errors/invalid_config_file"
 require "mongoid/errors/invalid_config_option"
 require "mongoid/errors/invalid_dependent_strategy"
 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"
@@ -23,19 +31,20 @@ require "mongoid/errors/invalid_persistence_option"
 require "mongoid/errors/invalid_query"
 # Must be after invalid_query.
 require "mongoid/errors/invalid_discriminator_key_target"
+require "mongoid/errors/invalid_dot_dollar_assignment"
 require "mongoid/errors/invalid_elem_match_operator"
 require "mongoid/errors/invalid_estimated_count_criteria"
+require "mongoid/errors/invalid_estimated_count_scoping"
 require "mongoid/errors/invalid_expression_operator"
 require "mongoid/errors/invalid_field_operator"
 require "mongoid/errors/invalid_relation"
 require "mongoid/errors/invalid_relation_option"
 require "mongoid/errors/invalid_scope"
-require "mongoid/errors/invalid_session_use"
+require "mongoid/errors/invalid_session_nesting"
 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/invalid_value"
+require "mongoid/errors/invalid_transaction_nesting"
 require "mongoid/errors/inverse_not_found"
 require "mongoid/errors/mixed_relations"
 require "mongoid/errors/mixed_client_configuration"
@@ -51,8 +60,12 @@ require "mongoid/errors/no_client_database"
 require "mongoid/errors/no_client_hosts"
 require "mongoid/errors/readonly_attribute"
 require "mongoid/errors/readonly_document"
+require "mongoid/errors/rollback"
+require "mongoid/errors/sessions_not_supported"
 require "mongoid/errors/scope_overwrite"
 require "mongoid/errors/too_many_nested_attribute_records"
+require "mongoid/errors/transaction_error"
+require "mongoid/errors/transactions_not_supported"
 require "mongoid/errors/unknown_attribute"
 require "mongoid/errors/unknown_model"
 require "mongoid/errors/unsaved_document"

data/lib/mongoid/evolvable.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 module Mongoid
 
@@ -12,10 +12,8 @@ module Mongoid
     #   document.__evolve_object_id__
     #
     # @return [ Object ] The document's id.
-    #
-    # @since 3.0.0
     def __evolve_object_id__
-      id
+      _id
     end
   end
 end

data/lib/mongoid/extensions/array.rb

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 module Mongoid
   module Extensions
+    # Adds type-casting behavior to Array class.
     module Array
 
       # Evolve the array into an array of object ids.
@@ -11,8 +12,6 @@ module Mongoid
       #   [ id ].__evolve_object_id__
       #
       # @return [ Array<BSON::ObjectId> ] The converted array.
-      #
-      # @since 3.0.0
       def __evolve_object_id__
         map!(&:__evolve_object_id__)
         self
@@ -24,11 +23,11 @@ module Mongoid
       #   [ 1, 2, 3 ].__find_args__
       #
       # @return [ Array ] The array of args.
-      #
-      # @since 3.0.0
+      # @deprecated
       def __find_args__
         flat_map{ |a| a.__find_args__ }.uniq{ |a| a.to_s }
       end
+      Mongoid.deprecate(self, :__find_args__)
 
       # Mongoize the array into an array of object ids.
       #
@@ -36,8 +35,6 @@ module Mongoid
       #   [ id ].__mongoize_object_id__
       #
       # @return [ Array<BSON::ObjectId> ] The converted array.
-      #
-      # @since 3.0.0
       def __mongoize_object_id__
         map!(&:__mongoize_object_id__).compact!
         self
@@ -54,32 +51,8 @@ module Mongoid
       # @return [ Time | ActiveSupport::TimeWithZone ] Local time in the
       #   configured default time zone corresponding to date/time components
       #   in this array.
-      #
-      # @since 3.0.0
       def __mongoize_time__
-        ::Time.configured.local(*self)
-      end
-
-      # Checks whether conditions given in this array are known to be
-      # unsatisfiable, i.e., querying with this array will always return no
-      # documents.
-      #
-      # This method used to assume that the array is the list of criteria
-      # to be used with an $and operator. This assumption is no longer made;
-      # therefore, since the interpretation of conditions in the array differs
-      # between $and, $or and $nor operators, this method now always returns
-      # false.
-      #
-      # This method is deprecated. Mongoid now uses
-      # +_mongoid_unsatisfiable_criteria?+ internally; this method is retained
-      # for backwards compatibility only. It always returns false.
-      #
-      # @return [ false ] Always false.
-      #
-      # @since 3.1.0
-      # @deprecated
-      def blank_criteria?
-        false
+        ::Time.zone.local(*self)
       end
 
       # Is the array a set of multiple arguments in a method?
@@ -87,12 +60,12 @@ module Mongoid
       # @example Is this multi args?
       #   [ 1, 2, 3 ].multi_arged?
       #
-      # @return [ true, false ] If the array is multi args.
-      #
-      # @since 3.0.0
+      # @return [ true | false ] If the array is multi args.
+      # @deprecated
       def multi_arged?
         !first.is_a?(Hash) && first.resizable? || size > 1
       end
+      Mongoid.deprecate(self, :multi_arged?)
 
       # Turn the object from the ruby type we deal with to a Mongo friendly
       # type.
@@ -100,17 +73,14 @@ module Mongoid
       # @example Mongoize the object.
       #   object.mongoize
       #
-      # @return [ Array ] The object.
-      #
-      # @since 3.0.0
+      # @return [ Array | nil ] The object or nil.
       def mongoize
         ::Array.mongoize(self)
       end
 
       # Delete the first object in the array that is equal to the supplied
       # object and return it. This is much faster than performing a standard
-      # delete for large arrays ince it attempt to delete multiple in the
-      # other.
+      # delete for large arrays since it does not perform multiple deletes.
       #
       # @example Delete the first object.
       #   [ "1", "2", "1" ].delete_one("1")
@@ -118,21 +88,17 @@ module Mongoid
       # @param [ Object ] object The object to delete.
       #
       # @return [ Object ] The deleted object.
-      #
-      # @since 2.1.0
       def delete_one(object)
         position = index(object)
         position ? delete_at(position) : nil
       end
 
-      # Is the object's size changable?
+      # Returns whether the object's size can be changed.
       #
       # @example Is the object resizable?
       #   object.resizable?
       #
       # @return [ true ] true.
-      #
-      # @since 3.0.0
       def resizable?
         true
       end
@@ -144,12 +110,11 @@ module Mongoid
         # @example Mongoize the object.
         #   Array.__mongoize_fk__(constraint, object)
         #
-        # @param [ Association ] association The association metadata.
+        # @param [ Mongoid::Association::Relatable ] association The association metadata.
         # @param [ Object ] object The object to convert.
         #
         # @return [ Array ] The array of ids.
-        #
-        # @since 3.0.0
+        # @deprecated
         def __mongoize_fk__(association, object)
           if object.resizable?
             object.blank? ? object : association.convert_to_foreign_key(object)
@@ -157,6 +122,7 @@ module Mongoid
             object.blank? ? [] : association.convert_to_foreign_key(Array(object))
           end
         end
+        Mongoid.deprecate(self, :__mongoize_fk__)
 
         # Turn the object from the ruby type we deal with to a Mongo friendly
         # type.
@@ -166,25 +132,21 @@ module Mongoid
         #
         # @param [ Object ] object The object to mongoize.
         #
-        # @return [ Array ] The object mongoized.
-        #
-        # @since 3.0.0
+        # @return [ Array | nil ] The object mongoized or nil.
         def mongoize(object)
-          if object.is_a?(::Array)
-            evolve(object).collect{ |obj| obj.class.mongoize(obj) }
-          else
-            evolve(object)
+          return if object.nil?
+          case object
+          when ::Array, ::Set
+            object.map(&:mongoize)
           end
         end
 
-        # Is the object's size changable?
+        # Returns whether the object's size can be changed.
         #
         # @example Is the object resizable?
         #   Array.resizable?
         #
         # @return [ true ] true.
-        #
-        # @since 3.0.0
         def resizable?
           true
         end