Class: Prism::AlternationPatternNode

Inherits:
PrismNode
  • Object
show all
Defined in:
lib/prism/node.rb,
ext/prism/api_node.c

Overview

Represents an alternation pattern in pattern matching.

foo => bar | baz
       ^^^^^^^^^

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(left, right, operator_loc, location) ⇒ AlternationPatternNode

def initialize: (left: Node, right: Node, operator_loc: Location, location: Location) -> void



273
274
275
276
277
278
 
# File 'lib/prism/node.rb', line 273

def initialize(left, right, operator_loc, location)
  @left = left
  @right = right
  @operator_loc = operator_loc
  @location = location
end

Instance Attribute Details

#left ⇒ Object (readonly)

attr_reader left: Node



264
265
266
 
# File 'lib/prism/node.rb', line 264

def left
  @left
end

#operator_loc ⇒ Object (readonly)

attr_reader operator_loc: Location



270
271
272
 
# File 'lib/prism/node.rb', line 270

def operator_loc
  @operator_loc
end

#right ⇒ Object (readonly)

attr_reader right: Node



267
268
269
 
# File 'lib/prism/node.rb', line 267

def right
  @right
end

Class Method Details

.type ⇒ Object

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



358
359
360
 
# File 'lib/prism/node.rb', line 358

def self.type
  :alternation_pattern_node
end

Instance Method Details

#accept(visitor) ⇒ Object

def accept: (visitor: Visitor) -> void



281
282
283
 
# File 'lib/prism/node.rb', line 281

def accept(visitor)
  visitor.visit_alternation_pattern_node(self)
end

#child_nodes ⇒ Object Also known as: deconstruct

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



286
287
288
 
# File 'lib/prism/node.rb', line 286

def child_nodes
  [left, right]
end

#comment_targets ⇒ Object

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



296
297
298
 
# File 'lib/prism/node.rb', line 296

def comment_targets
  [left, right, operator_loc]
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



291
292
293
 
# File 'lib/prism/node.rb', line 291

def compact_child_nodes
  [left, right]
end

#copy(**params) ⇒ Object

def copy: (**params) -> AlternationPatternNode



301
302
303
304
305
306
307
308
 
# File 'lib/prism/node.rb', line 301

def copy(**params)
  AlternationPatternNode.new(
    params.fetch(:left) { left },
    params.fetch(:right) { right },
    params.fetch(:operator_loc) { operator_loc },
    params.fetch(:location) { location },
  )
end

#deconstruct_keys(keys) ⇒ Object

def deconstruct_keys: (keys: Array) -> Hash[Symbol, nil | Node | Array | String | Token | Array | Location]



314
315
316
 
# File 'lib/prism/node.rb', line 314

def deconstruct_keys(keys)
  { left: left, right: right, operator_loc: operator_loc, location: location }
end

#inspect(inspector = NodeInspector.new) ⇒ Object

def inspect(inspector: NodeInspector) -> String



324
325
326
327
328
329
330
331
332
 
# File 'lib/prism/node.rb', line 324

def inspect(inspector = NodeInspector.new)
  inspector << inspector.header(self)
  inspector << "├── left:\n"
  inspector << inspector.child_node(left, "│   ")
  inspector << "├── right:\n"
  inspector << inspector.child_node(right, "│   ")
  inspector << "└── operator_loc: #{inspector.location(operator_loc)}\n"
  inspector.to_str
end

#operator ⇒ Object

def operator: () -> String



319
320
321
 
# File 'lib/prism/node.rb', line 319

def operator
  operator_loc.slice
end

#type ⇒ Object

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



348
349
350
 
# File 'lib/prism/node.rb', line 348

def type
  :alternation_pattern_node
end