aboutsummaryrefslogtreecommitdiffstats
path: root/activemodel/lib/active_model/validations/inclusion.rb
diff options
context:
space:
mode:
authorDavid Heinemeier Hansson <david@loudthinking.com>2008-04-01 00:05:48 +0000
committerDavid Heinemeier Hansson <david@loudthinking.com>2008-04-01 00:05:48 +0000
commit87535bd373a1d8a437b1d04a0272d35025192a79 (patch)
tree2bc21fac76ac0ad4facec36197a414b9c7d56bba /activemodel/lib/active_model/validations/inclusion.rb
parenta5445fd9c50161b8ccf2b36fcd26025882f73eaa (diff)
downloadrails-87535bd373a1d8a437b1d04a0272d35025192a79.tar.gz
rails-87535bd373a1d8a437b1d04a0272d35025192a79.tar.bz2
rails-87535bd373a1d8a437b1d04a0272d35025192a79.zip
Splitting them up first
git-svn-id: http://svn-commit.rubyonrails.org/rails/trunk@9173 5ecf4fe2-1ee6-0310-87b1-e25e094e27de
Diffstat (limited to 'activemodel/lib/active_model/validations/inclusion.rb')
-rw-r--r--activemodel/lib/active_model/validations/inclusion.rb37
1 files changed, 37 insertions, 0 deletions
diff --git a/activemodel/lib/active_model/validations/inclusion.rb b/activemodel/lib/active_model/validations/inclusion.rb
new file mode 100644
index 0000000000..0c9dce92b4
--- /dev/null
+++ b/activemodel/lib/active_model/validations/inclusion.rb
@@ -0,0 +1,37 @@
+module ActiveModel
+ module Validations
+ module ClassMethods
+ # 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
+ # validates_inclusion_of :format, :in => %w( jpg gif png ), :message => "extension %s is not included in the list"
+ # end
+ #
+ # Configuration options:
+ # * <tt>in</tt> - An enumerable object of available items
+ # * <tt>message</tt> - Specifies a customer error message (default is: "is not included in the list")
+ # * <tt>allow_nil</tt> - If set to true, skips this validation if the attribute is null (default is: false)
+ # * <tt>allow_blank</tt> - If set to true, skips this validation if the attribute is blank (default is: false)
+ # * <tt>if</tt> - 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.
+ # * <tt>unless</tt> - 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.
+ def validates_inclusion_of(*attr_names)
+ configuration = { :message => ActiveRecord::Errors.default_error_messages[:inclusion], :on => :save }
+ configuration.update(attr_names.extract_options!)
+
+ enum = configuration[:in] || configuration[:within]
+
+ 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?")
+
+ validates_each(attr_names, configuration) do |record, attr_name, value|
+ record.errors.add(attr_name, configuration[:message] % value) unless enum.include?(value)
+ end
+ end
+ end
+ end
+end \ No newline at end of file