module ActiveModel::AttributeMethods::ClassMethods
Открытые методы экземпляра
# File activemodel/lib/active_model/attribute_methods.rb, line 203 def alias_attribute(new_name, old_name) old_name = old_name.to_s new_name = new_name.to_s self.attribute_aliases = attribute_aliases.merge(new_name => old_name) aliases_by_attribute_name[old_name] << new_name eagerly_generate_alias_attribute_methods(new_name, old_name) end
Позволяет создавать псевдонимы для атрибутов.
class Person
include ActiveModel::AttributeMethods
attr_accessor :name
attribute_method_suffix '_short?'
define_attribute_methods :name
alias_attribute :nickname, :name
private
def attribute_short?(attr)
send(attr).length < 5
end
end
person = Person.new
person.name = 'Bob'
person.name # => "Bob"
person.nickname # => "Bob"
person.name_short? # => true
person.nickname_short? # => true
# File activemodel/lib/active_model/attribute_methods.rb, line 245 def attribute_alias(name) attribute_aliases[name.to_s] end
Возвращает исходное имя для псевдонима name
# File activemodel/lib/active_model/attribute_methods.rb, line 240 def attribute_alias?(new_name) attribute_aliases.key? new_name.to_s end
Является ли new_name псевдонимом?
# File activemodel/lib/active_model/attribute_methods.rb, line 175
def attribute_method_affix(*affixes)
self.attribute_method_patterns += affixes.map! { |affix| AttributeMethodPattern.new(**affix) }
undefine_attribute_methods
end Объявляет метод, доступный для всех атрибутов с указанными префиксом и суффиксом. Использует method_missing и respond_to? для преобразования метода.
#{prefix}#{attr}#{suffix}(*args, &block)
в
#{prefix}attribute#{suffix}(#{attr}, *args, &block)
Метод экземпляра #{prefix}attribute#{suffix} должен существовать и принимать как минимум аргумент attr.
class Person
include ActiveModel::AttributeMethods
attr_accessor :name
attribute_method_affix prefix: 'reset_', suffix: '_to_default!'
define_attribute_methods :name
private
def reset_attribute_to_default!(attr)
send("#{attr}=", 'Default Name')
end
end
person = Person.new
person.name # => 'Gem'
person.reset_name_to_default!
person.name # => 'Default Name'
# File activemodel/lib/active_model/attribute_methods.rb, line 106
def attribute_method_prefix(*prefixes, parameters: nil)
self.attribute_method_patterns += prefixes.map! { |prefix| AttributeMethodPattern.new(prefix: prefix, parameters: parameters) }
undefine_attribute_methods
end Объявляет метод, доступный для всех атрибутов с указанным префиксом. Использует method_missing и respond_to? для преобразования метода.
#{prefix}#{attr}(*args, &block)
в
#{prefix}attribute(#{attr}, *args, &block)
Метод экземпляра #{prefix}attribute должен существовать и принимать как минимум аргумент attr.
class Person
include ActiveModel::AttributeMethods
attr_accessor :name
attribute_method_prefix 'clear_'
define_attribute_methods :name
private
def clear_attribute(attr)
send("#{attr}=", nil)
end
end
person = Person.new
person.name = 'Bob'
person.name # => "Bob"
person.clear_name
person.name # => nil
# File activemodel/lib/active_model/attribute_methods.rb, line 140
def attribute_method_suffix(*suffixes, parameters: nil)
self.attribute_method_patterns += suffixes.map! { |suffix| AttributeMethodPattern.new(suffix: suffix, parameters: parameters) }
undefine_attribute_methods
end Объявляет метод, доступный для всех атрибутов с указанным суффиксом. Использует method_missing и respond_to? для преобразования метода.
#{attr}#{suffix}(*args, &block)
в
attribute#{suffix}(#{attr}, *args, &block)
Метод экземпляра attribute#{suffix} должен существовать и принимать как минимум аргумент attr.
class Person
include ActiveModel::AttributeMethods
attr_accessor :name
attribute_method_suffix '_short?'
define_attribute_methods :name
private
def attribute_short?(attr)
send(attr).length < 5
end
end
person = Person.new
person.name = 'Bob'
person.name # => "Bob"
person.name_short? # => true
# File activemodel/lib/active_model/attribute_methods.rb, line 311
def define_attribute_method(attr_name, _owner: generated_attribute_methods, as: attr_name)
ActiveSupport::CodeGenerator.batch(_owner, __FILE__, __LINE__) do |owner|
attribute_method_patterns.each do |pattern|
define_attribute_method_pattern(pattern, attr_name, owner: owner, as: as)
end
attribute_method_patterns_cache.clear
end
end Объявляет атрибут, к которому должен добавляться префикс и суффикс, указанные в ActiveModel::AttributeMethods.
Для использования передайте имя атрибута (в виде строки или символа). Не забудьте объявить define_attribute_method после определения методов префикса, суффикса или аффикса, иначе они не будут подключены.
class Person
include ActiveModel::AttributeMethods
attr_accessor :name
attribute_method_suffix '_short?'
# Call to define_attribute_method must appear after the
# attribute_method_prefix, attribute_method_suffix or
# attribute_method_affix declarations.
define_attribute_method :name
private
def attribute_short?(attr)
send(attr).length < 5
end
end
person = Person.new
person.name = 'Bob'
person.name # => "Bob"
person.name_short? # => true
# File activemodel/lib/active_model/attribute_methods.rb, line 272
def define_attribute_methods(*attr_names)
ActiveSupport::CodeGenerator.batch(generated_attribute_methods, __FILE__, __LINE__) do |owner|
attr_names.flatten.each do |attr_name|
define_attribute_method(attr_name, _owner: owner)
aliases_by_attribute_name[attr_name.to_s].each do |aliased_name|
generate_alias_attribute_methods owner, aliased_name, attr_name
end
end
end
end Объявляет атрибуты, к которым должен добавляться префикс и суффикс, указанные в ActiveModel::AttributeMethods.
Для использования передайте имена атрибутов (в виде строк или символов). Не забудьте объявить define_attribute_methods после определения методов префикса, суффикса или аффикса, иначе они не будут подключены.
class Person
include ActiveModel::AttributeMethods
attr_accessor :name, :age, :address
attribute_method_prefix 'clear_'
# Call to define_attribute_methods must appear after the
# attribute_method_prefix, attribute_method_suffix or
# attribute_method_affix declarations.
define_attribute_methods :name, :age, :address
private
def clear_attribute(attr)
send("#{attr}=", nil)
end
end
# File activemodel/lib/active_model/attribute_methods.rb, line 375
def undefine_attribute_methods
@generated_attribute_methods&.module_eval do
undef_method(*instance_methods)
end
attribute_method_patterns_cache.clear
end Удаляет из класса все ранее динамически определённые методы, включая методы-псевдонимы атрибутов.
class Person
include ActiveModel::AttributeMethods
attr_accessor :name
attribute_method_suffix '_short?'
define_attribute_method :name
alias_attribute :first_name, :name
private
def attribute_short?(attr)
send(attr).length < 5
end
end
person = Person.new
person.name = 'Bob'
person.first_name # => "Bob"
person.name_short? # => true
Person.undefine_attribute_methods
person.name_short? # => NoMethodError
person.first_name # => NoMethodError
© 2004–2021 David Heinemeier Hansson
Licensed under the MIT License.