module AttributeMethods
Ruby on Rails 7.0.10
Since v3.0.20Active Model Attribute Methods
Provides a way to add prefixes and suffixes to your methods as well as handling the creation of ActiveRecord::Base-like class methods such as table_name.
The requirements to implement ActiveModel::AttributeMethods are to:
-
include ActiveModel::AttributeMethodsin your class. -
Call each of its methods you want to add, such as
attribute_method_suffixorattribute_method_prefix. -
Call
define_attribute_methodsafter the other methods are called. -
Define the various generic
_attributemethods that you have declared. -
Define an
attributesmethod which returns a hash with each attribute name in your model as hash key and the attribute value as hash value. Hash keys must be strings.
A minimal implementation could be:
class Person
include ActiveModel::AttributeMethods
attribute_method_affix prefix: 'reset_', suffix: '_to_default!'
attribute_method_suffix '_contrived?'
attribute_method_prefix 'clear_'
define_attribute_methods :name
attr_accessor :name
def attributes
{ 'name' => @name }
end
private
def attribute_contrived?(attr)
true
end
def clear_attribute(attr)
send("#{attr}=", nil)
end
def reset_attribute_to_default!(attr)
send("#{attr}=", 'Default Name')
end
end
Namespace
Modules
Extends
Constants
Methods (defined here)
Private methods (4)
Show private methods Implementation detail — not part of the public API.
Used by
Included by (2)
Methods (inherited)
From ActiveSupport::Concern
(3)
- # class_methods
- # included
- # prepended