Module: ActiveRecord::Validations::ClassMethods

Defined in:
lib/active_record/validations.rb

Overview

All of the following validations are defined in the class scope of the model that you’re interested in validating. They offer a more declarative way of specifying when the model is valid and when it is not. It is recommended to use these over the low-level calls to validate and validate_on_create when possible.

Constant Summary collapse

DEFAULT_VALIDATION_OPTIONS = 
{
  :on => :save,
  :allow_nil => false,
  :message => nil
}.freeze
DEFAULT_SIZE_VALIDATION_OPTIONS = 
DEFAULT_VALIDATION_OPTIONS.merge(
  :too_long => ActiveRecord::Errors.default_error_messages[:too_long],
  :too_short => ActiveRecord::Errors.default_error_messages[:too_short],
  :wrong_length => ActiveRecord::Errors.default_error_messages[:wrong_length]
).freeze
ALL_RANGE_OPTIONS = 
[ :is, :within, :in, :minimum, :maximum ].freeze

Instance Method Summary collapse

Instance Method Details

#validate(*methods, &block) ⇒ Object 



211
212
213
214
 
# File 'lib/active_record/validations.rb', line 211

def validate(*methods, &block)
  methods << block if block_given?
  write_inheritable_set(:validate, methods)
end

#validate_on_create(*methods, &block) ⇒ Object 



216
217
218
219
 
# File 'lib/active_record/validations.rb', line 216

def validate_on_create(*methods, &block)
  methods << block if block_given?
  write_inheritable_set(:validate_on_create, methods)
end

#validate_on_update(*methods, &block) ⇒ Object 



221
222
223
224
 
# File 'lib/active_record/validations.rb', line 221

def validate_on_update(*methods, &block)
  methods << block if block_given?
  write_inheritable_set(:validate_on_update, methods)
end

#validates_acceptance_of(*attr_names) ⇒ Object

Encapsulates the pattern of wanting to validate the acceptance of a terms of service check box (or similar agreement). Example:

class Person < ActiveRecord::Base
  validates_acceptance_of :terms_of_service
  validates_acceptance_of :eula, :message => "must be abided"
end

The terms_of_service attribute is entirely virtual. No database column is needed. This check is performed only if terms_of_service is not nil and by default on save.

Configuration options:

  • message - A custom error message (default is: “can’t be empty”)

  • on - Specifies when this validation is active (default is :save, other options :create, :update)

NOTE: The agreement is considered valid if it’s set to the string “1”. This makes it easy to relate it to an HTML checkbox.



296
297
298
299
300
301
302
303
304
305
 
# File 'lib/active_record/validations.rb', line 296

