Spec-Zone.ru › Ruby on Rails 5.1

class ActiveModel::Errors

Parent:
Object
Included modules:
Enumerable

Active Model Ошибки

Предоставляет изменённую Hash которую можно включить в свой объект для обработки сообщений об ошибках и взаимодействия с помощниками 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..

Константы

CALLBACKS_OPTIONS
MESSAGE_OPTIONS

Атрибуты

details[R]
messages[R]

Публичные методы класса

new(base) Показать исходный код
# File activemodel/lib/active_model/errors.rb, line 72
def initialize(base)
  @base     = base
  @messages = apply_default_array({})
  @details = apply_default_array({})
end

Передайте экземпляр объекта, который использует объект ошибок.

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

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

[](attribute) Показать исходный код
# File activemodel/lib/active_model/errors.rb, line 144
def [](attribute)
  messages[attribute.to_sym]
end

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

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

Обратите внимание, что если вы пытаетесь получить ошибки для атрибута, для которого нет связанных ошибок, этот метод создаст для него пустой список ошибок и keys вернёт массив ключей ошибок, включающий этот атрибут.

person.errors.keys    # => []
person.errors[:name]  # => []
person.errors.keys    # => [:name]
add(attribute, message = :invalid, options = {}) Показать исходный код
# File activemodel/lib/active_model/errors.rb, line 286
def add(attribute, message = :invalid, options = {})
  message = message.call if message.respond_to?(:call)
  detail  = normalize_detail(message, options)
  message = normalize_message(attribute, message, options)
  if exception = options[:strict]
    exception = ActiveModel::StrictValidationFailed if exception == true
    raise exception, full_message(attribute, message)
  end

  details[attribute.to_sym]  << detail
  messages[attribute.to_sym] << message
end

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

person.errors.add(:name)
# => ["is invalid"]
person.errors.add(:name, :not_implemented, message: "must be implemented")
# => ["is invalid", "must be implemented"]

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

person.errors.details
# => {:name=>[{error: :not_implemented}, {error: :invalid}]}

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

Если message является процедурой, она будет вызвана, что позволит использовать 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, message = :invalid, options = {}) Показать исходный код
# File activemodel/lib/active_model/errors.rb, line 315
def added?(attribute, message = :invalid, options = {})
  message = message.call if message.respond_to?(:call)
  message = normalize_message(attribute, message, options)
  self[attribute].include? message
end

Возвращает true если ошибка на атрибуте с заданным сообщением присутствует, или false в противном случае. message обрабатывается так же, как и для 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 226
def as_json(options = nil)
  to_hash(options && options[:full_messages])
end

Возвращает хеш, который может быть использован как представление 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"]}
blank?()
Псевдоним для: empty?
clear() Показать исходный код
# File activemodel/lib/active_model/errors.rb, line 101
def clear
  messages.clear
  details.clear
end

Очистить сообщения об ошибках.

person.errors.full_messages # => ["name cannot be nil"]
person.errors.clear
person.errors.full_messages # => []
count()
Псевдоним для: size
delete(key) Показать исходный код
# File activemodel/lib/active_model/errors.rb, line 124
def delete(key)
  attribute = key.to_sym
  details.delete(attribute)
  messages.delete(attribute)
end

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

person.errors[:name]        # => ["cannot be nil"]
person.errors.delete(:name) # => ["cannot be nil"]
person.errors[:name]        # => []
each() { |attribute, error| ... } Показать исходный код
# File activemodel/lib/active_model/errors.rb, line 162
def each
  messages.each_key do |attribute|
    messages[attribute].each { |error| yield attribute, error }
  end
end

Итерируется по каждой паре ключ-значение в хэше сообщений об ошибках. Выводит атрибут и ошибку для этого атрибута. Если атрибут имеет более одного сообщения об ошибке, выводит по одному разу для каждого сообщения об ошибке.

person.errors.add(:name, :blank, message: "can't be blank")
person.errors.each do |attribute, error|
  # Will yield :name and "can't be blank"
end

person.errors.add(:name, :not_specified, message: "must be specified")
person.errors.each do |attribute, error|
  # Will yield :name and "can't be blank"
  # then yield :name and "must be specified"
end
empty?() Показать исходный код
# File activemodel/lib/active_model/errors.rb, line 200
def empty?
  size.zero?
end

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

