Class: Lev::BetterActiveModelErrors
- Includes:
- Enumerable
- Defined in:
- lib/lev/better_active_model_errors.rb
Overview
Better Errors
Same as ActiveModel::Errors but also retains error types
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::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:
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, :strict]
Instance Attribute Summary collapse
-
#messages ⇒ Object
readonly
Returns the value of attribute messages.
-
#types ⇒ Object
readonly
Returns the value of attribute types.
Class Method Summary collapse
- .full_message(model, attribute, message) ⇒ Object
-
.generate_message(model, attribute, type = :invalid, options = {}) ⇒ Object
TODO maybe don’t need this method split out any more?.
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
. -
#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 = nil, options = {}) ⇒ Boolean
Returns true if an error on the attribute with the given message is present, false otherwise.
-
#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.
- #each_with_type_and_message ⇒ Object
-
#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.
-
#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
. - #get_type(key) ⇒ Object
-
#include?(error) ⇒ Boolean
(also: #has_key?)
Do the error messages include an error with key
error
?. -
#initialize(base) ⇒ BetterActiveModelErrors
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_s ⇒ Object
-
#to_xml(options = {}) ⇒ Object
Returns an xml formatted representation of the Errors hash.
-
#values ⇒ Object
Returns all message values.
Constructor Details
#initialize(base) ⇒ BetterActiveModelErrors
Pass in the instance of the object that is using the errors object.
class Person
def initialize
@errors = ActiveModel::Errors.new(self)
end
end
80 81 82 83 84 |
# File 'lib/lev/better_active_model_errors.rb', line 80 def initialize(base) @base = base @types = ActiveSupport::OrderedHash.new @messages = ActiveSupport::OrderedHash.new end |
Instance Attribute Details
#messages ⇒ Object (readonly)
Returns the value of attribute messages.
70 71 72 |
# File 'lib/lev/better_active_model_errors.rb', line 70 def @messages end |
#types ⇒ Object (readonly)
Returns the value of attribute types.
71 72 73 |
# File 'lib/lev/better_active_model_errors.rb', line 71 def types @types end |
Class Method Details
.full_message(model, attribute, message) ⇒ Object
316 317 318 319 320 321 322 323 324 325 |
# File 'lib/lev/better_active_model_errors.rb', line 316 def self.(model, attribute, ) return if attribute == :base attr_name = attribute.to_s.gsub('.', '_').humanize attr_name = model.class.human_attribute_name(attribute, default: attr_name) I18n.t(:"errors.format", { default: "%{attribute} %{message}", attribute: attr_name, message: }) end |
.generate_message(model, attribute, type = :invalid, options = {}) ⇒ Object
TODO maybe don’t need this method split out any more?
356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 |
# File 'lib/lev/better_active_model_errors.rb', line 356 def self.(model, attribute, type = :invalid, = {}) type = .delete(:message) if [:message].is_a?(Symbol) attribute = attribute.to_sym if model.class.respond_to?(:i18n_scope) defaults = model.class.lookup_ancestors.map do |klass| [ :"#{model.class.i18n_scope}.errors.models.#{klass.model_name.i18n_key}.attributes.#{attribute}.#{type}", :"#{model.class.i18n_scope}.errors.models.#{klass.model_name.i18n_key}.#{type}" ] end else defaults = [] end defaults << .delete(:message) defaults << :"#{model.class.i18n_scope}.errors.messages.#{type}" if model.class.respond_to?(:i18n_scope) defaults << :"errors.attributes.#{attribute}.#{type}" defaults << :"errors.messages.#{type}" defaults.compact! defaults.flatten! key = defaults.shift value = (attribute != :base ? model.send(:read_attribute_for_validation, attribute) : nil) = { :default => defaults, :model => model.class.model_name.human, :attribute => model.class.human_attribute_name(attribute), :value => value }.merge() I18n.translate(key, ) 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"]
139 140 141 |
# File 'lib/lev/better_active_model_errors.rb', line 139 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']
147 148 149 |
# File 'lib/lev/better_active_model_errors.rb', line 147 def []=(attribute, error) self[attribute] << error end |
#add(attribute, message = nil, 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.
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.
258 259 260 261 262 263 264 265 266 |
# File 'lib/lev/better_active_model_errors.rb', line 258 def add(attribute, = nil, = {}) = (attribute, , ) if [:strict] raise ActiveModel::StrictValidationFailed, (attribute, ) end self[attribute] << self.types[attribute.to_sym] << .try(:to_sym) 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?).
278 279 280 281 282 283 |
# File 'lib/lev/better_active_model_errors.rb', line 278 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.
269 270 271 272 273 274 275 |
# File 'lib/lev/better_active_model_errors.rb', line 269 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 |
#added?(attribute, message = nil, 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
.
p.errors.add :name, :blank
p.errors.added? :name, :blank # => true
289 290 291 292 |
# File 'lib/lev/better_active_model_errors.rb', line 289 def added?(attribute, = nil, = {}) = (attribute, , ) self[attribute].include? end |
#as_json(options = nil) ⇒ Object
Returns an ActiveSupport::OrderedHash that can be used as the JSON representation for this object.
240 241 242 |
# File 'lib/lev/better_active_model_errors.rb', line 240 def as_json(=nil) to_hash end |
#clear ⇒ Object
Clear the messages
101 102 103 104 |
# File 'lib/lev/better_active_model_errors.rb', line 101 def clear types.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
213 214 215 |
# File 'lib/lev/better_active_model_errors.rb', line 213 def count to_a.size end |
#delete(key) ⇒ Object
Delete messages for key
128 129 130 131 132 |
# File 'lib/lev/better_active_model_errors.rb', line 128 def delete(key) key = key.to_sym types.delete(key) .delete(key) end |
#dup ⇒ Object
:nodoc:
93 94 95 96 97 |
# File 'lib/lev/better_active_model_errors.rb', line 93 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
165 166 167 168 169 |
# File 'lib/lev/better_active_model_errors.rb', line 165 def each .each_key do |attribute| self[attribute].each { |error| yield attribute, error } end end |
#each_with_type_and_message ⇒ Object
171 172 173 174 175 176 177 |
# File 'lib/lev/better_active_model_errors.rb', line 171 def types.each_key do |attribute| for ii in 0..self.types[attribute].size-1 yield attribute, self.types[attribute][ii], self.[attribute][ii] end 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.
219 220 221 |
# File 'lib/lev/better_active_model_errors.rb', line 219 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.
company.errors.(:name, "is invalid") # =>
"Name is invalid"
312 313 314 |
# File 'lib/lev/better_active_model_errors.rb', line 312 def (attribute, ) self.class.(@base, attribute, ) 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"]
304 305 306 |
# File 'lib/lev/better_active_model_errors.rb', line 304 def map { |attribute, | (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
351 352 353 |
# File 'lib/lev/better_active_model_errors.rb', line 351 def (attribute, type = :invalid, = {}) self.class.(@base, attribute, type, ) end |
#get(key) ⇒ Object
Get messages for key
113 114 115 |
# File 'lib/lev/better_active_model_errors.rb', line 113 def get(key) [key.to_sym] end |
#get_type(key) ⇒ Object
117 118 119 |
# File 'lib/lev/better_active_model_errors.rb', line 117 def get_type(key) types[key.to_sym] end |
#include?(error) ⇒ Boolean Also known as: has_key?
Do the error messages include an error with key error
?
107 108 109 |
# File 'lib/lev/better_active_model_errors.rb', line 107 def include?(error) (v = [error.to_sym]) && v.any? end |
#initialize_dup(other) ⇒ Object
86 87 88 89 |
# File 'lib/lev/better_active_model_errors.rb', line 86 def initialize_dup(other) @types = other.types.dup @messages = other..dup end |
#keys ⇒ Object
Returns all message keys
195 196 197 |
# File 'lib/lev/better_active_model_errors.rb', line 195 def keys .keys end |
#set(key, value) ⇒ Object
Set messages for key
to value
122 123 124 125 |
# File 'lib/lev/better_active_model_errors.rb', line 122 def set(key, value) types[key.to_sym] = (value == [] ? [] : (value.is_a?(Symbol) ? value : nil)) [key.to_sym] = 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
185 186 187 |
# File 'lib/lev/better_active_model_errors.rb', line 185 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"]
204 205 206 |
# File 'lib/lev/better_active_model_errors.rb', line 204 def to_a end |
#to_hash ⇒ Object
244 245 246 |
# File 'lib/lev/better_active_model_errors.rb', line 244 def to_hash .dup end |
#to_s ⇒ Object
248 249 250 |
# File 'lib/lev/better_active_model_errors.rb', line 248 def to_s inspect 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>
235 236 237 |
# File 'lib/lev/better_active_model_errors.rb', line 235 def to_xml(={}) to_a.to_xml .reverse_merge(:root => "errors", :skip_types => true) end |
#values ⇒ Object
Returns all message values
190 191 192 |
# File 'lib/lev/better_active_model_errors.rb', line 190 def values .values end |