модуль ActiveModel::Validations::HelperMethods
Публичные методы экземпляров
# File activemodel/lib/active_model/validations/absence.rb, line 28 def validates_absence_of(*attr_names) validates_with AbsenceValidator, _merge_attributes(attr_names) end
Проверяет, что указанные атрибуты пусты (как определено в Object#present?). Происходит по умолчанию при сохранении.
class Person < ActiveRecord::Base validates_absence_of :first_name end
Атрибут first_name должен присутствовать в объекте и быть пустым.
Параметры конфигурации:
-
:message- Пользовательское сообщение об ошибке (по умолчанию: «должен быть пустым»).
Также существует список стандартных параметров, поддерживаемых каждым валидатором: :if, :unless, :on, :allow_nil, :allow_blank, и :strict. См. ActiveModel::Validations#validates для получения дополнительной информации
# File activemodel/lib/active_model/validations/acceptance.rb, line 108 def validates_acceptance_of(*attr_names) validates_with AcceptanceValidator, _merge_attributes(attr_names) end
Оборачивает проверку принятия условий обслуживания (или аналогичного соглашения).
class Person < ActiveRecord::Base validates_acceptance_of :terms_of_service validates_acceptance_of :eula, message: 'must be abided' end
Если столбец базы данных не существует, атрибут terms_of_service полностью виртуальный. Эта проверка выполняется только если terms_of_service не nil и по умолчанию при сохранении.
Параметры конфигурации:
-
:message- Пользовательское сообщение об ошибке (по умолчанию: «должен быть принят»). -
:accept- Указывает значение, которое считается принятым. Также принимает массив возможных значений. Значение по умолчанию — массив [“1”, true], что упрощает связь с флажком HTML. Это значение должно быть установлено или включатьtrue, если вы валидируете столбец базы данных, так как атрибут приводится к типу «1» вtrueперед валидацией.
Также существует список стандартных параметров, поддерживаемых каждым валидатором: :if, :unless, :on, :allow_nil, :allow_blank, и :strict. См. ActiveModel::Validations#validates для получения дополнительной информации.
# File activemodel/lib/active_model/validations/comparison.rb, line 77 def validates_comparison_of(*attr_names) validates_with ComparisonValidator, _merge_attributes(attr_names) end
Проверяет, что значение указанного атрибута удовлетворяет всем определённым сравнениям с другим значением, процедурой или атрибутом.
class Person < ActiveRecord::Base validates_comparison_of :value, greater_than: 'the sum of its parts' end
Параметры конфигурации:
-
:message- Пользовательское сообщение об ошибке (по умолчанию: «сравнение не выполнено»). -
:greater_than- Указывает, что значение должно быть больше предоставленного значения. -
:greater_than_or_equal_to- Указывает, что значение должно быть больше или равно предоставленному значению. -
:equal_to- Указывает, что значение должно быть равно предоставленному значению. -
:less_than- Указывает, что значение должно быть меньше предоставленного значения. -
:less_than_or_equal_to- Указывает, что значение должно быть меньше или равно предоставленному значению. -
:other_than- Указывает, что значение не должно быть равно предоставленному значению.
Также существует список стандартных параметров, поддерживаемых каждым валидатором: :if, :unless, :on, :allow_nil, :allow_blank, и :strict . См. ActiveModel::Validations#validates для получения дополнительной информации
Валидатор требует по крайней мере одной из следующих проверок. Каждая из них может принимать процедуру, значение или символ, соответствующий методу:
-
:greater_than -
:greater_than_or_equal_to -
:equal_to -
:less_than -
:less_than_or_equal_to -
:other_than
Например:
class Person < ActiveRecord::Base
validates_comparison_of :birth_date, less_than_or_equal_to: -> { Date.today }
validates_comparison_of :preferred_name, other_than: :given_name, allow_nil: true
end
# File activemodel/lib/active_model/validations/confirmation.rb, line 75 def validates_confirmation_of(*attr_names) validates_with ConfirmationValidator, _merge_attributes(attr_names) end
Оборачивает проверку пароля или адреса электронной почты с подтверждением.
Model:
class Person < ActiveRecord::Base
validates_confirmation_of :user_name, :password
validates_confirmation_of :email_address,
message: 'should match confirmation'
end
View:
<%= password_field "person", "password" %>
<%= password_field "person", "password_confirmation" %> Добавленный атрибут password_confirmation виртуальный; он существует только как атрибут в памяти для проверки пароля. Для этого валидация добавляет аксессоры к модели для подтверждения атрибута.
ПРИМЕЧАНИЕ: Эта проверка выполняется только если password_confirmation не nil. Чтобы потребовать подтверждение, убедитесь, что вы добавили проверку наличия для атрибута подтверждения:
validates_presence_of :password_confirmation, if: :password_changed?
Параметры конфигурации:
-
:message- Пользовательское сообщение об ошибке (по умолчанию: «не совпадает с%{translated_attribute_name}»). -
:case_sensitive- Ищет точное совпадение. Игнорируется для столбцов, отличных от текстовых (по умолчаниюtrue).
Также существует список стандартных параметров, поддерживаемых каждым валидатором: :if, :unless, :on, :allow_nil, :allow_blank, и :strict. См. ActiveModel::Validations#validates для получения дополнительной информации
# File activemodel/lib/active_model/validations/exclusion.rb, line 44 def validates_exclusion_of(*attr_names) validates_with ExclusionValidator, _merge_attributes(attr_names) end
Проверяет, что значение указанного атрибута не содержится в определённом перечисляемом объекте.
class Person < ActiveRecord::Base
validates_exclusion_of :username, in: %w( admin superuser ), message: "You don't belong here"
validates_exclusion_of :age, in: 30..60, message: 'This site is only for under 30 and over 60'
validates_exclusion_of :format, in: %w( mov avi ), message: "extension %{value} is not allowed"
validates_exclusion_of :password, in: ->(person) { [person.username, person.first_name] },
message: 'should not be the same as your username or first name'
validates_exclusion_of :karma, in: :reserved_karmas
end
Параметры конфигурации:
-
:in- Перечисляемый объект элементов, в которые значение не должно входить. Может быть задан как процедура, лямбда или символ, возвращающий перечисляемый объект. Если перечисляемый объект — числовой, временной или диапазон дат, проверка выполняется с помощьюRange#cover?, в противном случае — с помощьюinclude?. При использовании процедуры или лямбды экземпляр, подлежащий проверке, передаётся как аргумент. -
:within- Синоним (или псевдоним) для:inRange#cover?, в противном случае сinclude?. -
:message- Указывает пользовательское сообщение об ошибке (по умолчанию: «зарезервировано»).
Также существует список стандартных параметров, поддерживаемых каждым валидатором: :if, :unless, :on, :allow_nil, :allow_blank, и :strict. См. ActiveModel::Validations#validates для получения дополнительной информации
# File activemodel/lib/active_model/validations/format.rb, line 108 def validates_format_of(*attr_names) validates_with FormatValidator, _merge_attributes(attr_names) end
Проверяет, соответствует ли значение указанного атрибута предоставленному регулярному выражению. Вы можете потребовать, чтобы атрибут соответствовал регулярному выражению:
class Person < ActiveRecord::Base
validates_format_of :email, with: /\A([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})\z/i, on: :create
end
Или потребовать, чтобы указанный атрибут не соответствовал регулярному выражению:
class Person < ActiveRecord::Base validates_format_of :email, without: /NOSPAM/ end
Вы также можете предоставить процедуру или лямбду, которые определят регулярное выражение, используемое для проверки атрибута.
class Person < ActiveRecord::Base
# Admin can have number as a first letter in their screen name
validates_format_of :screen_name,
with: ->(person) { person.admin? ? /\A[a-z0-9][a-z0-9_\-]*\z/i : /\A[a-z][a-z0-9_\-]*\z/i }
end
Примечание: используйте \A и \z для соответствия началу и концу строки, ^ и $ соответствуют началу/концу строки.
Из-за частой неправильной интерпретации ^ и $, вам нужно передать параметр multiline: true, если вы используете эти два якоря в предоставленном регулярном выражении. В большинстве случаев вы должны использовать \A и \z.
Вы должны передать либо :with либо :without в качестве параметра. Кроме того, оба должны быть регулярным выражением, процедурой или лямбдой, иначе будет выброшено исключение.
Параметры конфигурации:
-
:message- Пользовательское сообщение об ошибке (по умолчанию: «не соответствует формату»). -
:with- Регулярное выражение, которое, если атрибут соответствует ему, приведет к успешной проверке. Может быть предоставлено как процедура или лямбда, возвращающая регулярное выражение, которое будет вызвано во время выполнения. -
:without- Регулярное выражение, которое, если атрибут ему не соответствует, приведет к успешной проверке. Может быть предоставлено как процедура или лямбда, возвращающая регулярное выражение, которое будет вызвано во время выполнения. -
:multiline- Установите в значение true, если ваше регулярное выражение содержит якоря, соответствующие началу или концу строк, а не началу или концу строки. Эти якоря —^и$.
Также существует список стандартных параметров, поддерживаемых каждым валидатором: :if, :unless, :on, :allow_nil, :allow_blank, и :strict. См. ActiveModel::Validations#validates для получения дополнительной информации
# File activemodel/lib/active_model/validations/inclusion.rb, line 42 def validates_inclusion_of(*attr_names) validates_with InclusionValidator, _merge_attributes(attr_names) end
Проверяет, доступно ли значение указанного атрибута в определённом перечисляемом объекте.
class Person < ActiveRecord::Base
validates_inclusion_of :role, in: %w( admin contributor )
validates_inclusion_of :age, in: 0..99
validates_inclusion_of :format, in: %w( jpg gif png ), message: "extension %{value} is not included in the list"
validates_inclusion_of :states, in: ->(person) { STATES[person.country] }
validates_inclusion_of :karma, in: :available_karmas
end
Параметры конфигурации:
-
:in- Перечисляемый объект доступных элементов. Может быть передан как proc, lambda или символ, возвращающий перечисляемый объект. Если перечисляемый объект является числовым, временным или временным диапазоном, проверка выполняется сRange#cover?, в противном случае сinclude?. При использовании proc или lambda в качестве аргумента передаётся экземпляр, подлежащий валидации. -
:within- Синоним (или псевдоним) для:in -
:message- Указывает пользовательское сообщение об ошибке (по умолчанию: «не входит в список»).
Также поддерживается список стандартных параметров всех валидаторов: :if, :unless, :on, :allow_nil, :allow_blank, и :strict. Подробную информацию см. в ActiveModel::Validations#validates
# File activemodel/lib/active_model/validations/length.rb, line 122 def validates_length_of(*attr_names) validates_with LengthValidator, _merge_attributes(attr_names) end
Проверяет, соответствуют ли указанные атрибуты ограничениям длины, которые были переданы. Только один параметр ограничения может использоваться за раз, за исключением :minimum и :maximum, которые могут использоваться совместно:
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 :words_in_essay, minimum: 100, too_short: 'Your essay must be at least 100 words.'
private
def words_in_essay
essay.scan(/\w+/)
end
end
Параметры ограничения:
-
:minimum- Минимальный размер атрибута. -
:maximum- Максимальный размер атрибута. По умолчанию позволяетnil, если не используется с:minimum. -
:is- Точный размер атрибута. -
:within- Диапазон, задающий минимальный и максимальный размер атрибута. -
:in- Синоним (или псевдоним) для:within.
Другие параметры:
-
:allow_nil- Атрибут может бытьnil; проверка пропускается. -
:allow_blank- Атрибут может быть пустым; проверка пропускается. -
:too_long- Сообщение об ошибке, если атрибут превышает максимальную длину (по умолчанию: «слишком длинный (максимум %{count} символов)»). -
:too_short- Сообщение об ошибке, если атрибут короче минимальной длины (по умолчанию: «слишком короткий (минимум %{count} символов)»). -
:wrong_length- Сообщение об ошибке при использовании метода:isи атрибут имеет неправильный размер (по умолчанию: «неправильная длина (должно быть %{count} символов)»). -
:message- Сообщение об ошибке для нарушения:minimum,:maximum, или:is. Псевдоним соответствующего сообщенияtoo_long/too_short/wrong_length
Также поддерживается список стандартных параметров всех валидаторов: :if, :unless, :on и :strict. Подробную информацию см. в ActiveModel::Validations#validates
# File activemodel/lib/active_model/validations/numericality.rb, line 205 def validates_numericality_of(*attr_names) validates_with NumericalityValidator, _merge_attributes(attr_names) end
Проверяет, является ли значение указанного атрибута числовым, пытаясь преобразовать его в float с помощью Kernel.Float (если only_integer равно false) или применяя его к регулярному выражению /\A[+\-]?\d+\z/ (если only_integer установлено в true). Точность значений Kernel.Float гарантируется до 15 цифр.
class Person < ActiveRecord::Base validates_numericality_of :value, on: :create end
Параметры конфигурации:
-
:message- Пользовательское сообщение об ошибке (по умолчанию: «не является числом»). -
:only_integer- Указывает, должен ли атрибут быть целым числом (по умолчаниюfalse). -
:allow_nil- Пропуск валидации, если атрибутnil(по умолчаниюfalse). Обратите внимание, что для столбцовIntegerиFloatпустые строки преобразуются вnil -
:greater_than- Указывает, что значение должно быть больше указанного. -
:greater_than_or_equal_to- Указывает, что значение должно быть больше или равно указанному. -
:equal_to- Указывает, что значение должно быть равно указанному. -
:less_than- Указывает, что значение должно быть меньше указанного. -
:less_than_or_equal_to- Указывает, что значение должно быть меньше или равно указанному. -
:other_than- Указывает, что значение не должно быть равно указанному. -
:odd- Указывает, что значение должно быть нечётным. -
:even- Указывает, что значение должно быть чётным. -
:in- Проверка, что значение находится в заданном диапазоне.
Также поддерживается список стандартных параметров всех валидаторов: :if, :unless, :on, :allow_nil, :allow_blank, и :strict. Подробную информацию см. в ActiveModel::Validations#validates
Следующие проверки также могут быть переданы с помощью proc или символа, соответствующего методу:
-
:greater_than -
:greater_than_or_equal_to -
:equal_to -
:less_than -
:less_than_or_equal_to -
:only_integer -
:other_than
Например:
class Person < ActiveRecord::Base
validates_numericality_of :width, less_than: ->(person) { person.height }
validates_numericality_of :width, greater_than: :minimum_weight
end
# File activemodel/lib/active_model/validations/presence.rb, line 34 def validates_presence_of(*attr_names) validates_with PresenceValidator, _merge_attributes(attr_names) end
Проверяет, что указанные атрибуты не являются пустыми (как определено в Object#blank?). Происходит по умолчанию при сохранении.
class Person < ActiveRecord::Base validates_presence_of :first_name end
Атрибут first_name должен присутствовать в объекте и не может быть пустым.
Если необходимо проверить наличие булевого поля (где реальные значения true и false), следует использовать validates_inclusion_of :field_name, in: [true, false].
Это связано с тем, как Object#blank? обрабатывает значения булевого типа: false.blank? # => true.
Параметры конфигурации:
-
:message- Пользовательское сообщение об ошибке (по умолчанию: «не может быть пустым»).
Также поддерживается список стандартных параметров всех валидаторов: :if, :unless, :on, :allow_nil, :allow_blank, и :strict. Подробную информацию см. в ActiveModel::Validations#validates
© 2004–2021 David Heinemeier Hansson
Licensed under the MIT License.