validates_inclusion_of
- 1.0.0
- 1.1.6
- 1.2.6
- 2.0.3
- 2.1.0
- 2.2.1
- 2.3.8
- 3.0.0 (0)
- 3.0.9 (-2)
- 3.1.0 (26)
- 3.2.1 (7)
- 3.2.8 (4)
- 3.2.13 (0)
- 4.0.2 (-38)
- 4.1.8 (-6)
- 4.2.1 (0)
- 4.2.7 (0)
- 4.2.9 (0)
- 5.0.0.1 (1)
- 5.1.7 (0)
- 5.2.3 (0)
- 6.0.0 (1)
- 6.1.3.1 (0)
- 6.1.7.7 (0)
- 7.0.0 (0)
- 7.1.3.2 (0)
- 7.1.3.4 (0)
- What's this?
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" 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 with Range#cover? (backported in Active Support for 1.8), otherwise with include?.
-
:within - A synonym(or alias) for :in
-
: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).
-
:on - Specifies when this validation is active. Runs in all validation contexts by default (nil), other options are :create and :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.
-
:strict - Specifies whether validation should be strict. See ActiveModel::Validation#validates! for more information.