instance method
validates_inclusion_of
Ruby on Rails 3.1.12
Since v3.0.20Signature
validates_inclusion_of(*attr_names)
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" validates_inclusion_of :states, :in => lambda{ |person| STATES[person.country] } end
Configuration options:
-
:in- An enumerable object of available items. This can be supplied as a proc or lambda which returns an enumerable. If the enumerable is a range the test is performed withRange#cover?(backported in Active Support for 1.8), otherwise withinclude?. -
: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 isnil(default isfalse). -
:allow_blank- If set to true, skips this validation if the attribute is blank (default isfalse). -
:on- Specifies when this validation is active. Runs in all validation contexts by default (nil), other options are:createand:update. -
:if- Specifies a method, proc or string to call to determine if the validation should occur (e.g.:if => :allow_validation, or:if => Proc.new { |user| user.signup_step > 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 => :skip_validation, or:unless => Proc.new { |user| user.signup_step <= 2 }). The method, proc or string should return or evaluate to a true or false value.
Parameters
-
attr_namesrest
Source
# File activemodel/lib/active_model/validations/inclusion.rb, line 62
def validates_inclusion_of(*attr_names)
validates_with InclusionValidator, _merge_attributes(attr_names)
end
Defined in activemodel/lib/active_model/validations/inclusion.rb line 62
· View on GitHub
· Improve this page
· Find usages on GitHub
Defined in ActiveModel::Validations::HelperMethods