модуль ActiveRecord::Validations::ClassMethods

Публичные методы экземпляров

validates_associated(*attr_names) Показать исходный код

# File activerecord/lib/active_record/validations/associated.rb, line 46
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 значение.

validates_presence_of(*attr_names) Показать исходный код

# File activerecord/lib/active_record/validations/presence.rb, line 62
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 должен быть в объекте и не должен быть пустым или помеченным для удаления.

Если вам нужно проверить наличие boolean поля (где реальные значения true и false), вам нужно использовать validates_inclusion_of :field_name, in: [true, false].

Это связано с тем, как Object#blank? обрабатывает boolean значения: false.blank? # => true.

Этот валидатор делегирует валидацию присутствия ActiveModel, добавляя проверку, чтобы связанный объект не был помечен для удаления. Это предотвращает успешную валидацию и сохранение родительского объекта, что затем удаляет связанный объект, тем самым приводя родительский объект в невалидное состояние.

Настройки:

: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! для получения дополнительной информации.

validates_uniqueness_of(*attr_names) Показать исходный код

# 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

Или даже нескольких параметров scope. Например, чтобы убедиться, что учитель может быть только один раз в расписании за семестр для определённого класса.

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 — укажите условия, которые нужно включить в виде WHERE SQL фрагмента для ограничения поиска уникальности (например, 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::Validations#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». Лучший способ решить эту проблему — добавить уникальный индекс в таблицу базы данных с помощью ActiveRecord::ConnectionAdapters::SchemaStatements#add_index. В редких случаях, когда возникает проблема гонки, база данных гарантирует уникальность поля.

Когда база данных обнаруживает такую дублирующую вставку, ActiveRecord::Validations#save выбросит исключение ActiveRecord::StatementInvalid. Вы можете либо позволить этой ошибке распространиться (что приведёт к отображению стандартной страницы ошибок Rails), либо поймать её и перезапустить транзакцию (например, сообщив пользователю, что заголовок уже существует и попросив его ввести новый заголовок). Этот метод также известен как оптимистическое управление параллельными изменениями.

Связанные адаптеры ActiveRecord::ConnectionAdapters различают ошибки уникального индекса от других типов ошибок базы данных, выбрасывая исключение ActiveRecord::RecordNotUnique. Для других адаптеров вам придётся разобрать сообщение об ошибке (специфическое для базы данных) для обнаружения такого случая.

Следующие связанные адаптеры выбрасывают исключение ActiveRecord::RecordNotUnique: