Spec-Zone.ru › Ruby on Rails 5.1

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

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

validates_absence_of(*attr_names) Показать исходный код
# 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 для получения дополнительной информации.

validates_associated(*attr_names) Показать исходный код
# 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 значение.

validates_length_of(*attr_names) Показать исходный код
# 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 для получения дополнительной информации.

Также алиасирован как: validates_size_of
validates_presence_of(*attr_names) Показать исходный код
# 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::Validations#validates! для получения дополнительной информации.

validates_size_of(*attr_names)
Псевдоним для: validates_length_of
END_OF_DOCUMENT_MARKER
validates_uniqueness_of(*attr_names) Показать исходный код
# File activerecord/lib/active_record/validations/uniqueness.rb, line 203
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::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:

  • ActiveRecord::ConnectionAdapters::Mysql2Adapter.

  • ActiveRecord::ConnectionAdapters::SQLite3Adapter.

  • ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.

© 2004–2018 David Heinemeier Hansson
Licensed under the MIT License.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API