def validates_acceptance_of(*attr_names)
  configuration = { :message => ActiveRecord::Errors.default_error_messages[:accepted], :on => :save }
  configuration.update(attr_names.pop) if attr_names.last.is_a?(Hash)
  configuration[:message].gsub!(/\"/, '\\\\\"')

  for attr_name in attr_names
    attr_accessor(attr_name)
    class_eval(%(#{validation_method(configuration[:on])} %{errors.add('#{attr_name}', "#{configuration[:message]}") unless #{attr_name}.nil? or #{attr_name} == "1"}))
  end
end

#validates_associated(*attr_names) ⇒ Object

Validates whether the associated object or objects are all themselves valid. Works with any kind of association.

class Book < ActiveRecord::Base
  has_many :pages
  belongs_to :library

  validates_associated :pages, :library
end

Warning: If, after the above definition, you then wrote:

class Page < ActiveRecord::Base
  belongs_to :book

  validates_associated :book
end

this would specify a circular dependency and cause infinite recursion. The Rails team recommends against this practice.

Configuration options:

  • on Specifies when this validation is active (default is :save, other options :create, :update)



504
505
506
507
508
509
510
511
512
513
514
515
 
# File 'lib/active_record/validations.rb', line 504

def validates_associated(*attr_names)
  configuration = { :message => ActiveRecord::Errors.default_error_messages[:invalid], :on => :save }
  configuration.update(attr_names.pop) if attr_names.last.is_a?(Hash)
  configuration[:message].gsub!(/\"/, '\\\\\"')
  
  for attr_name in attr_names
    class_eval(%(#{validation_method(configuration[:on])} %{
      errors.add("#{attr_name}", "#{configuration[:message]}") unless
        (#{attr_name}.is_a?(Array) ? #{attr_name} : [#{attr_name}]).inject(true){ |memo, record| (record.nil? or record.valid?) and memo }
    }))
  end
end

#validates_confirmation_of(*attr_names) ⇒ Object

Encapsulates the pattern of wanting to validate a password or email address field with a confirmation. Example:

Model:
  class Person < ActiveRecord::Base
    validates_confirmation_of :user_name, :password
    validates_confirmation_of :email_address, :message => "should match confirmation"
  end

View:
  <%= password_field "person", "password" %>
  <%= password_field "person", "password_confirmation" %>

The person has to already have a password attribute (a column in the people table), but the password_confirmation is virtual. It exists only as an in-memory variable for validating the password. This check is performed only if password_confirmation is not nil and by default on save.

Configuration options:

  • message - A custom error message (default is: “doesn’t match confirmation”)

  • on - Specifies when this validation is active (default is :save, other options :create, :update)



270
271
272
273
274
275
276
277
278
279
 
# File 'lib/active_record/validations.rb', line 270

def validates_confirmation_of(*attr_names)
  configuration = { :message => ActiveRecord::Errors.default_error_messages[:confirmation], :on => :save }
  configuration.update(attr_names.pop) if attr_names.last.is_a?(Hash)
  configuration[:message].gsub!(/\"/, '\\\\\"')

  for attr_name in attr_names
    attr_accessor "#{attr_name}_confirmation"
    class_eval(%(#{validation_method(configuration[:on])} %{errors.add('#{attr_name}', "#{configuration[:message]}") unless #{attr_name}_confirmation.nil? or #{attr_name} == #{attr_name}_confirmation}))
  end
end

#validates_each(*attrs) ⇒ Object

Validates each attribute against a block.

class Person < ActiveRecord::Base
  validates_each :first_name, :last_name do |record, attr|
    record.errors.add attr, 'starts with z.' if attr[0] == ?z
  end
end

Options:

  • on - Specifies when this validation is active (default is :save, other options :create, :update)

  • allow_nil - Skip validation if attribute is nil.



237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/active_record/validations.rb', line 237

def validates_each(*attrs)
  options = attrs.last.is_a?(Hash) ? attrs.pop.symbolize_keys : {}
  attrs = attrs.flatten

  # Declare the validation.
  send(validation_method(options[:on] || :save)) do |record|
    attrs.each do |attr|
      value = record.send(attr)
      next if value.nil? && options[:allow_nil]
      yield record, attr, value
    end
  end
end

#validates_format_of(*attr_names) ⇒ Object

Validates whether the value of the specified attribute is of the correct form by matching it against the regular expression provided.

class Person < ActiveRecord::Base
  validates_format_of :email, :with => /^([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})$/, :on => :create
end

A regular expression must be provided or else an exception will be raised.

Configuration options:

  • message - A custom error message (default is: “is invalid”)

  • with - The regular expression used to validate the format with (note: must be supplied!)

  • on Specifies when this validation is active (default is :save, other options :create, :update)

Raises:

  • (ArgumentError) 


441
442
443
444
445
446
447
448
449
450
451
 
# File 'lib/active_record/validations.rb', line 441

def validates_format_of(*attr_names)
  configuration = { :message => ActiveRecord::Errors.default_error_messages[:invalid], :on => :save, :with => nil }
  configuration.update(attr_names.pop) if attr_names.last.is_a?(Hash)
  configuration[:message].gsub!(/\"/, '\\\\\"')

  raise(ArgumentError, "A regular expression must be supplied as the :with option of the configuration hash") unless configuration[:with].is_a?(Regexp)

  for attr_name in attr_names 
    class_eval(%(#{validation_method(configuration[:on])} %{errors.add("#{attr_name}", "#{configuration[:message]}") unless #{attr_name} and #{attr_name}.to_s.match(/#{Regexp.quote(configuration[:with].source)}/)}))
  end
end

#validates_inclusion_of(*attr_names) ⇒ Object

Validates whether the value of the specified attribute is available in a particular enumerable object.

class Person < ActiveRecord::Base
  validates_inclusion_of :gender, :in=>%w( m f ), :message=>"woah! what are you then!??!!"
  validates_inclusion_of :age, :in=>0..99
end

Configuration options:

  • in - An enumerable object of available items

  • message - Specifies a customer error message (default is: “is not included in the list”)

  • allow_nil - If set to true, skips this validation if the attribute is null (default is: false)

Raises:

  • (ArgumentError) 


464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
 
# File 'lib/active_record/validations.rb', line 464

def validates_inclusion_of(*attr_names)
  configuration = { :message => ActiveRecord::Errors.default_error_messages[:inclusion], :on => :save }
  configuration.update(attr_names.pop) if attr_names.last.is_a?(Hash)
  configuration[:message].gsub!(/\"/, '\\\\\"')

  enum = configuration[:in] || configuration[:within]
  allow_nil = configuration[:allow_nil]

  raise(ArgumentError, "An object with the method include? is required must be supplied as the :in option of the configuration hash") unless enum.respond_to?("include?")

  for attr_name in attr_names
    if allow_nil
      class_eval(%(#{validation_method(configuration[:on])} %{errors.add("#{attr_name}", "#{configuration[:message]}") unless #{attr_name}.nil? or (#{enum.inspect}).include?(#{attr_name}) }))
    else
      class_eval(%(#{validation_method(configuration[:on])} %{errors.add("#{attr_name}", "#{configuration[:message]}") unless (#{enum.inspect}).include?(#{attr_name}) }))
    end
  end
end

#validates_length_of(*attrs) ⇒ Object Also known as: validates_size_of

Validates that the specified attribute matches the length restrictions supplied. Only one option can be used at a time:

class Person < ActiveRecord::Base
  validates_length_of :first_name, :maximum=>30
  validates_length_of :last_name, :maximum=>30, :message=>"less than %d if you don't mind"
  validates_length_of :fax, :in => 7..32, :allow_nil => true
  validates_length_of :user_name, :within => 6..20, :too_long => "pick a shorter name", :too_short => "pick a longer name"
  validates_length_of :fav_bra_size, :minimum=>1, :too_short=>"please enter at least %d character"
  validates_length_of :smurf_leader, :is=>4, :message=>"papa is spelled with %d characters... don't play me."
end

Configuration options:

  • minimum - The minimum size of the attribute

  • maximum - The maximum size of the attribute

  • is - The exact size of the attribute

  • within - A range specifying the minimum and maximum size of the attribute

  • in - A synonym(or alias) for :within

  • allow_nil - Attribute may be nil; skip validation.

  • too_long - The error message if the attribute goes over the maximum (default is: “is too long (max is %d characters)”)

  • too_short - The error message if the attribute goes under the minimum (default is: “is too short (min is %d characters)”)

  • wrong_length - The error message if using the :is method and the attribute is the wrong size (default is: “is the wrong length (should be %d characters)”)

  • message - The error message to use for a :minimum, :maximum, or :is violation. An alias of the appropriate too_long/too_short/wrong_length message

  • on - Specifies when this validation is active (default is :save, other options :create, :update)



346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
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
396
 
# File 'lib/active_record/validations.rb', line 346

def validates_length_of(*attrs)
  # Merge given options with defaults.
  options = DEFAULT_SIZE_VALIDATION_OPTIONS.dup
  options.update(attrs.pop.symbolize_keys) if attrs.last.is_a?(Hash)

  # Ensure that one and only one range option is specified.
  range_options = ALL_RANGE_OPTIONS & options.keys
  case range_options.size
  when 0
    raise ArgumentError, 'Range unspecified.  Specify the :within, :maximum, :minimum, or :is option.'
  when 1
    # Valid number of options; do nothing.
  else
    raise ArgumentError, 'Too many range options specified.  Choose only one.'
  end

  # Get range option and value.
  option = range_options.first
  option_value = options[range_options.first]

  # Declare different validations per option.
  case range_options.first
  when :within, :in
    raise ArgumentError, ':within must be a Range' unless option_value.is_a?(Range)
    validates_each(attrs, options) do |record, attr|
      next if record.send(attr).nil? and options[:allow_nil]
      record.errors.add_on_boundary_breaking(attr, option_value, options[:too_long], options[:too_short])
    end
  when :is
    raise ArgumentError, ':is must be a nonnegative Integer' unless option_value.is_a?(Integer) and option_value >= 0
    message = options[:message] || options[:wrong_length]
    message = (message % option_value) rescue message
    validates_each(attrs, options) do |record, attr, value|
      record.errors.add(attr, message) if value.nil? or value.size != option_value
    end
  when :minimum
    raise ArgumentError, ':minimum must be a nonnegative Integer' unless option_value.is_a?(Integer) and option_value >= 0
    message = options[:message] || options[:too_short]
    message = (message % option_value) rescue message
    validates_each(attrs, options) do |record, attr, value|
      record.errors.add(attr, message) if value.nil? or value.size < option_value
    end
  when :maximum
    raise ArgumentError, ':maximum must be a nonnegative Integer' unless option_value.is_a?(Integer) and option_value >= 0
    message = options[:message] || options[:too_long]
    message = (message % option_value) rescue message
    validates_each(attrs, options) do |record, attr, value|
      record.errors.add(attr, message) if value.nil? or value.size > option_value
    end
  end
end

#validates_numericality_of(*attr_names) ⇒ Object

Validates whether the value of the specified attribute is numeric by trying to convert it to a float with Kernel.Float (if integer is false) or applying it to the regular expression /^[+\-]?\d+$/ (if integer is set to true).

class Person < ActiveRecord::Base
  validates_numericality_of :value, :on => :create
end

Configuration options:

  • message - A custom error message (default is: “is not a number”)

  • on Specifies when this validation is active (default is :save, other options :create, :update)

  • only_integer Specifies whether the value has to be an integer, e.g. an integral value (default is false)



529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
 
# File 'lib/active_record/validations.rb', line 529

def validates_numericality_of(*attr_names)
  configuration = { :message => ActiveRecord::Errors.default_error_messages[:not_a_number], :on => :save,
                     :integer => false }
  configuration.update(attr_names.pop) if attr_names.last.is_a?(Hash)

  for attr_name in attr_names
    if configuration[:only_integer]
      # we have to use a regexp here, because Kernel.Integer accepts nil and "0xdeadbeef", but does not
      # accept "099" and String#to_i accepts everything. The string containing the regexp is evaluated twice
      # so we have to escape everything properly
      class_eval(%(#{validation_method(configuration[:on])} %{
          errors.add("#{attr_name}", "#{configuration[:message]}") unless #{attr_name}_before_type_cast.to_s =~ /^[\\\\+\\\\-]?\\\\d+$/
      }))          
    else
      class_eval(%(#{validation_method(configuration[:on])} %{
          begin
            Kernel.Float(#{attr_name}_before_type_cast)
          rescue ArgumentError, TypeError
            errors.add("#{attr_name}", "#{configuration[:message]}")
          end
      }))
    end
  end
end

#validates_presence_of(*attr_names) ⇒ Object

Validates that the specified attributes are neither nil nor empty. Happens by default on save.

Configuration options:

  • message - A custom error message (default is: “has already been taken”)

  • on - Specifies when this validation is active (default is :save, other options :create, :update)



312
313
314
315
316
317
318
319
320
 
# File 'lib/active_record/validations.rb', line 312

def validates_presence_of(*attr_names)
  configuration = { :message => ActiveRecord::Errors.default_error_messages[:empty], :on => :save }
  configuration.update(attr_names.pop) if attr_names.last.is_a?(Hash)
  configuration[:message].gsub!(/\"/, '\\\\\"')

  for attr_name in attr_names
    class_eval(%(#{validation_method(configuration[:on])} %{errors.add_on_empty('#{attr_name}', "#{configuration[:message]}")}))
  end
end

#validates_uniqueness_of(*attr_names) ⇒ Object

Validates whether the value of the specified attributes are unique across the system. Useful for making sure that only one user can be named “davidhh”.

class Person < ActiveRecord::Base
  validates_uniqueness_of :user_name, :scope => "account_id"
end

When the record is created, a check is performed to make sure that no record exist in the database with the given value for the specified attribute (that maps to a column). When the record is updated, the same check is made but disregarding the record itself.

Configuration options:

  • message - Specifies a custom error message (default is: “has already been taken”)

  • scope - Ensures that the uniqueness is restricted to a condition of “scope = record.scope”



414
415
416
417
418
419
420
421
422
423
424
425
426
 
# File 'lib/active_record/validations.rb', line 414

def validates_uniqueness_of(*attr_names)
  configuration = { :message => ActiveRecord::Errors.default_error_messages[:taken] }
  configuration.update(attr_names.pop) if attr_names.last.is_a?(Hash)
  configuration[:message].gsub!(/\"/, '\\\\\"')

  for attr_name in attr_names
    if scope = configuration[:scope]
      class_eval(%(validate %{errors.add('#{attr_name}', "#{configuration[:message]}") if self.class.find_first(new_record? ? ['#{attr_name} = ? AND #{scope} = ?', #{attr_name}, #{scope}] : ["#{attr_name} = ? AND \\\#{self.class.primary_key} <> ? AND #{scope} = ?", #{attr_name}, id, #{scope}])}))
    else
      class_eval(%(validate %{errors.add('#{attr_name}', "#{configuration[:message]}") if self.class.find_first(new_record? ? ['#{attr_name} = ?', #{attr_name}] : ["#{attr_name} = ? AND \\\#{self.class.primary_key} <> ?", #{attr_name}, id])}))
    end
  end
end