Class: Delegator

Inherits:
BasicObject
Defined in:
lib/delegate.rb

Overview

This library provides three different ways to delegate method calls to an object. The easiest to use is SimpleDelegator. Pass an object to the constructor and all methods supported by the object will be delegated. This object can be changed later.

Going a step further, the top level DelegateClass method allows you to easily setup delegation through class inheritance. This is considerably more flexible and thus probably the most common use for this library.

Finally, if you need full control over the delegation scheme, you can inherit from the abstract class Delegator and customize as needed. (If you find yourself needing this control, have a look at Forwardable which is also in the standard library. It may suit your needs better.)

SimpleDelegator’s implementation serves as a nice example of the use of Delegator:

class SimpleDelegator < Delegator
  def __getobj__
    @delegate_sd_obj # return object we are delegating to, required
  end

  def __setobj__(obj)
    @delegate_sd_obj = obj # change delegation object,
                           # a feature we're providing
  end
end

Notes

Be advised, RDoc will not detect delegated methods.

Direct Known Subclasses

SimpleDelegator

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(obj) ⇒ Delegator

Pass in the obj to delegate method calls to. All methods supported by obj will be delegated to.



71
72
73
 
# File 'lib/delegate.rb', line 71

def initialize(obj)
  __setobj__(obj)
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(m, *args, &block) ⇒ Object

Handles the magic of delegation through _getobj_.



78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/delegate.rb', line 78

def method_missing(m, *args, &block)
  r = true
  target = self.__getobj__ {r = false}

  if r && target.respond_to?(m)
    target.__send__(m, *args, &block)
  elsif ::Kernel.respond_to?(m, true)
    ::Kernel.instance_method(m).bind(self).(*args, &block)
  else
    super(m, *args, &block)
  end
end

Class Method Details

.const_missing(n) ⇒ Object

:stopdoc:



56
57
58
 
# File 'lib/delegate.rb', line 56

def self.const_missing(n)
  ::Object.const_get(n)
end

.delegating_block(mid) ⇒ Object

:nodoc:



338
339
340
341
342
343
 
# File 'lib/delegate.rb', line 338

def Delegator.delegating_block(mid) # :nodoc:
  lambda do |*args, &block|
    target = self.__getobj__
    target.__send__(mid, *args, &block)
  end
end

.public_api ⇒ Object

:nodoc:



237
238
239
 
# File 'lib/delegate.rb', line 237

def self.public_api   # :nodoc:
  @delegator_api
end

Instance Method Details

#! ⇒ Object

Delegates ! to the _getobj_



151
152
153
 
# File 'lib/delegate.rb', line 151

def !
  !__getobj__
end

#!=(obj) ⇒ Object

Returns true if two objects are not considered of equal value.



143
144
145
146
 
# File 'lib/delegate.rb', line 143

def !=(obj)
  return false if obj.equal?(self)
  __getobj__ != obj
end

#==(obj) ⇒ Object

Returns true if two objects are considered of equal value.



135
136
137
138
 
# File 'lib/delegate.rb', line 135

def ==(obj)
  return true if obj.equal?(self)
  self.__getobj__ == obj
end

#__getobj__ ⇒ Object

This method must be overridden by subclasses and should return the object method calls are being delegated to.



159
160
161
 
# File 'lib/delegate.rb', line 159

def __getobj__
  __raise__ ::NotImplementedError, "need to define `__getobj__'"
end

#__setobj__(obj) ⇒ Object

This method must be overridden by subclasses and change the object delegate to obj.



167
168
169
 
# File 'lib/delegate.rb', line 167

def __setobj__(obj)
  __raise__ ::NotImplementedError, "need to define `__setobj__'"
end

#marshal_dump ⇒ Object

Serialization support for the object returned by _getobj_.



174
175
176
177
178
179
180
181
 
# File 'lib/delegate.rb', line 174

def marshal_dump
  ivars = instance_variables.reject {|var| /\A@delegate_/ =~ var}
  [
    :__v2__,
    ivars, ivars.map{|var| instance_variable_get(var)},
    __getobj__
  ]
end

#marshal_load(data) ⇒ Object

Reinitializes delegation from a serialized object.



186
187
188
189
190
191
192
193
194
 
# File 'lib/delegate.rb', line 186

def marshal_load(data)
  version, vars, values, obj = data
  if version == :__v2__
    vars.each_with_index{|var, i| instance_variable_set(var, values[i])}
    __setobj__(obj)
  else
    __setobj__(data)
  end
end

#method ⇒ Object

:method: freeze Freeze both the object returned by _getobj_ and self.



229
230
231
232
233
234
 
# File 'lib/delegate.rb', line 229

[:trust, :untrust, :taint, :untaint, :freeze].each do |method|
  define_method method do
    __getobj__.send(method)
    super()
  end
end

#methods(all = true) ⇒ Object

Returns the methods available to this delegate object as the union of this object’s and _getobj_ methods.



110
111
112
 
# File 'lib/delegate.rb', line 110

def methods(all=true)
  __getobj__.methods(all) | super
end

#protected_methods(all = true) ⇒ Object

Returns the methods available to this delegate object as the union of this object’s and _getobj_ protected methods.



126
127
128
 
# File 'lib/delegate.rb', line 126

def protected_methods(all=true)
  __getobj__.protected_methods(all) | super
end

#public_methods(all = true) ⇒ Object

Returns the methods available to this delegate object as the union of this object’s and _getobj_ public methods.



118
119
120
 
# File 'lib/delegate.rb', line 118

def public_methods(all=true)
  __getobj__.public_methods(all) | super
end

#respond_to_missing?(m, include_private) ⇒ Boolean

Checks for a method provided by this the delegate object by forwarding the call through _getobj_.

Returns:

  • (Boolean) 


95
96
97
98
99
100
101
102
103
104
 
# File 'lib/delegate.rb', line 95

def respond_to_missing?(m, include_private)
  r = true
  target = self.__getobj__ {r = false}
  r &&= target.respond_to?(m, include_private)
  if r && include_private && !target.respond_to?(m, false)
    warn "#{caller(3)[0]}: delegator does not forward private method \##{m}"
    return false
  end
  r
end