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, "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 Person.human_attribute_name(attr, = {})
attr
end
def Person.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]
Instance Attribute Summary collapse
-
#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.
-
#[]=(attribute, error) ⇒ Object
Adds to the supplied attribute the supplied error message.
-
#add(attribute, message = :invalid, options = {}) ⇒ Object
Adds
message
to the error messages onattribute
. -
#add_on_blank(attributes, options = {}) ⇒ Object
Will add an error message to each of the attributes in
attributes
that is blank (using Object#blank?). -
#add_on_empty(attributes, options = {}) ⇒ Object
Will add an error message to each of the attributes in
attributes
that is empty. -
#added?(attribute, message = :invalid, options = {}) ⇒ Boolean
Returns
true
if an error on the attribute with the given message is present,false
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.
-
#count ⇒ Object
Returns the number of error messages.
-
#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
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
). -
#get(key) ⇒ Object
Get messages for
key
. -
#include?(attribute) ⇒ Boolean
(also: #has_key?, #key?)
Returns
true
if the error messages include an error for the given keyattribute
,false
otherwise. -
#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.
-
#set(key, value) ⇒ Object
Set messages for
key
tovalue
. -
#size ⇒ Object
Returns the number of error messages.
-
#to_a ⇒ Object
Returns an array of error messages, with the attribute name included.
-
#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
71 72 73 74 |
# File 'lib/active_model/errors.rb', line 71 def initialize(base) @base = base @messages = {} end |
Instance Attribute Details
#messages ⇒ Object (readonly)
Returns the value of attribute messages.
62 63 64 |
# File 'lib/active_model/errors.rb', line 62 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"]
136 137 138 |
# File 'lib/active_model/errors.rb', line 136 def [](attribute) get(attribute.to_sym) || set(attribute.to_sym, []) end |
#[]=(attribute, error) ⇒ Object
Adds to the supplied attribute the supplied error message.
person.errors[:name] = "must be set"
person.errors[:name] # => ['must be set']
144 145 146 |
# File 'lib/active_model/errors.rb', line 144 def []=(attribute, error) self[attribute] << error end |
#add(attribute, message = :invalid, options = {}) ⇒ Object
Adds message
to the error messages 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, 'must be implemented')
# => ["is invalid", "must be implemented"]
person.errors.
# => {:name=>["must be implemented", "is 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, nil, strict: true)
# => ActiveModel::StrictValidationFailed: name is invalid
person.errors.add(:name, nil, 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, "either name or email must be present")
person.errors.
# => {:base=>["either name or email must be present"]}
299 300 301 302 303 304 305 306 307 |
# File 'lib/active_model/errors.rb', line 299 def add(attribute, = :invalid, = {}) = (attribute, , ) if exception = [:strict] exception = ActiveModel::StrictValidationFailed if exception == true raise exception, (attribute, ) end self[attribute] << end |
#add_on_blank(attributes, options = {}) ⇒ Object
Will add an error message to each of the attributes in attributes
that is blank (using Object#blank?).
person.errors.add_on_blank(:name)
person.errors.
# => {:name=>["can't be blank"]}
329 330 331 332 333 334 |
# File 'lib/active_model/errors.rb', line 329 def add_on_blank(attributes, = {}) Array(attributes).each do |attribute| value = @base.send(:read_attribute_for_validation, attribute) add(attribute, :blank, ) if value.blank? end end |
#add_on_empty(attributes, options = {}) ⇒ Object
Will add an error message to each of the attributes in attributes
that is empty.
person.errors.add_on_empty(:name)
person.errors.
# => {:name=>["can't be empty"]}
315 316 317 318 319 320 321 |
# File 'lib/active_model/errors.rb', line 315 def add_on_empty(attributes, = {}) Array(attributes).each do |attribute| value = @base.send(:read_attribute_for_validation, attribute) is_empty = value.respond_to?(:empty?) ? value.empty? : false add(attribute, :empty, ) if value.nil? || is_empty end end |
#added?(attribute, message = :invalid, options = {}) ⇒ Boolean
Returns true
if an error on the attribute with the given message is present, false
otherwise. message
is treated the same as for add
.
person.errors.add :name, :blank
person.errors.added? :name, :blank # => true
341 342 343 344 |
# File 'lib/active_model/errors.rb', line 341 def added?(attribute, = :invalid, = {}) = (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"]}
245 246 247 |
# File 'lib/active_model/errors.rb', line 245 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. # => []
86 87 88 |
# File 'lib/active_model/errors.rb', line 86 def clear .clear end |
#count ⇒ Object
Returns the number of error messages.
person.errors.add(:name, "can't be blank")
person.errors.count # => 1
person.errors.add(:name, "must be specified")
person.errors.count # => 2
209 210 211 |
# File 'lib/active_model/errors.rb', line 209 def count to_a.size end |
#delete(key) ⇒ Object
Delete messages for key
. Returns the deleted messages.
person.errors.get(:name) # => ["cannot be nil"]
person.errors.delete(:name) # => ["cannot be nil"]
person.errors.get(:name) # => nil
127 128 129 |
# File 'lib/active_model/errors.rb', line 127 def delete(key) .delete(key) 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, "can't be blank")
person.errors.each do |attribute, error|
# Will yield :name and "can't be blank"
end
person.errors.add(:name, "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| self[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
218 219 220 |
# File 'lib/active_model/errors.rb', line 218 def empty? all? { |k, v| v && v.empty? && !v.is_a?(String) } end |
#full_message(attribute, message) ⇒ Object
Returns a full message for a given attribute.
person.errors.(:name, 'is invalid') # => "Name is invalid"
377 378 379 380 381 382 383 384 385 386 |
# File 'lib/active_model/errors.rb', line 377 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
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"]
356 357 358 |
# File 'lib/active_model/errors.rb', line 356 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"]
370 371 372 |
# File 'lib/active_model/errors.rb', line 370 def (attribute) (get(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 models.MODEL.attributes.ATTRIBUTE.MESSAGE
, if it’s not there, it’s looked up in 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
412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 |
# File 'lib/active_model/errors.rb', line 412 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 << .delete(:message) 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 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 }.merge!() I18n.translate(key, ) end |
#get(key) ⇒ Object
Get messages for key
.
person.errors. # => {:name=>["cannot be nil"]}
person.errors.get(:name) # => ["cannot be nil"]
person.errors.get(:age) # => nil
109 110 111 |
# File 'lib/active_model/errors.rb', line 109 def get(key) [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
96 97 98 |
# File 'lib/active_model/errors.rb', line 96 def include?(attribute) [attribute].present? end |
#initialize_dup(other) ⇒ Object
:nodoc:
76 77 78 79 |
# File 'lib/active_model/errors.rb', line 76 def initialize_dup(other) # :nodoc: @messages = other..dup super end |
#keys ⇒ Object
Returns all message keys.
person.errors. # => {:name=>["cannot be nil", "must be specified"]}
person.errors.keys # => [:name]
190 191 192 |
# File 'lib/active_model/errors.rb', line 190 def keys .keys end |
#set(key, value) ⇒ Object
Set messages for key
to value
.
person.errors.get(:name) # => ["cannot be nil"]
person.errors.set(:name, ["can't be nil"])
person.errors.get(:name) # => ["can't be nil"]
118 119 120 |
# File 'lib/active_model/errors.rb', line 118 def set(key, value) [key] = value end |
#size ⇒ Object
Returns the number of error messages.
person.errors.add(:name, "can't be blank")
person.errors.size # => 1
person.errors.add(:name, "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_a ⇒ Object
Returns an array of error messages, with the attribute name included.
person.errors.add(:name, "can't be blank")
person.errors.add(:name, "must be specified")
person.errors.to_a # => ["name can't be blank", "name must be specified"]
199 200 201 |
# File 'lib/active_model/errors.rb', line 199 def to_a 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"]}
254 255 256 257 258 259 260 261 262 |
# File 'lib/active_model/errors.rb', line 254 def to_hash( = false) if self..each_with_object({}) do |(attribute, array), | [attribute] = array.map { || (attribute, ) } end else self..dup end end |
#to_xml(options = {}) ⇒ Object
Returns an xml formatted representation of the Errors hash.
person.errors.add(:name, "can't be blank")
person.errors.add(:name, "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>
235 236 237 |
# File 'lib/active_model/errors.rb', line 235 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"]]
182 183 184 |
# File 'lib/active_model/errors.rb', line 182 def values .values end |