doc/forwardable.rd

   1  -- forwardable.rb
   2
   3                                                 $Release Version: 1.1 $
   4                                                 $Revision$
   5                                                 Original version by Tosh
   6
   7 =begin
   8
   9 = Forwardable
  10
  11 A Module to define delegations for selected methods to a class.
  12
  13 == Usage
  14
  15 Using through extending the class.
  16
  17   class Foo
  18     extend Forwardable
  19
  20     def_delegators("@out", "printf", "print")
  21     def_delegators(:@in, :gets)
  22     def_delegator(:@contents, :[], "content_at")
  23   end
  24   f = Foo.new
  25   f.printf ...
  26   f.gets
  27   f.content_at(1)
  28
  29 == Methods
  30
  31 --- Forwardable#def_instance_delegators(accessor, *methods)
  32
  33       adding the delegations for each method of ((|methods|)) to
  34       ((|accessor|)).
  35
  36 --- Forwardable#def_instance_delegator(accessor, method, ali = method)
  37
  38       adding the delegation for ((|method|)) to ((|accessor|)). When
  39       you give optional argument ((|ali|)), ((|ali|)) is used as the
  40       name of the delegation method, instead of ((|method|)).
  41
  42 --- Forwardable#def_delegators(accessor, *methods)
  43
  44       the alias of ((|Forwardable#def_instance_delegators|)).
  45
  46 --- Forwardable#def_delegator(accessor, method, ali = method)
  47
  48       the alias of ((|Forwardable#def_instance_delegator|)).
  49
  50 = SingleForwardable
  51
  52 a Module to define delegations for selected methods to an object.
  53
  54 == Usage
  55
  56 Using through extending the object.
  57
  58   g = Goo.new
  59   g.extend SingleForwardable
  60   g.def_delegator("@out", :puts)
  61   g.puts ...
  62
  63 == Methods
  64
  65 --- SingleForwardable#def_singleton_delegators(accessor, *methods)
  66
  67       adding the delegations for each method of ((|methods|)) to
  68       ((|accessor|)).
  69
  70 --- SingleForwardable#def_singleton_delegator(accessor, method, ali = method)
  71
  72       adding the delegation for ((|method|)) to ((|accessor|)). When
  73       you give optional argument ((|ali|)), ((|ali|)) is used as the
  74       name of the delegation method, instead of ((|method|)).
  75
  76 --- SingleForwardable#def_delegators(accessor, *methods)
  77
  78       the alias of ((|SingleForwardable#def_instance_delegators|)).
  79
  80 --- SingleForwardable#def_delegator(accessor, method, ali = method)
  81
  82       the alias of ((|SingleForwardable#def_instance_delegator|)).
  83 =end