Spec-Zone.ru › Ruby on Rails 5.0

класс ActiveModel::Validator

Родитель:
Объект

Валидатор 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 MyValidator < ActiveModel::Validator
  def initialize(options={})
    super
    options[:class].send :attr_accessor, :custom_attribute
  end
end

Атрибуты

options[R]

Публичные Классовые Методы

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

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

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

Принимает параметры, которые будут доступны через options-читатель.

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

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

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

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

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

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

Spec-Zone.ru

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