mongoid 5.4.1 → 7.4.0

data/lib/config/locales/en.yml

@@ -7,16 +7,17 @@ en:
         message_title: "message"
         summary_title: "summary"
         resolution_title: "resolution"
+
         ambiguous_relationship:
-          message: "Ambiguous relations %{candidates} defined on %{klass}."
+          message: "Ambiguous associations %{candidates} defined on %{klass}."
           summary:
-            "When Mongoid attempts to set an inverse document of a relation
-            in memory, it needs to know which relation it belongs to. When
+            "When Mongoid attempts to set an inverse document of an association
+            in memory, it needs to know which association it belongs to. When
             setting %{name}, Mongoid looked on the class %{inverse}
-            for a matching relation, but multiples were found that could
+            for a matching association, but multiples were found that could
             potentially match: %{candidates}."
-          resolution: "On the %{name} relation on %{inverse} you must add an
-            :inverse_of option to specify the exact relationship on %{klass}
+          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}."
         callbacks:
           message: "Calling %{method} on %{klass} resulted in a false return
@@ -26,6 +27,15 @@ en:
             since the document did not actually get saved."
           resolution: "Double check all before callbacks to make sure they are
             not unintentionally returning false."
+        criteria_argument_required:
+          message: "Calling Criteria methods with nil arguments is not allowed."
+          summary: "Arguments to Criteria methods cannot be nil, and most
+            Criteria methods require at least one argument. Only logical
+            operations (and, or, nor and not), `all' and `where' can be called
+            without arguments.
+            The method that was called with nil argument was: %{query_method}."
+          resolution: "Invoke Criteria methods with non-nil arguments or omit
+            the respective invocations."
         calling_document_find_with_nil_is_invalid:
           message: "Calling Document.find with nil is invalid."
           summary: "Document.find expects the parameters to be 1 or more ids, and
@@ -34,6 +44,8 @@ en:
           resolution: "Most likely this is caused by passing parameters directly
             through to the find, and the parameter either is not present or the
             key from which it is accessed is incorrect."
+        destroy_restrict_with_error_dependencies_exist:
+          "is not empty and prevents the document from being destroyed"
         document_not_destroyed:
           message: "%{klass} with id %{id} was not destroyed."
           summary: "When calling %{klass}#destroy! and a callback halts the destroy
@@ -62,12 +74,17 @@ en:
             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 relation."
+            polymorphic belongs_to association."
           summary: "Mongoid cannot currently determine the classes it needs to
-            eager load when the relation is polymorphic. The parents reside in
+            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."
+        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://docs.mongodb.com/mongoid/current/reference/configuration/"
         invalid_collection:
           message: "Access to the collection for %{klass} is not allowed."
           summary: "%{klass}.collection was called, and %{klass} is an embedded
@@ -82,6 +99,12 @@ 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_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://docs.mongodb.com/mongoid/current/reference/configuration/"
         invalid_config_option:
           message: "Invalid configuration option: %{name}."
           summary: "A invalid configuration option was provided in your
@@ -89,8 +112,39 @@ 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}."
+          summary: "An invalid dependent strategy was defined for the association:
+            %{association}. The valid strategies are: %{valid_strategies}."
+          resolution: "Change the dependent strategy to one of the valid types."
+        invalid_discriminator_key_target:
+          message: "Setting the discriminator key on a child class is not allowed."
+          summary: "The discriminator key on the class %{class_name} was attempted
+            to be changed. Changing the discriminator key on a child class is not
+            allowed."
+          resolution: "Try setting the discriminator key on %{superclass} or one of %{class_name}'s
+            ancestors."
+        invalid_elem_match_operator:
+          message: "Invalid $elemMatch operator '%{operator}'."
+          summary: "You misspelled an operator or are using an operator that
+            Mongoid does not support."
+          resolution: "Valid field operators are: %{valid_operators}.
+            Ensure you are using one of these operators."
+        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 criteria."
+          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."
+        invalid_expression_operator:
+          message: "Invalid expression operator '%{operator}'."
+          summary: "You misspelled an operator, are using an operator that
+            Mongoid does not support, or are trying to use a field-level
+            operator on expression level."
+          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."
           summary: "Defining this field would override the method '%{name}',
