класс ActiveModel::Errors

Родительский класс:: Object
Подключённые модули:: Enumerable

Ошибки Active Model

Предоставляет функциональность, связанную с ошибками, которую можно включить в объект для обработки сообщений об ошибках и взаимодействия с помощниками Action View.

Минимальная реализация может выглядеть так:

class Person
  # Required dependency for ActiveModel::Errors
  extend ActiveModel::Naming

  def initialize
    @errors = ActiveModel::Errors.new(self)
  end

  attr_accessor :name
  attr_reader   :errors

  def validate!
    errors.add(:name, :blank, message: "cannot be nil") if name.nil?
  end

  # The following methods are needed to be minimally implemented

  def read_attribute_for_validation(attr)
    send(attr)
  end

  def self.human_attribute_name(attr, options = {})
    attr
  end

  def self.lookup_ancestors
    [self]
  end
end

Последние три метода необходимы в вашем объекте, чтобы Errors могла правильно генерировать сообщения об ошибках и обрабатывать несколько языков. Разумеется, если вы расширите объект с помощью ActiveModel::Translation, последние два метода реализовывать не потребуется. Аналогично, использование ActiveModel::Validations возьмёт на себя методы, связанные с проверкой данных.

Это позволяет делать следующее:

person = Person.new
person.validate!            # => ["cannot be nil"]
person.errors.full_messages # => ["name cannot be nil"]
# etc..

Атрибуты

errors [R]

Фактический массив объектов Error. Этот метод является псевдонимом objects.

objects [R]

Фактический массив объектов Error. Этот метод является псевдонимом objects.

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

new (base) Показать исходный код

# File activemodel/lib/active_model/errors.rb, line 114
def initialize(base)
  @base = base
  @errors = []
end

Передайте экземпляр объекта, использующего объект errors.

class Person
  def initialize
    @errors = ActiveModel::Errors.new(self)
  end
end

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

[] (attribute) Показать исходный код

# File activemodel/lib/active_model/errors.rb, line 226
def [](attribute)
  messages_for(attribute)
end

При передаче символа или имени метода возвращает массив ошибок для этого метода.

person.errors[:name]  # => ["cannot be nil"]
person.errors['name'] # => ["cannot be nil"]

add (attribute, type = :invalid, **options) Показать исходный код

# File activemodel/lib/active_model/errors.rb, line 339
def add(attribute, type = :invalid, **options)
  attribute, type, options = normalize_arguments(attribute, type, **options)
  error = Error.new(@base, attribute, type, **options)

  if exception = options[:strict]
    exception = ActiveModel::StrictValidationFailed if exception == true
    raise exception, error.full_message
  end

  @errors.append(error)

  error
end

Добавляет новую ошибку типа type для attribute. К одному и тому же attribute можно добавить несколько ошибок. Если type не задан, предполагается :invalid.

person.errors.add(:name)
# Adds <#ActiveModel::Error attribute=name, type=invalid>
person.errors.add(:name, :not_implemented, message: "must be implemented")
# Adds <#ActiveModel::Error attribute=name, type=not_implemented,
                            options={:message=>"must be implemented"}>

person.errors.messages
# => {:name=>["is invalid", "must be implemented"]}

Если type — строка, она будет использована как сообщение об ошибке.

Если type — символ, он будет переведён с использованием соответствующей области поиска (см. generate_message).

person.errors.add(:name, :blank)
person.errors.messages
# => {:name=>["can't be blank"]}

person.errors.add(:name, :too_long, count: 25)
person.errors.messages
# => ["is too long (maximum is 25 characters)"]

Если type — proc, он будет вызван, что позволяет использовать в ошибке, например, Time.now.

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

person.errors.add(:name, :invalid, strict: true)
# => ActiveModel::StrictValidationFailed: Name is invalid
person.errors.add(:name, :invalid, strict: NameIsInvalid)
# => NameIsInvalid: Name is invalid

