How to customize a custom validator error message?

luislavena · February 9, 2012, 12:23pm

I have this custom validator:

class EmailFormatValidator < ActiveModel::EachValidator
def validate_each(object, attribute, value)
unless value =~ /^([^@\s]+)@((?:[-a-z0-9]+.)+[a-z]{2,})$/i
object.errors[attribute] << (options[:message] || ‘is not valid’)
end
end
end

I’m using it in my user.rb model this way:

validates :email, presence: true, email_format: true

When email is invalid, this is the error shown:

Email is not valid

How can I customize the entire string?

I have tried this way in the custom validator:

class EmailFormatValidator < ActiveModel::EachValidator
def validate_each(object, attribute, value)
unless value =~ /^([^@\s]+)@((?:[-a-z0-9]+.)+[a-z]{2,})$/i
object.errors[attribute] = “Maybe your email is malformed.”
end
end
end

But it is always prefixing the field name in the error:

Email Maybe your email is malformed.

casper_the_ghost · February 9, 2012, 1:19pm

On Wed, Feb 8, 2012 at 5:50 PM, David M [email protected] wrote:

I’m using it in my user.rb model this way:

Email Maybe your email is malformed.

Which exact code are you using to “show” the error message?

Internally, the error message is only remembered as “is not valid” or
“can’t be blank” (without the attribute name, as you want to have),
but certain forms of showing the error (related to the “full_message”
function of ActiveModel errors.rb) join it by default with the attribute
name:

E.g.

$ rails c
Loading development environment (Rails 3.2.1)
1.9.3p0 :001 > o = Order.new
1.9.3p0 :002 > o.valid?
=> false
1.9.3p0 :004 > o.errors[:name]
=> [“can’t be blank”]
1.9.3p0 :005 > o.errors.full_messages
=> [“Name can’t be blank” …]
1.9.3p0 :007 > o.errors.full_messages[0]
=> “Name can’t be blank”

So, if you simply used user.errors[attribute], you would get the
error message without the attribute prepended.

If you want to have the list of all of them, code like this might help

1.9.3p0 :011 > o.errors.map{|attr, message| message}.join(‘
’)
=> "can’t be blank
can’t be blank
… "

Using I18n can resolve the problem in two ways:

…/config/locales$ cat errors.yml
en:

errors:
# The default format to use in full error messages.
# format: “%{attribute} %{message}”
format: “%{message}”

activerecord:
errors:
models:
order:
attributes:
name:
blank: Please fill in the name for this order

$ rails c
Loading development environment (Rails 3.2.1)
1.9.3p0 :001 > o = Order.new
1.9.3p0 :002 > o.valid?
=> false
1.9.3p0 :003 > o.errors.full_messages
=> [“Please fill in the name for this order”, “can’t be blank”, …]

I have changed 2 things here:

the error message itself for the Order#name attribute for a :blank
condition is customized.
the default “errors.format” that is used to form the “full_message”
string is changed to only have the error message (not prepended with
the attribute).

Source code can be found here:

github.com

rails/rails/blob/main/activemodel/lib/active_model/locale/en.yml#L4


      
          en:
            errors:
              # The default format to use in full error messages.
              format: "%{attribute} %{message}"
          
          
    # The values :model, :attribute and :value are always available for interpolation
              # The value :count is available when applicable. Can be used for pluralization.
              messages:
                model_invalid: "Validation failed: %{errors}"
                inclusion: "is not included in the list"
                exclusion: "is reserved"
                invalid: "is invalid"
                confirmation: "doesn’t match %{attribute}"
                accepted: "must be accepted"

github.com

rails/rails/blob/main/activemodel/lib/active_model/errors.rb#L272


      
          #   person.errors.group_by_attribute
          #   # => {:name=>[<#ActiveModel::Error>, <#ActiveModel::Error>]}
          def group_by_attribute
            @errors.group_by(&:attribute)
          end
          
          
# Adds a new error of +type+ on +attribute+.
          # More than one error can be added to the same +attribute+.
          # If no +type+ is supplied, <tt>:invalid</tt> is assumed.
          #
          #   person.errors.add(:name)
          #   # Adds <#ActiveModel::Error attribute=name, type=invalid>
          #   person.errors.add(:name, :not_implemented, message: "must be implemented")
          #   # Adds <#ActiveModel::Error attribute=name, type=not_implemented,
          #                               options={:message=>"must be implemented"}>
          #
          #   person.errors.messages
          #   # => {:name=>["is invalid", "must be implemented"]}
          #
          # If +type+ is a string, it will be used as error message.
          #

HTH,

Peter

*** Available for a new project ***

Peter V.
http://twitter.com/peter_v
http://rails.vandenabeele.com
http://coderwall.com/peter_v

casper_the_ghost · February 10, 2012, 3:46am

On Wed, Feb 8, 2012 at 11:50, David M [email protected] wrote:

class EmailFormatValidator < ActiveModel::EachValidator
def validate_each(object, attribute, value)
unless value =~ /^([^@\s]+)@((?:[-a-z0-9]+.)+[a-z]{2,})$/i
object.errors[attribute] << (options[:message] || ‘is not valid’)
end
end
end
…
When email is invalid, this is the error shown:

Email is not valid

How can I customize theentire string?

I have tried this way in the custom validator:
…
object.errors[attribute] = “Maybe your email is malformed.”

Note the difference in the technique you’re using to alter
object.errors[attribute] in each case. Try mimicking the original way
more closely. Let us know if that works.

-Dave

–
Dave A.: Available Cleared Ruby on Rails Freelancer
(NoVa/DC/Remote) – see www.DaveAronson.com, and blogs at
www.Codosaur.us, www.Dare2XL.com, www.RecruitingRants.com