Сопоставление с образцом

Сопоставление с образцом — это функция, позволяющая глубоко сопоставлять структурированные значения: проверять структуру и привязывать сопоставленные части к локальным переменным.

Сопоставление с образцом в Ruby реализуется с помощью выражения case/in:

case <expression>
in <pattern1>
  ...
in <pattern2>
  ...
in <pattern3>
  ...
else
  ...
end

(Обратите внимание, что ветви in и when НЕ могут быть смешаны в одном выражении case)

Или с помощью оператора => и оператора in, которые могут использоваться в отдельном выражении:

<expression> => <pattern>

<expression> in <pattern>

Выражение case/in является *исчерпывающим*: если значение выражения не соответствует ни одной ветви выражения case (и ветвь else отсутствует), то поднимается NoMatchingPatternError.

Поэтому, выражение case может использоваться для условного сопоставления и распаковки:

config = {db: {user: 'admin', password: 'abc123'}}

case config
in db: {user:} # matches subhash and puts matched value in variable user
  puts "Connect with user '#{user}'"
in connection: {username: }
  puts "Connect with user '#{username}'"
else
  puts "Unrecognized structure of config"
end
# Prints: "Connect with user 'admin'"

в то время как оператор => наиболее полезен, когда ожидаемая структура данных известна заранее, чтобы просто распаковать ее части:

config = {db: {user: 'admin', password: 'abc123'}}

config => {db: {user:}} # will raise if the config's structure is unexpected

puts "Connect with user '#{user}'"
# Prints: "Connect with user 'admin'"

<expression> in <pattern> эквивалентно case <expression>; in <pattern>; true; else false; end. Можно использовать его, когда нужно только узнать, было ли сопоставлено с образцом или нет:

users = [{name: "Alice", age: 12}, {name: "Bob", age: 23}]
users.any? {|user| user in {name: /B/, age: 20..} } #=> true

См. ниже дополнительные примеры и объяснения синтаксиса.

Образцы

Образцы могут быть:

• любой объект Ruby (сопоставляется с помощью оператора ===, как в when); (Образец значения)

• образец массива: [<subpattern>, <subpattern>, <subpattern>, ...]; (Образец массива)

• образец поиска: [*variable, <subpattern>, <subpattern>, <subpattern>, ..., *variable]; (Образец поиска)

• образец хеша: {key: <subpattern>, key: <subpattern>, ...}; (Образец хеша)

• комбинация образцов с помощью |; (Альтернативный образец)

• захват переменных: <pattern> => variable или variable; (В качестве образца, Образец переменной)

Любой образец может быть вложен в образцы массива/поиска/хеша, где указано <subpattern>.

Array образцы и образцы поиска сопоставляются с массивами или объектами, которые отвечают на deconstruct (см. ниже о последнем). Hash образцы сопоставляются с хешами или объектами, которые отвечают на deconstruct_keys (см. ниже о последнем). Обратите внимание, что для образцов хешей поддерживаются только символьные ключи.

Важное различие в поведении образцов массивов и хешей заключается в том, что массивы соответствуют только *целому* массиву:

case [1, 2, 3]
in [Integer, Integer]
  "matched"
else
  "not matched"
end
#=> "not matched"

в то время как хеши соответствуют даже если есть другие ключи помимо указанной части:

case {a: 1, b: 2, c: 3}
in {a: Integer}
  "matched"
else
  "not matched"
end
#=> "matched"

{} — единственное исключение из этого правила. Он сопоставляется только если задан пустой хеш:

case {a: 1, b: 2, c: 3}
in {}
  "matched"
else
  "not matched"
end
#=> "not matched"

case {}
in {}
  "matched"
else
  "not matched"
end
#=> "matched"

Также есть способ указать, что в сопоставляемом хеше не должно быть других ключей, кроме явно указанных в образце, с помощью **nil:

case {a: 1, b: 2}
in {a: Integer, **nil} # this will not match the pattern having keys other than a:
  "matched a part"
in {a: Integer, b: Integer, **nil}
  "matched a whole"
else
  "not matched"
end
#=> "matched a whole"

Оба образца массива и хеша поддерживают спецификацию «остатка»:

case [1, 2, 3]
in [Integer, *]
  "matched"
else
  "not matched"
end
#=> "matched"

case {a: 1, b: 2, c: 3}
in {a: Integer, **}
  "matched"
else
  "not matched"
end
#=> "matched"

В выражениях case (но не в => и in) круглые скобки вокруг обоих типов образцов можно опустить:

case [1, 2]
in Integer, Integer
  "matched"
else
  "not matched"
