класс Proc

Объект Proc представляет собой инкапсуляцию блока кода, который можно сохранить в локальной переменной, передать методу или другому объекту Proc и вызвать. Proc — важное понятие в Ruby и основа его возможностей функционального программирования.

square = Proc.new {|x| x**2 }

square.call(3)  #=> 9
# shorthands:
square.(3)      #=> 9
square[3]       #=> 9

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

def gen_times(factor)
  Proc.new {|n| n*factor } # remembers the value of factor at the moment of creation
end

times3 = gen_times(3)
times5 = gen_times(5)

times3.call(12)               #=> 36
times5.call(5)                #=> 25
times3.call(times5.call(4))   #=> 60

Создание

Существует несколько способов создать Proc

• Использовать конструктор класса Proc:

  proc1 = Proc.new {|x| x**2 }
  

• Использовать метод Kernel#proc как сокращённую запись для Proc.new:

  proc2 = proc {|x| x**2 }
  

• Получить блок кода в аргумент proc (обратите внимание на &):

  def make_proc(&block)
    block
  end
  
  proc3 = make_proc {|x| x**2 }
  

• Создать proc с семантикой lambda с помощью метода Kernel#lambda (объяснения о lambda приведены ниже):

  lambda1 = lambda {|x| x**2 }
  

• Использовать синтаксис литерала lambda proc литерал lambda proc (он также создаёт proc с семантикой lambda):

  lambda2 = ->(x) { x**2 }
  

Семантика lambda и обычных proc

Proc бывают двух видов: lambda и обычные proc (не-lambda). Различия:

• В lambda return и break означают выход из этой lambda;

• В обычных proc return означает выход из охватывающего метода (и вызывает LocalJumpError, если вызван вне метода);

• В обычных proc break означает выход из метода, которому был передан блок (и вызывает LocalJumpError, если вызван после возврата метода);

• В lambda аргументы обрабатываются так же, как в методах: строго, с вызовом ArgumentError при несовпадении количества аргументов и без дополнительной обработки аргументов;

• Обычные proc принимают аргументы более свободно: недостающие аргументы заполняются значением nil, одиночные аргументы Array раскладываются на несколько аргументов, если proc принимает несколько аргументов, а лишние аргументы не вызывают ошибку.

Примеры:

# +return+ in non-lambda proc, +b+, exits +m2+.
# (The block +{ return }+ is given for +m1+ and embraced by +m2+.)
$a = []; def m1(&b) b.call; $a << :m1 end; def m2() m1 { return }; $a << :m2 end; m2; p $a
#=> []

# +break+ in non-lambda proc, +b+, exits +m1+.
# (The block +{ break }+ is given for +m1+ and embraced by +m2+.)
$a = []; def m1(&b) b.call; $a << :m1 end; def m2() m1 { break }; $a << :m2 end; m2; p $a
#=> [:m2]

# +next+ in non-lambda proc, +b+, exits the block.
# (The block +{ next }+ is given for +m1+ and embraced by +m2+.)
$a = []; def m1(&b) b.call; $a << :m1 end; def m2() m1 { next }; $a << :m2 end; m2; p $a
#=> [:m1, :m2]

# Using +proc+ method changes the behavior as follows because
# The block is given for +proc+ method and embraced by +m2+.
$a = []; def m1(&b) b.call; $a << :m1 end; def m2() m1(&proc { return }); $a << :m2 end; m2; p $a
#=> []
$a = []; def m1(&b) b.call; $a << :m1 end; def m2() m1(&proc { break }); $a << :m2 end; m2; p $a
# break from proc-closure (LocalJumpError)
$a = []; def m1(&b) b.call; $a << :m1 end; def m2() m1(&proc { next }); $a << :m2 end; m2; p $a
#=> [:m1, :m2]

# +return+, +break+ and +next+ in the stubby lambda exits the block.
# (+lambda+ method behaves same.)
# (The block is given for stubby lambda syntax and embraced by +m2+.)
$a = []; def m1(&b) b.call; $a << :m1 end; def m2() m1(&-> { return }); $a << :m2 end; m2; p $a
#=> [:m1, :m2]
$a = []; def m1(&b) b.call; $a << :m1 end; def m2() m1(&-> { break }); $a << :m2 end; m2; p $a
#=> [:m1, :m2]
$a = []; def m1(&b) b.call; $a << :m1 end; def m2() m1(&-> { next }); $a << :m2 end; m2; p $a
#=> [:m1, :m2]

