Spec-Zone.ru › Ruby on Rails 8.1

class ActiveModel::Validator

Родитель:
Object

Валидатор Active Model

Простой базовый класс, который можно использовать вместе с ActiveModel::Validations::ClassMethods.validates_with

class Person
  include ActiveModel::Validations
  validates_with MyValidator
end

class MyValidator < ActiveModel::Validator
  def validate(record)
    if some_complex_logic
      record.errors.add(:base, "This record is invalid")
    end
  end

  private
    def some_complex_logic
      # ...
    end
end

Любой класс, наследующий ActiveModel::Validator, должен реализовать метод с именем validate, принимающий record.

class Person
  include ActiveModel::Validations
  validates_with MyValidator
end

class MyValidator < ActiveModel::Validator
  def validate(record)
    record # => The person instance being validated
    options # => Any non-standard options passed to validates_with
  end
end

Чтобы вызвать ошибку валидации, необходимо добавлять её непосредственно в record из сообщения валидатора.

class MyValidator < ActiveModel::Validator
  def validate(record)
    record.errors.add :base, "This is some custom error message"
    record.errors.add :first_name, "This is some complex validation"
    # etc...
  end
end

Чтобы добавить поведение в метод initialize, используйте следующую сигнатуру:

class MyValidator < ActiveModel::Validator
  def initialize(options)
    super
    @my_custom_field = options[:field_name] || :first_name
  end
end

Обратите внимание, что валидатор инициализируется только один раз за весь жизненный цикл приложения, а не при каждом запуске валидации.

Самый простой способ добавить пользовательские валидаторы для проверки отдельных атрибутов — использовать удобный класс ActiveModel::EachValidator.

class TitleValidator < ActiveModel::EachValidator
  def validate_each(record, attribute, value)
    record.errors.add attribute, 'must be Mr., Mrs., or Dr.' unless %w(Mr. Mrs. Dr.).include?(value)
  end
end

Теперь его можно использовать вместе с методом validates. Подробнее см. в разделе ActiveModel::Validations::ClassMethods#validates.

class Person
  include ActiveModel::Validations
  attr_accessor :title

  validates :title, presence: true, title: true
end

Может быть полезно получить доступ к классу, использующему этот валидатор, если имеются предварительные условия, например наличие attr_accessor. Этот класс доступен через options[:class] в конструкторе. Чтобы настроить валидатор, переопределите конструктор.

class MyValidator < ActiveModel::Validator
  def initialize(options={})
    super
    options[:class].attr_accessor :custom_attribute
  end
end

Атрибуты

options [R]

Общедоступные методы класса

kind () Показать исходный код
# File activemodel/lib/active_model/validator.rb, line 103
def self.kind
  @kind ||= name.split("::").last.underscore.chomp("_validator").to_sym unless anonymous?
end

Возвращает тип валидатора.

PresenceValidator.kind   # => :presence
AcceptanceValidator.kind # => :acceptance
new (options = {}) Показать исходный код
# File activemodel/lib/active_model/validator.rb, line 108
def initialize(options = {})
  @options = options.except(:class).freeze
end

Принимает параметры, доступные через геттер options.

Общедоступные методы экземпляра

kind () Показать исходный код
# File activemodel/lib/active_model/validator.rb, line 116
def kind
  self.class.kind
end

Возвращает тип этого валидатора.

PresenceValidator.new(attributes: [:username]).kind # => :presence
AcceptanceValidator.new(attributes: [:terms]).kind  # => :acceptance
validate (record) Показать исходный код
# File activemodel/lib/active_model/validator.rb, line 122
def validate(record)
  raise NotImplementedError, "Subclasses must implement a validate(record) method."
end

Переопределите этот метод в подклассах, добавив логику валидации и при необходимости добавляя ошибки в массив errors записей.

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

Spec-Zone.ru

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