модуль ActiveRecord::Validations::ClassMethods
Публичные методы экземпляров
# File activerecord/lib/active_record/validations/absence.rb, line 18 def validates_absence_of(*attr_names) validates_with AbsenceValidator, _merge_attributes(attr_names) end
Проверяет, что указанные атрибуты отсутствуют (как определено в Object#present?). Если атрибут является ассоциацией, связанный объект считается отсутствующим, если он был помечен для удаления.
См. ActiveModel::Validations::HelperMethods#validates_absence_of для получения дополнительной информации.
# File activerecord/lib/active_record/validations/associated.rb, line 53 def validates_associated(*attr_names) validates_with AssociatedValidator, _merge_attributes(attr_names) end
Проверяет, являются ли связанные объекты или объекты действительными. Работает с любым типом ассоциации.
class Book < ActiveRecord::Base has_many :pages belongs_to :library validates_associated :pages, :library end
ПРЕДУПРЕЖДЕНИЕ: Эта проверка не должна использоваться с обеих сторон ассоциации. Это приведёт к циклической зависимости и бесконечной рекурсии.
ПРИМЕЧАНИЕ: Эта проверка не завершится ошибкой, если ассоциация не была назначена. Если вы хотите убедиться, что ассоциация присутствует и гарантированно действительна, вам также необходимо использовать validates_presence_of.
Параметры конфигурации:
-
:message- Настраиваемое сообщение об ошибке (по умолчанию: «недействителен»). -
:on- Указывает контексты, в которых эта проверка активна. По умолчанию выполняется во всех контекстах проверки (nil). Вы можете передать символ или массив символов. (например,on: :createилиon: :custom_validation_contextилиon: [:create, :custom_validation_context]) -
:if- Указывает метод, лямбда-функцию или строку для вызова, чтобы определить, должна ли выполняться проверка (например,if: :allow_validation, илиif: Proc.new { |user| user.signup_step > 2 }). Метод, лямбда-функция или строка должны возвращать или оценивать значениеtrueилиfalse. -
:unless- Указывает метод, лямбда-функцию или строку для вызова, чтобы определить, не должна ли выполняться проверка (например,unless: :skip_validation, илиunless: Proc.new { |user| user.signup_step <= 2 }). Метод, лямбда-функция или строка должны возвращать или оценивать значениеtrueилиfalse.
# File activerecord/lib/active_record/validations/length.rb, line 17 def validates_length_of(*attr_names) validates_with LengthValidator, _merge_attributes(attr_names) end
Проверяет, что указанные атрибуты соответствуют ограничениям длины. Если атрибут является ассоциацией, записи, помеченные для удаления, не учитываются.
См. ActiveModel::Validations::HelperMethods#validates_length_of для получения дополнительной информации.
# File activerecord/lib/active_record/validations/presence.rb, line 61 def validates_presence_of(*attr_names) validates_with PresenceValidator, _merge_attributes(attr_names) end
Проверяет, что указанные атрибуты не пусты (как определено в Object#blank?), и, если атрибут является ассоциацией, что связанный объект не помечен для удаления. Происходит по умолчанию при сохранении.
class Person < ActiveRecord::Base has_one :face validates_presence_of :face end
Атрибут face должен присутствовать в объекте и не может быть пустым или помеченным для удаления.
Если вам нужно проверить наличие логического поля (где действительные значения — true и false), используйте validates_inclusion_of :field_name, in: [true, false].
Это связано со способом, которым Object#blank? обрабатывает логические значения: false.blank? # => true.
Этот валидатор делегирует проверку на наличие Active Model, добавляя проверку, что связанный объект не помечен для удаления. Это предотвращает успешную проверку и сохранение родительского объекта, а затем удаление связанного объекта, что ставит родительский объект в недействительное состояние.
ПРИМЕЧАНИЕ: Эта проверка не завершится ошибкой при использовании с ассоциацией, если последняя была назначена, но не действительна. Если вы хотите убедиться, что она и присутствует, и действительна, вам также необходимо использовать validates_associated.
Параметры конфигурации:
-
:message- Настраиваемое сообщение об ошибке (по умолчанию: «не может быть пустым»). -
:on- Указывает контексты, в которых эта проверка активна. По умолчанию выполняется во всех контекстах проверки (nil). Вы можете передать символ или массив символов. (например,on: :createилиon: :custom_validation_contextилиon: [:create, :custom_validation_context]) -
:if- Указывает метод, лямбда-функцию или строку для вызова, чтобы определить, должна ли выполняться проверка (например,if: :allow_validation, илиif: Proc.new { |user| user.signup_step > 2 }). Метод, лямбда-функция или строка должны возвращать или оценивать значениеtrueилиfalse. -
:unless- Указывает метод, лямбда-функцию или строку для вызова, чтобы определить, не должна ли выполняться проверка (например,unless: :skip_validation, илиunless: Proc.new { |user| user.signup_step <= 2 }). Метод, лямбда-функция или строка должны возвращать или оценивать значениеtrueилиfalse. -
:strict- Указывает, должна ли проверка быть строгой. См. ActiveModel::Validation#validates! для получения дополнительной информации.
# File activerecord/lib/active_record/validations/uniqueness.rb, line 234 def validates_uniqueness_of(*attr_names) validates_with UniquenessValidator, _merge_attributes(attr_names) end
Проверяет, являются ли значения указанных атрибутов уникальными во всей системе. Полезно для проверки, может ли только один пользователь иметь имя «davidhh».
class Person < ActiveRecord::Base validates_uniqueness_of :user_name end
Также можно проверить, являются ли значения указанных атрибутов уникальными на основе параметра :scope:
class Person < ActiveRecord::Base validates_uniqueness_of :user_name, scope: :account_id end
Или даже нескольких параметров области. Например, чтобы убедиться, что учитель может присутствовать в расписании только один раз в семестр на определённом уроке.
class TeacherSchedule < ActiveRecord::Base validates_uniqueness_of :teacher_id, scope: [:semester_id, :class_id] end
Также можно ограничить условие уникальности набором записей, соответствующих определённым условиям. В этом примере при проверке уникальности атрибута «заголовок» не учитываются архивные статьи:
class Article < ActiveRecord::Base
validates_uniqueness_of :title, conditions: -> { where.not(status: 'archived') }
end
При создании записи выполняется проверка, чтобы в базе данных не существовала запись с заданным значением для указанного атрибута (который отображается в столбце). При обновлении записи выполняется та же проверка, но без учёта самой записи.
Параметры конфигурации:
-
:message— Указывает пользовательское сообщение об ошибке (по умолчанию: «уже используется»). -
:scope— Один или несколько столбцов, по которым нужно ограничить область действия условия уникальности. -
:conditions— Укажите условия, которые должны быть включены как фрагмент SQLWHEREдля ограничения поиска уникальности (например,conditions: -> { where(status: 'active') }). -
:case_sensitive— Ищет точное совпадение. Игнорируется для столбцов, не являющихся текстовыми (trueпо умолчанию). -
:allow_nil— Если установлено вtrue, пропускает эту валидацию, если атрибутnil(по умолчаниюfalse). -
:allow_blank— Если установлено вtrue, пропускает эту валидацию, если атрибут пустой (по умолчаниюfalse). -
:if— Указывает метод, лямбда-выражение или строку, которые нужно вызвать для определения, нужно ли выполнять валидацию (например,if: :allow_validation, илиif: Proc.new { |user| user.signup_step > 2 }). Метод, лямбда-выражение или строка должны возвращать или вычислять значениеtrueилиfalse. -
:unless— Указывает метод, лямбда-выражение или строку, которые нужно вызвать для определения, нужно ли не выполнять валидацию (например,unless: :skip_validation, илиunless: Proc.new { |user| user.signup_step <= 2 }). Метод, лямбда-выражение или строка должны возвращать или вычислять значениеtrueилиfalse.
Конкурентность и целостность
Использование этого метода валидации в сочетании с ActiveRecord::Base#save не гарантирует отсутствие дублирующих записей, потому что проверки уникальности на уровне приложения подвержены проблемам гонки. Например, предположим, что два пользователя пытаются одновременно опубликовать комментарий, а заголовок комментария должен быть уникальным. На уровне базы данных действия этих пользователей могут быть переплетены следующим образом:
User 1 | User 2
------------------------------------+--------------------------------------
# User 1 checks whether there's |
# already a comment with the title |
# 'My Post'. This is not the case. |
SELECT * FROM comments |
WHERE title = 'My Post' |
|
| # User 2 does the same thing and also
| # infers that their title is unique.
| SELECT * FROM comments
| WHERE title = 'My Post'
|
# User 1 inserts their comment. |
INSERT INTO comments |
(title, content) VALUES |
('My Post', 'hi!') |
|
| # User 2 does the same thing.
| INSERT INTO comments
| (title, content) VALUES
| ('My Post', 'hello!')
|
| # ^^^^^^
| # Boom! We now have a duplicate
| # title! Это может произойти даже при использовании транзакций с уровнем изоляции «serializable». Лучший способ обойти эту проблему — добавить уникальный индекс в таблицу базы данных с помощью connection.add_index. В редком случае возникновения проблемы гонки база данных гарантирует уникальность поля.
Когда база данных обнаруживает такую дублирующую запись, ActiveRecord::Base#save вызовет исключение ActiveRecord::StatementInvalid. Вы можете либо позволить этой ошибке распространиться (в результате чего отобразится стандартная страница ошибок Rails), либо перехватить её и перезапустить транзакцию (например, сообщив пользователю, что заголовок уже существует, и попросив повторно ввести заголовок). Этот метод также известен как оптимистический контроль конкурентности.
Встроенные адаптеры ActiveRecord::ConnectionAdapters различают ошибки уникального индекса и другие типы ошибок базы данных, вызывая исключение ActiveRecord::RecordNotUnique. Для других адаптеров вам придётся анализировать сообщение об ошибке (специфичное для базы данных) для определения такого случая.
Следующие встроенные адаптеры вызывают исключение ActiveRecord::RecordNotUnique:
© 2004–2018 David Heinemeier Hansson
Licensed under the MIT License.