Class Index [+]

Quicksearch

ActiveModel::AttributeMethods::ClassMethods

Public Instance Methods

alias_attribute(new_name, old_name) click to toggle source
     # File lib/active_model/attribute_methods.rb, line 223
223:       def alias_attribute(new_name, old_name)
224:         attribute_method_matchers.each do |matcher|
225:           matcher_new = matcher.method_name(new_name).to_s
226:           matcher_old = matcher.method_name(old_name).to_s
227:           define_optimized_call self, matcher_new, matcher_old
228:         end
229:       end
attribute_method_affix(*affixes) click to toggle source

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

  #{prefix}#{attr}#{suffix}(*args, &block)

to

  #{prefix}attribute#{suffix}(#{attr}, *args, &block)

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

For example:

  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)
      ...
    end
  end

  person = Person.new
  person.name                         # => 'Gem'
  person.reset_name_to_default!
  person.name                         # => 'Gemma'
     # File lib/active_model/attribute_methods.rb, line 218
218:       def attribute_method_affix(*affixes)
219:         self.attribute_method_matchers += affixes.map { |affix| AttributeMethodMatcher.new :prefix => affix[:prefix], :suffix => affix[:suffix] }
220:         undefine_attribute_methods
221:       end
attribute_method_prefix(*prefixes) click to toggle source

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.

For example:

  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 lib/active_model/attribute_methods.rb, line 143
143:       def attribute_method_prefix(*prefixes)
144:         self.attribute_method_matchers += prefixes.map { |prefix| AttributeMethodMatcher.new :prefix => prefix }
145:         undefine_attribute_methods
146:       end
attribute_method_suffix(*suffixes) click to toggle source

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

  #{attr}#{suffix}(*args, &block)

to

  attribute#{suffix}(#{attr}, *args, &block)

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

For example:

  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 lib/active_model/attribute_methods.rb, line 180
180:       def attribute_method_suffix(*suffixes)
181:         self.attribute_method_matchers += suffixes.map { |suffix| AttributeMethodMatcher.new :suffix => suffix }
182:         undefine_attribute_methods
183:       end
define_attribute_method(attr_name) click to toggle source
     # File lib/active_model/attribute_methods.rb, line 259
259:       def define_attribute_method(attr_name)
260:         attribute_method_matchers.each do |matcher|
261:           method_name = matcher.method_name(attr_name)
262: 
263:           unless instance_method_already_implemented?(method_name)
264:             generate_method = "define_method_#{matcher.method_missing_target}"
265: 
266:             if respond_to?(generate_method, true)
267:               send(generate_method, attr_name)
268:             else
269:               define_optimized_call generated_attribute_methods, method_name, matcher.method_missing_target, attr_name.to_s
270:             end
271:           end
272:         end
273:         attribute_method_matchers_cache.clear
274:       end
define_attribute_methods(attr_names) click to toggle source

Declares the attributes that should be prefixed and suffixed by ActiveModel::AttributeMethods.

To use, pass in an array of attribute names (as strings or symbols), be sure to declare define_attribute_methods after you define any prefix, suffix or affix methods, or they will not hook in.

  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 declares.
    define_attribute_methods [:name, :age, :address]

    private

    def clear_attribute(attr)
      ...
    end
  end
     # File lib/active_model/attribute_methods.rb, line 255
255:       def define_attribute_methods(attr_names)
256:         attr_names.each { |attr_name| define_attribute_method(attr_name) }
257:       end
undefine_attribute_methods() click to toggle source

Removes all the previously dynamically defined methods from the class

     # File lib/active_model/attribute_methods.rb, line 277
277:       def undefine_attribute_methods
278:         generated_attribute_methods.module_eval do
279:           instance_methods.each { |m| undef_method(m) }
280:         end
281:         attribute_method_matchers_cache.clear
282:       end

Protected Instance Methods

instance_method_already_implemented?(method_name) click to toggle source
     # File lib/active_model/attribute_methods.rb, line 294
294:         def instance_method_already_implemented?(method_name)
295:           generated_attribute_methods.method_defined?(method_name)
296:         end

Disabled; run with --debug to generate this.

[Validate]

Generated with the Darkfish Rdoc Generator 1.1.6.