Method: ActiveModel::Validations::HelperMethods#validates_numericality_of

Defined in:
activemodel/lib/active_model/validations/numericality.rb

#validates_numericality_of(*attr_names) ⇒ Object

Validates whether the value of the specified attribute is numeric by trying to convert it to a float with Kernel.Float (if only_integer is false) or applying it to the regular expression /\A[+\-]?\d+\z/ (if only_integer is set to true). Precision of Kernel.Float values are guaranteed up to 15 digits.

class Person < ActiveRecord::Base
  validates_numericality_of :value, on: :create
end

Configuration options:

  • :message - A custom error message (default is: “is not a number”).

  • :only_integer - Specifies whether the value has to be an integer (default is false).

  • :only_numeric - Specifies whether the value has to be an instance of Numeric (default is false). The default behavior is to attempt parsing the value if it is a String.

  • :allow_nil - Skip validation if attribute is nil (default is false). Notice that for Integer and Float columns empty strings are converted to nil.

  • :greater_than - Specifies the value must be greater than the supplied value. The default error message for this option is _“must be greater than %count”_.

  • :greater_than_or_equal_to - Specifies the value must be greater than or equal the supplied value. The default error message for this option is _“must be greater than or equal to %count”_.

  • :equal_to - Specifies the value must be equal to the supplied value. The default error message for this option is _“must be equal to %count”_.

  • :less_than - Specifies the value must be less than the supplied value. The default error message for this option is _“must be less than %count”_.

  • :less_than_or_equal_to - Specifies the value must be less than or equal the supplied value. The default error message for this option is _“must be less than or equal to %count”_.

  • :other_than - Specifies the value must be other than the supplied value. The default error message for this option is _“must be other than %count”_.

  • :odd - Specifies the value must be an odd number. The default error message for this option is _“must be odd”_.

  • :even - Specifies the value must be an even number. The default error message for this option is _“must be even”_.

  • :in - Check that the value is within a range. The default error message for this option is _“must be in %count”_.

There is also a list of default options supported by every validator: :if, :unless, :on, :allow_nil, :allow_blank, and :strict . See ActiveModel::Validations::ClassMethods#validates for more information.

The following checks can also be supplied with a proc or a symbol which corresponds to a method:

  • :greater_than

  • :greater_than_or_equal_to

  • :equal_to

  • :less_than

  • :less_than_or_equal_to

  • :only_integer

  • :other_than

For example:

class Person < ActiveRecord::Base
  validates_numericality_of :width, less_than: ->(person) { person.height }
  validates_numericality_of :width, greater_than: :minimum_weight
end



217
218
219
 
# File 'activemodel/lib/active_model/validations/numericality.rb', line 217

def validates_numericality_of(*attr_names)
  validates_with NumericalityValidator, _merge_attributes(attr_names)
end