mongoid 7.2.1 → 9.0.0

data/lib/config/locales/en.yml

@@ -1,4 +1,8 @@
 en:
+  errors:
+    messages:
+      taken: "has already been taken"
+
   mongoid:
     errors:
       messages:
@@ -19,6 +23,17 @@ en:
           resolution: "On the %{name} association on %{inverse} you must add an
             :inverse_of option to specify the exact association on %{klass}
             that is the opposite of %{name}."
+        attribute_not_loaded:
+          message: "Attempted to access attribute '%{name}' on %{klass} which
+            was not loaded."
+          summary:
+            "You loaded an instance of %{klass} using a query projection method
+            such as `.only` or `.without`, then attempted to read or write an
+            attribute '%{name}' which was not included in the projection.
+            Mongoid intentionally prevents this to avoid overwriting data."
+          resolution: "Ensure your query projection methods such as `.only` and
+            `.without` include field '%{name}' when loading instances of %{klass},
+            or remove such projections methods entirely."
         callbacks:
           message: "Calling %{method} on %{klass} resulted in a false return
             from a callback."
@@ -27,6 +42,17 @@ en:
             since the document did not actually get saved."
           resolution: "Double check all before callbacks to make sure they are
             not unintentionally returning false."
+        create_collection_failure:
+          message: "Cannot create collection %{collection_name}
+            with options %{collection_options}. The following error was raised:
+            %{error}."
+          summary: "The server rejected createCollection command with given collection
+            options. This may happen when some of the options are invalid, or not
+            supported by your version of the server."
+          resolution: "Double check that collection options for the collection
+            %{collection_name} are valid. Consult with Ruby driver documentation
+            and MongoDB documentation if the desired options are supported by
+            your version of the server."
         criteria_argument_required:
           message: "Calling Criteria methods with nil arguments is not allowed."
           summary: "Arguments to Criteria methods cannot be nil, and most
@@ -61,7 +87,7 @@ en:
             and the following ids were not found: %{missing}."
           resolution: "Search for an id that is in the database or set
             the Mongoid.raise_not_found_error configuration option to false,
-            which will cause a nil to be returned instead of raising this error when
+            which will cause nil to be returned instead of raising this error when
             searching for a single id, or only the matched documents when searching
             for multiples."
         document_with_attributes_not_found:
@@ -71,15 +97,35 @@ en:
             will be raised."
           resolution: "Search for attributes that are in the database or set
             the Mongoid.raise_not_found_error configuration option to false,
-            which will cause a nil to be returned instead of raising this error."
-        eager_load:
-          message: "Eager loading :%{name} is not supported since it is a
-            polymorphic belongs_to association."
-          summary: "Mongoid cannot currently determine the classes it needs to
-            eager load when the association is polymorphic. The parents reside in
-            different collections so a simple id lookup is not sufficient enough."
-          resolution: "Don't attempt to perform this action and have patience,
-            maybe this will be supported in the future."
+            which will cause nil to be returned instead of raising this error."
+        document_with_shard_key_not_found:
+          message: "Document not found for class %{klass} with id %{missing} and
+            shard key %{shard_key}."
+          summary: "When calling %{klass}.find with an id and a shard key, each
+            parameter must match a document in the database or this error will
+            be raised. The search was for the id: %{missing} with
+            shard_key: %{shard_key} and it was not found."
+          resolution: "Search for an id/shard key that is in the database or set
+            the Mongoid.raise_not_found_error configuration option to false,
+            which will cause nil to be returned instead of raising this error."
+        drop_collection_failure:
+          message: "Cannot drop collection %{collection_name}."
+          summary: "Mongoid tried to drop collection %{collection_name}, but the
+            collection still exists in the database."
+          resolution: "Try to drop the collection manually using Ruby driver or
+            mongo shell."
+        empty_config_file:
+          message: "Empty configuration file: %{path}."
+          summary: "Your mongoid.yml configuration file appears to be empty."
+          resolution: "Ensure your configuration file contains the correct contents.
+            Refer to: https://www.mongodb.com/docs/mongoid/current/reference/configuration/"
+        immutable_attribute:
+          message: "Attempted to change the immutable attribute '%{name}' with
+            the value: %{value}."
+          summary: "Immutable attributes can only have values set when the
+            document is a new record."
+          resolution: "Do not attempt to update the value of '%{name}' after
+            the document is persisted."
         invalid_collection:
           message: "Access to the collection for %{klass} is not allowed."
           summary: "%{klass}.collection was called, and %{klass} is an embedded