@@ -104,26 +158,35 @@ en:
             allowed, and don't use these names. These include names that also
             conflict with core Ruby methods on Object, Module, Enumerable, or
             included gems that inject methods into these or Mongoid internals."
+        invalid_field_operator:
+          message: "Invalid field operator '%{operator}'."
+          summary: "You misspelled an operator, are using an operator that
+            Mongoid does not support, or are trying to use an expression-level
+            operator on field level."
+          resolution: "Valid field operators are: %{valid_operators}.
+            Ensure you are using one of these operators."
         invalid_field_option:
           message: "Invalid option :%{option} provided for field :%{name}."
           summary: "Mongoid requires that you only provide valid options on each
-            field definition in order to prevent unexpected behaviour later on."
+            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://docs.mongodb.com/mongoid/current/reference/fields/#custom-field-options"
         invalid_includes:
           message: "Invalid includes directive: %{klass}.includes(%{args})"
           summary: "Eager loading in Mongoid only supports providing arguments
-            to %{klass}.includes that are the names of relations on the %{klass}."
+            to %{klass}.includes that are the names of associations on the %{klass}."
           resolution: "Ensure that each parameter passed to %{klass}.includes is
-            a valid name of a relation on the %{klass} model. These are: %{relations}."
+            a valid name of an association on the %{klass} model. These are: %{relations}."
         invalid_index:
           message: "Invalid index specification on %{klass}: %{spec}, %{options}"
           summary: "Indexes in Mongoid are defined as a hash of field name and
@@ -160,8 +223,8 @@ en:
             \_\_\_\_index({ location: '2d' }, { background: true })\n
             \_\_end\n\n"
         invalid_options:
-          message: "Invalid option :%{invalid} provided to relation :%{name}."
-          summary: "Mongoid checks the options that are passed to the relation
+          message: "Invalid option :%{invalid} provided to association :%{name}."
+          summary: "Mongoid checks the options that are passed to the association
             macros to ensure that no ill side effects occur by letting something
             slip by."
           resolution: "Valid options are: %{valid}, make sure these are the ones
@@ -174,19 +237,57 @@ en:
             root path assigned."
           resolution: "Most likely your embedded model, %{klass} is also
             referenced via a has_many from a root document in another
-            collection. Double check the relation definitions and fix any
+            collection. Double check the association definitions and fix any
             instances where embedded documents are improperly referenced
             from other collections."
+        invalid_persistence_option:
+          message: "Invalid persistence option :%{invalid}."
+          summary: "The options used to change the persistence context must be one
+             of the valid options for a mongo client, or a collection name."
+          resolution: "Valid options are: %{valid}, make sure these are the ones
+             you are using."
+        invalid_relation:
+          message: "Defining an association named '%{name}' is not allowed."
+          summary: "Defining this association would override the method '%{name}',
+            which would cause issues with expectations around the original
+            method and cause extremely hard to debug issues. The original
+            method was defined in:\n
+            \_\_Object: %{origin}\n
+            \_\_File: %{file}\n
+            \_\_Line: %{line}"
+          resolution: "Use Mongoid.destructive_fields to see what names are not
+            allowed, and don't use these names. These include names that also
+            conflict with core Ruby methods on Object, Module, Enumerable, or
+            included gems that inject methods into these or Mongoid internals."
+        invalid_relation_option:
+          message: "Invalid association option :%{option} for association '%{name}' on class
+            %{klass}."
+          summary: "An invalid option was provided for an association."
+          resolution: "Valid options are: %{valid_options}, make sure you use only those."
         invalid_scope:
           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
             \_\_\_\_scope :inactive, ->{ where(active: false) }\n
             \_\_end\n\n"
