summaryrefslogtreecommitdiff
path: root/lib/forwardable.rb
diff options
context:
space:
mode:
authormatz <matz@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2005-10-05 16:15:16 +0000
committermatz <matz@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2005-10-05 16:15:16 +0000
commit22f1926644a213a39cd8a3f83a80518e5c15797f (patch)
tree664beb18420f4bc9329dc37e52bdeafbf000037a /lib/forwardable.rb
parent313e0cb56aedfceb0bfaab2e430d2211c5e2043b (diff)
* range.c (rb_range_beg_len): should return Qfalse for non-range
object. * pack.c (EXTEND16): [ruby-dev:27383] * eval.c (set_trace_func): add rb_secure(4) to prevent adding tracing function. * lib/delegate.rb: document update from James Edward Gray II <james@grayproductions.net>. [ruby-core:05942] * process.c (proc_daemon): should restrict execution on levels higher than $SAFE=2. suggested by URABE Shyouhei <shyouhei@ice.uec.ac.jp>. * lib/forwardable.rb: replaced by new implementation from <Daniel.Berger@qwest.com>. [ruby-core:05899] * file.c (path_check_0): disallow sticky world writable directory in PATH (and $LOAD_PATH). [ruby-dev:27226] * numeric.c (fix_idiv): 1.div(1.0) should return integer value. [ruby-dev:27235] * lib/yaml.rb: require 'yaml/constants'. [ruby-core:5776] * lib/xmlrpc/client.rb (XMLRPC::Client::do_rpc): add charset information to content-type header.[ruby-core:5127] * lib/xmlrpc/server.rb (CGIServer::serve): ditto. * lib/xmlrpc/server.rb (ModRubyServer::serve): ditto. * lib/xmlrpc/server.rb (WEBrickServlet::service): ditto. * test/dbm/test_dbm.rb (TestDBM::test_s_open_error): remove test_s_open_error test to detect duplicate open. [ruby-dev:27202] * eval.c (splat_value): use to_a to splat non Array object. * object.c (nil_to_a): remove nil.to_a. [experimental] git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@9349 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'lib/forwardable.rb')
-rw-r--r--lib/forwardable.rb206
1 files changed, 145 insertions, 61 deletions
diff --git a/lib/forwardable.rb b/lib/forwardable.rb
index b845f76ec4..3e979a3155 100644
--- a/lib/forwardable.rb
+++ b/lib/forwardable.rb
@@ -5,90 +5,174 @@
# $Date$
# by Keiju ISHITSUKA(keiju@ishitsuka.com)
# original definition by delegator.rb
-# --
-# Usage:
+# Revised by Daniel J. Berger with suggestions from Florian Gross.
#
-# class Foo
+# Documentation by James Edward Gray II and Gavin Sinclair
+#
+# == Introduction
+#
+# This library allows you delegate method calls to an object, on a method by
+# method basis.
+#
+# == Notes
+#
+# Be advised, RDoc will not detect delegated methods.
+#
+# <b>forwardable.rb provides single-method delegation via the
+# def_delegator() and def_delegators() methods. For full-class
+# delegation via DelegateClass(), see delegate.rb.</b>
+#
+# == Examples
+#
+# === Forwardable
+#
+# Forwardable makes building a new class based on existing work, with a proper
+# interface, almost trivial. We want to rely on what has come before obviously,
+# but with delegation we can take just the methods we need and even rename them
+# as appropriate. In many cases this is preferable to inheritance, which gives
+# us the entire old interface, even if much of it isn't needed.
+#
+# class Queue
# extend Forwardable
+#
+# def initialize
+# @q = [ ] # prepare delegate object
+# end
+#
+# # setup prefered interface, enq() and deq()...
+# def_delegator :@q, :push, :enq
+# def_delegator :@q, :shift, :deq
+#
+# # support some general Array methods that fit Queues well
+# def_delegators :@q, :clear, :first, :push, :shift, :size
+# end
+#
+# q = Queue.new
+# q.enq 1, 2, 3, 4, 5
+# q.push 6
+#
+# q.shift # => 1
+# while q.size > 0
+# puts q.deq
+# end
+#
+# q.enq "Ruby", "Perl", "Python"
+# puts q.first
+# q.clear
+# puts q.first
#
-# def_delegators("@out", "printf", "print")
-# def_delegators(:@in, :gets)
-# def_delegator(:@contents, :[], "content_at")
+# <i>Prints:</i>
+#
+# 2
+# 3
+# 4
+# 5
+# 6
+# Ruby
+# nil
+#
+# Forwardable can be used to setup delegation at the object level as well.
+#
+# printer = String.new
+# printer.extend Forwardable # prepare object for delegation
+# printer.def_delegator "STDOUT", "puts" # add delegation for STDOUT.puts()
+# printer.puts "Howdy!"
+#
+# <i>Prints:</i>
+#
+# Howdy!
+
+#
+# The Forwardable module provides delegation of specified
+# methods to a designated object, using the methods #def_delegator
+# and #def_delegators.
+#
+# For example, say you have a class RecordCollection which
+# contains an array <tt>@records</tt>. You could provide the lookup method
+# #record_number(), which simply calls #[] on the <tt>@records</tt>
+# array, like this:
+#
+# class RecordCollection
+# extends Forwardable
+# def_delegator :@records, :[], :record_number
+# end
+#
+# Further, if you wish to provide the methods #size, #<<, and #map,
+# all of which delegate to @records, this is how you can do it:
+#
+# class RecordCollection
+# # extends Forwardable, but we did that above
+# def_delegators :@records, :size, :<<, :map
# end
# f = Foo.new
# f.printf ...
# f.gets
# f.content_at(1)
#
-# g = Goo.new
-# g.extend SingleForwardable
-# g.def_delegator("@out", :puts)
-# g.puts ...
-#
-#
+# Also see the example at forwardable.rb.
module Forwardable
-
- @debug = nil
- class<<self
- attr_accessor :debug
+ FORWARDABLE_VERSION = "1.0.0"
+
+ # Takes a hash as its argument. The key is a symbol or an array of
+ # symbols. These symbols correspond to method names. The value is
+ # the accessor to which the methods will be delegated.
+ #
+ # :call-seq:
+ # delegate method => accessor
+ # delegate [method, method, ...] => accessor
+ #
+ def delegate(hash)
+ hash.each{ |methods, accessor|
+ methods = methods.to_s unless methods.respond_to?(:each)
+ methods.each{ |method|
+ def_instance_delegator(accessor, method)
+ }
+ }
end
+ #
+ # Shortcut for defining multiple delegator methods, but with no
+ # provision for using a different name. The following two code
+ # samples have the same effect:
+ #
+ # def_delegators :@records, :size, :<<, :map
+ #
+ # def_delegator :@records, :size
+ # def_delegator :@records, :<<
+ # def_delegator :@records, :map
+ #
def def_instance_delegators(accessor, *methods)
- for method in methods
+ methods.delete("__send__")
+ methods.delete("__id__")
+ methods.each{ |method|
def_instance_delegator(accessor, method)
- end
+ }
end
+ #
+ # Defines a method _method_ which delegates to _obj_ (i.e. it calls
+ # the method of the same name in _obj_). If _new_name_ is
+ # provided, it is used as the name for the delegate method.
+ #
def def_instance_delegator(accessor, method, ali = method)
- accessor = accessor.id2name if accessor.kind_of?(Integer)
- method = method.id2name if method.kind_of?(Integer)
- ali = ali.id2name if ali.kind_of?(Integer)
-
- module_eval(<<-EOS, "(__FORWARDABLE__)", 1)
+ str = %Q{
def #{ali}(*args, &block)
- begin
- #{accessor}.__send__(:#{method}, *args, &block)
- rescue Exception
- $@.delete_if{|s| /^\\(__FORWARDABLE__\\):/ =~ s} unless Forwardable::debug
- Kernel::raise
- end
+ #{accessor}.send(:#{method}, *args, &block)
end
- EOS
- end
-
- alias def_delegators def_instance_delegators
- alias def_delegator def_instance_delegator
-end
+ }
-module SingleForwardable
- def def_singleton_delegators(accessor, *methods)
- for method in methods
- def_singleton_delegator(accessor, method)
+ # If it's not a class or module, it's an instance
+ begin
+ module_eval(str)
+ rescue
+ instance_eval(str)
end
end
- def def_singleton_delegator(accessor, method, ali = method)
- accessor = accessor.id2name if accessor.kind_of?(Integer)
- method = method.id2name if method.kind_of?(Integer)
- ali = ali.id2name if ali.kind_of?(Integer)
-
- instance_eval(<<-EOS, "(__FORWARDABLE__)", 1)
- def #{ali}(*args, &block)
- begin
- #{accessor}.__send__(:#{method}, *args,&block)
- rescue Exception
- $@.delete_if{|s| /^\\(__FORWARDABLE__\\):/ =~ s} unless Forwardable::debug
- Kernel::raise
- end
- end
- EOS
- end
-
- alias def_delegators def_singleton_delegators
- alias def_delegator def_singleton_delegator
+ alias def_delegators def_instance_delegators
+ alias def_delegator def_instance_delegator
end
-
-
-
+# compatibility
+SingleForwardable = Forwardable