@@ -94,6 +140,37 @@ en:
             A collation option is only supported if the query is executed on a MongoDB server
             with version >= 3.4."
           resolution: "Remove the collation option from the query."
+        invalid_async_query_executor:
+          message: "Invalid async_query_executor option: %{executor}."
+          summary: "A invalid async query executor was specified.
+            The valid options are: %{options}."
+          resolution: "Pick an allowed option or fix the typo. If you were
+            expecting the option to be there, please consult the following page
+            with respect to Mongoid's configuration:\n\n
+            \_\_https://www.mongodb.com/docs/mongoid/current/reference/configuration/#mongoid-configuration-options"
+        invalid_auto_encryption_configuration:
+          message: "Invalid automatic encryption configuration for client %{client}."
+          summary: "Automatic encryption options for client %{client} are
+            incomplete or invalid."
+          resolution: "Please consult the following page with respect to
+            automatic encryption configuration:\n\n
+            \_\_https://www.mongodb.com/docs/ruby-driver/current/reference/client-side-encryption/#auto-encryption-options"
+        invalid_auto_encryption_configuration_for_kms_provider:
+          message: "Automatic encryption configuration for client %{client} does
+            not include options for kms_provider %{kms_provider}"
+          summary: "Automatic encryption configuration for client %{client} does
+            not include options for kms_provider %{kms_provider} in :kms_providers
+            hash."
+          resolution: "Check kms_provider name and :kms_providers options.
+            Please consult the following page with respect to
+            automatic encryption configuration:\n\n
+            \_\_https://www.mongodb.com/docs/ruby-driver/current/reference/client-side-encryption/#auto-encryption-options"
+        invalid_config_file:
+          message: "Invalid configuration file: %{path}."
+          summary: "Your mongoid.yml configuration file does not contain the
+            correct file structure."
+          resolution: "Ensure your configuration file contains the correct contents.
+            Refer to: https://www.mongodb.com/docs/mongoid/current/reference/configuration/"
         invalid_config_option:
           message: "Invalid configuration option: %{name}."
           summary: "A invalid configuration option was provided in your
@@ -101,7 +178,7 @@ en:
             options are: %{options}."
           resolution: "Remove the invalid option or fix the typo. If you were
             expecting the option to be there, please consult the following page
-            with repect to Mongoid's configuration:\n\n
+            with respect to Mongoid's configuration:\n\n
             \_\_http://mongoid.org/en/mongoid/docs/installation.html"
         invalid_dependent_strategy:
           message: "Invalid dependent strategy: %{invalid_strategy}."
@@ -115,6 +192,17 @@ en:
             allowed."
           resolution: "Try setting the discriminator key on %{superclass} or one of %{class_name}'s
             ancestors."
+        invalid_dot_dollar_assignment:
+          message: "Cannot set the %{attr} attribute on the %{klass} class."
+          summary: "Calling the setters for fields that start with a dollar
+            sign ($) or contain a dot/period (.) is prohibited. See the
+            Mongoid documentation on Field Names with Dots/Periods (.) and
+            Dollar Signs ($) for more information."
+          resolution: "In order to set fields that start with a dollar
+            sign ($) or contain a dot/period (.), the aggregation pipeline can
+            be used. MongoDB provides specific operators for working with these
+            fields. Refer to the MongoDB documentation here:
+            https://www.mongodb.com/docs/manual/core/dot-dollar-considerations/"
         invalid_elem_match_operator:
           message: "Invalid $elemMatch operator '%{operator}'."
           summary: "You misspelled an operator or are using an operator that
@@ -124,9 +212,14 @@ en:
         invalid_estimated_count_criteria:
           message: "Invalid criteria for estimated_count."
           summary: "Estimated count is strictly a collection-level operation and cannot be called
-            on a filtered critera."
-          resolution: "Try calling estimated_count directly on the class: %{class_name}.estimated_count.\n\n
-            \_If the class defines a default scope, use unscoped: %{class_name}.unscoped.estimated_count."
+            on a filtered criteria."
+          resolution: "Try calling estimated_count directly on the class: %{class_name}.estimated_count."
+        invalid_estimated_count_scoping:
+          message: "Invalid criteria for estimated_count."
+          summary: "Estimated count is strictly a collection-level operation and cannot be called
+            on a model that uses a default scope."
+          resolution: "Try calling estimated_count using unscoped: %{class_name}.unscoped.estimated_count.
+            Alternatively, the #count method can be used, which is usable with scoping."
         invalid_expression_operator:
           message: "Invalid expression operator '%{operator}'."
           summary: "You misspelled an operator, are using an operator that
