2008-03-31 20:05:48 -04:00
module ActiveModel
module Validations
2009-12-22 18:36:51 -05:00
class LengthValidator < EachValidator
2009-12-22 19:08:27 -05:00
OPTIONS = [ :is , :within , :in , :minimum , :maximum ] . freeze
MESSAGES = { :is = > :wrong_length , :minimum = > :too_short , :maximum = > :too_long } . freeze
CHECKS = { :is = > :== , :minimum = > :>= , :maximum = > :< = } . freeze
2009-12-22 18:36:51 -05:00
2009-12-22 19:08:27 -05:00
DEFAULT_TOKENIZER = lambda { | value | value . split ( / / ) }
2009-12-22 18:36:51 -05:00
attr_reader :type
def initialize ( options )
2009-12-22 19:08:27 -05:00
options [ :tokenizer ] || = DEFAULT_TOKENIZER
@type = ( OPTIONS & options . keys ) . first
2009-12-22 19:37:19 -05:00
super
2009-12-22 18:36:51 -05:00
end
2009-12-22 19:08:27 -05:00
def check_validity!
ensure_one_range_option!
ensure_argument_types!
end
2009-12-22 18:36:51 -05:00
def validate_each ( record , attribute , value )
checks = options . slice ( :minimum , :maximum , :is )
value = options [ :tokenizer ] . call ( value ) if value . kind_of? ( String )
if [ :within , :in ] . include? ( type )
range = options [ type ]
checks [ :minimum ] , checks [ :maximum ] = range . begin , range . end
checks [ :maximum ] -= 1 if range . exclude_end?
end
checks . each do | key , check_value |
custom_message = options [ :message ] || options [ MESSAGES [ key ] ]
validity_check = CHECKS [ key ]
valid_value = if key == :maximum
value . nil? || value . size . send ( validity_check , check_value )
else
value && value . size . send ( validity_check , check_value )
end
record . errors . add ( attribute , MESSAGES [ key ] , :default = > custom_message , :count = > check_value ) unless valid_value
end
end
2009-12-22 19:08:27 -05:00
protected
def ensure_one_range_option! #:nodoc:
range_options = OPTIONS & options . keys
case range_options . size
when 0
raise ArgumentError , 'Range unspecified. Specify the :within, :maximum, :minimum, or :is option.'
when 1
# Valid number of options; do nothing.
else
raise ArgumentError , 'Too many range options specified. Choose only one.'
end
end
def ensure_argument_types! #:nodoc:
value = options [ type ]
case type
when :within , :in
raise ArgumentError , " : #{ type } must be a Range " unless value . is_a? ( Range )
when :is , :minimum , :maximum
raise ArgumentError , " : #{ type } must be a nonnegative Integer " unless value . is_a? ( Integer ) && value > = 0
end
end
2009-12-22 18:36:51 -05:00
end
2008-03-31 20:05:48 -04:00
module ClassMethods
2009-03-19 19:28:59 -04:00
2008-03-31 20:05:48 -04:00
# Validates that the specified attribute matches the length restrictions supplied. Only one option can be used at a time:
#
# class Person < ActiveRecord::Base
2009-03-19 19:28:59 -04:00
# validates_length_of :first_name, :maximum=>30
# validates_length_of :last_name, :maximum=>30, :message=>"less than {{count}} if you don't mind"
2008-03-31 20:05:48 -04:00
# validates_length_of :fax, :in => 7..32, :allow_nil => true
# validates_length_of :phone, :in => 7..32, :allow_blank => true
# validates_length_of :user_name, :within => 6..20, :too_long => "pick a shorter name", :too_short => "pick a longer name"
2009-03-19 19:28:59 -04:00
# validates_length_of :fav_bra_size, :minimum => 1, :too_short => "please enter at least {{count}} character"
# validates_length_of :smurf_leader, :is => 4, :message => "papa is spelled with {{count}} characters... don't play me."
# validates_length_of :essay, :minimum => 100, :too_short => "Your essay must be at least {{count}} words."), :tokenizer => lambda {|str| str.scan(/\w+/) }
2008-03-31 20:05:48 -04:00
# end
#
# Configuration options:
2009-03-19 19:28:59 -04:00
# * <tt>:minimum</tt> - The minimum size of the attribute.
# * <tt>:maximum</tt> - The maximum size of the attribute.
# * <tt>:is</tt> - The exact size of the attribute.
# * <tt>:within</tt> - A range specifying the minimum and maximum size of the attribute.
# * <tt>:in</tt> - A synonym(or alias) for <tt>:within</tt>.
2008-05-02 09:45:23 -04:00
# * <tt>:allow_nil</tt> - Attribute may be +nil+; skip validation.
# * <tt>:allow_blank</tt> - Attribute may be blank; skip validation.
2009-03-19 19:28:59 -04:00
# * <tt>:too_long</tt> - The error message if the attribute goes over the maximum (default is: "is too long (maximum is {{count}} characters)").
# * <tt>:too_short</tt> - The error message if the attribute goes under the minimum (default is: "is too short (min is {{count}} characters)").
# * <tt>:wrong_length</tt> - The error message if using the <tt>:is</tt> method and the attribute is the wrong size (default is: "is the wrong length (should be {{count}} characters)").
# * <tt>:message</tt> - The error message to use for a <tt>:minimum</tt>, <tt>:maximum</tt>, or <tt>:is</tt> violation. An alias of the appropriate <tt>too_long</tt>/<tt>too_short</tt>/<tt>wrong_length</tt> message.
# * <tt>:on</tt> - Specifies when this validation is active (default is <tt>:save</tt>, other options <tt>:create</tt>, <tt>:update</tt>).
2008-05-02 09:45:23 -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.
2009-03-19 19:28:59 -04:00
# * <tt>:tokenizer</tt> - Specifies how to split up the attribute string. (e.g. <tt>:tokenizer => lambda {|str| str.scan(/\w+/)}</tt> to
# count words as in above example.)
# Defaults to <tt>lambda{ |value| value.split(//) }</tt> which counts individual characters.
2009-12-22 18:36:51 -05:00
def validates_length_of ( * attr_names )
2009-12-22 19:37:19 -05:00
options = attr_names . extract_options!
validates_with LengthValidator , options . merge ( :attributes = > attr_names )
2008-03-31 20:05:48 -04:00
end
alias_method :validates_size_of , :validates_length_of
end
end
2009-06-08 21:32:08 -04:00
end