diff options
author | Jeremy Kemper <jeremy@bitsweat.net> | 2006-05-08 18:04:07 +0000 |
---|---|---|
committer | Jeremy Kemper <jeremy@bitsweat.net> | 2006-05-08 18:04:07 +0000 |
commit | befd62c2fc04356980c4de493ffdee40e7a36c87 (patch) | |
tree | 690b3c860d8f8ea38672511bee92859bd440929a /activesupport/lib/active_support | |
parent | 0adcd811f945603a8037febaa158bbc1ffaba9d1 (diff) | |
download | rails-befd62c2fc04356980c4de493ffdee40e7a36c87.tar.gz rails-befd62c2fc04356980c4de493ffdee40e7a36c87.tar.bz2 rails-befd62c2fc04356980c4de493ffdee40e7a36c87.zip |
Document Active Support's Module::delegate. Closes #5002.
git-svn-id: http://svn-commit.rubyonrails.org/rails/trunk@4329 5ecf4fe2-1ee6-0310-87b1-e25e094e27de
Diffstat (limited to 'activesupport/lib/active_support')
-rw-r--r-- | activesupport/lib/active_support/core_ext/module/delegation.rb | 29 |
1 files changed, 27 insertions, 2 deletions
diff --git a/activesupport/lib/active_support/core_ext/module/delegation.rb b/activesupport/lib/active_support/core_ext/module/delegation.rb index 95173007ca..8a44bd9ba5 100644 --- a/activesupport/lib/active_support/core_ext/module/delegation.rb +++ b/activesupport/lib/active_support/core_ext/module/delegation.rb @@ -1,8 +1,33 @@ class Module + # Provides a delegate class method to easily expose contained objects' methods + # as your own. Pass one or more methods (specified as symbols or strings) + # and the name of the target object as the final :to option (also a symbol + # or string). At least one method and the :to option are required. + # + # Delegation is particularly useful with Active Record associations: + # class Greeter < ActiveRecord::Base + # def hello() "hello" end + # def goodbye() "goodbye" end + # end + # + # class Foo < ActiveRecord::Base + # belongs_to :greeter + # delegate :hello, :to => :greeter + # end + # + # Foo.new.hello # => "hello" + # Foo.new.goodbye # => NoMethodError: undefined method `goodbye' for #<Foo:0x1af30c> + # + # With multiple delegates to the same target are allowed: + # class Foo < ActiveRecord::Base + # delegate :hello, :goodbye, :to => :greeter + # end + # + # Foo.new.goodbye # => "goodbye" def delegate(*methods) options = methods.pop unless options.is_a?(Hash) && to = options[:to] - raise ArgumentError, "Delegation needs a target. Supply an options hash with a :to key" + raise ArgumentError, "Delegation needs a target. Supply an options hash with a :to key as the last argument (e.g. delegate :hello, :to => :greeter)." end methods.each do |method| @@ -13,4 +38,4 @@ class Module EOS end end -end
\ No newline at end of file +end |