aboutsummaryrefslogtreecommitdiffstats
path: root/activemodel/lib/active_model/validations/format.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/format.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/format.rb')
-rw-r--r--activemodel/lib/active_model/validations/format.rb39
1 files changed, 39 insertions, 0 deletions
diff --git a/activemodel/lib/active_model/validations/format.rb b/activemodel/lib/active_model/validations/format.rb
new file mode 100644
index 0000000000..f8395543ec
--- /dev/null
+++ b/activemodel/lib/active_model/validations/format.rb
@@ -0,0 +1,39 @@
+module ActiveModel
+ module Validations
+ module ClassMethods
+ # 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 => /\A([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})\Z/i, :on => :create
+ # end
+ #
+ # Note: use \A and \Z to match the start and end of the string, ^ and $ match the start/end of a line.
+ #
+ # A regular expression must be provided or else an exception will be raised.
+ #
+ # Configuration options:
+ # * <tt>message</tt> - A custom error message (default is: "is invalid")
+ # * <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>with</tt> - The regular expression used to validate the format with (note: must be supplied!)
+ # * <tt>on</tt> Specifies when this validation is active (default is :save, other options :create, :update)
+ # * <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_format_of(*attr_names)
+ configuration = { :message => ActiveRecord::Errors.default_error_messages[:invalid], :on => :save, :with => nil }
+ configuration.update(attr_names.extract_options!)
+
+ raise(ArgumentError, "A regular expression must be supplied as the :with option of the configuration hash") unless configuration[:with].is_a?(Regexp)
+
+ validates_each(attr_names, configuration) do |record, attr_name, value|
+ record.errors.add(attr_name, configuration[:message]) unless value.to_s =~ configuration[:with]
+ end
+ end
+ end
+ end
+end \ No newline at end of file