@@ -135,7 +228,7 @@ en:
           resolution: "Valid expression operators are: %{valid_operators}.
             Ensure you are using one of these operators."
         invalid_field:
-          message: "Defining a field named '%{name}' is not allowed."
+          message: "Defining a field named '%{field}' is not allowed."
           summary: "Defining this field would override the method '%{name}',
             which would cause issues with expectations around the original
             method and cause extremely hard to debug issues. The original
@@ -160,14 +253,30 @@ en:
             field definition in order to prevent unexpected behavior later on."
           resolution: "When defining the field :%{name} on '%{klass}', please provide
             valid options for the field. These are currently: %{valid}. If you
-            meant to define a custom field option, please do so first like so:\n\n
+            meant to define a custom field option, please do so first as follows:\n\n
             \_\_Mongoid::Fields.option :%{option} do |model, field, value|\n
             \_\_\_\_# Your logic here...\n
             \_\_end\n
             \_\_class %{klass}\n
             \_\_\_\_include Mongoid::Document\n
             \_\_\_\_field :%{name}, %{option}: true\n
-            \_\_end\n\n"
+            \_\_end\n\n
+            Refer to:
+            https://www.mongodb.com/docs/mongoid/current/reference/fields/#custom-field-options"
+        invalid_field_type:
+          message: "Invalid field type %{type_inspection} for field '%{field}' on model '%{klass}'."
+          summary: "Model '%{klass}' defines a field '%{field}' with an unknown type value
+            %{type_inspection}."
+          resolution: "Please provide a valid type value for the field.
+            Refer to:
+            https://www.mongodb.com/docs/mongoid/current/reference/fields/#using-symbols-or-strings-instead-of-classes"
+        invalid_global_executor_concurrency:
+          message: "Invalid global_executor_concurrency option."
+          summary: "You set global_executor_concurrency while async_query_executor
+            option is not set to :global_thread_pool. The global_executor_concurrency is
+            allowed only for the global thread pool executor."
+          resolution: "Set global_executor_concurrency option to :global_thread_pool
+            or remove global_executor_concurrency option."
         invalid_includes:
           message: "Invalid includes directive: %{klass}.includes(%{args})"
           summary: "Eager loading in Mongoid only supports providing arguments
@@ -183,7 +292,6 @@ en:
             Valid options are:\n
             \_\_background: true|false\n
             \_\_database: 'database_name'\n
-            \_\_drop_dups: true|false\n
             \_\_name: 'index_name'\n
             \_\_sparse: true|false\n
             \_\_unique: true|false\n
@@ -202,7 +310,8 @@ en:
             \_\_language_override\n
             \_\_default_language\n
             \_\_collation\n
-            Valid types are: 1, -1, '2d', '2dsphere', 'geoHaystack', 'text', 'hashed'\n\n
+            \_\_wildcard_projection: { 'path.to.field.a': 1, 'path.to.field.b': 0 }\n
+            Valid types are: 1, -1, '2d', '2dsphere', 'geoHaystack (deprecated)', 'text', 'hashed'\n\n
             Example:\n
             \_\_class Band\n
             \_\_\_\_include Mongoid::Document\n
@@ -255,7 +364,7 @@ en:
           message: "Defining a scope of value %{value} on %{klass} is not
             allowed."
           summary: "Scopes in Mongoid must be procs that wrap criteria objects."
-          resolution: "Change the scope to be a proc wrapped critera.\n\n
+          resolution: "Change the scope to be a proc wrapped criteria.\n\n
             Example:\n
             \_\_class Band\n
             \_\_\_\_include Mongoid::Document\n
@@ -272,13 +381,13 @@ en:
             in the session block share the same driver client. For example, a model may have a different
             client specified in its 'store_in' options.\n\n"
         invalid_session_nesting:
-          message: "A session was started while another session was being used."
-          summary: "Sessions cannot be nested. Only one session can be used in a thread at once."
-          resolution: "Only use one session at a time; sessions cannot be nested."
+          message: "A session was started while another session was being used on this client."
+          summary: "Sessions cannot be nested. Only one session can be used in a thread per client."
+          resolution: "Only use one session per client at a time; sessions cannot be nested."
         invalid_storage_options:
           message: "Invalid options passed to %{klass}.store_in: %{options}."
           summary: "The :store_in macro takes only a hash of parameters with