+        invalid_session_use:
+          message: "A session was attempted to be used with a model whose client cannot use
+            that session."
+          summary: "Sessions are started via driver clients (Model#mongo_client) and, in most cases, driver
+            clients are shared across models. When different models have their own clients, a session cannot
+            be obtained via one model and used for operations on another model."
+          resolution: "Only execute operations on the model class or instances of the model through which
+            the session was created. Otherwise, ensure that all models on which operations are executed
+            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."
         invalid_storage_options:
           message: "Invalid options passed to %{klass}.store_in: %{options}."
           summary: "The :store_in macro takes only a hash of parameters with
@@ -197,7 +298,7 @@ en:
             Example:\n
             \_\_class Band\n
             \_\_\_\_include Mongoid::Document\n
-            \_\_\_\_store_in collection: 'artists', database: 'secondary'\n
+            \_\_\_\_store_in collection: 'artists', database: 'music'\n
             \_\_end\n\n"
         invalid_storage_parent:
           message: "Invalid store_in call on class %{klass}."
@@ -218,35 +319,35 @@ en:
           message: "When adding a(n) %{klass} to %{base}#%{name}, Mongoid could
             not determine the inverse foreign key to set. The attempted key was
             '%{inverse}'."
-          summary: "When adding a document to a relation, Mongoid attempts
-            to link the newly added document to the base of the relation in
+          summary: "When adding a document to an association, Mongoid attempts
+            to link the newly added document to the base of the association in
             memory, as well as set the foreign key to link them on the
             database side. In this case Mongoid could not determine what the
             inverse foreign key was."
           resolution: "If an inverse is not required, like a belongs_to or
             has_and_belongs_to_many, ensure that :inverse_of => nil is set
-            on the relation. If the inverse is needed, most likely the
-            inverse cannot be figured out from the names of the relations and
-            you will need to explicitly tell Mongoid on the relation what
+            on the association. If the inverse is needed, most likely the
+            inverse cannot be figured out from the names of the associations and
+            you will need to explicitly tell Mongoid on the association what
             the inverse is.\n\n
             Example:\n
-            \_\_class Lush\n
+            \_\_class Car\n
             \_\_\_\_include Mongoid::Document\n
-            \_\_\_\_has_one :whiskey, class_name: \"Drink\", inverse_of: :alcoholic\n
+            \_\_\_\_has_one :engine, class_name: \"Motor\", inverse_of: :machine\n
             \_\_end\n\n
-            \_\_class Drink\n
+            \_\_class Motor\n
             \_\_\_\_include Mongoid::Document\n
-            \_\_\_\_belongs_to :alcoholic, class_name: \"Lush\", inverse_of: :whiskey\n
+            \_\_\_\_belongs_to :machine, class_name: \"Car\", inverse_of: :engine\n
             \_\_end"
         invalid_set_polymorphic_relation:
           message: "The %{name} attribute can't be set to an instance of
-            %{other_klass} as %{other_klass} has multiple relations referencing
+            %{other_klass} as %{other_klass} has multiple associations referencing
             %{klass} as %{name}."
-          summary: "If the parent class of a polymorphic relation has multiple
-            definitions for the same relation, the values must be set from the
+          summary: "If the parent class of a polymorphic association has multiple
+            definitions for the same association, the values must be set from the
             parent side and not the child side since Mongoid cannot determine
-            from the child side which relation to go in."
-          resolution: "Set the values from the parent, or redefine the relation
+            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}"
@@ -254,7 +355,7 @@ en:
           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 relational association is not allowed since the
+            document via a non-embedded association is not allowed since the
             %{embedded} is embedded."
           summary: "In order to properly access a(n) %{embedded} from %{root}
             the reference would need to go through the root document of
@@ -274,15 +375,15 @@ en:
           resolution: "Provide either only a uri as configuration or only
             standard options."
         nested_attributes_metadata_not_found:
-          message: "Could not find metadata for relation '%{name}' on model:
+          message: "Could not find metadata for association '%{name}' on model:
             %{klass}."
-          summary: "When defining nested attributes for a relation, Mongoid
-            needs to access the metadata for the relation '%{name}' in order
+          summary: "When defining nested attributes for an association, Mongoid
+            needs to access the metadata for the association '%{name}' in order
             if add autosave functionality to it, if applicable. Either no