person.errors.messages # => {}

Для attribute следует задать значение :base, если ошибка не связана напрямую с одним атрибутом.

person.errors.add(:base, :name_or_email_blank,
  message: "either name or email must be present")
person.errors.messages
# => {:base=>["either name or email must be present"]}
person.errors.details
# => {:base=>[{error: :name_or_email_blank}]}

added? (attribute, type = :invalid, options = {}) Показать исходный код

# File activemodel/lib/active_model/errors.rb, line 369
def added?(attribute, type = :invalid, options = {})
  attribute, type, options = normalize_arguments(attribute, type, **options)

  if type.is_a? Symbol
    @errors.any? { |error|
      error.strict_match?(attribute, type, **options)
    }
  else
    messages_for(attribute).include?(type)
  end
end

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

person.errors.add :name, :blank
person.errors.added? :name, :blank           # => true
person.errors.added? :name, "can't be blank" # => true

Если для ошибки требуются параметры, метод возвращает true при правильных параметрах или false при неверных либо отсутствующих параметрах.

person.errors.add :name, :too_long, count: 25
person.errors.added? :name, :too_long, count: 25                     # => true
person.errors.added? :name, "is too long (maximum is 25 characters)" # => true
person.errors.added? :name, :too_long, count: 24                     # => false
person.errors.added? :name, :too_long                                # => false
person.errors.added? :name, "is too long"                            # => false

as_json (options = nil) Показать исходный код

# File activemodel/lib/active_model/errors.rb, line 244
def as_json(options = nil)
  to_hash(options && options[:full_messages])
end

Возвращает Hash, который можно использовать как JSON-представление этого объекта. Можно передать параметр :full_messages. Он определяет, должен ли JSON-объект содержать полные сообщения (по умолчанию — false).

person.errors.as_json                      # => {:name=>["cannot be nil"]}
person.errors.as_json(full_messages: true) # => {:name=>["name cannot be nil"]}

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

# File activemodel/lib/active_model/errors.rb, line 234
def attribute_names
  @errors.map(&:attribute).uniq.freeze
end

Возвращает имена всех атрибутов с ошибками.

person.errors.messages        # => {:name=>["cannot be nil", "must be specified"]}
person.errors.attribute_names # => [:name]

clear Показать исходный код

# File activemodel/lib/active_model/errors.rb, line 77