-            the keys :database, :collection, or :client."
+            the keys :database, :collection, :collection_options, or :client."
           resolution: "Change the options passed to store_in to match the
             documented API, and ensure all keys in the options hash are
             symbols.\n\n
@@ -287,12 +396,6 @@ en:
             \_\_\_\_include Mongoid::Document\n
             \_\_\_\_store_in collection: 'artists', database: 'music'\n
             \_\_end\n\n"
-        invalid_storage_parent:
-          message: "Invalid store_in call on class %{klass}."
-          summary: "The :store_in macro can only be called on a base Mongoid Document"
-          resolution: "Remove the store_in call on class %{klass}, as it will use its
-            parent store configuration. Or remove the hierarchy extension for this
-            class."
         invalid_time:
           message: "'%{value}' is not a valid Time."
           summary: "Mongoid tries to serialize the values for Date, DateTime, and
@@ -302,6 +405,10 @@ en:
             for Date, DateTime, and Time objects. When this is a String it needs
             to be valid for Time.parse. Other objects must be valid to pass to
             Time.local."
+        invalid_transaction_nesting:
+          message: "A transaction was started while another transaction was being used on this client."
+          summary: "Transactions cannot be nested. Only one transaction can be used in a thread per client."
+          resolution: "Only use one transaction per client at a time; transactions cannot be nested."
         inverse_not_found:
           message: "When adding a(n) %{klass} to %{base}#%{name}, Mongoid could
             not determine the inverse foreign key to set. The attempted key was
@@ -336,10 +443,6 @@ en:
             from the child side which association to go in."
           resolution: "Set the values from the parent, or redefine the association
             with only a single definition in the parent."
-        invalid_value:
-          message: "Value of type %{value_class} cannot be written to a field of type %{field_class}"
-          summary: "Tried to set a value of type %{value_class} to a field of type %{field_class}"
-          resolution: "Verify if the value to be set correspond to field definition"
         mixed_relations:
           message: "Referencing a(n) %{embedded} document from the %{root}
             document via a non-embedded association is not allowed since the
@@ -391,17 +494,23 @@ en:
             \_\_\_\_\_\_default:\n
             \_\_\_\_\_\_\_\_hosts:\n
             \_\_\_\_\_\_\_\_\_\_- localhost:27017\n\n"
+        no_documents_found:
+          message: "Could not find a document of class %{klass}."
+          summary: "Mongoid attempted to find a document of the class %{klass}
+            but none exist."
+          resolution: "Create a document of class %{klass} or use a finder
+            method that does not raise an exception when no documents are
+            found."
         no_environment:
           message: "Could not load the configuration since no environment
             was defined."
