2008-03-31 20:05:48 -04:00
|
|
|
module ActiveModel
|
2012-05-16 11:01:43 -04:00
|
|
|
|
2008-03-31 20:05:48 -04:00
|
|
|
module Validations
|
2012-10-21 02:26:01 -04:00
|
|
|
class NumericalityValidator < EachValidator # :nodoc:
|
2013-05-01 20:10:06 -04:00
|
|
|
CHECKS = { greater_than: :>, greater_than_or_equal_to: :>=,
|
|
|
|
equal_to: :==, less_than: :<, less_than_or_equal_to: :<=,
|
|
|
|
odd: :odd?, even: :even?, other_than: :!= }.freeze
|
2009-12-22 19:08:27 -05:00
|
|
|
|
2010-06-21 06:17:24 -04:00
|
|
|
RESERVED_OPTIONS = CHECKS.keys + [:only_integer]
|
|
|
|
|
2009-12-22 19:08:27 -05:00
|
|
|
def check_validity!
|
2010-01-11 17:37:48 -05:00
|
|
|
keys = CHECKS.keys - [:odd, :even]
|
|
|
|
options.slice(*keys).each do |option, value|
|
2013-11-14 21:19:03 -05:00
|
|
|
unless value.is_a?(Numeric) || value.is_a?(Proc) || value.is_a?(Symbol)
|
|
|
|
raise ArgumentError, ":#{option} must be a number, a symbol or a proc"
|
|
|
|
end
|
2009-12-22 19:08:27 -05:00
|
|
|
end
|
|
|
|
end
|
2009-12-22 18:36:51 -05:00
|
|
|
|
|
|
|
def validate_each(record, attr_name, value)
|
2013-01-06 17:36:11 -05:00
|
|
|
before_type_cast = :"#{attr_name}_before_type_cast"
|
2009-12-22 18:36:51 -05:00
|
|
|
|
2013-01-06 17:36:11 -05:00
|
|
|
raw_value = record.send(before_type_cast) if record.respond_to?(before_type_cast)
|
2009-12-22 19:08:27 -05:00
|
|
|
raw_value ||= value
|
2009-12-22 18:36:51 -05:00
|
|
|
|
2014-11-30 20:24:53 -05:00
|
|
|
if record_attribute_changed_in_place?(record, attr_name)
|
|
|
|
raw_value = value
|
|
|
|
end
|
|
|
|
|
2009-12-22 19:08:27 -05:00
|
|
|
return if options[:allow_nil] && raw_value.nil?
|
2009-12-22 18:36:51 -05:00
|
|
|
|
2010-04-24 13:17:14 -04:00
|
|
|
unless value = parse_raw_value_as_a_number(raw_value)
|
2010-05-19 10:25:46 -04:00
|
|
|
record.errors.add(attr_name, :not_a_number, filtered_options(raw_value))
|
2009-12-22 19:08:27 -05:00
|
|
|
return
|
2009-12-22 18:36:51 -05:00
|
|
|
end
|
|
|
|
|
2014-06-22 06:22:27 -04:00
|
|
|
if allow_only_integer?(record)
|
2010-04-24 13:17:14 -04:00
|
|
|
unless value = parse_raw_value_as_an_integer(raw_value)
|
2010-05-19 10:25:46 -04:00
|
|
|
record.errors.add(attr_name, :not_an_integer, filtered_options(raw_value))
|
2010-04-24 13:17:14 -04:00
|
|
|
return
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2009-12-22 18:36:51 -05:00
|
|
|
options.slice(*CHECKS.keys).each do |option, option_value|
|
|
|
|
case option
|
|
|
|
when :odd, :even
|
2009-12-22 19:08:27 -05:00
|
|
|
unless value.to_i.send(CHECKS[option])
|
2010-05-19 10:25:46 -04:00
|
|
|
record.errors.add(attr_name, option, filtered_options(value))
|
2009-12-22 18:36:51 -05:00
|
|
|
end
|
|
|
|
else
|
2013-11-14 21:19:28 -05:00
|
|
|
case option_value
|
|
|
|
when Proc
|
|
|
|
option_value = option_value.call(record)
|
|
|
|
when Symbol
|
|
|
|
option_value = record.send(option_value)
|
|
|
|
end
|
2009-12-22 19:08:27 -05:00
|
|
|
|
|
|
|
unless value.send(CHECKS[option], option_value)
|
2013-11-14 21:24:40 -05:00
|
|
|
record.errors.add(attr_name, option, filtered_options(value).merge!(count: option_value))
|
2009-12-22 18:36:51 -05:00
|
|
|
end
|
|
|
|
end
|
2010-04-24 13:17:14 -04:00
|
|
|
end
|
2009-12-22 18:36:51 -05:00
|
|
|
end
|
|
|
|
|
2009-12-22 19:08:27 -05:00
|
|
|
protected
|
2008-03-31 20:05:48 -04:00
|
|
|
|
2010-04-24 13:17:14 -04:00
|
|
|
def parse_raw_value_as_a_number(raw_value)
|
2013-11-14 20:59:40 -05:00
|
|
|
Kernel.Float(raw_value) if raw_value !~ /\A0[xX]/
|
|
|
|
rescue ArgumentError, TypeError
|
|
|
|
nil
|
2009-12-22 19:08:27 -05:00
|
|
|
end
|
|
|
|
|
2010-04-24 13:17:14 -04:00
|
|
|
def parse_raw_value_as_an_integer(raw_value)
|
2014-10-02 16:55:22 -04:00
|
|
|
raw_value.to_i if raw_value.to_s =~ /\A[+-]?\d+\z/
|
2010-04-24 13:17:14 -04:00
|
|
|
end
|
|
|
|
|
2010-05-19 10:25:46 -04:00
|
|
|
def filtered_options(value)
|
2013-11-14 21:05:10 -05:00
|
|
|
filtered = options.except(*RESERVED_OPTIONS)
|
|
|
|
filtered[:value] = value
|
|
|
|
filtered
|
2010-05-19 10:25:46 -04:00
|
|
|
end
|
2014-06-22 06:22:27 -04:00
|
|
|
|
|
|
|
def allow_only_integer?(record)
|
|
|
|
case options[:only_integer]
|
|
|
|
when Symbol
|
|
|
|
record.send(options[:only_integer])
|
|
|
|
when Proc
|
|
|
|
options[:only_integer].call(record)
|
|
|
|
else
|
|
|
|
options[:only_integer]
|
|
|
|
end
|
|
|
|
end
|
2014-11-30 20:24:53 -05:00
|
|
|
|
|
|
|
private
|
|
|
|
|
|
|
|
def record_attribute_changed_in_place?(record, attr_name)
|
|
|
|
record.respond_to?(:attribute_changed_in_place?) &&
|
|
|
|
record.attribute_changed_in_place?(attr_name.to_s)
|
|
|
|
end
|
2009-12-22 19:08:27 -05:00
|
|
|
end
|
|
|
|
|
2010-05-11 06:28:42 -04:00
|
|
|
module HelperMethods
|
2012-07-05 01:09:29 -04:00
|
|
|
# Validates whether the value of the specified attribute is numeric by
|
|
|
|
# trying to convert it to a float with Kernel.Float (if <tt>only_integer</tt>
|
|
|
|
# is +false+) or applying it to the regular expression <tt>/\A[\+\-]?\d+\Z/</tt>
|
|
|
|
# (if <tt>only_integer</tt> is set to +true+).
|
2008-03-31 20:05:48 -04:00
|
|
|
#
|
|
|
|
# class Person < ActiveRecord::Base
|
2012-07-05 01:09:29 -04:00
|
|
|
# validates_numericality_of :value, on: :create
|
2008-03-31 20:05:48 -04:00
|
|
|
# end
|
|
|
|
#
|
|
|
|
# Configuration options:
|
2008-05-09 05:38:02 -04:00
|
|
|
# * <tt>:message</tt> - A custom error message (default is: "is not a number").
|
2012-07-05 01:09:29 -04:00
|
|
|
# * <tt>:only_integer</tt> - Specifies whether the value has to be an
|
|
|
|
# integer, e.g. an integral value (default is +false+).
|
2012-05-16 02:23:46 -04:00
|
|
|
# * <tt>:allow_nil</tt> - Skip validation if attribute is +nil+ (default is
|
|
|
|
# +false+). Notice that for fixnum and float columns empty strings are
|
|
|
|
# converted to +nil+.
|
|
|
|
# * <tt>:greater_than</tt> - Specifies the value must be greater than the
|
|
|
|
# supplied value.
|
2012-07-05 01:09:29 -04:00
|
|
|
# * <tt>:greater_than_or_equal_to</tt> - Specifies the value must be
|
|
|
|
# greater than or equal the supplied value.
|
|
|
|
# * <tt>:equal_to</tt> - Specifies the value must be equal to the supplied
|
2012-05-16 02:23:46 -04:00
|
|
|
# value.
|
2012-07-05 01:09:29 -04:00
|
|
|
# * <tt>:less_than</tt> - Specifies the value must be less than the
|
|
|
|
# supplied value.
|
|
|
|
# * <tt>:less_than_or_equal_to</tt> - Specifies the value must be less
|
|
|
|
# than or equal the supplied value.
|
|
|
|
# * <tt>:other_than</tt> - Specifies the value must be other than the
|
|
|
|
# supplied value.
|
2008-05-09 05:38:02 -04:00
|
|
|
# * <tt>:odd</tt> - Specifies the value must be an odd number.
|
|
|
|
# * <tt>:even</tt> - Specifies the value must be an even number.
|
2012-07-10 03:07:38 -04:00
|
|
|
#
|
|
|
|
# There is also a list of default options supported by every validator:
|
2014-01-26 14:47:56 -05:00
|
|
|
# +:if+, +:unless+, +:on+, +:allow_nil+, +:allow_blank+, and +:strict+ .
|
2012-07-10 03:07:38 -04:00
|
|
|
# See <tt>ActiveModel::Validation#validates</tt> for more information
|
2012-05-16 02:23:46 -04:00
|
|
|
#
|
|
|
|
# The following checks can also be supplied with a proc or a symbol which
|
|
|
|
# corresponds to a method:
|
2009-08-31 14:34:46 -04:00
|
|
|
#
|
|
|
|
# * <tt>:greater_than</tt>
|
|
|
|
# * <tt>:greater_than_or_equal_to</tt>
|
|
|
|
# * <tt>:equal_to</tt>
|
|
|
|
# * <tt>:less_than</tt>
|
|
|
|
# * <tt>:less_than_or_equal_to</tt>
|
2014-06-22 06:22:27 -04:00
|
|
|
# * <tt>:only_integer</tt>
|
2009-08-31 14:34:46 -04:00
|
|
|
#
|
2012-05-16 02:23:46 -04:00
|
|
|
# For example:
|
|
|
|
#
|
2009-08-31 14:34:46 -04:00
|
|
|
# class Person < ActiveRecord::Base
|
2012-10-25 21:41:35 -04:00
|
|
|
# validates_numericality_of :width, less_than: ->(person) { person.height }
|
2012-07-05 01:09:29 -04:00
|
|
|
# validates_numericality_of :width, greater_than: :minimum_weight
|
2009-08-31 14:34:46 -04:00
|
|
|
# end
|
2008-03-31 20:05:48 -04:00
|
|
|
def validates_numericality_of(*attr_names)
|
2010-01-07 12:44:35 -05:00
|
|
|
validates_with NumericalityValidator, _merge_attributes(attr_names)
|
2008-03-31 20:05:48 -04:00
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
2009-06-08 21:32:08 -04:00
|
|
|
end
|