mirror of
https://github.com/rails/rails.git
synced 2022-11-09 12:12:34 -05:00
64 lines
3.6 KiB
Ruby
64 lines
3.6 KiB
Ruby
module ActiveModel
|
|
module Validations
|
|
class FormatValidator < EachValidator
|
|
def validate_each(record, attribute, value)
|
|
if options[:with] && value.to_s !~ options[:with]
|
|
record.errors.add(attribute, :invalid, :default => options[:message], :value => value)
|
|
elsif options[:without] && value.to_s =~ options[:without]
|
|
record.errors.add(attribute, :invalid, :default => options[:message], :value => value)
|
|
end
|
|
end
|
|
end
|
|
|
|
module ClassMethods
|
|
# Validates whether the value of the specified attribute is of the correct form, going by the regular expression provided.
|
|
# You can require that the attribute matches the regular expression:
|
|
#
|
|
# class Person < ActiveRecord::Base
|
|
# validates_format_of :email, :with => /\A([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})\Z/i, :on => :create
|
|
# end
|
|
#
|
|
# Alternatively, you can require that the specified attribute does _not_ match the regular expression:
|
|
#
|
|
# class Person < ActiveRecord::Base
|
|
# validates_format_of :email, :without => /NOSPAM/
|
|
# end
|
|
#
|
|
# Note: use <tt>\A</tt> and <tt>\Z</tt> to match the start and end of the string, <tt>^</tt> and <tt>$</tt> match the start/end of a line.
|
|
#
|
|
# You must pass either <tt>:with</tt> or <tt>:without</tt> as an option. In addition, both must be a regular expression,
|
|
# 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 +nil+ (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> - Regular expression that if the attribute matches will result in a successful validation.
|
|
# * <tt>:without</tt> - Regular expression that if the attribute does not match will result in a successful validation.
|
|
# * <tt>:on</tt> - Specifies when this validation is active (default is <tt>:save</tt>, other options <tt>:create</tt>, <tt>:update</tt>).
|
|
# * <tt>:if</tt> - Specifies a method, proc or string to call to determine if the validation should
|
|
# occur (e.g. <tt>:if => :allow_validation</tt>, or <tt>:if => Proc.new { |user| user.signup_step > 2 }</tt>). 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. <tt>:unless => :skip_validation</tt>, or <tt>:unless => Proc.new { |user| user.signup_step <= 2 }</tt>). The
|
|
# method, proc or string should return or evaluate to a true or false value.
|
|
def validates_format_of(*attr_names)
|
|
options = attr_names.extract_options!
|
|
|
|
unless options.include?(:with) ^ options.include?(:without) # ^ == xor, or "exclusive or"
|
|
raise ArgumentError, "Either :with or :without must be supplied (but not both)"
|
|
end
|
|
|
|
if options[:with] && !options[:with].is_a?(Regexp)
|
|
raise ArgumentError, "A regular expression must be supplied as the :with option of the configuration hash"
|
|
end
|
|
|
|
if options[:without] && !options[:without].is_a?(Regexp)
|
|
raise ArgumentError, "A regular expression must be supplied as the :without option of the configuration hash"
|
|
end
|
|
|
|
validates_with FormatValidator, options.merge(:attributes => attr_names)
|
|
end
|
|
end
|
|
end
|
|
end
|