Class: ActiveModel::Error

Inherits:
Object
  • Object
show all
Defined in:
lib/active_model/error.rb

Overview

Active Model Error

Represents one single error

Direct Known Subclasses

NestedError

Constant Summary collapse

CALLBACKS_OPTIONS = 
[:if, :unless, :on, :allow_nil, :allow_blank, :strict]
MESSAGE_OPTIONS = 
[:message]

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(base, attribute, type = :invalid, **options) ⇒ Error

Returns a new instance of Error.



103
104
105
106
107
108
109
 
# File 'lib/active_model/error.rb', line 103

def initialize(base, attribute, type = :invalid, **options)
  @base = base
  @attribute = attribute
  @raw_type = type
  @type = type || :invalid
  @options = options
end

Instance Attribute Details

#attribute ⇒ Object (readonly)

The attribute of base which the error belongs to



121
122
123
 
# File 'lib/active_model/error.rb', line 121

def attribute
  @attribute
end

#base ⇒ Object (readonly)

The object which the error belongs to



119
120
121
 
# File 'lib/active_model/error.rb', line 119

def base
  @base
end

#options ⇒ Object (readonly)

The options provided when calling errors#add



128
129
130
 
# File 'lib/active_model/error.rb', line 128

def options
  @options
end

#raw_type ⇒ Object (readonly)

The raw value provided as the second parameter when calling errors#add



126
127
128
 
# File 'lib/active_model/error.rb', line 126

def raw_type
  @raw_type
end

#type ⇒ Object (readonly)

The type of error, defaults to :invalid unless specified



123
124
125
 
# File 'lib/active_model/error.rb', line 123

def type
  @type
end

Class Method Details

.full_message(attribute, message, base) ⇒ Object

:nodoc:



15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/active_model/error.rb', line 15

def self.full_message(attribute, message, base) # :nodoc:
  return message if attribute == :base

  base_class = base.class
  attribute = attribute.to_s

  if i18n_customize_full_message && base_class.respond_to?(:i18n_scope)
    attribute = attribute.remove(/\[\d+\]/)
    parts = attribute.split(".")
    attribute_name = parts.pop
    namespace = parts.join("/") unless parts.empty?
    attributes_scope = "#{base_class.i18n_scope}.errors.models"

    if namespace
      defaults = base_class.lookup_ancestors.map do |klass|
        [
          :"#{attributes_scope}.#{klass.model_name.i18n_key}/#{namespace}.attributes.#{attribute_name}.format",
          :"#{attributes_scope}.#{klass.model_name.i18n_key}/#{namespace}.format",
        ]
      end
    else
      defaults = base_class.lookup_ancestors.map do |klass|
        [
          :"#{attributes_scope}.#{klass.model_name.i18n_key}.attributes.#{attribute_name}.format",
          :"#{attributes_scope}.#{klass.model_name.i18n_key}.format",
        ]
      end
    end

    defaults.flatten!
  else
    defaults = []
  end

  defaults << :"errors.format"
  defaults << "%{attribute} %{message}"

  attr_name = attribute.remove(/\.base\z/).tr(".", "_").humanize
  attr_name = base_class.human_attribute_name(attribute, {
    default: attr_name,
    base: base,
  })

  I18n.t(defaults.shift,
    default:  defaults,
    attribute: attr_name,
    message:   message)
end

.generate_message(attribute, type, base, options) ⇒ Object

:nodoc:



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/active_model/error.rb', line 64