end
#=> "matched"

case {a: 1, b: 2, c: 3}
in a: Integer
  "matched"
else
  "not matched"
end
#=> "matched"

Find образец похож на образец массива, но он может использоваться для проверки наличия в данном объекте элементов, которые соответствуют образцу:

case ["a", 1, "b", "c", 2]
in [*, String, String, *]
  "matched"
else
  "not matched"
end

Привязка переменных

Помимо глубокой проверки структуры, одной из очень важных функций сопоставления с образцом является привязка сопоставленных частей к локальным переменным. Основной формой привязки является просто указание => variable_name после сопоставленного (под)образца (это может показаться похожим на хранение исключений в локальных переменных в rescue ExceptionClass => var блоке):

case [1, 2]
in Integer => a, Integer
  "matched: #{a}"
else
  "not matched"
end
#=> "matched: 1"

case {a: 1, b: 2, c: 3}
in a: Integer => m
  "matched: #{m}"
else
  "not matched"
end
#=> "matched: 1"

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

case [1, 2]
in a, Integer
  "matched: #{a}"
else
  "not matched"
end
#=> "matched: 1"

case {a: 1, b: 2, c: 3}
in a: m
  "matched: #{m}"
else
  "not matched"
end
#=> "matched: 1"

Для образцов хешей существует еще более простой формат: указание только ключа (без под-образца) привязывает локальную переменную к имени ключа тоже:

case {a: 1, b: 2, c: 3}
in a:
  "matched: #{a}"
else
  "not matched"
end
#=> "matched: 1"

Binding работает и для вложенных образцов:

case {name: 'John', friends: [{name: 'Jane'}, {name: 'Rajesh'}]}
in name:, friends: [{name: first_friend}, *]
  "matched: #{first_friend}"
else
  "not matched"
end
#=> "matched: Jane"

Часть «остатка» образца также может быть привязана к переменной:

case [1, 2, 3]
in a, *rest
  "matched: #{a}, #{rest}"
else
  "not matched"
end
#=> "matched: 1, [2, 3]"

case {a: 1, b: 2, c: 3}
in a:, **rest
  "matched: #{a}, #{rest}"
else
  "not matched"
end
#=> "matched: 1, {:b=>2, :c=>3}"

Binding к переменным в настоящее время НЕ работает для альтернативных образцов, соединенных с |:

case {a: 1, b: 2}
in {a: } | Array
  "matched: #{a}"
else
  "not matched"
end
# SyntaxError (illegal variable in alternative pattern (a))

Переменные, начинающиеся с _, — единственное исключение из этого правила:

case {a: 1, b: 2}
in {a: _, b: _foo} | Array
  "matched: #{_}, #{_foo}"
else
  "not matched"
end
# => "matched: 1, 2"

Тем не менее, не рекомендуется повторно использовать связанное значение, поскольку цель этого образца — указать на отброшенное значение.

Фиксация переменных

Из-за возможности привязки переменных существующую локальную переменную нельзя напрямую использовать в качестве под-образца:

expectation = 18

case [1, 2]
in expectation, *rest
  "matched. expectation was: #{expectation}"
else
  "not matched. expectation was: #{expectation}"
end
# expected: "not matched. expectation was: 18"
# real: "matched. expectation was: 1" -- local variable just rewritten

В этом случае можно использовать оператор фиксации ^, чтобы сказать Ruby «просто используйте это значение как часть образца»:

expectation = 18
case [1, 2]
in ^expectation, *rest
  "matched. expectation was: #{expectation}"
else
  "not matched. expectation was: #{expectation}"
end
#=> "not matched. expectation was: 18"

Одно из важных применений фиксации переменных заключается в указании, что одно и то же значение должно встречаться в образце несколько раз:

jane = {school: 'high', schools: [{id: 1, level: 'middle'}, {id: 2, level: 'high'}]}
john = {school: 'high', schools: [{id: 1, level: 'middle'}]}

case jane
in school:, schools: [*, {id:, level: ^school}] # select the last school, level should match
  "matched. school: #{id}"
else
  "not matched"
end
#=> "matched. school: 2"

case john # the specified school level is "high", but last school does not match
in school:, schools: [*, {id:, level: ^school}]
  "matched. school: #{id}"
else
  "not matched"
end
#=> "not matched"

Сопоставление не примитивных объектов: deconstruct и deconstruct_keys

Как уже упоминалось выше, образцы массивов, поиска и хешей, помимо буквальных массивов и хешей, будут пытаться сопоставить любой объект, реализующий deconstruct (для образцов массивов/поиска) или deconstruct_keys (для образцов хешей).

