module ActiveModel class Errors < Hash include DeprecatedErrorMethods class << self def default_error_messages message = "Errors.default_error_messages has been deprecated. Please use I18n.translate('activerecord.errors.messages')." ActiveSupport::Deprecation.warn(message) I18n.translate 'activerecord.errors.messages' end end def initialize(base) @base = base super() end alias_method :get, :[] alias_method :set, :[]= def [](attribute) if errors = get(attribute.to_sym) errors else set(attribute.to_sym, []) end end def []=(attribute, error) self[attribute.to_sym] << error end def each each_key do |attribute| self[attribute].each { |error| yield attribute, error } end end def size values.flatten.size end def to_a full_messages end def count to_a.size end def to_xml(options={}) options[:root] ||= "errors" options[:indent] ||= 2 options[:builder] ||= Builder::XmlMarkup.new(:indent => options[:indent]) options[:builder].instruct! unless options.delete(:skip_instruct) options[:builder].errors do |e| to_a.each { |error| e.error(error) } end end # Adds an error message (+messsage+) to the +attribute+, which will be returned on a call to on(attribute) # for the same attribute and ensure that this error object returns false when asked if empty?. More than one # error can be added to the same +attribute+ in which case an array will be returned on a call to on(attribute). # If no +messsage+ is supplied, :invalid is assumed. # If +message+ is a Symbol, it will be translated, using the appropriate scope (see translate_error). def add(attribute, message = nil, options = {}) message ||= :invalid message = generate_message(attribute, message, options) if message.is_a?(Symbol) self[attribute] << message end # Will add an error message to each of the attributes in +attributes+ that is empty. def add_on_empty(attributes, custom_message = nil) [attributes].flatten.each do |attribute| value = @base.respond_to?(attribute.to_s) ? @base.send(attribute.to_s) : @base[attribute.to_s] is_empty = value.respond_to?(:empty?) ? value.empty? : false add(attribute, :empty, :default => custom_message) unless !value.nil? && !is_empty end end # Will add an error message to each of the attributes in +attributes+ that is blank (using Object#blank?). def add_on_blank(attributes, custom_message = nil) [attributes].flatten.each do |attribute| value = @base.respond_to?(attribute.to_sym) ? @base.send(attribute.to_sym) : @base[attribute.to_sym] add(attribute, :blank, :default => custom_message) if value.blank? end end # Returns all the full error messages in an array. # # class Company < ActiveRecord::Base # 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", "Address can't be blank"] def full_messages(options = {}) full_messages = [] each do |attribute, messages| next if messages.empty? if attribute == :base messages.each {|m| full_messages << m } else if @base.class.respond_to?(:human_attribute_name) attr_name = @base.class.human_attribute_name(attribute.to_s) else attr_name = attribute.to_s.humanize end prefix = attr_name + I18n.t('activerecord.errors.format.separator', :default => ' ') messages.each do |m| full_messages << "#{prefix}#{m}" end end end full_messages end # Translates an error message in it's default scope (activerecord.errrors.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 it returns the translation of the # default message (e.g. activerecord.errors.messages.MESSAGE). The translated model name, # translated attribute name and the value are available for interpolation. # # When using inheritence 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: # #
    #
  1. activerecord.errors.models.admin.attributes.title.blank
  2. #
  3. activerecord.errors.models.admin.blank
  4. #
  5. activerecord.errors.models.user.attributes.title.blank
  6. #
  7. activerecord.errors.models.user.blank
  8. #
  9. activerecord.errors.messages.blank
  10. #
  11. any default you provided through the +options+ hash (in the activerecord.errors scope)
  12. #
def generate_message(attribute, message = :invalid, options = {}) message, options[:default] = options[:default], message if options[:default].is_a?(Symbol) defaults = @base.class.self_and_descendants_from_active_record.map do |klass| [ :"models.#{klass.name.underscore}.attributes.#{attribute}.#{message}", :"models.#{klass.name.underscore}.#{message}" ] end defaults << options.delete(:default) defaults = defaults.compact.flatten << :"messages.#{message}" key = defaults.shift value = @base.respond_to?(attribute) ? @base.send(attribute) : nil options = { :default => defaults, :model => @base.class.human_name, :attribute => @base.class.human_attribute_name(attribute.to_s), :value => value, :scope => [:activerecord, :errors] }.merge(options) I18n.translate(key, options) end end end