p = proc {|x, y| "x=#{x}, y=#{y}" }
p.call(1, 2)      #=> "x=1, y=2"
p.call([1, 2])    #=> "x=1, y=2", array deconstructed
p.call(1, 2, 8)   #=> "x=1, y=2", extra argument discarded
p.call(1)         #=> "x=1, y=", nil substituted instead of error

l = lambda {|x, y| "x=#{x}, y=#{y}" }
l.call(1, 2)      #=> "x=1, y=2"
l.call([1, 2])    # ArgumentError: wrong number of arguments (given 1, expected 2)
l.call(1, 2, 8)   # ArgumentError: wrong number of arguments (given 3, expected 2)
l.call(1)         # ArgumentError: wrong number of arguments (given 1, expected 2)

def test_return
  -> { return 3 }.call      # just returns from lambda into method body
  proc { return 4 }.call    # returns from method
  return 5
end

test_return # => 4, return from proc

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

Proc полезны для реализации итераторов:

def test
  [[1, 2], [3, 4], [5, 6]].map {|a, b| return a if a + b > 10 }
                            #  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
end

Внутри map блок кода рассматривается как обычный proc (не-lambda), а значит, внутренние массивы раскладываются на пары аргументов, а return завершает метод test. С более строгой lambda это было бы невозможно.

Отличить lambda от обычного proc можно с помощью метода экземпляра lambda?.

Семантика lambda обычно сохраняется на протяжении всего времени жизни proc, в том числе при & — преобразовании в блок кода:

p = proc {|x, y| x }
l = lambda {|x, y| x }
[[1, 2], [3, 4]].map(&p) #=> [1, 3]
[[1, 2], [3, 4]].map(&l) # ArgumentError: wrong number of arguments (given 1, expected 2)

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

class C
  define_method(:e, &proc {})
end
C.new.e(1,2)       #=> ArgumentError
C.new.method(:e).to_proc.lambda?   #=> true

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

class C
  def self.def2(name, &body)
    define_method(name, &body)
  end

  def2(:f) {}
end
C.new.f(1,2)       #=> ArgumentError

Обёртка def2 получает body как обычный proc, но при этом определяет метод с обычной семантикой.

Преобразование других объектов в proc

Любой объект, реализующий метод to_proc, можно преобразовать в proc с помощью оператора &, а значит, его можно использовать в итераторах.

class Greeter
  def initialize(greeting)
    @greeting = greeting
  end

  def to_proc
    proc {|name| "#{@greeting}, #{name}!" }
  end
end

hi = Greeter.new("Hi")
hey = Greeter.new("Hey")
["Bob", "Jane"].map(&hi)    #=> ["Hi, Bob!", "Hi, Jane!"]
["Bob", "Jane"].map(&hey)   #=> ["Hey, Bob!", "Hey, Jane!"]

Среди основных классов Ruby этот метод реализован в Symbol, Method и Hash.

:to_s.to_proc.call(1)           #=> "1"
[1, 2].map(&:to_s)              #=> ["1", "2"]

method(:puts).to_proc.call(1)   # prints 1
[1, 2].each(&method(:puts))     # prints 1, 2

{test: 1}.to_proc.call(:test)       #=> 1
%i[test many keys].map(&{test: 1})  #=> [1, nil, nil]

Осиротевшие Proc

return и break в блоке завершают метод. Если из блока создан объект Proc и этот объект Proc существует после возврата метода, return и break не могут работать. В таком случае return и break вызывают LocalJumpError. Объект Proc в такой ситуации называется осиротевшим объектом Proc.

Обратите внимание, что метод, из которого выполняется выход, различается для return и break. Возможна ситуация, когда объект осиротел для break, но не осиротел для return.

def m1(&b) b.call end; def m2(); m1 { return } end; m2 # ok
def m1(&b) b.call end; def m2(); m1 { break } end; m2 # ok

def m1(&b) b end; def m2(); m1 { return }.call end; m2 # ok
def m1(&b) b end; def m2(); m1 { break }.call end; m2 # LocalJumpError