-          summary: "Mongoid attempted to find the appropriate environment
-            but no Rails.env, Sinatra::Base.environment, RACK_ENV, or
-            MONGOID_ENV could be found."
-          resolution: "Make sure some environment is set from the mentioned
-            options. Mongoid cannot load configuration from the yaml without
-            knowing which environment it is in, and we have considered
-            defaulting to development an undesireable side effect of this not
-            being defined."
+          summary: "Mongoid could not determine the environment to use because
+            it was not specified in any of the following locations:
+            Rails.env, Sinatra::Base.environment,
+            ENV[\"RACK_ENV\"], ENV[\"MONGOID_ENV\"]. Without knowing the
+            environment, Mongoid cannot load its configuration."
+          resolution: "Please ensure an environment is set in one of the
+            listed locations. The environment must be explicitly set."
         no_map_reduce_output:
           message: "No output location was specified for the map/reduce
             operation."
@@ -450,7 +559,7 @@ en:
             to connect."
           resolution: "Double check your mongoid.yml to make sure under the
             clients key that a configuration exists for '%{name}'. If you
-            have set the configuration programatically, ensure that '%{name}'
+            have set the configuration programmatically, ensure that '%{name}'
             exists in the configuration hash."
         no_clients_config:
           message: "No clients configuration provided."
@@ -506,9 +615,8 @@ en:
           resolution: "Don't define '%{name}' as readonly, or do not attempt
             to update its value after the document is persisted."
         readonly_document:
-          message: "Attempted to persist the readonly document '%{klass}'."
-          summary: "Documents loaded from the database using #only
-            cannot be persisted."
+          message: "Attempted to persist a readonly document of class '%{klass}'."
+          summary: "Documents that are marked readonly cannot be persisted."
           resolution: "Don't attempt to persist documents that are flagged as
             readonly."
         scope_overwrite:
@@ -528,34 +636,46 @@ en:
             server versions 3.6 and higher."
           resolution: "Verify that all servers in your deployment are at least
             version 3.6 or don't attempt to use sessions with older server versions."
-        taken:
-          "is already taken"
         too_many_nested_attribute_records:
           message: "Accepting nested attributes for %{association} is limited
-            to %{limit} records."
+            to %{limit} documents."
           summary: "More documents were sent to be processed than the allowed
             limit."
           resolution: "The limit is set as an option to the macro, for example:
             accepts_nested_attributes_for :%{association}, limit: %{limit}.
             Consider raising this limit or making sure no more are sent than
             the set value."
+        transactions_not_supported:
+          message: "Transactions are not supported by the connected server(s)."
+          summary: "A session was attempted to be used with a MongoDB server version
+            that doesn't support transactions. Transactions are supported in MongoDB
+            server versions 3.6 and higher."
+          resolution: "Verify that all servers in your deployment are at least
+            version 3.6 or don't attempt to use transactions with older server versions."
+        transaction_error:
+          message: "Transaction failed with the following error: %{error}."
+          summary: "The transaction failed because MongoDB server or MongoDB driver
+            raised an unexpected error."
+          resolution: "Consult with Ruby driver documentation
+            and MongoDB documentation."
         unknown_attribute:
           message: "Attempted to set a value for '%{name}' which is not
             allowed on the model %{klass}."
-          summary: "Without including Mongoid::Attributes::Dynamic in your model
-            and the attribute does not already exist in the attributes hash,
-            attempting to call %{klass}#%{name}= for it is not allowed. This is
-            also triggered by passing the attribute to any method that accepts an
-            attributes hash, and is raised instead of getting a NoMethodError."
-          resolution: "You can include Mongoid::Attributes::Dynamic if you
-            expect to be writing values for undefined fields often."
+          summary: "%{klass}#%{name}= was called but there is no '%{name}'
+            field defined in the model, and Mongoid::Attributes::Dynamic is
+            not included. This error is also raised instead of NoMethodError
+            if the unknown attribute is passed to any method that accepts an
+            attributes hash, such as #attributes=."
+          resolution: "Define the field '%{name}' in %{klass}, or include
+            Mongoid::Attributes::Dynamic in %{klass} if you intend to
+            store values in fields that are not explicitly defined."
         unknown_model:
-          message: "Attempted to instantiate an object of the unknown Model '%{klass}'."
+          message: "Attempted to instantiate an object of the unknown model '%{klass}'."
           summary: "A document with the value '%{value}' at the key '_type' was used to
             instantiate a model object but Mongoid cannot find this Class."
           resolution: "The _type field is a reserved one used by Mongoid to determine the
             class for instantiating an object. Please don't save data in this field or ensure
-            that any values in this field correspond to valid Models."
+            that any values in this field correspond to valid models."
         unsaved_document:
           message: "Attempted to save %{document} before the parent %{base}."
           summary: "You cannot call create or create! through the
@@ -578,9 +698,20 @@ en:
           resolution: "Try persisting the document with valid data or remove
             the validations."
         delete_restriction:
-          message: "Cannot delete %{document} because of dependent '%{relation}'."
+          message: "Cannot destroy %{document} because of dependent '%{relation}'."
           summary: "When defining '%{relation}' with a :dependent => :restrict_with_error,
-            Mongoid will raise an error when attempting to delete the
+            Mongoid will raise an error when attempting to destroy the
             %{document} when the child '%{relation}' still has documents in it."
           resolution: "Don't attempt to delete the parent %{document} when
             it has children, or change the dependent option on the association."
+        client_session_mismatch:
+          message: "%{model} used within another client's session"
+          summary: >
+            Each model is associated with a client. Each session (transaction)
+            is also associated with a client. You've attempted to create or
+            update a model within a session associated with a different client.
+            This may be a bug in your code.
+          resolution: >
+            Either process the %{model} model outside the enclosing
+            transaction, or open a new transaction for that model before
+            performing the create/update.