instance method attribute_method_prefix

Ruby on Rails edge

Since v3.0.20

Available in: v3.0.20 v3.1.12 v3.2.22.5 v4.0.13 v4.1.16 v4.2.11.3 v5.0.7.2 v5.1.7 v5.2.8.1 v6.0.6.1 v6.1.7.10 v7.0.10 v7.1.6 v7.2.4 v8.0.5.1 v8.1.4 edge

Signature

attribute_method_prefix(*prefixes, parameters: nil)

Declares a method available for all attributes with the given prefix. Uses method_missing and respond_to? to rewrite the method.

“‘ #{prefix}#{attr}(*args, &block) “`

to

“‘ #{prefix}attribute(#{attr}, *args, &block) “`

An instance method ‘#{prefix}attribute` must exist and accept at least the attr argument.

“‘ 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 “‘

Parameters

prefixes rest
parameters key = nil
Source
# File activemodel/lib/active_model/attribute_methods.rb, line 108
      def attribute_method_prefix(*prefixes, parameters: nil)
        prefixes.map! { |prefix| AttributeMethodPattern.new(prefix: prefix, parameters: parameters) }
        self.attribute_method_patterns = (attribute_method_patterns + prefixes).freeze
        undefine_attribute_methods
      end

Defined in activemodel/lib/active_model/attribute_methods.rb line 108 · View on GitHub · Improve this page · Find usages on GitHub

Defined in ActiveModel::AttributeMethods::ClassMethods

Type at least 2 characters to search.

Use the arrow keys to navigate results, Enter to open one, Escape to close.

Keyboard shortcuts

/
Focus search
⌘K / Ctrl-K
Command palette
?
This help
Esc
Close