модуль ActiveModel::AttributeMethods::ClassMethods
Публичные методы экземпляров
# File activemodel/lib/active_model/attribute_methods.rb, line 208
def alias_attribute(new_name, old_name)
self.attribute_aliases = attribute_aliases.merge(new_name.to_s => old_name.to_s)
CodeGenerator.batch(self, __FILE__, __LINE__) do |owner|
attribute_method_matchers.each do |matcher|
matcher_new = matcher.method_name(new_name).to_s
matcher_old = matcher.method_name(old_name).to_s
define_proxy_call false, owner, matcher_new, matcher_old
end
end
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 225 def attribute_alias(name) attribute_aliases[name.to_s] end
Возвращает исходное имя для псевдонима name
# File activemodel/lib/active_model/attribute_methods.rb, line 220 def attribute_alias?(new_name) attribute_aliases.key? new_name.to_s end
Является ли new_name псевдонимом?
# File activemodel/lib/active_model/attribute_methods.rb, line 179
def attribute_method_affix(*affixes)
self.attribute_method_matchers += affixes.map! { |affix| AttributeMethodMatcher.new prefix: affix[:prefix], suffix: affix[:suffix] }
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 108
def attribute_method_prefix(*prefixes)
self.attribute_method_matchers += prefixes.map! { |prefix| AttributeMethodMatcher.new prefix: prefix }
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 143
def attribute_method_suffix(*suffixes)
self.attribute_method_matchers += suffixes.map! { |suffix| AttributeMethodMatcher.new suffix: suffix }
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 288
def define_attribute_method(attr_name, _owner: generated_attribute_methods)
CodeGenerator.batch(_owner, __FILE__, __LINE__) do |owner|
attribute_method_matchers.each do |matcher|
method_name = matcher.method_name(attr_name)
unless instance_method_already_implemented?(method_name)
generate_method = "define_method_#{matcher.target}"
if respond_to?(generate_method, true)
send(generate_method, attr_name.to_s, owner: owner)
else
define_proxy_call true, owner, method_name, matcher.target, attr_name.to_s
end
end
end
attribute_method_matchers_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 253
def define_attribute_methods(*attr_names)
CodeGenerator.batch(generated_attribute_methods, __FILE__, __LINE__) do |owner|
attr_names.flatten.each { |attr_name| define_attribute_method(attr_name, _owner: owner) }
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 330
def undefine_attribute_methods
generated_attribute_methods.module_eval do
undef_method(*instance_methods)
end
attribute_method_matchers_cache.clear
end Удаляет все ранее динамически определенные методы из класса.
class Person
include ActiveModel::AttributeMethods
attr_accessor :name
attribute_method_suffix '_short?'
define_attribute_method :name
private
def attribute_short?(attr)
send(attr).length < 5
end
end
person = Person.new
person.name = 'Bob'
person.name_short? # => true
Person.undefine_attribute_methods
person.name_short? # => NoMethodError
© 2004–2020 David Heinemeier Hansson
Licensed under the MIT License.