mongoid 7.2.1 → 9.0.0

data/lib/mongoid/errors/invalid_estimated_count_criteria.rb

@@ -1,16 +1,17 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# 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,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 module Mongoid
   module Errors

data/lib/mongoid/errors/invalid_field.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 module Mongoid
   module Errors
@@ -13,14 +13,18 @@ module Mongoid
       # @example Create the error.
       #   InvalidField.new(person, :crazy_method_name)
       #
+      # @api private
+      #
       # @param [ Class ] klass The document class.
+      # @param [ Symbol ] field The field name.
       # @param [ Symbol ] name The method name.
-      def initialize(klass, name)
+      def initialize(klass, field, name)
         super(
           compose_message(
             "invalid_field",
             {
               name: name,
+              field: field,
               origin: origin(klass, name),
               file: location(klass, name)[0],
               line: location(klass, name)[1]
@@ -39,9 +43,7 @@ module Mongoid
       # @param [ Class ] klass The document class.
       # @param [ Symbol ] name The method name.
       #
-      # @return [ Class, Module ] The originating class or module.
-      #
-      # @since 3.0.0
+      # @return [ Class | Module ] The originating class or module.
       def origin(klass, name)
         klass.instance_method(name).owner
       end
@@ -55,8 +57,6 @@ module Mongoid
       # @param [ Symbol ] name The method name.
       #
       # @return [ Array<String, Integer> ] The location of the method.
-      #
-      # @since 3.0.0
       def location(klass, name)
         @location ||=
           (klass.instance_method(name).source_location || [ "Unknown", 0 ])

data/lib/mongoid/errors/invalid_field_operator.rb

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

data/lib/mongoid/errors/invalid_field_option.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 module Mongoid
   module Errors
@@ -17,8 +17,6 @@ module Mongoid
       # @param [ Symbol ] name The method name.
       # @param [ Symbol ] option The option name.
       # @param [ Array<Symbol> ] valid All the valid options.
-      #
-      # @since 3.0.0
       def initialize(klass, name, option, valid)
         super(
           compose_message(

data/lib/mongoid/errors/invalid_field_type.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+# rubocop:todo all
+
+module Mongoid
+  module Errors
+
+    # This error is raised when trying to define a field using a :type option value
+    # that is not present in the field type mapping.
+    class InvalidFieldType < MongoidError
+
+      # Create the new error.
+      #
+      # @example Instantiate the error.
+      #   InvalidFieldType.new('Person', 'first_name', 'stringgy')
+      #
+      # @param [ String ] klass The model class.
+      # @param [ String ] field The field on which the invalid type is used.
+      # @param [ Symbol | String ] type The value of the field :type option.
+      def initialize(klass, field, type)
+        super(
+          compose_message('invalid_field_type',
+            klass: klass, field: field, type_inspection: type.inspect)
+        )
+      end
+    end
+  end
+end

data/lib/mongoid/errors/invalid_find.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 error.
       #   InvalidFind.new
-      #
-      # @since 2.2.0
       def initialize
         super(compose_message("calling_document_find_with_nil_is_invalid", {}))
       end

data/lib/mongoid/errors/invalid_global_executor_concurrency.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+# rubocop:todo all
+
+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_includes.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 [ Class ] klass The model class.
       # @param [ Array<Object> ] args The arguments passed to the includes.
-      #
-      # @since 3.0.2
       def initialize(klass, args)
         super(
           compose_message(

data/lib/mongoid/errors/invalid_index.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 [ Class ] klass The model class.
       # @param [ Hash ] spec The invalid specification.
       # @param [ Hash ] options The invalid options.
-      #
-      # @since 3.0.0
       def initialize(klass, spec, options)
         super(
           compose_message(

data/lib/mongoid/errors/invalid_options.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 [ Symbol ] name The name of the association.
       # @param [ Symbol ] invalid The invalid option.
       # @param [ Array<Symbol> ] valid The allowed options.
-      #
-      # @since 2.1.0
       def initialize(name, invalid, valid)
         super(
           compose_message(

data/lib/mongoid/errors/invalid_path.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
       #   InvalidPath.new(Address)
       #
       # @param [ Class ] klass The document class.
-      #
-      # @since 3.0.14
       def initialize(klass)
         super(compose_message("invalid_path", { klass: klass }))
       end

data/lib/mongoid/errors/invalid_persistence_option.rb

@@ -1,12 +1,10 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 module Mongoid
   module Errors
 
     # Raised when invalid options are used to create a persistence context.
-    #
-    # @since 6.0.0
     class InvalidPersistenceOption < MongoidError
 
       # Instantiate the persistence context option error.
@@ -16,8 +14,6 @@ module Mongoid
       #
       # @param [ Symbol ] invalid The invalid option.
       # @param [ Array<Symbol> ] valid The allowed options.
-      #
-      # @since 6.0.0
       def initialize(invalid, valid)
         super(
             compose_message(

data/lib/mongoid/errors/invalid_query.rb

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

data/lib/mongoid/errors/invalid_relation.rb

@@ -1,13 +1,11 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 module Mongoid
   module Errors
 
     # This error is raised when trying to create an association that conflicts with
     # an already defined method.
-    #
-    # @since 6.0.0
     class InvalidRelation < MongoidError
 
       # Create the new error.
@@ -41,9 +39,7 @@ module Mongoid
       # @param [ Class ] klass The document class.
       # @param [ Symbol ] name The method name.
       #
-      # @return [ Class, Module ] The originating class or module.
-      #
-      # @since 6.0.0
+      # @return [ Class | Module ] The originating class or module.
       def origin(klass, name)
         klass.instance_method(name).owner
       end
@@ -57,8 +53,6 @@ module Mongoid
       # @param [ Symbol ] name The method name.
       #
       # @return [ Array<String, Integer> ] The location of the method.
-      #
-      # @since 6.0.0
       def location(klass, name)
         @location ||=
             (klass.instance_method(name).source_location || [ "Unknown", 0 ])

data/lib/mongoid/errors/invalid_relation_option.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 module Mongoid
   module Errors
@@ -13,11 +13,9 @@ module Mongoid
       #   InvalidRelationOption.new(Person, invalid_option: 'make_me_a_sandwich')
       #
       # @param [ Class ] klass The model class.
-      # @param [ String, Symbol ] name The association name.
+      # @param [ String | Symbol ] name The association name.
       # @param [ Symbol ] option The invalid option.
       # @param [ Array<Symbol> ] valid_options The valid option.
-      #
-      # @since 3.0.0
       def initialize(klass, name, option, valid_options)
         super(
             compose_message(

data/lib/mongoid/errors/invalid_scope.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 model class.
       # @param [ Object ] value The attempted scope value.
-      #
-      # @since 3.0.0
       def initialize(klass, value)
         super(
           compose_message("invalid_scope", { klass: klass, value: value })

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,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 module Mongoid
   module Errors
@@ -25,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,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 module Mongoid
   module Errors
@@ -13,9 +13,7 @@ module Mongoid
       #   InvalidStorageOptions.new(Person, invalid_option: 'name')
       #
       # @param [ Class ] klass The model class.
-      # @param [ Hash, String, Symbol ] options The provided options.
-      #
-      # @since 3.0.0
+      # @param [ Hash | String | Symbol ] options The provided options.
       def initialize(klass, options)
         super(
           compose_message(

data/lib/mongoid/errors/invalid_time.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
       #   InvalidTime.new("this is not a time")
       #
       # @param [ Object ] value The value that was attempted.
-      #
-      # @since 2.3.1
       def initialize(value)
         super(compose_message("invalid_time", { value: value }))
       end

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,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 module Mongoid
   module Errors
@@ -16,8 +16,6 @@ module Mongoid
       # @param [ Symbol ] name The name of the association.
       # @param [ Class ] klass The child class.
       # @param [ Symbol ] inverse The attempted inverse key.
-      #
-      # @since 3.0.0
       def initialize(base, name, klass, inverse)
         super(
           compose_message(

data/lib/mongoid/errors/mixed_client_configuration.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 [ Symbol ] name The name of the client config.
       # @param [ Hash ] config The configuration options.
-      #
-      # @since 3.0.0
       def initialize(name, config)
         super(
           compose_message(

data/lib/mongoid/errors/mixed_relations.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 module Mongoid
   module Errors
@@ -18,8 +18,6 @@ module Mongoid
     #     embedded_in :person
     #     referenced_in :post
     #   end
-    #
-    # @since 2.0.0
     class MixedRelations < MongoidError
       def initialize(root_klass, embedded_klass)
         super(

data/lib/mongoid/errors/mongoid_error.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 module Mongoid
   module Errors
@@ -19,8 +19,6 @@ module Mongoid
       #   error.compose_message
       #
       # @return [ String ] The composed message.
-      #
-      # @since 3.0.0
       def compose_message(key, attributes = {})
         @problem = translate_problem(key, attributes)
         @summary = translate_summary(key, attributes)
@@ -30,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
@@ -48,7 +46,7 @@ module Mongoid
       #
       # @return [ String ] A localized error message string.
       def translate(key, options)
-        ::I18n.translate("#{BASE_KEY}.#{key}", options)
+        ::I18n.translate("#{BASE_KEY}.#{key}", **options)
       end
 
       # Create the problem.
@@ -56,12 +54,10 @@ module Mongoid
       # @example Create the problem.
       #   error.problem("error", {})
       #
-      # @param [ String, Symbol ] key The error key.
+      # @param [ String | Symbol ] key The error key.
       # @param [ Hash ] attributes The attributes to interpolate.
       #
       # @return [ String ] The problem.
-      #
-      # @since 3.0.0
       def translate_problem(key, attributes)
         translate("#{key}.message", attributes)
       end
@@ -71,12 +67,10 @@ module Mongoid
       # @example Create the summary.
       #   error.summary("error", {})
       #
-      # @param [ String, Symbol ] key The error key.
+      # @param [ String | Symbol ] key The error key.
       # @param [ Hash ] attributes The attributes to interpolate.
       #
       # @return [ String ] The summary.
-      #
-      # @since 3.0.0
       def translate_summary(key, attributes)
         translate("#{key}.summary", attributes)
       end
@@ -86,12 +80,10 @@ module Mongoid
       # @example Create the resolution.
       #   error.resolution("error", {})
       #
-      # @param [ String, Symbol ] key The error key.
+      # @param [ String | Symbol ] key The error key.
       # @param [ Hash ] attributes The attributes to interpolate.
       #
       # @return [ String ] The resolution.
-      #
-      # @since 3.0.0
       def translate_resolution(key, attributes)
         translate("#{key}.resolution", attributes)
       end

data/lib/mongoid/errors/nested_attributes_metadata_not_found.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
       #   NestedAttributesMetadataNotFound.new(klass, name)
       #
       # @param [ Class ] klass The class of the document.
-      # @param [ Symbol, String ] name The name of the association
-      #
-      # @since 3.0.0
+      # @param [ Symbol | String ] name The name of the association
       def initialize(klass, name)
         super(
           compose_message(

data/lib/mongoid/errors/no_client_config.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
       #   NoClientConfig.new(:analytics)
       #
       # @param [ String | Symbol ] name The name of the client.
-      #
-      # @since 3.0.0
       def initialize(name)
         super(compose_message("no_client_config", { name: name }))
       end

data/lib/mongoid/errors/no_client_database.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 module Mongoid
   module Errors
@@ -12,10 +12,8 @@ module Mongoid
       # @example Create the new error.
       #   NoClientDatabase.new(:default, {}})
       #
-      # @param [ Symbol, String ] name The db config key.
+      # @param [ Symbol | String ] name The db config key.
       # @param [ Hash ] config The hash configuration options.
-      #
-      # @since 3.0.0
       def initialize(name, config)
         super(
           compose_message(

data/lib/mongoid/errors/no_client_hosts.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 module Mongoid
   module Errors
@@ -12,10 +12,8 @@ module Mongoid
       # @example Create the new error.
       #   NoClientHosts.new(:default, {}})
       #
-      # @param [ Symbol, String ] name The db config key.
+      # @param [ Symbol | String ] name The db config key.
       # @param [ Hash ] config The hash configuration options.
-      #
-      # @since 3.0.0
       def initialize(name, config)
         super(
           compose_message(

data/lib/mongoid/errors/no_clients_config.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# encoding: utf-8
+# rubocop:todo all
 
 module Mongoid
   module Errors
@@ -12,8 +12,6 @@ module Mongoid
       #
       # @example Create the error.
       #   NoClientsConfig.new
-      #
-      # @since 3.0.0
       def initialize
         super(compose_message("no_clients_config", {}))
       end