def self.generate_message(attribute, type, base, options) # :nodoc:
  type = options.delete(:message) if options[:message].is_a?(Symbol)
  value = (attribute != :base ? base.read_attribute_for_validation(attribute) : nil)

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

  if base.class.respond_to?(:i18n_scope)
    i18n_scope = base.class.i18n_scope.to_s
    attribute = attribute.to_s.remove(/\[\d+\]/)

    defaults = base.class.lookup_ancestors.flat_map do |klass|
      [ :"#{i18n_scope}.errors.models.#{klass.model_name.i18n_key}.attributes.#{attribute}.#{type}",
        :"#{i18n_scope}.errors.models.#{klass.model_name.i18n_key}.#{type}" ]
    end
    defaults << :"#{i18n_scope}.errors.messages.#{type}"

    catch(:exception) do
      translation = I18n.translate(defaults.first, **options.merge(default: defaults.drop(1), throw: true))
      return translation unless translation.nil?
    end unless options[:message]
  else
    defaults = []
  end

  defaults << :"errors.attributes.#{attribute}.#{type}"
  defaults << :"errors.messages.#{type}"

  key = defaults.shift
  defaults = options.delete(:message) if options[:message]
  options[:default] = defaults

  I18n.translate(key, **options)
end

Instance Method Details

#==(other) ⇒ Object Also known as: eql?

:nodoc:



190
191
192
 
# File 'lib/active_model/error.rb', line 190

def ==(other) # :nodoc:
  other.is_a?(self.class) && attributes_for_hash == other.attributes_for_hash
end

#details ⇒ Object Also known as: detail

Returns the error details.

error = ActiveModel::Error.new(person, :name, :too_short, count: 5)
error.details
# => { error: :too_short, count: 5 }



149
150
151
 
# File 'lib/active_model/error.rb', line 149

def details
  { error: raw_type }.merge(options.except(*CALLBACKS_OPTIONS + MESSAGE_OPTIONS))
end

#full_message ⇒ Object

Returns the full error message.

error = ActiveModel::Error.new(person, :name, :too_short, count: 5)
error.full_message
# => "Name is too short (minimum is 5 characters)"



159
160
161
 
# File 'lib/active_model/error.rb', line 159

def full_message
  self.class.full_message(attribute, message, @base)
end

#hash ⇒ Object

:nodoc:



195
196
197
 
# File 'lib/active_model/error.rb', line 195

def hash # :nodoc:
  attributes_for_hash.hash
end

#initialize_dup(other) ⇒ Object

:nodoc:



111
112
113
114
115
116
 
# File 'lib/active_model/error.rb', line 111

def initialize_dup(other) # :nodoc:
  @attribute = @attribute.dup
  @raw_type = @raw_type.dup
  @type = @type.dup
  @options = @options.deep_dup
end

#inspect ⇒ Object

:nodoc:



199
200
201
 
# File 'lib/active_model/error.rb', line 199

def inspect # :nodoc:
  "#<#{self.class.name} attribute=#{@attribute}, type=#{@type}, options=#{@options.inspect}>"
end

#match?(attribute, type = nil, **options) ⇒ Boolean

See if error matches provided attribute, type, and options.

Omitted params are not checked for a match.

Returns:

  • (Boolean) 


166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/active_model/error.rb', line 166

def match?(attribute, type = nil, **options)
  if @attribute != attribute || (type && @type != type)
    return false
  end

  options.each do |key, value|
    if @options[key] != value
      return false
    end
  end

  true
end

#message ⇒ Object

Returns the error message.

error = ActiveModel::Error.new(person, :name, :too_short, count: 5)
error.message
# => "is too short (minimum is 5 characters)"



135
136
137
138
139
140
141
142
 
# File 'lib/active_model/error.rb', line 135

def message
  case raw_type
  when Symbol
    self.class.generate_message(attribute, raw_type, @base, options.except(*CALLBACKS_OPTIONS))
  else
    raw_type
  end
end

#strict_match?(attribute, type, **options) ⇒ Boolean

See if error matches provided attribute, type, and options exactly.

All params must be equal to Error’s own attributes to be considered a strict match.

Returns:

  • (Boolean) 


184
185
186
187
188
 
# File 'lib/active_model/error.rb', line 184

def strict_match?(attribute, type, **options)
  return false unless match?(attribute, type)

  options == @options.except(*CALLBACKS_OPTIONS + MESSAGE_OPTIONS)
end