/ Ruby on Rails
/
method

validates_inclusion_of

rails latest stable - Class: ActiveRecord::Validations::ClassMethods

Method deprecated or moved

This method is deprecated or moved on the latest stable version. The last existing version (v2.3.8) is shown here.

validates_inclusion_of(*attr_names)
public

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 )
    validates_inclusion_of :age, :in => 0..99
    validates_inclusion_of :format, :in => %w( jpg gif png ), :message => "extension {{value}} is not included in the list"
  end

Configuration options:

  • :in - An enumerable object of available items.
  • :message - Specifies a custom error message (default is: "is not included in the list").
  • :allow_nil - If set to true, skips this validation if the attribute is nil (default is false).
  • :allow_blank - If set to true, skips this validation if the attribute is blank (default is false).
  • :if - Specifies a method, proc or string to call to determine if the validation should occur (e.g. :if =&gt; :allow_validation, or :if =&gt; Proc.new { |user| user.signup_step &gt; 2 }). The method, proc or string should return or evaluate to a true or false value.
  • :unless - Specifies a method, proc or string to call to determine if the validation should not occur (e.g. :unless =&gt; :skip_validation, or :unless =&gt; Proc.new { |user| user.signup_step &lt;= 2 }). The method, proc or string should return or evaluate to a true or false value.