Class: ActiveModel::Errors
- Inherits:
-
ActiveSupport::OrderedHash
- Object
- ActiveSupport::OrderedHash
- ActiveModel::Errors
- Includes:
- DeprecatedErrorMethods
- 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 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.
-
#count ⇒ Object
Returns the number of error messages.
-
#each ⇒ Object
Iterates through each error key, value pair in the error messages hash.
-
#empty? ⇒ Boolean
(also: #blank?)
Returns true if there are any errors, false if not.
-
#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 ⇒ Object
-
#initialize(base) ⇒ Errors
constructor
Pass in the instance of the object that is using the errors object.
- #set ⇒ Object
-
#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.
Methods included from DeprecatedErrorMethods
#add_to_base, #each_full, #invalid?, #on, #on_base
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
75 76 77 78 |
# File 'lib/active_model/errors.rb', line 75 def initialize(base) @base = base super() 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"]
88 89 90 |
# File 'lib/active_model/errors.rb', line 88 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']
96 97 98 |
# File 'lib/active_model/errors.rb', line 96 def []=(attribute, error) self[attribute.to_sym] << 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.
186 187 188 189 190 191 192 193 194 195 196 |
# File 'lib/active_model/errors.rb', line 186 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?).
215 216 217 218 219 220 221 222 223 224 225 226 227 |
# File 'lib/active_model/errors.rb', line 215 def add_on_blank(attributes, = {}) if && !.is_a?(Hash) = { :message => } ActiveSupport::Deprecation.warn \ "ActiveModel::Errors#add_on_blank(attributes, custom_message) has been deprecated.\n" + "Instead of passing a custom_message pass an options Hash { :message => custom_message }." end [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.
199 200 201 202 203 204 205 206 207 208 209 210 211 212 |
# File 'lib/active_model/errors.rb', line 199 def add_on_empty(attributes, = {}) if && !.is_a?(Hash) = { :message => } ActiveSupport::Deprecation.warn \ "ActiveModel::Errors#add_on_empty(attributes, custom_message) has been deprecated.\n" + "Instead of passing a custom_message pass an options Hash { :message => custom_message }." end [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.
169 170 171 |
# File 'lib/active_model/errors.rb', line 169 def as_json(=nil) to_hash 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
144 145 146 |
# File 'lib/active_model/errors.rb', line 144 def count to_a.size 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
114 115 116 117 118 |
# File 'lib/active_model/errors.rb', line 114 def each each_key do |attribute| self[attribute].each { |error| yield attribute, error } end end |
#empty? ⇒ Boolean Also known as: blank?
Returns true if there are any errors, false if not.
149 150 151 |
# File 'lib/active_model/errors.rb', line 149 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", "Address can't be blank"]
239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 |
# File 'lib/active_model/errors.rb', line 239 def = [] each do |attribute, | = Array.wrap() next if .empty? if attribute == :base .each {|m| << m } else attr_name = attribute.to_s.gsub('.', '_').humanize attr_name = @base.class.human_attribute_name(attribute, :default => attr_name) = { :default => "%{attribute} %{message}", :attribute => attr_name } .each do |m| << I18n.t(:"errors.format", .merge(:message => m)) end end 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:
<ol> <li>activemodel.errors.models.admin.attributes.title.blank
</li> <li>activemodel.errors.models.admin.blank
</li> <li>activemodel.errors.models.user.attributes.title.blank
</li> <li>activemodel.errors.models.user.blank
</li> <li>any default you provided through the options
hash (in the activemodel.errors scope)</li> <li>activemodel.errors.messages.blank
</li> <li>errors.attributes.title.blank
</li> <li>errors.messages.blank
</li> </ol>
287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 |
# File 'lib/active_model/errors.rb', line 287 def (attribute, type = :invalid, = {}) type = .delete(:message) if [:message].is_a?(Symbol) if [:default] ActiveSupport::Deprecation.warn \ "Giving :default as validation option to errors.add has been deprecated.\n" + "Please use :message instead." [:message] = .delete(:default) end 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 ⇒ Object
80 |
# File 'lib/active_model/errors.rb', line 80 alias_method :get, :[] |
#set ⇒ Object
81 |
# File 'lib/active_model/errors.rb', line 81 alias_method :set, :[]= |
#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
126 127 128 |
# File 'lib/active_model/errors.rb', line 126 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"]
135 136 137 |
# File 'lib/active_model/errors.rb', line 135 def to_a end |
#to_hash ⇒ Object
173 174 175 176 177 |
# File 'lib/active_model/errors.rb', line 173 def to_hash hash = ActiveSupport::OrderedHash.new each { |k, v| (hash[k] ||= []) << v } hash 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>
164 165 166 |
# File 'lib/active_model/errors.rb', line 164 def to_xml(={}) to_a.to_xml .reverse_merge(:root => "errors", :skip_types => true) end |