mongoid 7.3.2 → 7.4.0

data/lib/mongoid/errors/invalid_config_file.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Mongoid
+  module Errors
+
+    # This error is raised when a bad configuration file is attempted to be
+    # loaded.
+    class InvalidConfigFile < MongoidError
+
+      # Create the new error.
+      #
+      # @param [ String ] path The path of the config file used.
+      #
+      # @api private
+      def initialize(path)
+        super(
+          compose_message(
+            "invalid_config_file",
+            { path: path }
+          )
+        )
+      end
+    end
+  end
+end

data/lib/mongoid/errors/invalid_config_option.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Errors
@@ -14,8 +13,6 @@ module Mongoid
       #   InvalidConfigOption.new(:name, [ :option ])
       #
       # @param [ Symbol, String ] name The attempted config option name.
-      #
-      # @since 3.0.0
       def initialize(name)
         super(
           compose_message(

data/lib/mongoid/errors/invalid_dependent_strategy.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Errors
@@ -16,8 +15,6 @@ module Mongoid
       #   dependency is defined.
       # @param [ Symbol, String ] invalid_strategy The attempted invalid strategy.
       # @param [ Array<Symbol> ] valid_strategies The valid strategies.
-      #
-      # @since 7.0.0
       def initialize(association, invalid_strategy, valid_strategies)
         super(
             compose_message(

data/lib/mongoid/errors/invalid_discriminator_key_target.rb

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

data/lib/mongoid/errors/invalid_elem_match_operator.rb

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

data/lib/mongoid/errors/invalid_estimated_count_criteria.rb

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

data/lib/mongoid/errors/invalid_expression_operator.rb

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

data/lib/mongoid/errors/invalid_field.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Errors
@@ -40,8 +39,6 @@ module Mongoid
       # @param [ Symbol ] name The method name.
       #
       # @return [ Class, Module ] The originating class or module.
-      #
-      # @since 3.0.0
       def origin(klass, name)
         klass.instance_method(name).owner
       end
@@ -55,8 +52,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,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Errors

data/lib/mongoid/errors/invalid_field_option.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Errors
@@ -17,8 +16,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_find.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Errors
@@ -11,8 +10,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_includes.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Errors
@@ -15,8 +14,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,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Errors
@@ -15,8 +14,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,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Errors
@@ -15,8 +14,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,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Errors
@@ -13,8 +12,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,9 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 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 +13,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,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Errors

data/lib/mongoid/errors/invalid_relation.rb

@@ -1,13 +1,10 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 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.
@@ -42,8 +39,6 @@ module Mongoid
       # @param [ Symbol ] name The method name.
       #
       # @return [ Class, Module ] The originating class or module.
-      #
-      # @since 6.0.0
       def origin(klass, name)
         klass.instance_method(name).owner
       end
@@ -57,8 +52,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,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Errors
@@ -16,8 +15,6 @@ module Mongoid
       # @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,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Errors
@@ -14,8 +13,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_use.rb

@@ -1,13 +1,10 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Errors
 
     # This error is raised when a session is attempted to be used with a model whose client cannot use it, if
     #   sessions are nested, or if the mongodb deployment doesn't support sessions.
-    #
-    # @since 6.4.0
     class InvalidSessionUse < MongoidError
 
       # Create the error.
@@ -15,9 +12,7 @@ module Mongoid
       # @example Create the error.
       #   InvalidSessionUse.new(:invalid_session_use)
       #
-      # @param [ :invalid_sesion_use, :invalid_session_nesting ] error_type The type of session misuse.
-      #
-      # @since 6.4.0
+      # @param [ :invalid_session_use, :invalid_session_nesting ] error_type The type of session misuse.
       def initialize(error_type)
         super(compose_message(error_type.to_s))
       end

data/lib/mongoid/errors/invalid_set_polymorphic_relation.rb

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

data/lib/mongoid/errors/invalid_storage_options.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Errors
@@ -14,8 +13,6 @@ module Mongoid
       #
       # @param [ Class ] klass The model class.
       # @param [ Hash, String, Symbol ] options The provided options.
-      #
-      # @since 3.0.0
       def initialize(klass, options)
         super(
           compose_message(

data/lib/mongoid/errors/invalid_storage_parent.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Errors
@@ -13,8 +12,6 @@ module Mongoid
       #    InvalidStorageParent.new(Person)
       #
       # @param [ Class ] klass The model class.
-      #
-      # @since 4.0.0
       def initialize(klass)
         super(
           compose_message(

data/lib/mongoid/errors/invalid_time.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Errors
@@ -14,8 +13,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_value.rb

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

data/lib/mongoid/errors/inverse_not_found.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Errors
@@ -16,8 +15,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,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Errors
@@ -15,8 +14,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,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Errors
@@ -18,8 +17,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,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Errors
@@ -19,8 +18,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)
@@ -60,8 +57,6 @@ module Mongoid
       # @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
@@ -75,8 +70,6 @@ module Mongoid
       # @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
@@ -90,8 +83,6 @@ module Mongoid
       # @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,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Errors
@@ -15,8 +14,6 @@ module Mongoid
       #
       # @param [ Class ] klass The class of the document.
       # @param [ Symbol, String ] name The name of the association
-      #
-      # @since 3.0.0
       def initialize(klass, name)
         super(
           compose_message(

data/lib/mongoid/errors/no_client_config.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Errors
@@ -14,8 +13,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,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Errors
@@ -14,8 +13,6 @@ module Mongoid
       #
       # @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,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Errors
@@ -14,8 +13,6 @@ module Mongoid
       #
       # @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,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Errors
@@ -12,8 +11,6 @@ module Mongoid
       #
       # @example Create the error.
       #   NoClientsConfig.new
-      #
-      # @since 3.0.0
       def initialize
         super(compose_message("no_clients_config", {}))
       end

data/lib/mongoid/errors/no_default_client.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Errors
@@ -13,8 +12,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,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Errors
@@ -11,8 +10,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,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Errors
@@ -14,8 +13,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,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Errors
@@ -13,8 +12,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,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Errors
@@ -14,8 +13,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,4 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 module Mongoid
   module Errors
@@ -15,8 +14,6 @@ module Mongoid
       #
       # @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,18 @@
 # frozen_string_literal: true
-# encoding: utf-8
 
 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