View on GitHub


Test Coverage
          "can't be blank in %{location}"
        message_title: "message"
        summary_title: "summary"
        resolution_title: "resolution"
          message: "Ambiguous relations %{candidates} defined on %{klass}."
            "When Mongoid attempts to set an inverse document of a relation
            in memory, it needs to know which relation it belongs to. When
            setting %{name}, Mongoid looked on the class %{inverse}
            for a matching relation, 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}
            that is the opposite of %{name}."
          message: "Calling %{method} on %{klass} resulted in a false return
            from a callback."
          summary: "If a before callback returns false when using Document.create!,
            Document#save!, or Document#update_attributes! this error will get raised
            since the document did not actually get saved."
          resolution: "Double check all before callbacks to make sure they are
            not unintentionally returning false."
          message: "Calling Document.find with nil is invalid."
          summary: "Document.find expects the parameters to be 1 or more ids, and
            will return a single document if 1 id is provided, otherwise an array
            of documents if multiple ids are provided."
          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."
          message: "%{klass} with id %{id} was not destroyed."
          summary: "When calling %{klass}#destroy! and a callback halts the destroy
            callback chain by returning a false value, the deletion will not
            actually occur."
          resolution: "Check the before/after destroy callbacks to ensure that the
            return values are truthy for the chain to continue."
          message: "Document(s) not found for class %{klass} with id(s) %{missing}."
          summary: "When calling %{klass}.find with an id or array of ids, each
            parameter must match a document in the database or this error will be
            raised. The search was for the id(s): %{searched} (%{total} total)
            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
            searching for a single id, or only the matched documents when searching
            for multiples."
          message: "Document not found for class %{klass} with attributes %{attributes}."
          summary: "When calling %{klass}.find_by with a hash of attributes, all
            attributes provided must match a document in the database or this error
            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."
          message: "Eager loading :%{name} is not supported since it is a
            polymorphic belongs_to relation."
          summary: "Mongoid cannot currently determine the classes it needs to
            eager load when the relation 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."
          message: "Access to the collection for %{klass} is not allowed."
          summary: "%{klass}.collection was called, and %{klass} is an embedded
            document - it resides within the collection of the root document of
            the hierarchy."
          resolution: "For access to the collection that the embedded document is
            in, use %{klass}#_root.collection, or do not attempt to persist an
            embedded document without a parent set."
          message: "Invalid configuration option: %{name}."
          summary: "A invalid configuration option was provided in your
            mongoid.yml, or a typo is potentially present. The valid configuration
            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
          message: "Defining a field named '%{name}' 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
            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."
          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."
          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
            \_\_Mongoid::Fields.option :%{option} do |model, field, value|\n
            \_\_\_\_# Your logic here...\n
            \_\_class %{klass}\n
            \_\_\_\_include Mongoid::Document\n
            \_\_\_\_field :%{name}, %{option}: true\n
          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}
            model, and only supports one level of eager loading. (ie, eager loading
            associations not on the %{klass} but one step away via another relation
            is not allowed."
          resolution: "Ensure that each parameter passed to %{klass}.includes is
            a valid name of a relation on the %{klass} model. These are: %{relations}."
          message: "Invalid index specification on %{klass}: %{spec}, %{options}"
          summary: "Indexes in Mongoid are defined as a hash of field name and
            direction/2d pairs, with a hash for any additional options."
          resolution: "Ensure that the index conforms to the correct syntax and
            has the correct options.\n\n
            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
            \_\_min: 1\n
            \_\_max: 1\n
            \_\_bits: 26\n
            \_\_bucket_size : 1\n
            \_\_weights: { content: 1, title: 2 }\n
            \_\_expire_after_seconds: number_of_seconds\n
            Valid types are: 1, -1, '2d', '2dsphere', 'geoHaystack', 'text', 'hashed'\n\n
            \_\_class Band\n
            \_\_\_\_include Mongoid::Document\n
            \_\_\_\_index({ name: 1, label: -1 }, { sparse: true })\n
            \_\_\_\_index({ location: '2d' }, { background: true })\n
          message: "Invalid option :%{invalid} provided to relation :%{name}."
          summary: "Mongoid checks the options that are passed to the relation
            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
            you are using."
          message: "Having a root path assigned for %{klass} is invalid."
          summary: "Mongoid has two different path objects for determining
            the location of a document in the database, Root and Embedded.
            This error is raised when an embedded document somehow gets a
            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
            instances where embedded documents are improperly referenced
            from other collections."
          message: "Defining a scope of value %{value} on %{klass} is not
          summary: "Scopes in Mongoid must be procs that wrap criteria objects."
          resolution: "Change the scope to be a proc wrapped critera.\n\n
            \_\_class Band\n
            \_\_\_\_include Mongoid::Document\n
            \_\_\_\_scope :inactive, ->{ where(active: false) }\n
          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."
          resolution: "Change the options passed to store_in to match the
            documented API, and ensure all keys in the options hash are
            \_\_class Band\n
            \_\_\_\_include Mongoid::Document\n
            \_\_\_\_store_in collection: 'artists', database: 'secondary'\n
          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
          message: "'%{value}' is not a valid Time."
          summary: "Mongoid tries to serialize the values for Date, DateTime, and
            Time into proper UTC times to store in the database. The provided
            value could not be parsed."
          resolution: "Make sure to pass parsable values to the field setter
            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
          message: "When adding a(n) %{klass} to %{base}#%{name}, Mongoid could
            not determine the inverse foreign key to set. The attempted key was
          summary: "When adding a document to a relation, Mongoid attempts
            to link the newly added document to the base of the relation 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
            the inverse is.\n\n
            \_\_class Lush\n
            \_\_\_\_include Mongoid::Document\n
            \_\_\_\_has_one :whiskey, class_name: \"Drink\", inverse_of: :alcoholic\n
            \_\_class Drink\n
            \_\_\_\_include Mongoid::Document\n
            \_\_\_\_belongs_to :alcoholic, class_name: \"Lush\", inverse_of: :whiskey\n
          message: "The %{name} attribute can't be set to an instance of
            %{other_klass} as %{other_klass} has multiple relations 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
            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
            with only a single definition in the parent."
          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"
          message: "Referencing a(n) %{embedded} document from the %{root}
            document via a relational 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
            %{embedded}. In a simple case this would require Mongoid to store
            an extra foreign key for the root, in more complex cases where
            %{embedded} is multiple levels deep a key would need to be stored
            for each parent up the hierarchy."
          resolution: "Consider not embedding %{embedded}, or do the key
            storage and access in a custom manner in the application code."
          message: "Both uri and standard configuration options defined for
            client: '%{name}'."
          summary: "Instead of simply giving uri or standard options a
            preference order, Mongoid assumes that you have made a mistake in
            your configuration and requires that you provide one or the other,
            but not both. The options that were provided were: %{config}."
          resolution: "Provide either only a uri as configuration or only
            standard options."
          message: "Could not find metadata for relation '%{name}' on model:
          summary: "When defining nested attributes for a relation, Mongoid
            needs to access the metadata for the relation '%{name}' in order
            if add autosave functionality to it, if applicable. Either no
            relation named '%{name}' could be found, or the relation 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
            the accepts_nested_attributes_for macro in the model - order
            matters so that Mongoid has access to the metadata.\n\n
            \_\_class Band\n
            \_\_\_\_include Mongoid::Document\n
            \_\_\_\_has_many :albums\n
            \_\_\_\_accepts_nested_attributes_for :albums\n
          message: "No default client configuration is defined."
          summary: "The configuration provided settings for: %{keys}, but
            Mongoid requires a :default to be defined at minimum."
          resolution: "If configuring via a mongoid.yml, ensure that within
            your :clients section a :default client is defined.\n\n
            \_\_\_\_\_\_\_\_\_\_- localhost:27017\n\n"
          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."
          message: "No output location was specified for the map/reduce
          summary: "When executing a map/reduce, you must provide the output
            location of the results. The attempted command was: %{command}."
          resolution: "Provide the location that the output of the operation
            is to go by chaining an #out call to the map/reduce.\n\n
            \_\_Band.map_reduce(map, reduce).out(inline: 1)\n\n
            Valid options for the out function are:\n
            \_\_inline:  1\n
            \_\_merge:   'collection-name'\n
            \_\_replace: 'collection-name'\n
            \_\_reduce:  'collection-name'\n\n"
          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
            one. The presence of the metadata is required in order to
            provide various functionality around relations. 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
            parent (embeds_one/embeds_many) and the inverse (embedded_in)
            present in order to work properly."
          message: "Cannot persist embedded document %{klass} without a
            parent document."
          summary: "If the document is embedded, in order to be persisted it
            must always have a reference to its parent document. This is
            most likely caused by either calling %{klass}.create or
            %{klass}.create! without setting the parent document as an
          resolution: "Ensure that you've set the parent relation if
            instantiating the embedded document directly, or always create new
            embedded documents via the parent relation."
          message: "No configuration could be found for a client named
          summary: "When attempting to create the new client, Mongoid could
            not find a client configuration for the name: '%{name}'. This is
            necessary in order to know the host, port, and options needed
            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}'
            exists in the configuration hash."
          message: "No clients configuration provided."
          summary: "Mongoid's configuration requires that you provide details
            about each client that can be connected to, and requires in
            the clients config at least 1 default client to exist."
          resolution: "Double check your mongoid.yml to make sure that you
            have a top-level clients key with at least 1 default client
            configuration for it. You can regenerate a new mongoid.yml for
            assistance via `rails g mongoid:config`.\n\n
            \_\_\_\_\_\_\_\_database: mongoid_dev\n
            \_\_\_\_\_\_\_\_\_\_- localhost:27017\n\n"
          message: "No database provided for client configuration: :%{name}."
          summary: "Each client configuration must provide a database so Mongoid
            knows where the default database to persist to. What was provided
            was: %{config}."
          resolution: "If configuring via a mongoid.yml, ensure that within
            your :%{name} section a :database value for the client's default
            database is defined.\n\n
            \_\_\_\_\_\_\_\_database: my_app_db\n
            \_\_\_\_\_\_\_\_\_\_- localhost:27017\n\n"
          message: "No hosts provided for client configuration: :%{name}."
          summary: "Each client configuration must provide hosts so Mongoid
            knows where the database server is located. What was provided
            was: %{config}."
          resolution: "If configuring via a mongoid.yml, ensure that within
            your :%{name} section a :hosts value for the client hosts is
            \_\_\_\_\_\_\_\_database: my_app_db\n
            \_\_\_\_\_\_\_\_\_\_- localhost:27017\n\n"
          message: "Attempted to set the readonly attribute '%{name}' with
            the value: %{value}."
          summary: "Attributes flagged as readonly via Model.attr_readonly
            can only have values set when the document is a new record."
          resolution: "Don't define '%{name}' as readonly, or do not attempt
            to update its value after the document is persisted."
          message: "Attempted to persist the readonly document '%{klass}'."
          summary: "Documents loaded from the database using #only
            cannot be persisted."
          resolution: "Don't attempt to persist documents that are flagged as
          message: "Cannot create scope :%{scope_name}, because of existing
            method %{model_name}.%{scope_name}."
          summary: "When defining a scope that conflicts with a method that
            already exists on the model, this error will get raised if
            Mongoid.scope_overwrite_exception is set to true."
          resolution: "Change the name of the scope so it does not conflict
            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."
          "is already taken"
          message: "Accepting nested attributes for %{association} is limited
            to %{limit} records."
          summary: "More documents were sent to be processed than the allowed
          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."
          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."
          message: "Attempted to save %{document} before the parent %{base}."
          summary: "You cannot call create or create! through the
            relation (%{document}) who's parent (%{base}) is
            not already saved. This would case the database to be out of sync
            since the child could potentially reference a nonexistant parent."
          resolution: "Make sure to only use create or create! when the parent
            document %{base} is persisted."
          message: "Executing Javascript $where selector on an embedded criteria
            is not supported."
          summary: "Mongoid only supports providing a hash of arguments to
            #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."
          message: "Validation of %{document} failed."
          summary: "The following errors were found: %{errors}"
          resolution: "Try persisting the document with valid data or remove
            the validations."
          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
            %{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."