модуль ActiveRecord::Validations::ClassMethods
Публичные методы экземпляров
# File activerecord/lib/active_record/validations/absence.rb, line 20 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 60 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 19 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/numericality.rb, line 31 def validates_numericality_of(*attr_names) validates_with NumericalityValidator, _merge_attributes(attr_names) end
Проверяет, является ли значение указанного атрибута числовым, пытаясь преобразовать его в число с плавающей точкой с помощью Kernel.Float (если only_integer равно false или применяя его к регулярному выражению /\A[+\-]?\d+\z/ (если only_integer установлено в true). Точность Kernel.Float по умолчанию равна значению точности столбца или 15.
См. ActiveModel::Validations::HelperMethods.validates_numericality_of для получения дополнительной информации.
# File activerecord/lib/active_record/validations/presence.rb, line 40 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 должен присутствовать в объекте и не должен быть пустым или помеченным для удаления.
Этот валидатор использует валидацию наличия Active Model, добавляя проверку на то, что связанный объект не помечен для удаления. Это предотвращает успешную проверку и сохранение родительского объекта, что затем удаляет связанный объект, тем самым помещая родительский объект в невалидное состояние.
См. ActiveModel::Validations::HelperMethods.validates_presence_of для получения дополнительной информации.
ПРИМЕЧАНИЕ: Эта проверка не завершится неудачей при использовании с ассоциацией, если последняя была назначена, но не валидна. Если вы хотите убедиться, что она присутствует и валидна, вам также необходимо использовать validates_associated.
# File activerecord/lib/active_record/validations/uniqueness.rb, line 290 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
Или даже нескольких параметров scope. Например, для того, чтобы учитель мог быть в расписании только один раз в семестр на определённом уроке.
class TeacherSchedule < ActiveRecord::Base validates_uniqueness_of :teacher_id, scope: [:semester_id, :class_id] end
Также возможно ограничить условие уникальности набором записей, соответствующих определённым условиям. В данном примере при проверке уникальности атрибута title не учитываются архивированные статьи:
class Article < ActiveRecord::Base
validates_uniqueness_of :title, conditions: -> { where.not(status: 'archived') }
end
Для построения условий, основанных на состоянии записи, определите вызываемый метод с параметром, который будет представлять запись. В данном примере проверяется уникальность названия статьи по году публикации:
class Article < ActiveRecord::Base
validates_uniqueness_of :title, conditions: ->(article) {
published_at = article.published_at
where(published_at: published_at.beginning_of_year..published_at.end_of_year)
}
end
При создании записи выполняется проверка, чтобы в базе данных не существовало записи с заданным значением для указанного атрибута (который соответствует столбцу). При обновлении записи выполняется та же проверка, но без учёта самой записи.
Настройки:
-
:message- Указывает пользовательское сообщение об ошибке (по умолчанию: «уже используется»). -
:scope- Один или несколько столбцов, по которым следует ограничить область действия условия уникальности. -
:conditions- Укажите условия, которые нужно включить какWHEREфрагмент SQL для ограничения поиска уникальности (например,conditions: -> { where(status: 'active') }). -
:case_sensitive- Ищет точное соответствие. Игнорируется для столбцов, не являющихся текстовыми. По умолчанию учитывается дефолтное сопоставление базы данных. -
: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! Лучший способ решения этой проблемы — добавить уникальный индекс в таблицу базы данных с помощью connection.add_index. В редких случаях, когда возникает проблема гонки, база данных гарантирует уникальность поля.
Когда база данных обнаруживает такую дублирующую вставку, ActiveRecord::Base#save сгенерирует исключение ActiveRecord::StatementInvalid. Вы можете либо разрешить распространение этой ошибки (что приведёт к отображению стандартной страницы ошибок Rails), либо перехватить её и перезапустить транзакцию (например, сообщив пользователю, что заголовок уже существует, и попросив его ввести новый заголовок). Этот метод также известен как оптимистический контроль конкуренции.
Встроенные адаптеры ActiveRecord::ConnectionAdapters различают ошибки уникального индекса от других типов ошибок базы данных, выбрасывая исключение ActiveRecord::RecordNotUnique. Для других адаптеров вам придется разобрать сообщение об ошибке (специфичное для базы данных) для обнаружения такого случая.
Следующие встроенные адаптеры генерируют исключение ActiveRecord::RecordNotUnique:
-
ActiveRecord::ConnectionAdapters::TrilogyAdapter.
© 2004–2021 David Heinemeier Hansson
Licensed under the MIT License.