class Point
  def initialize(x, y)
    @x, @y = x, y
  end

  def deconstruct
    puts "deconstruct called"
    [@x, @y]
  end

  def deconstruct_keys(keys)
    puts "deconstruct_keys called with #{keys.inspect}"
    {x: @x, y: @y}
  end
end

case Point.new(1, -2)
in px, Integer  # sub-patterns and variable binding works
  "matched: #{px}"
else
  "not matched"
end
# prints "deconstruct called"
"matched: 1"

case Point.new(1, -2)
in x: 0.. => px
  "matched: #{px}"
else
  "not matched"
end
# prints: deconstruct_keys called with [:x]
#=> "matched: 1"

keys передаются в deconstruct_keys, чтобы предоставить возможность оптимизации в сопоставляемом классе: если вычисление полного представления хеша дорогостоящее, можно вычислить только необходимый подхеш. Когда используется образец **rest, nil передается как значение keys:

case Point.new(1, -2)
in x: 0.. => px, **rest
  "matched: #{px}"
else
  "not matched"
end
# prints: deconstruct_keys called with nil
#=> "matched: 1"

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

class SuperPoint < Point
end

case Point.new(1, -2)
in SuperPoint(x: 0.. => px)
  "matched: #{px}"
else
  "not matched"
end
#=> "not matched"

case SuperPoint.new(1, -2)
in SuperPoint[x: 0.. => px] # [] or () parentheses are allowed
  "matched: #{px}"
else
  "not matched"
end
#=> "matched: 1"

Блоки условий

if может использоваться для добавления дополнительного условия (блока условий) при совпадении с образцом. Это условие может использовать привязанные переменные:

case [1, 2]
in a, b if b == a*2
  "matched"
else
  "not matched"
end
#=> "matched"

case [1, 1]
in a, b if b == a*2
  "matched"
else
  "not matched"
end
#=> "not matched"

unless также работает:

case [1, 1]
in a, b unless b == a*2
  "matched"
else
  "not matched"
end
#=> "matched"

Текущий статус функции

Начиная с Ruby 3.0, однострочные сопоставления с образцом и образцы поиска считаются *экспериментальными*: его синтаксис может измениться в будущем. Каждый раз, когда вы используете эти функции в коде, будет выводиться предупреждение:

[0] => [*, 0, *]
# warning: Find pattern is experimental, and the behavior may change in future versions of Ruby!
# warning: One-line pattern matching is experimental, and the behavior may change in future versions of Ruby!

Чтобы подавить это предупреждение, можно использовать метод Warning::[]=:

Warning[:experimental] = false
eval('[0] => [*, 0, *]')
# ...no warning printed...

Обратите внимание, что предупреждения о сопоставлении с образцом поднимаются на этапе компиляции, поэтому это не подавит предупреждение:

Warning[:experimental] = false # At the time this line is evaluated, the parsing happened and warning emitted
[0] => [*, 0, *]

Таким образом, только загруженные впоследствии файлы или код, обработанный с помощью `eval`, подвержены влиянию переключения флага.

В качестве альтернативы, можно использовать командную строку -W:no-experimental, чтобы отключить предупреждения об «экспериментальных» функциях.

Приложение А. Синтаксис образцов

Приблизительный синтаксис:

pattern: value_pattern
       | variable_pattern
       | alternative_pattern
       | as_pattern
       | array_pattern
       | find_pattern
       | hash_pattern

value_pattern: literal
             | Constant
             | ^variable

variable_pattern: variable

alternative_pattern: pattern | pattern | ...

as_pattern: pattern => variable

array_pattern: [pattern, ..., *variable]
             | Constant(pattern, ..., *variable)
             | Constant[pattern, ..., *variable]

find_pattern: [*variable, pattern, ..., *variable]
            | Constant(*variable, pattern, ..., *variable)
            | Constant[*variable, pattern, ..., *variable]

hash_pattern: {key: pattern, key:, ..., **variable}
            | Constant(key: pattern, key:, ..., **variable)
            | Constant[key: pattern, key:, ..., **variable]

Приложение B. Некоторые примеры неопределенного поведения

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

Использование переменной в несопоставленном образце:

case [0, 1]
in [a, 2]
  "not matched"
in b
  "matched"
in c
  "not matched"
end
a #=> undefined
c #=> undefined

Количество deconstruct, вызовов метода deconstruct_keys:

$i = 0
ary = [0]
def ary.deconstruct
  $i += 1
  self
end
case ary
in [0, 1]
  "not matched"
in [0]
  "matched"
end
$i #=> undefined