instance method `validates_length_of`

Ruby on Rails 4.0.13

Since v3.0.20

Available in: v3.0.20 v3.1.12 v3.2.22.5 v4.0.13 v4.1.16 v4.2.9 v5.2.8.1 v6.0.6 v6.1.7.10 v7.0.10 v7.1.6 v7.2.3 v8.0.4 v8.1.2

Compare with:

validates_length_of(*attr_names)

Validates that the specified attribute matches the length restrictions supplied. Only one option can be used at a time:

class Person < ActiveRecord::Base
  validates_length_of :first_name, maximum: 30
  validates_length_of :last_name, maximum: 30, message: "less than 30 if you don't mind"
  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'
  validates_length_of :zip_code, minimum: 5, too_short: 'please enter at least 5 characters'
  validates_length_of :smurf_leader, is: 4, message: "papa is spelled with 4 characters... don't play me."
  validates_length_of :essay, minimum: 100, too_short: 'Your essay must be at least 100 words.',
                      tokenizer: ->(str) { str.scan(/\w+/) }
end

Configuration options:

:minimum - The minimum size of the attribute.
:maximum - The maximum size of the attribute. Allows nil by default if not used with :minimum.
:is - The exact size of the attribute.
:within - A range specifying the minimum and maximum size of the attribute.
:in - A synonym (or alias) for :within.
:allow_nil - Attribute may be nil; skip validation.
:allow_blank - Attribute may be blank; skip validation.
:too_long - The error message if the attribute goes over the maximum (default is: “is too long (maximum is %{count} characters)”).
:too_short - The error message if the attribute goes under the minimum (default is: “is too short (min is %{count} characters)”).
:wrong_length - The error message if using the :is method and the attribute is the wrong size (default is: “is the wrong length (should be %{count} characters)”).
:message - The error message to use for a :minimum, :maximum, or :is violation. An alias of the appropriate too_long/too_short/wrong_length message.
:tokenizer - Specifies how to split up the attribute string. (e.g. tokenizer: ->(str) { str.scan(/\w+/) } to count words as in above example). Defaults to ->(value) { value.split(//) } which counts individual characters.

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

Parameters

attr_names rest

Source

# File activemodel/lib/active_model/validations/length.rb, line 119
      def validates_length_of(*attr_names)
        validates_with LengthValidator, _merge_attributes(attr_names)
      end

Defined in activemodel/lib/active_model/validations/length.rb line 119 · View on GitHub · Improve this page · Find usages on GitHub

Defined in ActiveModel::Validations::HelperMethods

Signature

Parameters