класс Delegator

Родитель:: BasicObject

Эта библиотека предоставляет три различных способа делегирования вызовов методов объекту. Самый простой в использовании — SimpleDelegator. Передайте объект в конструктор, и все методы, поддерживаемые объектом, будут делегированы. Этот объект можно изменить позже.

Идя дальше, метод DelegateClass верхнего уровня позволяет легко настроить делегирование через наследование классов. Это значительно более гибко и, следовательно, вероятно, является наиболее распространённым использованием этой библиотеки.

Наконец, если вам нужен полный контроль над схемой делегирования, вы можете унаследовать от абстрактного класса Delegator и настроить его по мере необходимости. (Если вы обнаружите, что вам нужен этот контроль, взгляните на Forwardable, который также находится в стандартной библиотеке. Он может лучше подойти для ваших нужд.)

Реализация SimpleDelegator служит хорошим примером использования 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

Примечания

Обратите внимание, что RDoc не будет обнаруживать делегированные методы.

Методы публичного класса

new(obj) Показать исходный код

# File lib/delegate.rb, line 71
def initialize(obj)
  __setobj__(obj)
end

Передайте obj, чтобы делегировать вызовы методов. Все методы, поддерживаемые obj, будут делегированы.

Методы публичного экземпляра

!() Показать исходный код

# File lib/delegate.rb, line 159
def !
  !__getobj__
end

Делегирует ! на _getobj_

!=(obj) Показать исходный код

# File lib/delegate.rb, line 143
def !=(obj)
  return false if obj.equal?(self)
  __getobj__ != obj
end

Возвращает true, если два объекта не считаются равными по значению.

==(obj) Показать исходный код

# File lib/delegate.rb, line 135
def ==(obj)
  return true if obj.equal?(self)
  self.__getobj__ == obj
end

Возвращает true, если два объекта считаются равными по значению.

__getobj__() Показать исходный код

# File lib/delegate.rb, line 167
def __getobj__
  __raise__ ::NotImplementedError, "need to define `__getobj__'"
end

Этот метод должен быть переопределён подклассами и должен возвращать объект, к которому делегируются вызовы методов.

__raise__()

Псевдоним для: raise

__setobj__(obj) Показать исходный код

# File lib/delegate.rb, line 175
def __setobj__(obj)
  __raise__ ::NotImplementedError, "need to define `__setobj__'"
end

Этот метод должен быть переопределен подклассами и изменить объект делегата на obj.

eql?(obj) Показать исходный код

# File lib/delegate.rb, line 151
def eql?(obj)
  return true if obj.equal?(self)
  obj.eql?(__getobj__)
end

Возвращает true, если два объекта считаются равными по значению.

freeze() Показать исходный код

# File lib/delegate.rb, line 237

Замораживает как объект, возвращаемый _getobj_, так и self.

marshal_dump() Показать исходный код

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

Поддержка сериализации для объекта, возвращаемого _getobj_.

marshal_load(data) Показать исходный код

# File lib/delegate.rb, line 194
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_missing(m, *args, &block) Показать исходный код

# 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

Обрабатывает магию делегирования через _getobj_.

Вызывает метод суперкласса BasicObject#method_missing

methods(all=true) Показать исходный код

# File lib/delegate.rb, line 110
def methods(all=true)
  __getobj__.methods(all) | super
end

Возвращает методы, доступные этому объекту-делегату, как объединение методов этого объекта и _getobj_.

Вызывает метод суперкласса

protected_methods(all=true) Показать исходный код

# File lib/delegate.rb, line 126
def protected_methods(all=true)
  __getobj__.protected_methods(all) | super
end

Возвращает защищённые методы, доступные этому объекту-делегату, как объединение защищённых методов этого объекта и _getobj_.

Вызывает метод суперкласса

public_methods(all=true) Показать исходный код

# File lib/delegate.rb, line 118
def public_methods(all=true)
  __getobj__.public_methods(all) | super
end

Возвращает публичные методы, доступные этому объекту-делегату, как объединение публичных методов этого объекта и _getobj_.

Вызывает метод суперкласса

raise() Показать исходный код

# File lib/delegate.rb, line 67

Используйте __raise__, если у вашего Delegator нет объекта для делегирования вызова метода raise.

Также псевдоним для: __raise__

respond_to_missing?(m, include_private) Показать исходный код

# 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 "delegator does not forward private method \##{m}", uplevel: 3
    return false
  end
  r
end

Проверяет наличие метода, предоставленного объектом-делегатом, перенаправляя вызов через _getobj_.

taint() Показать исходный код

# File lib/delegate.rb, line 227

Загрязнить и объект, возвращаемый _getobj_, и self.

trust() Показать исходный код

# File lib/delegate.rb, line 217

Доверие к объекту, возвращаемому _getobj_, и self.

untaint() Показать исходный код

# File lib/delegate.rb, line 232

Снять загрязнение как с объекта, возвращаемого _getobj_, так и с self.

untrust() Показать исходный код

# File lib/delegate.rb, line 222

Снять доверие как к объекту, возвращаемому _getobj_, так и к self.

Ruby Core © 1993–2017 Yukihiro Matsumoto
Licensed under the Ruby License.
Ruby Standard Library © contributors
Licensed under their own licenses.