2008-03-31 20:05:48 -04:00
|
|
|
module ActiveModel
|
2010-06-15 13:50:19 -04:00
|
|
|
# == Active Model Format Validator
|
2008-03-31 20:05:48 -04:00
|
|
|
module Validations
|
2009-12-22 18:36:51 -05:00
|
|
|
class FormatValidator < EachValidator
|
|
|
|
def validate_each(record, attribute, value)
|
2011-03-11 00:35:23 -05:00
|
|
|
if options[:with]
|
2011-04-11 12:01:10 -04:00
|
|
|
regexp = option_call(record, :with)
|
|
|
|
record_error(record, attribute, :with, value) if value.to_s !~ regexp
|
2011-03-11 00:35:23 -05:00
|
|
|
elsif options[:without]
|
2011-04-11 12:01:10 -04:00
|
|
|
regexp = option_call(record, :without)
|
|
|
|
record_error(record, attribute, :without, value) if value.to_s =~ regexp
|
2009-12-22 18:36:51 -05:00
|
|
|
end
|
|
|
|
end
|
2010-05-19 10:25:46 -04:00
|
|
|
|
2010-01-07 12:44:35 -05:00
|
|
|
def check_validity!
|
|
|
|
unless options.include?(:with) ^ options.include?(:without) # ^ == xor, or "exclusive or"
|
|
|
|
raise ArgumentError, "Either :with or :without must be supplied (but not both)"
|
|
|
|
end
|
|
|
|
|
2011-04-11 12:01:10 -04:00
|
|
|
check_options_validity(options, :with)
|
|
|
|
check_options_validity(options, :without)
|
|
|
|
end
|
|
|
|
|
|
|
|
private
|
|
|
|
|
|
|
|
def option_call(record, name)
|
|
|
|
option = options[name]
|
|
|
|
option.respond_to?(:call) ? option.call(record) : option
|
|
|
|
end
|
|
|
|
|
|
|
|
def record_error(record, attribute, name, value)
|
|
|
|
record.errors.add(attribute, :invalid, options.except(name).merge!(:value => value))
|
|
|
|
end
|
2010-01-07 12:44:35 -05:00
|
|
|
|
2011-04-11 12:01:10 -04:00
|
|
|
def check_options_validity(options, name)
|
|
|
|
option = options[name]
|
|
|
|
if option && !option.is_a?(Regexp) && !option.respond_to?(:call)
|
|
|
|
raise ArgumentError, "A regular expression or a proc or lambda must be supplied as :#{name}"
|
2010-01-07 12:44:35 -05:00
|
|
|
end
|
|
|
|
end
|
2009-12-22 18:36:51 -05:00
|
|
|
end
|
|
|
|
|
2010-05-11 06:28:42 -04:00
|
|
|
module HelperMethods
|
2012-05-16 02:23:46 -04:00
|
|
|
# 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:
|
2008-03-31 20:05:48 -04:00
|
|
|
#
|
|
|
|
# class Person < ActiveRecord::Base
|
|
|
|
# validates_format_of :email, :with => /\A([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})\Z/i, :on => :create
|
|
|
|
# end
|
|
|
|
#
|
2012-05-16 02:23:46 -04:00
|
|
|
# Alternatively, you can require that the specified attribute does _not_
|
|
|
|
# match the regular expression:
|
2009-08-09 22:47:32 -04:00
|
|
|
#
|
|
|
|
# class Person < ActiveRecord::Base
|
|
|
|
# validates_format_of :email, :without => /NOSPAM/
|
|
|
|
# end
|
|
|
|
#
|
2012-05-16 02:23:46 -04:00
|
|
|
# You can also provide a proc or lambda which will determine the regular
|
|
|
|
# expression that will be used to validate the attribute.
|
2011-03-11 00:35:23 -05:00
|
|
|
#
|
|
|
|
# class Person < ActiveRecord::Base
|
|
|
|
# # Admin can have number as a first letter in their screen name
|
2012-05-16 02:23:46 -04:00
|
|
|
# validates_format_of :screen_name,
|
|
|
|
# :with => lambda{ |person| person.admin? ? /\A[a-z0-9][a-z0-9_\-]*\Z/i : /\A[a-z][a-z0-9_\-]*\Z/i }
|
2011-03-11 00:35:23 -05:00
|
|
|
# end
|
|
|
|
#
|
2012-05-16 02:23:46 -04:00
|
|
|
# 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.
|
2008-03-31 20:05:48 -04:00
|
|
|
#
|
2012-05-16 02:23:46 -04:00
|
|
|
# You must pass either <tt>:with</tt> or <tt>:without</tt> as an option.
|
|
|
|
# In addition, both must be a regular expression or a proc or lambda, or
|
|
|
|
# else an exception will be raised.
|
2008-03-31 20:05:48 -04:00
|
|
|
#
|
|
|
|
# Configuration options:
|
2009-03-19 19:28:59 -04:00
|
|
|
# * <tt>:message</tt> - A custom error message (default is: "is invalid").
|
2012-05-16 02:23:46 -04:00
|
|
|
# * <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. This can be provided as a proc or lambda
|
|
|
|
# returning regular expression which will be called at runtime.
|
|
|
|
# * <tt>:without</tt> - Regular expression that if the attribute does not match
|
|
|
|
# will result in a successful validation. This can be provided as a proc or
|
|
|
|
# lambda returning regular expression which will be called at runtime.
|
2011-02-21 05:37:08 -05:00
|
|
|
# * <tt>:on</tt> - Specifies when this validation is active. Runs in all
|
|
|
|
# validation contexts by default (+nil+), other options are <tt>:create</tt>
|
|
|
|
# and <tt>:update</tt>.
|
2012-05-16 02:23:46 -04:00
|
|
|
# * <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
|
2008-03-31 20:05:48 -04:00
|
|
|
# method, proc or string should return or evaluate to a true or false value.
|
2011-08-17 10:26:00 -04:00
|
|
|
# * <tt>:strict</tt> - Specifies whether validation should be strict.
|
2012-05-16 02:23:46 -04:00
|
|
|
# See <tt>ActiveModel::Validation#validates!</tt> for more information.
|
2008-03-31 20:05:48 -04:00
|
|
|
def validates_format_of(*attr_names)
|
2010-01-07 12:44:35 -05:00
|
|
|
validates_with FormatValidator, _merge_attributes(attr_names)
|
2008-03-31 20:05:48 -04:00
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
2009-06-08 21:32:08 -04:00
|
|
|
end
|