Удаляет все ошибки. Однако удаление ошибок не делает модель допустимой. При следующем запуске проверок (например, с помощью ActiveRecord::Validations#valid?) коллекция ошибок будет заполнена снова, если какие-либо проверки завершатся неудачно.

delete (attribute, type = nil, **options) Показать исходный код

# File activemodel/lib/active_model/errors.rb, line 212
def delete(attribute, type = nil, **options)
  attribute, type, options = normalize_arguments(attribute, type, **options)
  matches = where(attribute, type, **options)
  matches.each do |error|
    @errors.delete(error)
  end
  matches.map(&:message).presence
end

Удаляет сообщения для key. Возвращает удалённые сообщения.

person.errors[:name]        # => ["cannot be nil"]
person.errors.delete(:name) # => ["cannot be nil"]
person.errors[:name]        # => []

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

# File activemodel/lib/active_model/errors.rb, line 273
def details
  hash = group_by_attribute.transform_values do |errors|
    errors.map(&:details)
  end
  hash.default = EMPTY_ARRAY
  hash.freeze
  hash
end

Возвращает Hash атрибутов с массивами сведений об их ошибках.

each(&block) Показать исходный код

# File activemodel/lib/active_model/errors.rb, line 64

Перебирает каждый объект ошибки.

person.errors.add(:name, :too_short, count: 2)
person.errors.each do |error|
  # Will yield <#ActiveModel::Error attribute=name, type=too_short,
                                    options={:count=>3}>
end

empty? Показать исходный код

# File activemodel/lib/active_model/errors.rb, line 87

Возвращает true, если ошибок нет.

full_message (attribute, message) Показать исходный код

# File activemodel/lib/active_model/errors.rb, line 448
def full_message(attribute, message)
  Error.full_message(attribute, message, @base)
end

Возвращает полное сообщение для указанного атрибута.

person.errors.full_message(:name, 'is invalid') # => "Name is invalid"

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

# File activemodel/lib/active_model/errors.rb, line 412
def full_messages
  @errors.map(&:full_message)
end

Возвращает массив всех полных сообщений об ошибках.

class Person
  validates_presence_of :name, :address, :email
  validates_length_of :name, in: 5..30
end

person = Person.create(address: '123 First St.')
person.errors.full_messages
# => ["Name is too short (minimum is 5 characters)", "Name can't be blank", "Email can't be blank"]

Также имеет псевдоним: to_a

full_messages_for (attribute) Показать исходный код

# File activemodel/lib/active_model/errors.rb, line 427
def full_messages_for(attribute)
  where(attribute).map(&:full_message).freeze
end

Возвращает массив всех полных сообщений об ошибках для указанного атрибута.

class Person
  validates_presence_of :name, :email
  validates_length_of :name, in: 5..30
end

person = Person.create()
person.errors.full_messages_for(:name)
# => ["Name is too short (minimum is 5 characters)", "Name can't be blank"]

generate_message (attribute, type = :invalid, options = {}) Показать исходный код

# File activemodel/lib/active_model/errors.rb, line 476
def generate_message(attribute, type = :invalid, options = {})
  Error.generate_message(attribute, type, @base, options)
end

Переводит сообщение об ошибке в области поиска по умолчанию (activemodel.errors.messages).

Сообщения Error сначала ищутся в activemodel.errors.models.MODEL.attributes.ATTRIBUTE.MESSAGE; если там их нет, поиск выполняется в activemodel.errors.models.MODEL.MESSAGE, а если и там их нет, возвращается перевод сообщения по умолчанию (например, activemodel.errors.messages.MESSAGE). Переведённые имя модели, имя атрибута и значение доступны для подстановки.

При использовании наследования в моделях также проверяются все родительские модели, но только если сама модель не найдена. Допустим, у вас есть class Admin < User; end и вам нужен перевод сообщения об ошибке :blank для атрибута title. Поиск выполняется для следующих переводов:

activemodel.errors.models.admin.attributes.title.blank
activemodel.errors.models.admin.blank
activemodel.errors.models.user.attributes.title.blank
activemodel.errors.models.user.blank
любое значение по умолчанию, заданное через хеш options (в области поиска activemodel.errors)
activemodel.errors.messages.blank
errors.attributes.title.blank
errors.messages.blank

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

# File activemodel/lib/active_model/errors.rb, line 286
def group_by_attribute
  @errors.group_by(&:attribute)
end

Возвращает Hash атрибутов с массивами объектов Error.

person.errors.group_by_attribute
# => {:name=>[<#ActiveModel::Error>, <#ActiveModel::Error>]}

has_key? (attribute)

Псевдоним метода: include?

import (error, override_options = {}) Показать исходный код

# File activemodel/lib/active_model/errors.rb, line 151
def import(error, override_options = {})
  [:attribute, :type].each do |key|
    if override_options.key?(key)
      override_options[key] = override_options[key].to_sym
    end
  end
  @errors.append(NestedError.new(@base, error, override_options))
end

Импортирует одну ошибку. Импортированные ошибки оборачиваются в NestedError, обеспечивающий доступ к исходному объекту ошибки. Чтобы переопределить атрибут или тип, используйте override_options.

Параметры

:attribute — переопределяет атрибут, к которому относится ошибка.
:type — переопределяет тип ошибки.

include? (attribute) Показать исходный код

# File activemodel/lib/active_model/errors.rb, line 199
def include?(attribute)
  @errors.any? { |error|
    error.match?(attribute.to_sym)
  }
end

Возвращает true, если среди сообщений об ошибках есть ошибка для указанного ключа attribute, в противном случае возвращает false.

person.errors.messages        # => {:name=>["cannot be nil"]}
person.errors.include?(:name) # => true
person.errors.include?(:age)  # => false

Также имеет псевдонимы: has_key?, key?

key? (attribute)

Псевдоним метода: include?

merge! (other) Показать исходный код

# File activemodel/lib/active_model/errors.rb, line 171
def merge!(other)
  return errors if equal?(other)

  other.errors.each { |error|
    import(error)
  }
end

Объединяет ошибки из other, оборачивая каждую Error в NestedError.

Параметры

other — экземпляр ActiveModel::Errors.

Примеры

person.errors.merge!(other)

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

# File activemodel/lib/active_model/errors.rb, line 265
def messages
  hash = to_hash
  hash.default = EMPTY_ARRAY
  hash.freeze
  hash
end

Возвращает Hash атрибутов с массивами сообщений об их ошибках.

messages_for (attribute) Показать исходный код

# File activemodel/lib/active_model/errors.rb, line 441
def messages_for(attribute)
  where(attribute).map(&:message)
end

Возвращает массив всех сообщений об ошибках для указанного атрибута.

class Person
  validates_presence_of :name, :email
  validates_length_of :name, in: 5..30
end

person = Person.create()
person.errors.messages_for(:name)
# => ["is too short (minimum is 5 characters)", "can't be blank"]

of_kind? (attribute, type = :invalid) Показать исходный код

# File activemodel/lib/active_model/errors.rb, line 392
def of_kind?(attribute, type = :invalid)
  attribute, type = normalize_arguments(attribute, type)

  if type.is_a? Symbol
    !where(attribute, type).empty?
  else
    messages_for(attribute).include?(type)
  end
end

Возвращает true, если для атрибута присутствует ошибка указанного типа, в противном случае возвращает false. type обрабатывается так же, как и для add.

person.errors.add :age
person.errors.add :name, :too_long, count: 25
person.errors.of_kind? :age                                            # => true
person.errors.of_kind? :name                                           # => false
person.errors.of_kind? :name, :too_long                                # => true
person.errors.of_kind? :name, "is too long (maximum is 25 characters)" # => true
person.errors.of_kind? :name, :not_too_long                            # => false
person.errors.of_kind? :name, "is too long"                            # => false

size Показать исходный код

# File activemodel/lib/active_model/errors.rb, line 100
delegate :each, :clear, :empty?, :size, :uniq!, to: :@errors

Возвращает количество ошибок.

to_a ()

Псевдоним метода: full_messages

to_hash (full_messages = false) Показать исходный код

# File activemodel/lib/active_model/errors.rb, line 253
def to_hash(full_messages = false)
  message_method = full_messages ? :full_message : :message
  group_by_attribute.transform_values do |errors|
    errors.map(&message_method)
  end
end

Возвращает Hash атрибутов с сообщениями об ошибках. Если full_messages имеет значение true, будут включены полные сообщения (см. full_message).

person.errors.to_hash       # => {:name=>["cannot be nil"]}
person.errors.to_hash(true) # => {:name=>["name cannot be nil"]}

where (attribute, type = nil, **options) Показать исходный код

# File activemodel/lib/active_model/errors.rb, line 186
def where(attribute, type = nil, **options)
  attribute, type, options = normalize_arguments(attribute, type, **options)
  @errors.select { |error|
    error.match?(attribute, type, **options)
  }
end

Ищет ошибки, соответствующие attribute, type или options.

Сопоставляются только переданные параметры.

person.errors.where(:name) # => all name errors.
person.errors.where(:name, :too_short) # => all name errors being too short
person.errors.where(:name, :too_short, minimum: 2) # => all name errors being too short and minimum is 2