class Prism::FindPatternNode

Represents a find pattern in pattern matching.

foo in *bar, baz, *qux
       ^^^^^^^^^^^^^^^

foo in [*bar, baz, *qux]
       ^^^^^^^^^^^^^^^^^

foo in Foo(*bar, baz, *qux)
       ^^^^^^^^^^^^^^^^^^^^

Attributes

closing_loc[R]

attr_reader closing_loc: Location?

constant[R]

attr_reader constant: Node?

left[R]

attr_reader left: Node

opening_loc[R]

attr_reader opening_loc: Location?

requireds[R]

attr_reader requireds: Array

right[R]

attr_reader right: Node

Public Class Methods

new(constant, left, requireds, right, opening_loc, closing_loc, location) click to toggle source

def initialize: (constant: Node?, left: Node, requireds: Array, right: Node, opening_loc: Location?, closing_loc: Location?, location: Location) -> void

# File lib/prism/node.rb, line 6117
def initialize(constant, left, requireds, right, opening_loc, closing_loc, location)
  @constant = constant
  @left = left
  @requireds = requireds
  @right = right
  @opening_loc = opening_loc
  @closing_loc = closing_loc
  @location = location
end

type() click to toggle source

Similar to type, this method returns a symbol that you can use for splitting on the type of the node without having to do a long === chain. Note that like type, it will still be slower than using == for a single class, but should be faster in a case statement or an array comparison.

def self.type: () -> Symbol

# File lib/prism/node.rb, line 6226
def self.type
  :find_pattern_node
end

Public Instance Methods

accept(visitor) click to toggle source

def accept: (visitor: Visitor) -> void

# File lib/prism/node.rb, line 6128
def accept(visitor)
  visitor.visit_find_pattern_node(self)
end

child_nodes() click to toggle source

def child_nodes: () -> Array[nil | Node]

# File lib/prism/node.rb, line 6133
def child_nodes
  [constant, left, *requireds, right]
end

Also aliased as: deconstruct

closing() click to toggle source

def closing: () -> String?

# File lib/prism/node.rb, line 6179
def closing
  closing_loc&.slice
end

comment_targets() click to toggle source

def comment_targets: () -> Array[Node | Location]

# File lib/prism/node.rb, line 6148
def comment_targets
  [*constant, left, *requireds, right, *opening_loc, *closing_loc]
end

compact_child_nodes() click to toggle source

def compact_child_nodes: () -> Array

# File lib/prism/node.rb, line 6138
def compact_child_nodes
  compact = []
  compact << constant if constant
  compact << left
  compact.concat(requireds)
  compact << right
  compact
end

copy(**params) click to toggle source

def copy: (**params) -> FindPatternNode

# File lib/prism/node.rb, line 6153
def copy(**params)
  FindPatternNode.new(
    params.fetch(:constant) { constant },
    params.fetch(:left) { left },
    params.fetch(:requireds) { requireds },
    params.fetch(:right) { right },
    params.fetch(:opening_loc) { opening_loc },
    params.fetch(:closing_loc) { closing_loc },
    params.fetch(:location) { location },
  )
end

deconstruct()

def deconstruct: () -> Array[nil | Node]

Alias for: child_nodes

deconstruct_keys(keys) click to toggle source

# File lib/prism/node.rb, line 6169
def deconstruct_keys(keys)
  { constant: constant, left: left, requireds: requireds, right: right, opening_loc: opening_loc, closing_loc: closing_loc, location: location }
end

inspect(inspector = NodeInspector.new) click to toggle source

def inspect(inspector: NodeInspector) -> String

# File lib/prism/node.rb, line 6184
def inspect(inspector = NodeInspector.new)
  inspector << inspector.header(self)
  if (constant = self.constant).nil?
    inspector << "├── constant: ∅\n"
  else
    inspector << "├── constant:\n"
    inspector << constant.inspect(inspector.child_inspector("│   ")).delete_prefix(inspector.prefix)
  end
  inspector << "├── left:\n"
  inspector << inspector.child_node(left, "│   ")
  inspector << "├── requireds: #{inspector.list("#{inspector.prefix}│   ", requireds)}"
  inspector << "├── right:\n"
  inspector << inspector.child_node(right, "│   ")
  inspector << "├── opening_loc: #{inspector.location(opening_loc)}\n"
  inspector << "└── closing_loc: #{inspector.location(closing_loc)}\n"
  inspector.to_str
end

opening() click to toggle source

def opening: () -> String?

# File lib/prism/node.rb, line 6174
def opening
  opening_loc&.slice
end

type() click to toggle source

Sometimes you want to check an instance of a node against a list of classes to see what kind of behavior to perform. Usually this is done by calling ‘[cls1, cls2].include?(node.class)` or putting the node into a case statement and doing `case node; when cls1; when cls2; end`. Both of these approaches are relatively slow because of the constant lookups, method calls, and/or array allocations.

Instead, you can call type, which will return to you a symbol that you can use for comparison. This is faster than the other approaches because it uses a single integer comparison, but also because if you’re on CRuby you can take advantage of the fact that case statements with all symbol keys will use a jump table.

def type: () -> Symbol

# File lib/prism/node.rb, line 6216
def type
  :find_pattern_node
end