class AttrValidator::ValidationErrors
Attributes
Public Class Methods
# File lib/attr_validator/validation_errors.rb, line 4 def initialize @messages = {} end
Public Instance Methods
When passed a symbol or a name of a method, returns an array of errors for the method.
errors[:name] # => ["can not be nil"] errors['name'] # => ["can not be nil"]
# File lib/attr_validator/validation_errors.rb, line 61 def [](attribute) get(attribute.to_sym) || set(attribute.to_sym, []) end
Adds to the supplied attribute the supplied error message.
errors[:name] = "must be set" errors[:name] # => ['must be set']
# File lib/attr_validator/validation_errors.rb, line 69 def []=(attribute, error) self[attribute] << error end
Adds message
to the error messages on attribute
. More than one error can be added to the same attribute
errors.add(:name, 'is invalid') # => ["is invalid"] errors.add(:name, 'must be implemented') # => ["is invalid", "must be implemented"] errors.messages # => {:name=>["must be implemented", "is invalid"]}
If message
is a proc, it will be called, allowing for things like Time.now
to be used within an error.
errors.messages # => {}
# File lib/attr_validator/validation_errors.rb, line 181 def add(attribute, message) self[attribute] << message end
Adds messages
to the error messages on attribute
.
errors.add(:name, ['is invalid', 'must present']) # => ["is invalid", "must present"]
# File lib/attr_validator/validation_errors.rb, line 189 def add_all(attribute, errors) messages[attribute] ||= [] messages[attribute] += errors end
Returns true
if an error on the attribute with the given message is present, false
otherwise. message
is treated the same as for add
.
errors.add :name, :blank errors.added? :name, :blank # => true
# File lib/attr_validator/validation_errors.rb, line 199 def added?(attribute, message) self[attribute].include? message end
Clear the error messages.
errors.full_messages # => ["name can not be nil"] errors.clear errors.full_messages # => []
# File lib/attr_validator/validation_errors.rb, line 13 def clear messages.clear end
Returns the number of error messages.
errors.add(:name, "can't be blank") errors.count # => 1 errors.add(:name, "must be specified") errors.count # => 2
# File lib/attr_validator/validation_errors.rb, line 134 def count to_a.size end
Delete messages for key
. Returns the deleted messages.
errors.get(:name) # => ["can not be nil"] errors.delete(:name) # => ["can not be nil"] errors.get(:name) # => nil
# File lib/attr_validator/validation_errors.rb, line 52 def delete(key) messages.delete(key) end
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.
errors.add(:name, "can't be blank") errors.each do |attribute, error| # Will yield :name and "can't be blank" end errors.add(:name, "must be specified") errors.each do |attribute, error| # Will yield :name and "can't be blank" # then yield :name and "must be specified" end
# File lib/attr_validator/validation_errors.rb, line 87 def each messages.each_key do |attribute| self[attribute].each { |error| yield attribute, error } end end
Returns true
if no errors are found, false
otherwise. If the error message is a string it can be empty.
errors.full_messages # => ["name can not be nil"] errors.empty? # => false
# File lib/attr_validator/validation_errors.rb, line 143 def empty? messages.all? { |k, v| v && v.empty? && !v.is_a?(String) } end
Returns a full message for a given attribute.
errors.full_message(:name, 'is invalid') # => "Name is invalid"
# File lib/attr_validator/validation_errors.rb, line 234 def full_message(attribute, message) return message 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: message }) end
Returns all the full error messages in an array.
class PersonValidator validates :name, :address, :email, presence: true validates :name, length: { min: 5, max: 30 } end = create(address: '123 First St.') errors.full_messages # => ["Name is too short (minimum is 5 characters)", "Name can't be blank", "Email can't be blank"]
# File lib/attr_validator/validation_errors.rb, line 213 def full_messages map { |attribute, message| full_message(attribute, message) } end
Returns all the full error messages for a given attribute in an array.
class PersonValidator validates :name, :address, :email, presence: true validates :name, length: { min: 5, max: 30 } end = create() errors.full_messages_for(:name) # => ["Name is too short (minimum is 5 characters)", "Name can't be blank"]
# File lib/attr_validator/validation_errors.rb, line 227 def full_messages_for(attribute) (get(attribute) || []).map { |message| full_message(attribute, message) } end
Get messages for key
.
errors.messages # => {:name=>["can not be nil"]} errors.get(:name) # => ["can not be nil"] errors.get(:age) # => nil
# File lib/attr_validator/validation_errors.rb, line 34 def get(key) messages[key] end
Returns true
if the error messages include an error for the given key attribute
, false
otherwise.
errors.messages # => {:name=>["can not be nil"]} errors.include?(:name) # => true errors.include?(:age) # => false
# File lib/attr_validator/validation_errors.rb, line 23 def include?(attribute) (v = messages[attribute]) && v.any? end
Returns all message keys.
errors.messages # => {:name=>["can not be nil", "must be specified"]} errors.keys # => [:name]
# File lib/attr_validator/validation_errors.rb, line 115 def keys messages.keys end
Set messages for key
to value
.
errors.get(:name) # => ["can not be nil"] errors.set(:name, ["can't be nil"]) errors.get(:name) # => ["can't be nil"]
# File lib/attr_validator/validation_errors.rb, line 43 def set(key, value) messages[key] = value end
Returns the number of error messages.
errors.add(:name, "can't be blank") errors.size # => 1 errors.add(:name, "must be specified") errors.size # => 2
# File lib/attr_validator/validation_errors.rb, line 99 def size values.flatten.size end
Returns an array of error messages, with the attribute name included.
errors.add(:name, "can't be blank") errors.add(:name, "must be specified") errors.to_a # => ["name can't be blank", "name must be specified"]
# File lib/attr_validator/validation_errors.rb, line 124 def to_a full_messages end
Returns a Hash of attributes with their error messages. If full_messages
is true
, it will contain full messages (see full_message
).
errors.to_hash # => {:name=>["can not be nil"]} errors.to_hash(true) # => {:name=>["name can not be nil"]}
# File lib/attr_validator/validation_errors.rb, line 154 def to_hash(full_messages = false) if full_messages messages = {} self.messages.each do |attribute, array| messages[attribute] = array.map { |message| full_message(attribute, message) } end messages else self.messages.dup end end
Returns all message values.
errors.messages # => {:name=>["can not be nil", "must be specified"]} errors.values # => [["can not be nil", "must be specified"]]
# File lib/attr_validator/validation_errors.rb, line 107 def values messages.values end