class UseCaseValidations::Errors
Constants
- CALLBACKS_OPTIONS
Attributes
Public Class Methods
Pass in the instance of the object that is using the errors object.
class Person def initialize @errors = ActiveModel::Errors.new(self) end end
# File lib/usecasing_validations/errors.rb, line 17 def initialize(base) @base = base @messages = {} end
Public Instance Methods
When passed a symbol or a name of a method, returns an array of errors for the method.
person.errors[:name] # => ["can not be nil"] person.errors['name'] # => ["can not be nil"]
# File lib/usecasing_validations/errors.rb, line 80 def [](attribute) get(attribute.to_sym) || set(attribute.to_sym, []) end
Adds to the supplied attribute the supplied error message.
person.errors[:name] = "must be set" person.errors[:name] # => ['must be set']
# File lib/usecasing_validations/errors.rb, line 88 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
. 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.messages # => {: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.
person.errors.messages # => {}
# File lib/usecasing_validations/errors.rb, line 229 def add(attribute, message = nil, options = {}) message = normalize_message(attribute, message, options) self[attribute] << message 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
.
person.errors.add :name, :blank person.errors.added? :name, :blank # => true
# File lib/usecasing_validations/errors.rb, line 239 def added?(attribute, message = nil, options = {}) message = normalize_message(attribute, message, options) self[attribute].include? message end
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.as_json # => {:name=>["can not be nil"]} person.as_json(full_messages: true) # => {:name=>["name can not be nil"]}
# File lib/usecasing_validations/errors.rb, line 189 def as_json(options=nil) to_hash(options && options[:full_messages]) end
Clear the error messages.
person.errors.full_messages # => ["name can not be nil"] person.errors.clear person.errors.full_messages # => []
# File lib/usecasing_validations/errors.rb, line 32 def clear messages.clear end
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
# File lib/usecasing_validations/errors.rb, line 153 def count to_a.size end
Delete messages for key
. Returns the deleted messages.
person.errors.get(:name) # => ["can not be nil"] person.errors.delete(:name) # => ["can not be nil"] person.errors.get(:name) # => nil
# File lib/usecasing_validations/errors.rb, line 71 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.
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
# File lib/usecasing_validations/errors.rb, line 106 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.
person.errors.full_messages # => ["name can not be nil"] person.errors.empty? # => false
# File lib/usecasing_validations/errors.rb, line 162 def empty? all? { |k, v| v && v.empty? && !v.is_a?(String) } end
Returns a full message for a given attribute.
person.errors.full_message(:name, 'is invalid') # => "Name is invalid"
# File lib/usecasing_validations/errors.rb, line 275 def full_message(attribute, message) return message if attribute == :base || !@base.class.respond_to?(:model_name) 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 Person validates_presence_of :name, :address, :email validates_length_of :name, in: 5..30 end person = Person.create(address: '123 First St.') person.errors.full_messages # => ["Name is too short (minimum is 5 characters)", "Name can't be blank", "Email can't be blank"]
# File lib/usecasing_validations/errors.rb, line 254 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 Person validates_presence_of :name, :email validates_length_of :name, in: 5..30 end person = Person.create() person.errors.full_messages_for(:name) # => ["Name is too short (minimum is 5 characters)", "Name can't be blank"]
# File lib/usecasing_validations/errors.rb, line 268 def full_messages_for(attribute) (get(attribute) || []).map { |message| full_message(attribute, message) } end
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
# File lib/usecasing_validations/errors.rb, line 311 def generate_message(attribute, type = :invalid, options = {}) type = options.delete(:message) if options[:message].is_a?(Symbol) if !@base.class.respond_to?(:model_name) return options.key?(:message) ? options[:message] : type end 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 << options.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(attribute) : nil) options = { default: defaults, model: @base.class.model_name.human, attribute: @base.class.human_attribute_name(attribute), value: value }.merge!(options) I18n.translate(key, options) end
Get messages for key
.
person.errors.messages # => {:name=>["can not be nil"]} person.errors.get(:name) # => ["can not be nil"] person.errors.get(:age) # => nil
# File lib/usecasing_validations/errors.rb, line 53 def get(key) messages[key] end
Returns true
if the error messages include an error for the given key attribute
, false
otherwise.
person.errors.messages # => {:name=>["can not be nil"]} person.errors.include?(:name) # => true person.errors.include?(:age) # => false
# File lib/usecasing_validations/errors.rb, line 42 def include?(attribute) (v = messages[attribute]) && v.any? end
Returns all message keys.
person.errors.messages # => {:name=>["can not be nil", "must be specified"]} person.errors.keys # => [:name]
# File lib/usecasing_validations/errors.rb, line 134 def keys messages.keys end
Set messages for key
to value
.
person.errors.get(:name) # => ["can not be nil"] person.errors.set(:name, ["can't be nil"]) person.errors.get(:name) # => ["can't be nil"]
# File lib/usecasing_validations/errors.rb, line 62 def set(key, value) messages[key] = value end
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
# File lib/usecasing_validations/errors.rb, line 118 def size values.flatten.size end
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"]
# File lib/usecasing_validations/errors.rb, line 143 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
).
person.to_hash # => {:name=>["can not be nil"]} person.to_hash(true) # => {:name=>["name can not be nil"]}
# File lib/usecasing_validations/errors.rb, line 198 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 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>
# File lib/usecasing_validations/errors.rb, line 179 def to_xml(options={}) to_a.to_xml({ root: "errors", skip_types: true }.merge!(options)) end
Returns all message values.
person.errors.messages # => {:name=>["can not be nil", "must be specified"]} person.errors.values # => [["can not be nil", "must be specified"]]
# File lib/usecasing_validations/errors.rb, line 126 def values messages.values end
Private Instance Methods
# File lib/usecasing_validations/errors.rb, line 349 def normalize_message(attribute, message, options) message ||= :invalid case message when Symbol generate_message(attribute, message, Helpers._except(options, *CALLBACKS_OPTIONS)) when Proc message.call else message end end