module ActiveModel::AttributeMethods::ClassMethods
def alias_attribute(new_name, old_name)
person.name_short? # => true
person.nickname # => "Bob"
person.name # => "Bob"
person.name = 'Bob'
person = Person.new
end
end
send(attr).length < 5
def attribute_short?(attr)
private
alias_attribute :nickname, :name
define_attribute_methods :name
attribute_method_suffix '_short?'
attr_accessor :name
include ActiveModel::AttributeMethods
class Person
Allows you to make aliases for attributes.
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
def alias_attribute_method_definition(code_generator, pattern, new_name, old_name) # :nodoc:
def alias_attribute_method_definition(code_generator, pattern, new_name, old_name) # :nodoc: method_name = pattern.method_name(new_name).to_s target_name = pattern.method_name(old_name).to_s parameters = pattern.parameters mangled_name = build_mangled_name(target_name) call_args = [] call_args << parameters if parameters define_call(code_generator, method_name, target_name, mangled_name, parameters, call_args, namespace: :alias_attribute, as: method_name) end
def aliases_by_attribute_name # :nodoc:
def aliases_by_attribute_name # :nodoc: @aliases_by_attribute_name ||= Hash.new { |h, k| h[k] = [] } end
def attribute_alias(name)
def attribute_alias(name) attribute_aliases[name.to_s] end
def attribute_alias?(new_name)
def attribute_alias?(new_name) attribute_aliases.key? new_name.to_s end
def attribute_method_affix(*affixes)
person.reset_name_to_default!
person.name # => 'Gem'
person = Person.new
end
end
send("#{attr}=", 'Default Name')
def reset_attribute_to_default!(attr)
private
define_attribute_methods :name
attribute_method_affix prefix: 'reset_', suffix: '_to_default!'
attr_accessor :name
include ActiveModel::AttributeMethods
class Person
accept at least the +attr+ argument.
An #{prefix}attribute#{suffix} instance method must exist and
#{prefix}attribute#{suffix}(#{attr}, *args, &block)
to
#{prefix}#{attr}#{suffix}(*args, &block)
the method.
and suffix. Uses +method_missing+ and respond_to? to rewrite
Declares a method available for all attributes with the given prefix
def attribute_method_affix(*affixes) self.attribute_method_patterns += affixes.map! { |affix| AttributeMethodPattern.new(**affix) } undefine_attribute_methods end
def attribute_method_patterns_cache
significantly (in our case our test suite finishes 10% faster with
used to alleviate the GC, which ultimately also speeds up the app
match result is always the same given a +method_name+, this cache is
object creations. Most of the time it returns a +nil+ match. As the
array doing regular expression matches, which results in a lot of
+matched_attribute_method+. The latter method iterates through an
invoked often in a typical rails, both of which invoke the method
The methods +method_missing+ and +respond_to?+ of this module are
def attribute_method_patterns_cache @attribute_method_patterns_cache ||= Concurrent::Map.new(initial_capacity: 4) end
def attribute_method_patterns_matching(method_name)
def attribute_method_patterns_matching(method_name) attribute_method_patterns_cache.compute_if_absent(method_name) do attribute_method_patterns.filter_map { |pattern| pattern.match(method_name) } end end
def attribute_method_prefix(*prefixes, parameters: nil)
person.clear_name
person.name # => "Bob"
person.name = 'Bob'
person = Person.new
end
end
send("#{attr}=", nil)
def clear_attribute(attr)
private
define_attribute_methods :name
attribute_method_prefix 'clear_'
attr_accessor :name
include ActiveModel::AttributeMethods
class Person
at least the +attr+ argument.
An instance method #{prefix}attribute must exist and accept
#{prefix}attribute(#{attr}, *args, &block)
to
#{prefix}#{attr}(*args, &block)
Uses +method_missing+ and respond_to? to rewrite the method.
Declares a method available for all attributes with the given prefix.
def attribute_method_prefix(*prefixes, parameters: nil) self.attribute_method_patterns += prefixes.map! { |prefix| AttributeMethodPattern.new(prefix: prefix, parameters: parameters) } undefine_attribute_methods end
def attribute_method_suffix(*suffixes, parameters: nil)
person.name # => "Bob"
person.name = 'Bob'
person = Person.new
end
end
send(attr).length < 5
def attribute_short?(attr)
private
define_attribute_methods :name
attribute_method_suffix '_short?'
attr_accessor :name
include ActiveModel::AttributeMethods
class Person
least the +attr+ argument.
An attribute#{suffix} instance method must exist and accept at
attribute#{suffix}(#{attr}, *args, &block)
to
#{attr}#{suffix}(*args, &block)
Uses +method_missing+ and respond_to? to rewrite the method.
Declares a method available for all attributes with the given suffix.
def attribute_method_suffix(*suffixes, parameters: nil) self.attribute_method_patterns += suffixes.map! { |suffix| AttributeMethodPattern.new(suffix: suffix, parameters: parameters) } undefine_attribute_methods end
def build_mangled_name(name)
def build_mangled_name(name) mangled_name = name unless NAME_COMPILABLE_REGEXP.match?(name) mangled_name = :"__temp__#{name.unpack1("h*")}" end mangled_name end
def define_attribute_method(attr_name, _owner: generated_attribute_methods, as: attr_name)
person.name # => "Bob"
person.name = 'Bob'
person = Person.new
end
end
send(attr).length < 5
def attribute_short?(attr)
private
define_attribute_method :name
# attribute_method_affix declarations.
# attribute_method_prefix, attribute_method_suffix or
# Call to define_attribute_method must appear after the
attribute_method_suffix '_short?'
attr_accessor :name
include ActiveModel::AttributeMethods
class Person
method, or they will not hook in.
+define_attribute_method+ after you define any prefix, suffix or affix
To use, pass an attribute name (as string or symbol). Be sure to declare
+ActiveModel::AttributeMethods+.
Declares an attribute that should be prefixed and suffixed by
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
def define_attribute_method_pattern(pattern, attr_name, owner:, as:, override: false) # :nodoc:
def define_attribute_method_pattern(pattern, attr_name, owner:, as:, override: false) # :nodoc: canonical_method_name = pattern.method_name(attr_name) public_method_name = pattern.method_name(as) # If defining a regular attribute method, we don't override methods that are explicitly # defined in parent classes. if instance_method_already_implemented?(public_method_name) # However, for `alias_attribute`, we always define the method. # We check for override second because `instance_method_already_implemented?` # also check for dangerous methods. return unless override end generate_method = "define_method_#{pattern.proxy_target}" if respond_to?(generate_method, true) send(generate_method, attr_name.to_s, owner: owner, as: as) else define_proxy_call( owner, canonical_method_name, pattern.proxy_target, pattern.parameters, attr_name.to_s, namespace: :active_model_proxy, as: public_method_name ) end end
def define_attribute_methods(*attr_names)
end
send("#{attr}=", nil)
def clear_attribute(attr)
private
define_attribute_methods :name, :age, :address
# attribute_method_affix declarations.
# attribute_method_prefix, attribute_method_suffix or
# Call to define_attribute_methods must appear after the
attribute_method_prefix 'clear_'
attr_accessor :name, :age, :address
include ActiveModel::AttributeMethods
class Person
methods, or they will not hook in.
+define_attribute_methods+ after you define any prefix, suffix, or affix
To use, pass attribute names (as strings or symbols). Be sure to declare
+ActiveModel::AttributeMethods+.
Declares the attributes that should be prefixed and suffixed by
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
def define_call(code_generator, name, target_name, mangled_name, parameters, call_args, namespace:, as:)
def define_call(code_generator, name, target_name, mangled_name, parameters, call_args, namespace:, as:) code_generator.define_cached_method(mangled_name, as: as, namespace: namespace) do |batch| body = if CALL_COMPILABLE_REGEXP.match?(target_name) "self.#{target_name}(#{call_args.join(", ")})" else call_args.unshift(":'#{target_name}'") "send(#{call_args.join(", ")})" end batch << "def #{mangled_name}(#{parameters || ''})" << body << "end" end end
def define_proxy_call(code_generator, name, proxy_target, parameters, *call_args, namespace:, as: name)
using the given `extra` args. This falls back on `send`
Define a method `name` in `mod` that dispatches to `send`
def define_proxy_call(code_generator, name, proxy_target, parameters, *call_args, namespace:, as: name) mangled_name = build_mangled_name(name) call_args.map!(&:inspect) call_args << parameters if parameters # We have to use a different namespace for every target method, because # if someone defines an attribute that look like an attribute method we could clash, e.g. # attribute :title_was # attribute :title namespace = :"#{namespace}_#{proxy_target}" define_call(code_generator, name, proxy_target, mangled_name, parameters, call_args, namespace: namespace, as: as) end
def eagerly_generate_alias_attribute_methods(new_name, old_name) # :nodoc:
def eagerly_generate_alias_attribute_methods(new_name, old_name) # :nodoc: ActiveSupport::CodeGenerator.batch(generated_attribute_methods, __FILE__, __LINE__) do |code_generator| generate_alias_attribute_methods(code_generator, new_name, old_name) end end
def generate_alias_attribute_methods(code_generator, new_name, old_name) # :nodoc:
def generate_alias_attribute_methods(code_generator, new_name, old_name) # :nodoc: ActiveSupport::CodeGenerator.batch(code_generator, __FILE__, __LINE__) do |owner| attribute_method_patterns.each do |pattern| alias_attribute_method_definition(code_generator, pattern, new_name, old_name) end attribute_method_patterns_cache.clear end end
def generated_attribute_methods
def generated_attribute_methods @generated_attribute_methods ||= Module.new.tap { |mod| include mod } end
def inherited(base) # :nodoc:
def inherited(base) # :nodoc: super base.class_eval do @attribute_method_patterns_cache = nil @aliases_by_attribute_name = nil @generated_attribute_methods = nil end end
def instance_method_already_implemented?(method_name)
def instance_method_already_implemented?(method_name) generated_attribute_methods.method_defined?(method_name) end
def resolve_attribute_name(name)
def resolve_attribute_name(name) attribute_aliases.fetch(super, &:itself) end
def undefine_attribute_methods
person.name_short? # => NoMethodError
Person.undefine_attribute_methods
person.name_short? # => true
person.first_name # => "Bob"
person.name = 'Bob'
person = Person.new
end
end
send(attr).length < 5
def attribute_short?(attr)
private
alias_attribute :first_name, :name
define_attribute_method :name
attribute_method_suffix '_short?'
attr_accessor :name
include ActiveModel::AttributeMethods
class Person
Removes all the previously dynamically defined methods from the class, including alias attribute methods.
def undefine_attribute_methods generated_attribute_methods.module_eval do undef_method(*instance_methods) end attribute_method_patterns_cache.clear end