Class: UseCaseValidations::Errors

Inherits:
Object
  • Object
show all
Includes:
Enumerable
Defined in:
lib/usecasing_validations/errors.rb

Constant Summary collapse

CALLBACKS_OPTIONS = 
[:if, :unless, :on, :allow_nil, :allow_blank, :strict]

Instance Attribute Summary collapse

Instance Method Summary collapse

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



17
18
19
20
 
# File 'lib/usecasing_validations/errors.rb', line 17

def initialize(base)
  @base     = base
  @messages = {}
end

Instance Attribute Details

#messages ⇒ Object (readonly)

Returns the value of attribute messages.



8
9
10
 
# File 'lib/usecasing_validations/errors.rb', line 8

def messages
  @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.

person.errors[:name]  # => ["can not be nil"]
person.errors['name'] # => ["can not be nil"]



80
81
82
 
# File 'lib/usecasing_validations/errors.rb', line 80

def [](attribute)
  get(attribute.to_sym) || set(attribute.to_sym, [])
end

#[]=(attribute, error) ⇒ Object

Adds to the supplied attribute the supplied error message.

person.errors[:name] = "must be set"
person.errors[:name] # => ['must be set']



88
89
90
 
# File 'lib/usecasing_validations/errors.rb', line 88

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.

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 # => {}



229
230
231
232
 
# File 'lib/usecasing_validations/errors.rb', line 229

def add(attribute, message = nil, options = {})
  message = normalize_message(attribute, message, options)
  self[attribute] << message
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.

person.errors.add :name, :blank
person.errors.added? :name, :blank # => true

Returns:

  • (Boolean) 


239
240
241
242
 
# 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

#as_json(options = nil) ⇒ Object

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"]}



189
190
191
 
# File 'lib/usecasing_validations/errors.rb', line 189

def as_json(options=nil)
  to_hash(options && options[:full_messages])
end

#clear ⇒ Object

Clear the error messages.

person.errors.full_messages # => ["name can not be nil"]
person.errors.clear
person.errors.full_messages # => []



32
33
34
 
# File 'lib/usecasing_validations/errors.rb', line 32

def clear
  messages.clear
end

#count ⇒ Object

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



153
154
155
 
# File 'lib/usecasing_validations/errors.rb', line 153

def count
  to_a.size
end

#delete(key) ⇒ Object

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



71
72
73
 
# File 'lib/usecasing_validations/errors.rb', line 71

def delete(key)
  messages.delete(key)
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.

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



106
107
108
109
110
 
# File 'lib/usecasing_validations/errors.rb', line 106

def each
  messages.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. If the error message is a string it can be empty.

person.errors.full_messages # => ["name can not be nil"]
person.errors.empty?        # => false

Returns:

  • (Boolean) 


162
163
164
 
# File 'lib/usecasing_validations/errors.rb', line 162

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.

person.errors.full_message(:name, 'is invalid') # => "Name is invalid"



275
276
277
278
279
280
281
282
283
284
285
 
# 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

#full_messages ⇒ Object

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"]



254
255
256
 
# File 'lib/usecasing_validations/errors.rb', line 254

def full_messages
  map { |attribute, message| full_message(attribute, message) }
end

#full_messages_for(attribute) ⇒ Object

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"]



268
269
270
 
# File 'lib/usecasing_validations/errors.rb', line 268

def full_messages_for(attribute)
  (get(attribute) || []).map { |message| full_message(attribute, message) }
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 the activemodel.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
339
340
341
342
343
344
345
346
 
# 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(key) ⇒ Object

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



53
54
55
 
# File 'lib/usecasing_validations/errors.rb', line 53

def get(key)
  messages[key]
end

#include?(attribute) ⇒ Boolean Also known as: has_key?

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

Returns:

  • (Boolean) 


42
43
44
 
# File 'lib/usecasing_validations/errors.rb', line 42

def include?(attribute)
  (v = messages[attribute]) && v.any?
end

#initialize_dup(other) ⇒ Object

:nodoc:



22
23
24
25
 
# File 'lib/usecasing_validations/errors.rb', line 22

def initialize_dup(other) # :nodoc:
  @messages = other.messages.dup
  super
end

#keys ⇒ Object

Returns all message keys.

person.errors.messages # => {:name=>["can not be nil", "must be specified"]}
person.errors.keys     # => [:name]



134
135
136
 
# File 'lib/usecasing_validations/errors.rb', line 134

def keys
  messages.keys
end

#set(key, value) ⇒ Object

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"]



62
63
64
 
# File 'lib/usecasing_validations/errors.rb', line 62

def set(key, value)
  messages[key] = value
end

#size ⇒ Object

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



118
119
120
 
# File 'lib/usecasing_validations/errors.rb', line 118

def size
  values.flatten.size
end

#to_a ⇒ Object

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"]



143
144
145
 
# File 'lib/usecasing_validations/errors.rb', line 143

def to_a
  full_messages
end

#to_hash(full_messages = false) ⇒ Object

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"]}



198
199
200
201
202
203
204
205
206
207
208
 
# 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

#to_xml(options = {}) ⇒ Object

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>



179
180
181
 
# File 'lib/usecasing_validations/errors.rb', line 179

def to_xml(options={})
  to_a.to_xml({ root: "errors", skip_types: true }.merge!(options))
end

#values ⇒ Object

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"]]



126
127
128
 
# File 'lib/usecasing_validations/errors.rb', line 126

def values
  messages.values
end