Class: ActiveModel::Errors
- Inherits:
-
Object
- Object
- ActiveModel::Errors
- Includes:
- Enumerable
- Defined in:
- lib/active_model/errors.rb
Overview
Active Model Errors
Provides a modified Hash
that you can include in your object for handling error messages and interacting with Action View helpers.
A minimal implementation could be:
class Person
# Required dependency for ActiveModel::Errors
extend ActiveModel::Naming
def initialize
@errors = ActiveModel::Errors.new(self)
end
attr_accessor :name
attr_reader :errors
def validate!
errors.add(:name, :blank, message: "cannot be nil") if name.nil?
end
# The following methods are needed to be minimally implemented
def read_attribute_for_validation(attr)
send(attr)
end
def self.human_attribute_name(attr, = {})
attr
end
def self.lookup_ancestors
[self]
end
end
The last three methods are required in your object for Errors
to be able to generate error messages correctly and also handle multiple languages. Of course, if you extend your object with ActiveModel::Translation
you will not need to implement the last two. Likewise, using ActiveModel::Validations
will handle the validation related methods for you.
The above allows you to do:
person = Person.new
person.validate! # => ["cannot be nil"]
person.errors. # => ["name cannot be nil"]
# etc..
Constant Summary collapse
- CALLBACKS_OPTIONS =
[:if, :unless, :on, :allow_nil, :allow_blank, :strict]
- MESSAGE_OPTIONS =
[:message]
Instance Attribute Summary collapse
-
#details ⇒ Object
readonly
Returns the value of attribute details.
-
#messages ⇒ Object
readonly
Returns the value of attribute messages.
Instance Method Summary collapse
-
#[](attribute) ⇒ Object
When passed a symbol or a name of a method, returns an array of errors for the method.
-
#add(attribute, message = :invalid, options = {}) ⇒ Object
Adds
message
to the error messages and used validator type todetails
onattribute
. -
#added?(attribute, message = :invalid, options = {}) ⇒ Boolean
Returns
true
if an error on the attribute with the given message is present, orfalse
otherwise. -
#as_json(options = nil) ⇒ Object
Returns a Hash that can be used as the JSON representation for this object.
-
#clear ⇒ Object
Clear the error messages.
-
#copy!(other) ⇒ Object
Copies the errors from
other
. -
#delete(key) ⇒ Object
Delete messages for
key
. -
#each ⇒ Object
Iterates through each error key, value pair in the error messages hash.
-
#empty? ⇒ Boolean
(also: #blank?)
Returns
true
if no errors are found,false
otherwise. -
#full_message(attribute, message) ⇒ Object
Returns a full message for a given attribute.
-
#full_messages ⇒ Object
(also: #to_a)
Returns all the full error messages in an array.
-
#full_messages_for(attribute) ⇒ Object
Returns all the full error messages for a given attribute in an array.
-
#generate_message(attribute, type = :invalid, options = {}) ⇒ Object
Translates an error message in its default scope (
activemodel.errors.messages
). -
#include?(attribute) ⇒ Boolean
(also: #has_key?, #key?)
Returns
true
if the error messages include an error for the given keyattribute
,false
otherwise. -
#init_with(coder) ⇒ Object
:nodoc:.
-
#initialize(base) ⇒ Errors
constructor
Pass in the instance of the object that is using the errors object.
-
#initialize_dup(other) ⇒ Object
:nodoc:.
-
#keys ⇒ Object
Returns all message keys.
-
#marshal_dump ⇒ Object
:nodoc:.
-
#marshal_load(array) ⇒ Object
:nodoc:.
-
#size ⇒ Object
(also: #count)
Returns the number of error messages.
-
#to_hash(full_messages = false) ⇒ Object
Returns a Hash of attributes with their error messages.
-
#to_xml(options = {}) ⇒ Object
Returns an xml formatted representation of the Errors hash.
-
#values ⇒ Object
Returns all message values.
Constructor Details
#initialize(base) ⇒ Errors
Pass in the instance of the object that is using the errors object.
class Person
def initialize
@errors = ActiveModel::Errors.new(self)
end
end
72 73 74 75 76 |
# File 'lib/active_model/errors.rb', line 72 def initialize(base) @base = base @messages = apply_default_array({}) @details = apply_default_array({}) end |
Instance Attribute Details
#details ⇒ Object (readonly)
Returns the value of attribute details.
63 64 65 |
# File 'lib/active_model/errors.rb', line 63 def details @details end |
#messages ⇒ Object (readonly)
Returns the value of attribute messages.
63 64 65 |
# File 'lib/active_model/errors.rb', line 63 def @messages end |
Instance Method Details
#[](attribute) ⇒ Object
When passed a symbol or a name of a method, returns an array of errors for the method.
person.errors[:name] # => ["cannot be nil"]
person.errors['name'] # => ["cannot be nil"]
Note that, if you try to get errors of an attribute which has no errors associated with it, this method will instantiate an empty error list for it and keys
will return an array of error keys which includes this attribute.
person.errors.keys # => []
person.errors[:name] # => []
person.errors.keys # => [:name]
144 145 146 |
# File 'lib/active_model/errors.rb', line 144 def [](attribute) [attribute.to_sym] end |
#add(attribute, message = :invalid, options = {}) ⇒ Object
Adds message
to the error messages and used validator type to details
on attribute
. More than one error can be added to the same attribute
. If no message
is supplied, :invalid
is assumed.
person.errors.add(:name)
# => ["is invalid"]
person.errors.add(:name, :not_implemented, message: "must be implemented")
# => ["is invalid", "must be implemented"]
person.errors.
# => {:name=>["is invalid", "must be implemented"]}
person.errors.details
# => {:name=>[{error: :not_implemented}, {error: :invalid}]}
If message
is a symbol, it will be translated using the appropriate scope (see generate_message
).
If message
is a proc, it will be called, allowing for things like Time.now
to be used within an error.
If the :strict
option is set to true
, it will raise ActiveModel::StrictValidationFailed instead of adding the error. :strict
option can also be set to any other exception.
person.errors.add(:name, :invalid, strict: true)
# => ActiveModel::StrictValidationFailed: Name is invalid
person.errors.add(:name, :invalid, strict: NameIsInvalid)
# => NameIsInvalid: Name is invalid
person.errors. # => {}
attribute
should be set to :base
if the error is not directly associated with a single attribute.
person.errors.add(:base, :name_or_email_blank,
message: "either name or email must be present")
person.errors.
# => {:base=>["either name or email must be present"]}
person.errors.details
# => {:base=>[{error: :name_or_email_blank}]}
286 287 288 289 290 291 292 293 294 295 296 297 |
# File 'lib/active_model/errors.rb', line 286 def add(attribute, = :invalid, = {}) = .call if .respond_to?(:call) detail = normalize_detail(, ) = (attribute, , ) if exception = [:strict] exception = ActiveModel::StrictValidationFailed if exception == true raise exception, (attribute, ) end details[attribute.to_sym] << detail [attribute.to_sym] << end |
#added?(attribute, message = :invalid, options = {}) ⇒ Boolean
Returns true
if an error on the attribute with the given message is present, or false
otherwise. message
is treated the same as for add
.
person.errors.add :name, :blank
person.errors.added? :name, :blank # => true
person.errors.added? :name, "can't be blank" # => true
If the error message requires an option, then it returns true
with the correct option, or false
with an incorrect or missing option.
person.errors.add :name, :too_long, { count: 25 }
person.errors.added? :name, :too_long, count: 25 # => true
person.errors.added? :name, "is too long (maximum is 25 characters)" # => true
person.errors.added? :name, :too_long, count: 24 # => false
person.errors.added? :name, :too_long # => false
person.errors.added? :name, "is too long" # => false
315 316 317 318 319 |
# File 'lib/active_model/errors.rb', line 315 def added?(attribute, = :invalid, = {}) = .call if .respond_to?(:call) = (attribute, , ) self[attribute].include? end |
#as_json(options = nil) ⇒ Object
Returns a Hash that can be used as the JSON representation for this object. You can pass the :full_messages
option. This determines if the json object should contain full messages or not (false by default).
person.errors.as_json # => {:name=>["cannot be nil"]}
person.errors.as_json(full_messages: true) # => {:name=>["name cannot be nil"]}
226 227 228 |
# File 'lib/active_model/errors.rb', line 226 def as_json( = nil) to_hash( && [:full_messages]) end |
#clear ⇒ Object
Clear the error messages.
person.errors. # => ["name cannot be nil"]
person.errors.clear
person.errors. # => []
101 102 103 104 |
# File 'lib/active_model/errors.rb', line 101 def clear .clear details.clear end |
#copy!(other) ⇒ Object
Copies the errors from other
.
other - The ActiveModel::Errors instance.
Examples
person.errors.copy!(other)
91 92 93 94 |
# File 'lib/active_model/errors.rb', line 91 def copy!(other) # :nodoc: @messages = other..dup @details = other.details.dup end |
#delete(key) ⇒ Object
Delete messages for key
. Returns the deleted messages.
person.errors[:name] # => ["cannot be nil"]
person.errors.delete(:name) # => ["cannot be nil"]
person.errors[:name] # => []
124 125 126 127 128 |
# File 'lib/active_model/errors.rb', line 124 def delete(key) attribute = key.to_sym details.delete(attribute) .delete(attribute) end |
#each ⇒ Object
Iterates through each error key, value pair in the error messages hash. Yields the attribute and the error for that attribute. If the attribute has more than one error message, yields once for each error message.
person.errors.add(:name, :blank, message: "can't be blank")
person.errors.each do |attribute, error|
# Will yield :name and "can't be blank"
end
person.errors.add(:name, :not_specified, message: "must be specified")
person.errors.each do |attribute, error|
# Will yield :name and "can't be blank"
# then yield :name and "must be specified"
end
162 163 164 165 166 |
# File 'lib/active_model/errors.rb', line 162 def each .each_key do |attribute| [attribute].each { |error| yield attribute, error } end end |
#empty? ⇒ Boolean Also known as: blank?
Returns true
if no errors are found, false
otherwise. If the error message is a string it can be empty.
person.errors. # => ["name cannot be nil"]
person.errors.empty? # => false
200 201 202 |
# File 'lib/active_model/errors.rb', line 200 def empty? size.zero? end |
#full_message(attribute, message) ⇒ Object
Returns a full message for a given attribute.
person.errors.(:name, 'is invalid') # => "Name is invalid"
354 355 356 357 358 359 360 361 362 |
# File 'lib/active_model/errors.rb', line 354 def (attribute, ) return if attribute == :base attr_name = attribute.to_s.tr(".", "_").humanize attr_name = @base.class.human_attribute_name(attribute, default: attr_name) I18n.t(:"errors.format", default: "%{attribute} %{message}", attribute: attr_name, message: ) end |
#full_messages ⇒ Object Also known as: to_a
Returns all the full error messages in an array.
class Person
validates_presence_of :name, :address, :email
validates_length_of :name, in: 5..30
end
person = Person.create(address: '123 First St.')
person.errors.
# => ["Name is too short (minimum is 5 characters)", "Name can't be blank", "Email can't be blank"]
331 332 333 |
# File 'lib/active_model/errors.rb', line 331 def map { |attribute, | (attribute, ) } end |
#full_messages_for(attribute) ⇒ Object
Returns all the full error messages for a given attribute in an array.
class Person
validates_presence_of :name, :email
validates_length_of :name, in: 5..30
end
person = Person.create()
person.errors.(:name)
# => ["Name is too short (minimum is 5 characters)", "Name can't be blank"]
346 347 348 349 |
# File 'lib/active_model/errors.rb', line 346 def (attribute) attribute = attribute.to_sym [attribute].map { || (attribute, ) } end |
#generate_message(attribute, type = :invalid, options = {}) ⇒ Object
Translates an error message in its default scope (activemodel.errors.messages
).
Error messages are first looked up in activemodel.errors.models.MODEL.attributes.ATTRIBUTE.MESSAGE
, if it’s not there, it’s looked up in activemodel.errors.models.MODEL.MESSAGE
and if that is not there also, it returns the translation of the default message (e.g. activemodel.errors.messages.MESSAGE
). The translated model name, translated attribute name and the value are available for interpolation.
When using inheritance in your models, it will check all the inherited models too, but only if the model itself hasn’t been found. Say you have class Admin < User; end
and you wanted the translation for the :blank
error message for the title
attribute, it looks for these translations:
-
activemodel.errors.models.admin.attributes.title.blank
-
activemodel.errors.models.admin.blank
-
activemodel.errors.models.user.attributes.title.blank
-
activemodel.errors.models.user.blank
-
any default you provided through the
options
hash (in theactivemodel.errors
scope) -
activemodel.errors.messages.blank
-
errors.attributes.title.blank
-
errors.messages.blank
388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 |
# File 'lib/active_model/errors.rb', line 388 def (attribute, type = :invalid, = {}) type = .delete(:message) if [:message].is_a?(Symbol) if @base.class.respond_to?(:i18n_scope) defaults = @base.class.lookup_ancestors.map do |klass| [ :"#{@base.class.i18n_scope}.errors.models.#{klass.model_name.i18n_key}.attributes.#{attribute}.#{type}", :"#{@base.class.i18n_scope}.errors.models.#{klass.model_name.i18n_key}.#{type}" ] end else defaults = [] end defaults << :"#{@base.class.i18n_scope}.errors.messages.#{type}" if @base.class.respond_to?(:i18n_scope) defaults << :"errors.attributes.#{attribute}.#{type}" defaults << :"errors.messages.#{type}" defaults.compact! defaults.flatten! key = defaults.shift defaults = .delete(:message) if [:message] value = (attribute != :base ? @base.send(:read_attribute_for_validation, attribute) : nil) = { default: defaults, model: @base.model_name.human, attribute: @base.class.human_attribute_name(attribute), value: value, object: @base }.merge!() I18n.translate(key, ) end |
#include?(attribute) ⇒ Boolean Also known as: has_key?, key?
Returns true
if the error messages include an error for the given key attribute
, false
otherwise.
person.errors. # => {:name=>["cannot be nil"]}
person.errors.include?(:name) # => true
person.errors.include?(:age) # => false
112 113 114 115 |
# File 'lib/active_model/errors.rb', line 112 def include?(attribute) attribute = attribute.to_sym .key?(attribute) && [attribute].present? end |
#init_with(coder) ⇒ Object
:nodoc:
432 433 434 435 436 437 |
# File 'lib/active_model/errors.rb', line 432 def init_with(coder) # :nodoc: coder.map.each { |k, v| instance_variable_set(:"@#{k}", v) } @details ||= {} apply_default_array(@messages) apply_default_array(@details) end |
#initialize_dup(other) ⇒ Object
:nodoc:
78 79 80 81 82 |
# File 'lib/active_model/errors.rb', line 78 def initialize_dup(other) # :nodoc: @messages = other..dup @details = other.details.deep_dup super end |
#keys ⇒ Object
Returns all message keys.
person.errors. # => {:name=>["cannot be nil", "must be specified"]}
person.errors.keys # => [:name]
191 192 193 |
# File 'lib/active_model/errors.rb', line 191 def keys .keys end |
#marshal_dump ⇒ Object
:nodoc:
422 423 424 |
# File 'lib/active_model/errors.rb', line 422 def marshal_dump # :nodoc: [@base, without_default_proc(@messages), without_default_proc(@details)] end |
#marshal_load(array) ⇒ Object
:nodoc:
426 427 428 429 430 |
# File 'lib/active_model/errors.rb', line 426 def marshal_load(array) # :nodoc: @base, @messages, @details = array apply_default_array(@messages) apply_default_array(@details) end |
#size ⇒ Object Also known as: count
Returns the number of error messages.
person.errors.add(:name, :blank, message: "can't be blank")
person.errors.size # => 1
person.errors.add(:name, :not_specified, message: "must be specified")
person.errors.size # => 2
174 175 176 |
# File 'lib/active_model/errors.rb', line 174 def size values.flatten.size end |
#to_hash(full_messages = false) ⇒ Object
Returns a Hash of attributes with their error messages. If full_messages
is true
, it will contain full messages (see full_message
).
person.errors.to_hash # => {:name=>["cannot be nil"]}
person.errors.to_hash(true) # => {:name=>["name cannot be nil"]}
235 236 237 238 239 240 241 242 243 |
# File 'lib/active_model/errors.rb', line 235 def to_hash( = false) if .each_with_object({}) do |(attribute, array), | [attribute] = array.map { || (attribute, ) } end else without_default_proc() end end |
#to_xml(options = {}) ⇒ Object
Returns an xml formatted representation of the Errors hash.
person.errors.add(:name, :blank, message: "can't be blank")
person.errors.add(:name, :not_specified, message: "must be specified")
person.errors.to_xml
# =>
# <?xml version=\"1.0\" encoding=\"UTF-8\"?>
# <errors>
# <error>name can't be blank</error>
# <error>name must be specified</error>
# </errors>
216 217 218 |
# File 'lib/active_model/errors.rb', line 216 def to_xml( = {}) to_a.to_xml({ root: "errors", skip_types: true }.merge!()) end |
#values ⇒ Object
Returns all message values.
person.errors. # => {:name=>["cannot be nil", "must be specified"]}
person.errors.values # => [["cannot be nil", "must be specified"]]
183 184 185 |
# File 'lib/active_model/errors.rb', line 183 def values .values end |