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

# File activemodel/lib/active_model/validations.rb, line 269
def attribute_method?(attribute)
  method_defined?(attribute)
end

Возвращает true если attribute является методом атрибута, false в противном случае.

class Person
  include ActiveModel::Validations

  attr_accessor :name
end

User.attribute_method?(:name) # => true
User.attribute_method?(:age)  # => false

# File activemodel/lib/active_model/validations.rb, line 233
def clear_validators!
  reset_callbacks(:validate)
  _validators.clear
end

Очищает все валидаторы и проверки.

Обратите внимание, что это очистит все, что используется для проверки модели как для методов validates_with и validate. Это очищает валидаторы, созданные вызовом validates_with, и обратные вызовы, заданные вызовом validate.

class Person
  include ActiveModel::Validations

  validates_with MyValidator
  validates_with OtherValidator, on: :create
  validates_with StrictValidator, strict: true
  validate :cannot_be_robot

  def cannot_be_robot
    errors.add(:base, 'A person cannot be a robot') if person_is_robot
  end
end

Person.validators
# => [
#      #<MyValidator:0x007fbff403e808 @options={}>,
#      #<OtherValidator:0x007fbff403d930 @options={on: :create}>,
#      #<StrictValidator:0x007fbff3204a30 @options={strict:true}>
#    ]

Если выполнить Person.clear_validators! и затем проверить, какие валидаторы есть у этого класса, вы получите:

Person.validators # => []

Также будет удалён обратный вызов, заданный validate :cannot_be_robot, так что:

Person._validate_callbacks.empty?  # => true

# File activemodel/lib/active_model/validations.rb, line 151
def validate(*args, &block)
  options = args.extract_options!

  if args.all? { |arg| arg.is_a?(Symbol) }
    options.each_key do |k|
      unless VALID_OPTIONS_FOR_VALIDATE.include?(k)
        raise ArgumentError.new("Unknown key: #{k.inspect}. Valid keys are: #{VALID_OPTIONS_FOR_VALIDATE.map(&:inspect).join(', ')}. Perhaps you meant to call `validates` instead of `validate`?")
      end
    end
  end

  if options.key?(:on)
    options = options.dup
    options[:if] = Array(options[:if])
    options[:if].unshift ->(o) {
      !(Array(options[:on]) & Array(o.validation_context)).empty?
    }
  end

  args << options
  set_callback(:validate, *args, &block)
end

Добавляет метод или блок валидации в класс. Это полезно, когда переопределение метода экземпляра validate становится слишком громоздким, и вам нужен более описательный способ объявления ваших валидаций.

Это можно сделать с помощью символа, указывающего на метод:

class Comment
  include ActiveModel::Validations

  validate :must_be_friends

  def must_be_friends
    errors.add(:base, 'Must be friends to leave a comment') unless commenter.friend_of?(commentee)
  end
end

С блоком, который передаётся с текущей записью для валидации:

class Comment
  include ActiveModel::Validations

  validate do |comment|
    comment.must_be_friends
  end

  def must_be_friends
    errors.add(:base, 'Must be friends to leave a comment') unless commenter.friend_of?(commentee)
  end
end

Или с блоком, где self указывает на текущую запись для валидации:

class Comment
  include ActiveModel::Validations

  validate do
    errors.add(:base, 'Must be friends to leave a comment') unless commenter.friend_of?(commentee)
  end
end

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

Параметры:

• :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 activemodel/lib/active_model/validations/validates.rb, line 104
def validates(*attributes)
  defaults = attributes.extract_options!.dup
  validations = defaults.slice!(*_validates_default_keys)

  raise ArgumentError, "You need to supply at least one attribute" if attributes.empty?
  raise ArgumentError, "You need to supply at least one validation" if validations.empty?

  defaults[:attributes] = attributes

  validations.each do |key, options|
    next unless options
    key = "#{key.to_s.camelize}Validator"

    begin
      validator = key.include?('::'.freeze) ? key.constantize : const_get(key)
    rescue NameError
      raise ArgumentError, "Unknown validator: '#{key}'"
    end

    validates_with(validator, defaults.merge(_parse_validates_options(options)))
  end
end

Этот метод является сокращением для всех стандартных валидаторов и любых пользовательских классов валидаторов, заканчивающихся на 'Validator'. Обратите внимание, что стандартные валидаторы Rails можно переопределить внутри определенных классов, создав пользовательские классы валидаторов вместо них, например, PresenceValidator.

Примеры использования стандартных валидаторов Rails:

validates :terms, acceptance: true
validates :password, confirmation: true
validates :username, exclusion: { in: %w(admin superuser) }
validates :email, format: { with: /\A([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})\z/i, on: :create }
validates :age, inclusion: { in: 0..9 }
validates :first_name, length: { maximum: 30 }
validates :age, numericality: true
validates :username, presence: true
validates :username, uniqueness: true

Мощность метода validates проявляется при использовании пользовательских валидаторов и стандартных валидаторов в одном вызове для заданного атрибута.

class EmailValidator < ActiveModel::EachValidator
  def validate_each(record, attribute, value)
    record.errors.add attribute, (options[:message] || "is not an email") unless
      value =~ /\A([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})\z/i
  end
end

class Person
  include ActiveModel::Validations
  attr_accessor :name, :email

  validates :name, presence: true, uniqueness: true, length: { maximum: 100 }
  validates :email, presence: true, email: true
end

Классы Validator также могут существовать внутри класса, который валидируется, что позволяет включать пользовательские модули валидаторов по мере необходимости.