def m1(&b) b end; def m2(); m1 { return } end; m2.call # LocalJumpError
def m1(&b) b end; def m2(); m1 { break } end; m2.call # LocalJumpError

Поскольку в lambda return и break завершают сам блок, lambda не могут осиротеть.

Анонимные параметры блока

Чтобы упростить запись коротких блоков, Ruby предоставляет два типа анонимных параметров: it (один параметр) и нумерованные параметры: _1, _2 и так далее.

# Explicit parameter:
%w[test me please].each { |str| puts str.upcase } # prints TEST, ME, PLEASE
(1..5).map { |i| i**2 } # => [1, 4, 9, 16, 25]

# it:
%w[test me please].each { puts it.upcase } # prints TEST, ME, PLEASE
(1..5).map { it**2 } # => [1, 4, 9, 16, 25]

# Numbered parameter:
%w[test me please].each { puts _1.upcase } # prints TEST, ME, PLEASE
(1..5).map { _1**2 } # => [1, 4, 9, 16, 25]

it

it — это имя, доступное внутри блока, если явные параметры не определены, как показано выше.

%w[test me please].each { puts it.upcase } # prints TEST, ME, PLEASE
(1..5).map { it**2 } # => [1, 4, 9, 16, 25]

it — это «мягкое ключевое слово»: оно не является зарезервированным именем и может использоваться в качестве имени метода или локальной переменной:

it = 5 # no warnings
def it(&block) # RSpec-like API, no warnings
   # ...
end

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

[1, 2, 3].each {
  # takes a value of implicit parameter "it" and uses it to
  # define a local variable with the same name
  it = it**2
  p it
}

Использование it в блоке с явно определёнными параметрами вызывает исключение:

[1, 2, 3].each { |x| p it }
# syntax error found (SyntaxError)
# [1, 2, 3].each { |x| p it }
#                        ^~ 'it' is not allowed when an ordinary parameter is defined

Но если доступно локальное имя (переменная или метод), будет использовано оно:

it = 5
[1, 2, 3].each { |x| p it }
# Prints 5, 5, 5

Блоки с it можно вкладывать:

%w[test me].each { it.each_char { p it } }
# Prints "t", "e", "s", "t", "m", "e"

Считается, что блоки с it имеют один параметр:

p = proc { it**2 }
l = lambda { it**2 }
p.parameters     # => [[:opt]]
p.arity          # => 1
l.parameters     # => [[:req]]
l.arity          # => 1

Нумерованные параметры

Нумерованные параметры — ещё один способ неявно задавать имена параметров блока. В отличие от it, нумерованные параметры позволяют обращаться к нескольким параметрам в одном блоке.

%w[test me please].each { puts _1.upcase } # prints TEST, ME, PLEASE
{a: 100, b: 200}.map { "#{_1} = #{_2}" } # => "a = 100", "b = 200"

Поддерживаются имена параметров от _1 до _9:

[10, 20, 30].zip([40, 50, 60], [70, 80, 90]).map { _1 + _2 + _3 }
# => [120, 150, 180]

Однако рекомендуется использовать их осмотрительно, вероятно, ограничившись _1 и _2 и однострочными блоками.

Нумерованные параметры нельзя использовать вместе с параметрами, имеющими явные имена:

[10, 20, 30].map { |x| _1**2 }
# SyntaxError (ordinary parameter is defined)

Нумерованные параметры нельзя сочетать и с it:

[10, 20, 30].map { _1 + it }
# SyntaxError: 'it' is not allowed when a numbered parameter is already used

Чтобы избежать конфликтов, использование _1, _2 и так далее в качестве имён локальных переменных или аргументов метода приводит к ошибке.

  _1 = 'test'
# ^~ _1 is reserved for numbered parameters (SyntaxError)

Использование неявных нумерованных параметров влияет на арность блока:

p = proc { _1 + _2 }
l = lambda { _1 + _2 }
p.parameters     # => [[:opt, :_1], [:opt, :_2]]
p.arity          # => 2
l.parameters     # => [[:req, :_1], [:req, :_2]]
l.arity          # => 2

Блоки с нумерованными параметрами нельзя вкладывать:

%w[test me].each { _1.each_char { p _1 } }
# numbered parameter is already used in outer block (SyntaxError)
# %w[test me].each { _1.each_char { p _1 } }
#                    ^~