Class: Lev::BetterActiveModelErrors

Inherits:
Object
  • Object
show all
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, options = {})
    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.full_messages  # => ["name can not be nil"]
# etc..

Constant Summary collapse

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

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
  @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 



324
325
326
327
328
329
330
331
332
333
 
# File 'lib/lev/better_active_model_errors.rb', line 324

def self.full_message(model, attribute, message)
  return message 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:   message
  })
end

.generate_message(model, attribute, type = :invalid, options = {}) ⇒ Object

TODO maybe don’t need this method split out any more?



364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
 
# File 'lib/lev/better_active_model_errors.rb', line 364

def self.generate_message(model, attribute, type = :invalid, options = {})
  type = options.delete(:message) if options[: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 << options.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)

  options = {
    :default => defaults,
    :model => model.class.model_name.human,
    :attribute => model.class.human_attribute_name(attribute),
    :value => value
  }.merge(options)

  I18n.translate(key, options)
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"]



147
148
149
 
# File 'lib/lev/better_active_model_errors.rb', line 147

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



155
156
157
 
# File 'lib/lev/better_active_model_errors.rb', line 155

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.



266
267
268
269
270
271
272
273
274
 
# File 'lib/lev/better_active_model_errors.rb', line 266

def add(attribute, message = nil, options = {})
  normalized_message = normalize_message(attribute, message, options)
  if options[:strict]
    raise ActiveModel::StrictValidationFailed, full_message(attribute, normalized_message)
  end

  self[attribute] << normalized_message
  self.types[attribute.to_sym] << message.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?).



286
287
288
289
290
291
 
# File 'lib/lev/better_active_model_errors.rb', line 286

def add_on_blank(attributes, options = {})
  [attributes].flatten.each do |attribute|
    value = @base.send(:read_attribute_for_validation, attribute)
    add(attribute, :blank, options) 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.



277
278
279
280
281
282
283
 
# File 'lib/lev/better_active_model_errors.rb', line 277

def add_on_empty(attributes, options = {})
  [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, options) 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

Returns:

  • (Boolean) 


297
298
299
300
 
# File 'lib/lev/better_active_model_errors.rb', line 297

def added?(attribute, message = nil, options = {})
  message = normalize_message(attribute, message, options)
  self[attribute].include? message
end

#as_json(options = nil) ⇒ Object

Returns an ActiveSupport::OrderedHash that can be used as the JSON representation for this object.



248
249
250
 
# File 'lib/lev/better_active_model_errors.rb', line 248

def as_json(options=nil)
  to_hash
end

#clear ⇒ Object

Clear the messages



109
110
111
112
 
# File 'lib/lev/better_active_model_errors.rb', line 109

def clear
  types.clear
  messages.clear
end

#copy!(other) ⇒ Object

copy & details are needed to match ‘ActiveModel::Errors` interface



87
88
89
 
# File 'lib/lev/better_active_model_errors.rb', line 87

def copy!(other)
  initialize_dup(other)
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



221
222
223
 
# File 'lib/lev/better_active_model_errors.rb', line 221

def count
  to_a.size
end

#delete(key) ⇒ Object

Delete messages for key



136
137
138
139
140
 
# File 'lib/lev/better_active_model_errors.rb', line 136

def delete(key)
  key = key.to_sym
  types.delete(key)
  messages.delete(key)
end

#details ⇒ Object 



90
91
92
 
# File 'lib/lev/better_active_model_errors.rb', line 90

def details
  {}
end

#dup ⇒ Object

:nodoc:



101
102
103
104
105
 
# File 'lib/lev/better_active_model_errors.rb', line 101

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



173
174
175
176
177
 
# File 'lib/lev/better_active_model_errors.rb', line 173

def each
  messages.each_key do |attribute|
    self[attribute].each { |error| yield attribute, error }
  end
end

#each_with_type_and_message ⇒ Object 



179
180
181
182
183
184
185
 
# File 'lib/lev/better_active_model_errors.rb', line 179

def each_with_type_and_message
  types.each_key do |attribute|
    for ii in 0..self.types[attribute].size-1
      yield attribute, self.types[attribute][ii], self.messages[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.

Returns:

  • (Boolean) 


227
228
229
 
# File 'lib/lev/better_active_model_errors.rb', line 227

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.full_message(:name, "is invalid")  # =>
  "Name is invalid"



320
321
322
 
# File 'lib/lev/better_active_model_errors.rb', line 320

def full_message(attribute, message)
  self.class.full_message(@base, attribute, message)
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.full_messages # =>
  ["Name is too short (minimum is 5 characters)", "Name can't be blank", "Email can't be blank"]



312
313
314
 
# File 'lib/lev/better_active_model_errors.rb', line 312

def full_messages
  map { |attribute, 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



359
360
361
 
# File 'lib/lev/better_active_model_errors.rb', line 359

def generate_message(attribute, type = :invalid, options = {})
  self.class.generate_message(@base, attribute, type, options)
end

#get(key) ⇒ Object

Get messages for key



121
122
123
 
# File 'lib/lev/better_active_model_errors.rb', line 121

def get(key)
  messages[key.to_sym]
end

#get_type(key) ⇒ Object 



125
126
127
 
# File 'lib/lev/better_active_model_errors.rb', line 125

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?

Returns:

  • (Boolean) 


115
116
117
 
# File 'lib/lev/better_active_model_errors.rb', line 115

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

#initialize_dup(other) ⇒ Object 



94
95
96
97
 
# File 'lib/lev/better_active_model_errors.rb', line 94

def initialize_dup(other)
  @types = other.types.dup
  @messages = other.messages.dup
end

#keys ⇒ Object

Returns all message keys



203
204
205
 
# File 'lib/lev/better_active_model_errors.rb', line 203

def keys
  messages.keys
end

#set(key, value) ⇒ Object

Set messages for key to value



130
131
132
133
 
# File 'lib/lev/better_active_model_errors.rb', line 130

def set(key, value)
  types[key.to_sym] = (value == [] ? [] : (value.is_a?(Symbol) ? value : nil))
  messages[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



193
194
195
 
# File 'lib/lev/better_active_model_errors.rb', line 193

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



212
213
214
 
# File 'lib/lev/better_active_model_errors.rb', line 212

def to_a
  full_messages
end

#to_hash ⇒ Object 



252
253
254
 
# File 'lib/lev/better_active_model_errors.rb', line 252

def to_hash
  messages.dup
end

#to_s ⇒ Object 



256
257
258
 
# File 'lib/lev/better_active_model_errors.rb', line 256

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>



243
244
245
 
# File 'lib/lev/better_active_model_errors.rb', line 243

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

#values ⇒ Object

Returns all message values



198
199
200
 
# File 'lib/lev/better_active_model_errors.rb', line 198

def values
  messages.values
end