mongoid 8.1.6 → 9.0.0

data/lib/mongoid/errors/attribute_not_loaded.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+# rubocop:todo all
+
+module Mongoid
+  module Errors
+
+    # Raised when attempting to read or write an attribute which has
+    # not been loaded. This can occur when using `.only` or `.without`
+    # query projection methods.
+    #
+    # @example Getting a field which has not been loaded.
+    #   Band.only(:name).first.label
+    #   #=> raises Mongoid::Errors::AttributeNotLoaded
+    #
+    # @example Setting a field which has not been loaded.
+    #   Band.without(:label).first.label = 'Sub Pop Records'
+    #   #=> raises Mongoid::Errors::AttributeNotLoaded
+    class AttributeNotLoaded < MongoidError
+
+      # Create the new error.
+      #
+      # @example Instantiate the error.
+      #   AttributeNotLoaded.new(Person, "title")
+      #
+      # @param [ Class ] klass The model class.
+      # @param [ String | Symbol ] name The name of the attribute.
+      def initialize(klass, name)
+        super(
+          compose_message("attribute_not_loaded", { klass: klass.name, name: name })
+        )
+      end
+    end
+  end
+end

data/lib/mongoid/errors/callback.rb

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

data/lib/mongoid/errors/create_collection_failure.rb

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

data/lib/mongoid/errors/criteria_argument_required.rb

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

data/lib/mongoid/errors/delete_restriction.rb

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

data/lib/mongoid/errors/document_not_destroyed.rb

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

data/lib/mongoid/errors/document_not_found.rb

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

data/lib/mongoid/errors/drop_collection_failure.rb

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

data/lib/mongoid/errors/empty_config_file.rb

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

data/lib/mongoid/errors/immutable_attribute.rb

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

data/lib/mongoid/errors/in_memory_collation_not_supported.rb

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

data/lib/mongoid/errors/invalid_async_query_executor.rb

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

data/lib/mongoid/errors/invalid_auto_encryption_configuration.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+# rubocop:todo all
+
+module Mongoid
+  module Errors
+
+    # This error is raised when automatic encryption configuration for a client
+    # is invalid.
+    class InvalidAutoEncryptionConfiguration < MongoidError
+
+      # Initialize the error.
+      #
+      # @param [ Symbol ] name The name of the client config.
+      def initialize(name, kms_provider = nil)
+        if kms_provider
+          super(
+            compose_message(
+              "invalid_auto_encryption_configuration_for_kms_provider",
+              { client: name, kms_provider: kms_provider }
+            )
+          )
+        else
+          super(
+            compose_message(
+              "invalid_auto_encryption_configuration",
+              { client: name }
+            )
+          )
+        end
+      end
+    end
+  end
+end

data/lib/mongoid/errors/invalid_collection.rb

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

data/lib/mongoid/errors/invalid_config_file.rb

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

data/lib/mongoid/errors/invalid_config_option.rb

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

data/lib/mongoid/errors/invalid_dependent_strategy.rb

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

data/lib/mongoid/errors/invalid_discriminator_key_target.rb

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

data/lib/mongoid/errors/invalid_dot_dollar_assignment.rb

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

data/lib/mongoid/errors/invalid_elem_match_operator.rb

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

data/lib/mongoid/errors/invalid_estimated_count_criteria.rb

@@ -1,15 +1,17 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   module Errors
 
+    # This error is raised when trying to call estimated_count
+    # on a filtered criteria.
     class InvalidEstimatedCountCriteria < MongoidError
 
-      # Creates the exception raised when trying to call estimated_count
-      # on a filtered criteria.
+      # Creates the exception.
       #
-      # @param [ String ] class_name The klass of the criteria used to call
-      #                              estimated count.
+      # @param [ String ] class_name The name of the criteria
+      #   class used to call estimated count.
       #
       # @api private
       def initialize(class_name)

data/lib/mongoid/errors/invalid_estimated_count_scoping.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+# rubocop:todo all
+
+module Mongoid
+  module Errors
+
+    # This error is raised when trying to call estimated_count
+    # on a model with a default scope.
+    class InvalidEstimatedCountScoping < MongoidError
+
+      # Creates the exception.
+      #
+      # @param [ String ] class_name The name of the criteria
+      #   class used to call estimated count.
+      #
+      # @api private
+      def initialize(class_name)
+        super(
+          compose_message(
+            "invalid_estimated_count_scoping",
+            { class_name: class_name }
+          )
+        )
+      end
+    end
+  end
+end

