Class: ActiveModel::Error
Relationships & Source Files | |
Extension / Inclusion / Inheritance Descendants | |
Subclasses:
|
|
Inherits: | Object |
Defined in: | activemodel/lib/active_model/error.rb |
Overview
Represents one single error
Constant Summary
-
CALLBACKS_OPTIONS =
# File 'activemodel/lib/active_model/error.rb', line 10[:if, :unless, :on, :allow_nil, :allow_blank, :strict]
-
MESSAGE_OPTIONS =
# File 'activemodel/lib/active_model/error.rb', line 11[: ]
Class Attribute Summary
Class Method Summary
Instance Attribute Summary
-
#attribute
readonly
The attribute of #base which the error belongs to.
-
#base
readonly
The object which the error belongs to.
- #i18n_customize_full_message rw
- #i18n_customize_full_message? ⇒ Boolean rw
-
#options
readonly
The options provided when calling
errors#add
. -
#raw_type
readonly
The raw value provided as the second parameter when calling
errors#add
. -
#type
readonly
The type of error, defaults to
:invalid
unless specified.
Instance Method Summary
-
#detail
Alias for #details.
-
#details
(also: #detail)
Returns the error details.
-
#eql?(other)
Alias for #==.
-
#full_message
Returns the full error message.
-
#match?(attribute, type = nil, **options) ⇒ Boolean
See if error matches provided #attribute, #type, and #options.
-
#message
Returns the error message.
-
#strict_match?(attribute, type, **options) ⇒ Boolean
See if error matches provided #attribute, #type, and #options exactly.
Constructor Details
.new(base, attribute, type = :invalid, **options) ⇒ Error
Class Attribute Details
.i18n_customize_full_message (rw)
[ GitHub ]# File 'activemodel/lib/active_model/error.rb', line 13
class_attribute :, default: false
.i18n_customize_full_message? ⇒ Boolean
(rw)
[ GitHub ]
# File 'activemodel/lib/active_model/error.rb', line 13
class_attribute :, default: false
Instance Attribute Details
#attribute (readonly)
The attribute of #base which the error belongs to
# File 'activemodel/lib/active_model/error.rb', line 121
attr_reader :attribute
#base (readonly)
The object which the error belongs to
# File 'activemodel/lib/active_model/error.rb', line 119
attr_reader :base
#i18n_customize_full_message (rw)
[ GitHub ]# File 'activemodel/lib/active_model/error.rb', line 13
class_attribute :, default: false
#i18n_customize_full_message? ⇒ Boolean
(rw)
[ GitHub ]
# File 'activemodel/lib/active_model/error.rb', line 13
class_attribute :, default: false
#options (readonly)
The options provided when calling errors#add
# File 'activemodel/lib/active_model/error.rb', line 128
attr_reader :
#raw_type (readonly)
The raw value provided as the second parameter when calling errors#add
# File 'activemodel/lib/active_model/error.rb', line 126
attr_reader :raw_type
#type (readonly)
The type of error, defaults to :invalid
unless specified
# File 'activemodel/lib/active_model/error.rb', line 123
attr_reader :type
Instance Method Details
#detail
Alias for #details.
# File 'activemodel/lib/active_model/error.rb', line 152
alias_method :detail, :details
#details 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 }
# File 'activemodel/lib/active_model/error.rb', line 149
def details { error: raw_type }.merge( .except(*CALLBACKS_OPTIONS + MESSAGE_OPTIONS)) end
#eql?(other)
Alias for #==.
# File 'activemodel/lib/active_model/error.rb', line 193
alias eql? ==
#full_message
Returns the full error message.
error = ActiveModel::Error.new(person, :name, :too_short, count: 5)
error.
# => "Name is too short (minimum is 5 characters)"
# File 'activemodel/lib/active_model/error.rb', line 159
def self.class. (attribute, , @base) end
#match?(attribute, type = nil, **options) ⇒ Boolean
See if error matches provided #attribute, #type, and #options.
Omitted params are not checked for a match.
#message
Returns the error message.
error = ActiveModel::Error.new(person, :name, :too_short, count: 5)
error.
# => "is too short (minimum is 5 characters)"
#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.
# File 'activemodel/lib/active_model/error.rb', line 184
def strict_match?(attribute, type, ** ) return false unless match?(attribute, type) == @options.except(*CALLBACKS_OPTIONS + MESSAGE_OPTIONS) end