kotovalexarian-likes-github/rails--rails
1
0
Fork 0
mirror of https://github.com/rails/rails.git synced 2022-11-09 12:12:34 -05:00
Code Releases Activity

Merge pull request #13442 from aditya-kapoor/update-docs

Browse source 
Updated documentation for Attribute Methods [ci skip]
This commit is contained in:
Godfrey Chan 2013-12-26 02:02:53 -08:00
commit 87323487ce
1 changed files with 11 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
activemodel/lib/active_model/attribute_methods.rb
View file

@ -14,11 +14,11 @@ module ActiveModel
class MissingAttributeError < NoMethodError class MissingAttributeError < NoMethodError
end end
# == Active Model Attribute Methods # == Active \Model \Attribute \Methods
# #
# <tt>ActiveModel::AttributeMethods</tt> provides a way to add prefixes and # Provides a way to add prefixes and suffixes to your methods as
# suffixes to your methods as well as handling the creation of # well as handling the creation of <tt>ActiveRecord::Base</tt>-like
# <tt>ActiveRecord::Base</tt>-like class methods such as +table_name+. # class methods such as +table_name+.
# #
# The requirements to implement <tt>ActiveModel::AttributeMethods</tt> are to: # The requirements to implement <tt>ActiveModel::AttributeMethods</tt> are to:
# #
@ -27,7 +27,9 @@ module ActiveModel
# or +attribute_method_prefix+. # or +attribute_method_prefix+.
# * Call +define_attribute_methods+ after the other methods are called. # * Call +define_attribute_methods+ after the other methods are called.
# * Define the various generic +_attribute+ methods that you have declared. # * Define the various generic +_attribute+ methods that you have declared.
# * Define an +attributes+ method, see below. # * Define an +attributes+ method which returns a hash with each
# attribute name in your model as hash key and the attribute value as hash value.
# Hash keys must be strings.
# #
# A minimal implementation could be: # A minimal implementation could be:
# #
@ -59,13 +61,6 @@ module ActiveModel
# send("#{attr}=", 'Default Name') # send("#{attr}=", 'Default Name')
# end # end
# end # end
#
# Note that whenever you include <tt>ActiveModel::AttributeMethods</tt> in
# your class, it requires you to implement an +attributes+ method which
# returns a hash with each attribute name in your model as hash key and the
# attribute value as hash value.
#
# Hash keys must be strings.
module AttributeMethods module AttributeMethods
extend ActiveSupport::Concern extend ActiveSupport::Concern
@ -173,14 +168,14 @@ module ActiveModel
# private # private
# #
# def reset_attribute_to_default!(attr) # def reset_attribute_to_default!(attr)
# ... # send("#{attr}=", 'Default Name')
# end # end
# end # end
# #
# person = Person.new # person = Person.new
# person.name # => 'Gem' # person.name # => 'Gem'
# person.reset_name_to_default! # person.reset_name_to_default!
# person.name # => 'Gemma' # person.name # => 'Default Name'
def attribute_method_affix(*affixes) def attribute_method_affix(*affixes)
self.attribute_method_matchers += affixes.map! { |affix| AttributeMethodMatcher.new prefix: affix[:prefix], suffix: affix[:suffix] } self.attribute_method_matchers += affixes.map! { |affix| AttributeMethodMatcher.new prefix: affix[:prefix], suffix: affix[:suffix] }
undefine_attribute_methods undefine_attribute_methods
@ -250,7 +245,7 @@ module ActiveModel
# private # private
# #
# def clear_attribute(attr) # def clear_attribute(attr)
# ... # send("#{attr}", nil)
# end # end
# end # end
def define_attribute_methods(*attr_names) def define_attribute_methods(*attr_names)