Class: ActiveModel::Errors
- Inherits:
-
Object
- Object
- ActiveModel::Errors
- Includes:
- Enumerable
- Defined in:
- lib/active_model/errors.rb
Overview
Active Model Errors
Provides a modified OrderedHash
that you can include in your object for handling error messages and interacting with Action Pack 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, "can not 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::Translations 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:
p = Person.new
p.validate! # => ["can not be nil"]
p.errors. # => ["name can not be nil"]
# etc..
Constant Summary collapse
- CALLBACKS_OPTIONS =
[:if, :unless, :on, :allow_nil, :allow_blank]
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 = nil, options = {}) ⇒ Object
Adds
message
to the error messages onattribute
, which will be returned on a call toon(attribute)
for the same attribute. -
#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. -
#as_json(options = nil) ⇒ Object
Returns an ActiveSupport::OrderedHash that can be used as the JSON representation for this object.
-
#clear ⇒ Object
Clear the messages.
-
#count ⇒ Object
Returns the number of error messages.
-
#delete(key) ⇒ Object
Delete messages for
key
. -
#dup ⇒ Object
:nodoc:.
-
#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_messages ⇒ Object
Returns all the full error messages 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?(error) ⇒ Boolean
Do the error messages include an error with key
error
?. -
#initialize(base) ⇒ Errors
constructor
Pass in the instance of the object that is using the errors object.
- #initialize_dup(other) ⇒ Object
-
#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 ⇒ Object
-
#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
77 78 79 80 |
# File 'lib/active_model/errors.rb', line 77 def initialize(base) @base = base @messages = ActiveSupport::OrderedHash.new end |
Instance Attribute Details
#messages ⇒ Object (readonly)
Returns the value of attribute messages.
68 69 70 |
# File 'lib/active_model/errors.rb', line 68 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.
p.errors[:name] # => ["can not be nil"]
p.errors['name'] # => ["can not be nil"]
125 126 127 |
# File 'lib/active_model/errors.rb', line 125 def [](attribute) get(attribute.to_sym) || set(attribute.to_sym, []) end |
#[]=(attribute, error) ⇒ Object
Adds to the supplied attribute the supplied error message.
p.errors[:name] = "must be set"
p.errors[:name] # => ['must be set']
133 134 135 |
# File 'lib/active_model/errors.rb', line 133 def []=(attribute, error) self[attribute] << error end |
#add(attribute, message = nil, options = {}) ⇒ Object
Adds message
to the error messages on attribute
, which will be returned on a call to on(attribute)
for the same attribute. More than one error can be added to the same attribute
in which case an array will be returned on a call to on(attribute)
. If no message
is supplied, :invalid
is assumed.
If message
is a symbol, it will be translated using the appropriate scope (see translate_error
). If message
is a proc, it will be called, allowing for things like Time.now
to be used within an error.
231 232 233 234 235 236 237 238 239 240 241 |
# File 'lib/active_model/errors.rb', line 231 def add(attribute, = nil, = {}) ||= :invalid if .is_a?(Symbol) = (attribute, , .except(*CALLBACKS_OPTIONS)) elsif .is_a?(Proc) = .call 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?).
253 254 255 256 257 258 |
# File 'lib/active_model/errors.rb', line 253 def add_on_blank(attributes, = {}) [attributes].flatten.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.
244 245 246 247 248 249 250 |
# File 'lib/active_model/errors.rb', line 244 def add_on_empty(attributes, = {}) [attributes].flatten.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 |
#as_json(options = nil) ⇒ Object
Returns an ActiveSupport::OrderedHash that can be used as the JSON representation for this object.
216 217 218 |
# File 'lib/active_model/errors.rb', line 216 def as_json(=nil) to_hash end |
#clear ⇒ Object
Clear the messages
96 97 98 |
# File 'lib/active_model/errors.rb', line 96 def clear .clear end |
#count ⇒ Object
Returns the number of error messages.
p.errors.add(:name, "can't be blank")
p.errors.count # => 1
p.errors.add(:name, "must be specified")
p.errors.count # => 2
191 192 193 |
# File 'lib/active_model/errors.rb', line 191 def count to_a.size end |
#delete(key) ⇒ Object
Delete messages for key
116 117 118 |
# File 'lib/active_model/errors.rb', line 116 def delete(key) .delete(key) end |
#dup ⇒ Object
:nodoc:
88 89 90 91 92 |
# File 'lib/active_model/errors.rb', line 88 def dup # :nodoc: copy = super copy.initialize_dup(self) copy 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.
p.errors.add(:name, "can't be blank")
p.errors.each do |attribute, errors_array|
# Will yield :name and "can't be blank"
end
p.errors.add(:name, "must be specified")
p.errors.each do |attribute, errors_array|
# Will yield :name and "can't be blank"
# then yield :name and "must be specified"
end
151 152 153 154 155 |
# File 'lib/active_model/errors.rb', line 151 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.
196 197 198 |
# File 'lib/active_model/errors.rb', line 196 def empty? all? { |k, v| v && v.empty? } end |
#full_messages ⇒ Object
Returns all the full error messages in an array.
class Company
validates_presence_of :name, :address, :email
validates_length_of :name, :in => 5..30
end
company = Company.create(:address => '123 First St.')
company.errors. # =>
["Name is too short (minimum is 5 characters)", "Name can't be blank", "Email can't be blank"]
270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 |
# File 'lib/active_model/errors.rb', line 270 def map { |attribute, | if attribute == :base else attr_name = attribute.to_s.gsub('.', '_').humanize attr_name = @base.class.human_attribute_name(attribute, :default => attr_name) I18n.t(:"errors.format", { :default => "%{attribute} %{message}", :attribute => attr_name, :message => }) end } 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
311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 |
# File 'lib/active_model/errors.rb', line 311 def (attribute, type = :invalid, = {}) type = .delete(:message) if [:message].is_a?(Symbol) 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 defaults << .delete(:message) defaults << :"#{@base.class.i18n_scope}.errors.messages.#{type}" 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.class.model_name.human, :attribute => @base.class.human_attribute_name(attribute), :value => value }.merge() I18n.translate(key, ) end |
#get(key) ⇒ Object
Get messages for key
106 107 108 |
# File 'lib/active_model/errors.rb', line 106 def get(key) [key] end |
#include?(error) ⇒ Boolean
Do the error messages include an error with key error
?
101 102 103 |
# File 'lib/active_model/errors.rb', line 101 def include?(error) (v = [error]) && v.any? end |
#initialize_dup(other) ⇒ Object
82 83 84 |
# File 'lib/active_model/errors.rb', line 82 def initialize_dup(other) @messages = other..dup end |
#keys ⇒ Object
Returns all message keys
173 174 175 |
# File 'lib/active_model/errors.rb', line 173 def keys .keys end |
#set(key, value) ⇒ Object
Set messages for key
to value
111 112 113 |
# File 'lib/active_model/errors.rb', line 111 def set(key, value) [key] = value end |
#size ⇒ Object
Returns the number of error messages.
p.errors.add(:name, "can't be blank")
p.errors.size # => 1
p.errors.add(:name, "must be specified")
p.errors.size # => 2
163 164 165 |
# File 'lib/active_model/errors.rb', line 163 def size values.flatten.size end |
#to_a ⇒ Object
Returns an array of error messages, with the attribute name included
p.errors.add(:name, "can't be blank")
p.errors.add(:name, "must be specified")
p.errors.to_a # => ["name can't be blank", "name must be specified"]
182 183 184 |
# File 'lib/active_model/errors.rb', line 182 def to_a end |
#to_hash ⇒ Object
220 221 222 |
# File 'lib/active_model/errors.rb', line 220 def to_hash .dup end |
#to_xml(options = {}) ⇒ Object
Returns an xml formatted representation of the Errors hash.
p.errors.add(:name, "can't be blank")
p.errors.add(:name, "must be specified")
p.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>
211 212 213 |
# File 'lib/active_model/errors.rb', line 211 def to_xml(={}) to_a.to_xml .reverse_merge(:root => "errors", :skip_types => true) end |
#values ⇒ Object
Returns all message values
168 169 170 |
# File 'lib/active_model/errors.rb', line 168 def values .values end |