класс 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 70
def initialize(obj)
  __setobj__(obj)
end

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

Методы экземпляра

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

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

Делегирует ! в _getobj_

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

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

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

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

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

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

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

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

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

__raise__()

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

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

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

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

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

# File lib/delegate.rb, line 228

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

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

# File lib/delegate.rb, line 173
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 185
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 77
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 109
def methods(all=true)
  __getobj__.methods(all) | super
end

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

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

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

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

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

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

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

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

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

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

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

# File lib/delegate.rb, line 66

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

Также известен как: __raise__

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

# File lib/delegate.rb, line 94
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

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

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

# File lib/delegate.rb, line 218

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

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

# File lib/delegate.rb, line 208

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

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

# File lib/delegate.rb, line 223

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

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

# File lib/delegate.rb, line 213

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

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