Уточнения

Благодаря открытым классам Ruby, вы можете переопределять или добавлять функциональность существующим классам. Это называется «модификацией обезьяны». К сожалению, область действия таких изменений глобальна. Все пользователи класса, подвергшегося модификации обезьяны, видят одни и те же изменения. Это может привести к непредвиденным побочным эффектам или поломке программ.

Уточнения предназначены для уменьшения влияния модификаций обезьяны на других пользователей класса, подвергшегося модификации. Уточнения предоставляют способ локального расширения класса. Уточнения могут изменять как классы, так и модули.

Вот базовая уточнение:

class C
  def foo
    puts "C#foo"
  end
end

module M
  refine C do
    def foo
      puts "C#foo in M"
    end
  end
end

Сначала определяется класс C. Затем создается уточнение для C с использованием Module#refine.

Module#refine создаёт анонимный модуль, содержащий изменения или уточнения класса (C в примере). self в блоке refine — это анонимный модуль, аналогичный Module#module_eval.

Активировать уточнение можно с помощью:

using M

c = C.new

c.foo # prints "C#foo in M"

Область действия

Уточнения можно активировать на верхнем уровне и внутри классов и модулей. Активировать уточнения внутри метода нельзя. Уточнения активны до конца текущего определения класса или модуля, или до конца текущего файла, если они используются на верхнем уровне.

Уточнения можно активировать в строке, переданной в Kernel#eval. Уточнения активны до конца строки eval.

Уточнения имеют лексическую область действия. Уточнения активны только в области действия после вызова using. Любой код перед оператором using не будет иметь активированного уточнения.

При передаче управления за пределы области действия уточнение деактивируется. Это означает, что если вы загружаете или подключаете файл или вызываете метод, определённый вне текущей области, уточнение будет деактивировано:

class C
end

module M
  refine C do
    def foo
      puts "C#foo in M"
    end
  end
end

def call_foo(x)
  x.foo
end

using M

x = C.new
x.foo       # prints "C#foo in M"
call_foo(x) #=> raises NoMethodError

Если метод определён в области, где активен уточнение, уточнение будет активным при вызове метода. Этот пример охватывает несколько файлов:

c.rb:

class C
end

m.rb:

require "c"

module M
  refine C do
    def foo
      puts "C#foo in M"
    end
  end
end

m_user.rb:

require "m"

using M

class MUser
  def call_foo(x)
    x.foo
  end
end

main.rb:

require "m_user"

x = C.new
m_user = MUser.new
m_user.call_foo(x) # prints "C#foo in M"
x.foo              #=> raises NoMethodError

Поскольку уточнение M активно в m_user.rb, где определён MUser#call_foo, оно также активно, когда main.rb вызывает call_foo.

Поскольку использование — метод, уточнения активны только при его вызове. Вот примеры, где уточнение M активно и неактивно.

В файле:

# not activated here
using M
# activated here
class Foo
  # activated here
  def foo
    # activated here
  end
  # activated here
end
# activated here

В классе:

# not activated here
class Foo
  # not activated here
  def foo
    # not activated here
  end
  using M
  # activated here
  def bar
    # activated here
  end
  # activated here
end
# not activated here

Обратите внимание, что уточнения в M не активируются автоматически, если класс Foo будет повторно открыт позже.

В eval:

# not activated here
eval <<EOF
  # not activated here
  using M
  # activated here
EOF
# not activated here

При отсутствии оценки:

# not activated here
if false
  using M
end
# not activated here

При определении нескольких уточнений в одном модуле внутри нескольких refine блоков, все уточнения из одного модуля активны при вызове изменённого метода (любого из методов to_json из примера ниже):

module ToJSON
  refine Integer do
    def to_json
      to_s
    end
  end

  refine Array do
    def to_json
      "[" + map { |i| i.to_json }.join(",") + "]"
    end
  end

  refine Hash do
    def to_json
      "{" + map { |k, v| k.to_s.dump + ":" + v.to_json }.join(",") + "}"
    end
  end
end

using ToJSON

p [{1=>2}, {3=>4}].to_json # prints "[{\"1\":2},{\"3\":4}]"

Method Поиск

При поиске метода для экземпляра класса C Ruby проверяет:

• Если для C активны уточнения, в обратном порядке их активации:

  • Префиксные модули из уточнения для C

  • Уточнение для C

  • Включённые модули из уточнения для C

• Префиксные модули C

• C

• Включённые модули C

Если метод не был найден ни на одном этапе, это повторяется с суперклассом C.

Обратите внимание, что методы в подклассе имеют приоритет над уточнениями в суперклассе. Например, если метод / определён в уточнении для Numeric 1 / 2 вызывает исходный Integer#/, так как Integer — подкласс Numeric и ищется перед уточнениями для суперкласса Numeric. Поскольку метод / также присутствует в дочернем Integer, поиск метода не поднимается до суперкласса.

Однако, если метод foo определён для Numeric в уточнении, 1.foo вызывает этот метод, так как foo не существует в Integer.

super

Когда вызывается super поиск метода проверяет:

• Включённые модули текущего класса. Обратите внимание, что текущий класс может быть уточнением.

• Если текущий класс является уточнением, поиск метода выполняется как в разделе «Поиск метода» выше.

• Если у текущего класса есть непосредственный суперкласс, поиск метода выполняется как в разделе «Поиск метода» выше, используя суперкласс.

Обратите внимание, что super в методе уточнения вызывает метод в уточнённом классе, даже если в той же области был активирован другой уточнение.

Интроспекция методов

При использовании методов интроспекции, таких как Kernel#method или Kernel#methods, уточнения не учитываются.

Это поведение может быть изменено в будущем.

Наследование уточнений модулем Module#include

Когда модуль X включается в модуль Y, Y наследует уточнения от X.

Например, C наследует уточнения от A и B в следующем коде:

module A
  refine X do ... end
  refine Y do ... end
end
module B
  refine Z do ... end
end
module C
  include A
  include B
end

using C
# Refinements in A and B are activated here.

Уточнения в потомках имеют более высокий приоритет, чем уточнения предков.

Дополнительная литература

См. bugs.ruby-lang.org/projects/ruby-trunk/wiki/RefinementsSpec для текущего спецификации реализации уточнений. В спецификации также содержатся дополнительные детали.