person.errors.full_messages # => ["name cannot be nil"]
person.errors.empty?        # => false
Также псевдоним для: blank?
full_message(attribute, message) Показать исходный код
# File activemodel/lib/active_model/errors.rb, line 354
def full_message(attribute, message)
  return message if attribute == :base
  attr_name = attribute.to_s.tr(".", "_").humanize
  attr_name = @base.class.human_attribute_name(attribute, default: attr_name)
  I18n.t(:"errors.format",
    default:  "%{attribute} %{message}",
    attribute: attr_name,
    message:   message)
end

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

person.errors.full_message(:name, 'is invalid') # => "Name is invalid"
full_messages() Показать исходный код
# File activemodel/lib/active_model/errors.rb, line 331
def full_messages
  map { |attribute, message| full_message(attribute, 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 346
def full_messages_for(attribute)
  attribute = attribute.to_sym
  messages[attribute].map { |message| full_message(attribute, message) }
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 388
def generate_message(attribute, type = :invalid, options = {})
  type = options.delete(:message) if options[:message].is_a?(Symbol)

  if @base.class.respond_to?(:i18n_scope)
    defaults = @base.class.lookup_ancestors.map do |klass|
      [ :"#{@base.class.i18n_scope}.errors.models.#{klass.model_name.i18n_key}.attributes.#{attribute}.#{type}",
        :"#{@base.class.i18n_scope}.errors.models.#{klass.model_name.i18n_key}.#{type}" ]
    end
  else
    defaults = []
  end

  defaults << :"#{@base.class.i18n_scope}.errors.messages.#{type}" if @base.class.respond_to?(:i18n_scope)
  defaults << :"errors.attributes.#{attribute}.#{type}"
  defaults << :"errors.messages.#{type}"

  defaults.compact!
  defaults.flatten!

  key = defaults.shift
  defaults = options.delete(:message) if options[:message]
  value = (attribute != :base ? @base.send(:read_attribute_for_validation, attribute) : nil)

  options = {
    default: defaults,
    model: @base.model_name.human,
    attribute: @base.class.human_attribute_name(attribute),
    value: value,
    object: @base
  }.merge!(options)

  I18n.translate(key, options)
end

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

Сначала ищется сообщение об ошибке в 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

has_key?(attribute)
Псевдоним для: include?
include?(attribute) Показать исходный код
# File activemodel/lib/active_model/errors.rb, line 112
def include?(attribute)
  attribute = attribute.to_sym
  messages.key?(attribute) && messages[attribute].present?
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?
keys() Показать исходный код
# File activemodel/lib/active_model/errors.rb, line 191
def keys
  messages.keys
end

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

person.errors.messages # => {:name=>["cannot be nil", "must be specified"]}
person.errors.keys     # => [:name]
size() Показать исходный код
# File activemodel/lib/active_model/errors.rb, line 174
def size
  values.flatten.size
end

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

person.errors.add(:name, :blank, message: "can't be blank")
person.errors.size # => 1
person.errors.add(:name, :not_specified, message: "must be specified")
person.errors.size # => 2
Также псевдоним для: count
to_a()
Псевдоним для: full_messages
END_OF_DOCUMENT_MARKER
to_hash(full_messages = false) Показать исходный код
# File activemodel/lib/active_model/errors.rb, line 235
def to_hash(full_messages = false)
  if full_messages
    messages.each_with_object({}) do |(attribute, array), messages|
      messages[attribute] = array.map { |message| full_message(attribute, message) }
    end
  else
    without_default_proc(messages)
  end
end

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

person.errors.to_hash       # => {:name=>["cannot be nil"]}
person.errors.to_hash(true) # => {:name=>["name cannot be nil"]}
to_xml(options = {}) Показать исходный код
# File activemodel/lib/active_model/errors.rb, line 216
def to_xml(options = {})
  to_a.to_xml({ root: "errors", skip_types: true }.merge!(options))
end

Возвращает xml-представление хеша ошибок.

person.errors.add(:name, :blank, message: "can't be blank")
person.errors.add(:name, :not_specified, message: "must be specified")
person.errors.to_xml
# =>
#  <?xml version=\"1.0\" encoding=\"UTF-8\"?>
#  <errors>
#    <error>name can't be blank</error>
#    <error>name must be specified</error>
#  </errors>
values() Показать исходный код
# File activemodel/lib/active_model/errors.rb, line 183
def values
  messages.values
end

Возвращает все значения сообщений.

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

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

Spec-Zone.ru

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