data/lib/mongoid/errors/invalid_expression_operator.rb

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

data/lib/mongoid/errors/invalid_field.rb

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

data/lib/mongoid/errors/invalid_field_operator.rb

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

data/lib/mongoid/errors/invalid_field_option.rb

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

data/lib/mongoid/errors/invalid_field_type.rb

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

data/lib/mongoid/errors/invalid_find.rb

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

data/lib/mongoid/errors/invalid_global_executor_concurrency.rb

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

data/lib/mongoid/errors/invalid_includes.rb

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

data/lib/mongoid/errors/invalid_index.rb

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

data/lib/mongoid/errors/invalid_options.rb

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

data/lib/mongoid/errors/invalid_path.rb

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

data/lib/mongoid/errors/invalid_persistence_option.rb

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

data/lib/mongoid/errors/invalid_query.rb

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

data/lib/mongoid/errors/invalid_relation.rb

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

data/lib/mongoid/errors/invalid_relation_option.rb

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

data/lib/mongoid/errors/invalid_scope.rb

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

data/lib/mongoid/errors/invalid_session_nesting.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 already
+    # has an opened session.
+    class InvalidSessionNesting < MongoidError
+
+      # Create the error.
+      def initialize
+        super(compose_message('invalid_session_nesting'))
+      end
+    end
+  end
+end

data/lib/mongoid/errors/invalid_set_polymorphic_relation.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   module Errors
@@ -24,7 +25,6 @@ module Mongoid
     #   eye = Eye.new
     #   face = Face.new
     #   eye.eyeable = face # Raises error
-
     class InvalidSetPolymorphicRelation < MongoidError
 
       # Create the new invalid set polymorphic association error.

data/lib/mongoid/errors/invalid_storage_options.rb

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

data/lib/mongoid/errors/invalid_time.rb

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

data/lib/mongoid/errors/invalid_transaction_nesting.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 already
+    # has an opened transaction.
+    class InvalidTransactionNesting < MongoidError
+
+      # Create the error.
+      def initialize
+        super(compose_message('invalid_transaction_nesting'))
+      end
+    end
+  end
+end

data/lib/mongoid/errors/inverse_not_found.rb

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

data/lib/mongoid/errors/mixed_client_configuration.rb

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

data/lib/mongoid/errors/mixed_relations.rb

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

data/lib/mongoid/errors/mongoid_error.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   module Errors
@@ -27,9 +28,9 @@ module Mongoid
         @resolution_title = translate("resolution_title", {})
 
 
-        "\n#{@problem_title}:\n  #{@problem}"+
-        "\n#{@summary_title}:\n  #{@summary}"+
-        "\n#{@resolution_title}:\n  #{@resolution}"
+        "\n#{@problem_title}:\n  #{@problem&.strip}"+
+        "\n#{@summary_title}:\n  #{@summary&.strip}"+
+        "\n#{@resolution_title}:\n  #{@resolution&.strip}"
       end
 
       private

data/lib/mongoid/errors/nested_attributes_metadata_not_found.rb

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

data/lib/mongoid/errors/no_client_config.rb

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

data/lib/mongoid/errors/no_client_database.rb

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

data/lib/mongoid/errors/no_client_hosts.rb

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

data/lib/mongoid/errors/no_clients_config.rb

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

data/lib/mongoid/errors/no_default_client.rb

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

data/lib/mongoid/errors/no_environment.rb

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

data/lib/mongoid/errors/no_map_reduce_output.rb

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

data/lib/mongoid/errors/no_metadata.rb

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

data/lib/mongoid/errors/no_parent.rb

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

data/lib/mongoid/errors/readonly_attribute.rb

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

data/lib/mongoid/errors/readonly_document.rb

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

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,4 +1,5 @@
 # frozen_string_literal: true
+# 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,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   module Errors

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,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:todo all
 
 module Mongoid
   module Errors