-            relation named '%{name}' could be found, or the relation had not
+            association named '%{name}' could be found, or the association had not
             been defined yet."
-          resolution: "Make sure that there is a relation defined named
-            '%{name}' on %{klass} or that the relation definition comes before
+          resolution: "Make sure that there is an association defined named
+            '%{name}' on %{klass} or that the association definition comes before
             the accepts_nested_attributes_for macro in the model - order
             matters so that Mongoid has access to the metadata.\n\n
             Example:\n
@@ -312,7 +413,7 @@ en:
           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
+            defaulting to development an undesirable side effect of this not
             being defined."
         no_map_reduce_output:
           message: "No output location was specified for the map/reduce
@@ -330,16 +431,16 @@ en:
             \_\_reduce:  'collection-name'\n\n"
         no_metadata:
           message: "Metadata not found for document of type %{klass}."
-          summary: "Mongoid sets the metadata of a relation on the document
-            when it is either loaded from within the relation, or added to
+          summary: "Mongoid sets the metadata of an association on the document
+            when it is either loaded from within the association, or added to
             one. The presence of the metadata is required in order to
-            provide various functionality around relations. Most likely you
+            provide various functionality around associations. Most likely you
             are getting this error because the document is embedded and was
             attempted to be persisted without being associated with a parent,
-            or the relation was not properly defined."
-          resolution: "Ensure that your relations on the %{klass} model
-            are all properly defined, and that the inverse relations
-            are also properly defined. Embedded relations must have both the
+            or the association was not properly defined."
+          resolution: "Ensure that your associations on the %{klass} model
+            are all properly defined, and that the inverse associations
+            are also properly defined. Embedded associations must have both the
             parent (embeds_one/embeds_many) and the inverse (embedded_in)
             present in order to work properly."
         no_parent:
@@ -350,9 +451,9 @@ en:
             most likely caused by either calling %{klass}.create or
             %{klass}.create! without setting the parent document as an
             attribute."
-          resolution: "Ensure that you've set the parent relation if
+          resolution: "Ensure that you've set the parent association if
             instantiating the embedded document directly, or always create new
-            embedded documents via the parent relation."
+            embedded documents via the parent association."
         no_client_config:
           message: "No configuration could be found for a client named
             '%{name}'."
@@ -362,7 +463,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."
@@ -433,6 +534,13 @@ en:
             with the already defined method %{model_name}, or set the
             configuration option Mongoid.scope_overwrite_exception to false,
             which is its default. In this case a warning will be logged."
+        sessions_not_supported:
+          message: "Sessions 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 sessions. Sessions 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 sessions with older server versions."
         taken:
           "is already taken"
         too_many_nested_attribute_records:
@@ -447,17 +555,25 @@ en:
         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}'."
+          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."
         unsaved_document:
           message: "Attempted to save %{document} before the parent %{base}."
           summary: "You cannot call create or create! through the
-            relation (%{document}) whose parent (%{base}) is
+            association (%{document}) whose parent (%{base}) is
             not already saved. This would cause the database to be out of sync
             since the child could potentially reference a nonexistent parent."
           resolution: "Make sure to only use create or create! when the parent
@@ -469,16 +585,16 @@ en:
             #where criterion on embedded documents. Since %{klass} is embedded,
             the expression %{javascript} is not allowed."
           resolution: "Please provide a standard hash to #where when the criteria
-            is for an embedded relation."
+            is for an embedded association."
         validations:
           message: "Validation of %{document} failed."
           summary: "The following errors were found: %{errors}"
           resolution: "Try persisting the document with valid data or remove
             the validations."
         delete_restriction:
-          message: "Cannot delete %{document} because of dependent '%{relation}'."
-          summary: "When defining '%{relation}' with a :dependent => :restrict,
-            Mongoid will raise an error when attempting to delete the
+          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 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 relation."
+            it has children, or change the dependent option on the association."