class Film
  include ActiveModel::Validations

  class TitleValidator < ActiveModel::EachValidator
    def validate_each(record, attribute, value)
      record.errors.add attribute, "must start with 'the'" unless value =~ /\Athe/i
    end
  end

  validates :name, title: true
end

Кроме того, классы валидаторов могут быть в другом пространстве имен и все равно использоваться в любом классе.

validates :name, :'film/title' => true

Хэш валидаторов также может обрабатывать регулярные выражения, диапазоны, массивы и строки в сокращенной форме.

validates :email, format: /@/
validates :gender, inclusion: %w(male female)
validates :password, length: 6..20

При использовании сокращенной формы диапазоны и массивы передаются в инициализатор вашего валидатора как options[:in], в то время как другие типы, включая регулярные выражения и строки, передаются как options[:with].

Также есть список параметров, которые можно использовать вместе с валидаторами:

• :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.

• :allow_nil - Пропускает валидацию, если атрибут nil.

• :allow_blank - Пропускает валидацию, если атрибут пустой.

• :strict - Если параметр :strict установлен в true, будет поднято исключение ActiveModel::StrictValidationFailed вместо добавления ошибки. Параметр :strict также может быть установлен на любое другое исключение.

Пример:

validates :password, presence: true, confirmation: true, if: :password_required?
validates :token, uniqueness: true, strict: TokenGenerationException

Наконец, параметры :if, :unless, :on, :allow_blank, :allow_nil, :strict и :message могут быть заданы одному конкретному валидатору в виде хэша:

validates :password, presence: { if: :password_required?, message: 'is forgotten.' }, confirmation: true

# File activemodel/lib/active_model/validations/validates.rb, line 145
def validates!(*attributes)
  options = attributes.extract_options!
  options[:strict] = true
  validates(*(attributes << options))
end

Этот метод используется для определения валидаций, которые не могут быть исправлены конечными пользователями и считаются исключительными. Таким образом, каждый валидатор, определённый с восклицательным знаком или с параметром :strict со значением true, всегда будет поднимать исключение ActiveModel::StrictValidationFailed вместо добавления ошибки при провале валидации. См. validates для получения более подробной информации о самой валидации.

class Person
  include ActiveModel::Validations

  attr_accessor :name
  validates! :name, presence: true
end

person = Person.new
person.name = ''
person.valid?
# => ActiveModel::StrictValidationFailed: Name can't be blank

# File activemodel/lib/active_model/validations.rb, line 87
def validates_each(*attr_names, &block)
  validates_with BlockValidator, _merge_attributes(attr_names), &block
end

Проверяет каждый атрибут по блоку.

class Person
  include ActiveModel::Validations

  attr_accessor :first_name, :last_name

  validates_each :first_name, :last_name, allow_blank: true do |record, attr, value|
    record.errors.add attr, 'starts with z.' if value.to_s[0] == ?z
  end
end

Параметры:

• :on - Указывает контексты, где активна эта валидация. По умолчанию выполняется во всех контекстах валидации (nil). Вы можете передать символ или массив символов. (например, on: :create или on: :custom_validation_context или on: [:create, :custom_validation_context])

• :allow_nil - Пропускает валидацию, если атрибут nil.

• :allow_blank - Пропускает валидацию, если атрибут пустой.

• :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 activemodel/lib/active_model/validations/with.rb, line 77
def validates_with(*args, &block)
  options = args.extract_options!
  options[:class] = self

  args.each do |klass|
    validator = klass.new(options, &block)

    if validator.respond_to?(:attributes) && !validator.attributes.empty?
      validator.attributes.each do |attribute|
        _validators[attribute.to_sym] << validator
      end
    else
      _validators[nil] << validator
    end

    validate(validator, options)
  end
end

Передаёт запись в указанный класс или классы, позволяя им добавлять ошибки на основе более сложных условий.

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

Вы также можете передать несколько классов, например:

class Person
  include ActiveModel::Validations
  validates_with MyValidator, MyOtherValidator, on: :create
end

Параметры конфигурации:

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

Если вы передаёте дополнительные параметры конфигурации, они будут переданы в класс и доступны как options.

class Person
  include ActiveModel::Validations
  validates_with MyValidator, my_custom_key: 'my custom value'
end

class MyValidator < ActiveModel::Validator
  def validate(record)
    options[:my_custom_key] # => "my custom value"
  end
end

# File activemodel/lib/active_model/validations.rb, line 191
def validators
  _validators.values.flatten.uniq
end

Список всех валидаторов, используемых для проверки модели с помощью метода validates_with.

class Person
  include ActiveModel::Validations

  validates_with MyValidator
  validates_with OtherValidator, on: :create
  validates_with StrictValidator, strict: true
end

Person.validators
# => [
#      #<MyValidator:0x007fbff403e808 @options={}>,
#      #<OtherValidator:0x007fbff403d930 @options={on: :create}>,
#      #<StrictValidator:0x007fbff3204a30 @options={strict:true}>
#    ]

# File activemodel/lib/active_model/validations.rb, line 253
def validators_on(*attributes)
  attributes.flat_map do |attribute|
    _validators[attribute.to_sym]
  end
end

Список всех валидаторов, используемых для проверки конкретного атрибута.

class Person
  include ActiveModel::Validations

  attr_accessor :name , :age

  validates_presence_of :name
  validates_inclusion_of :age, in: 0..99
end

Person.validators_on(:name)
# => [
#       #<ActiveModel::Validations::PresenceValidator:0x007fe604914e60 @attributes=[:name], @options={}>,
#    ]