Class: Prism::MatchPredicateNode

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

Overview

Represents the use of the modifier ‘in` operator.

foo in bar
^^^^^^^^^^

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(value, pattern, operator_loc, location) ⇒ MatchPredicateNode

def initialize: (value: Node, pattern: Node, operator_loc: Location, location: Location) -> void



11604
11605
11606
11607
11608
11609
 
# File 'lib/prism/node.rb', line 11604

def initialize(value, pattern, operator_loc, location)
  @value = value
  @pattern = pattern
  @operator_loc = operator_loc
  @location = location
end

Instance Attribute Details

#operator_loc ⇒ Object (readonly)

attr_reader operator_loc: Location



11601
11602
11603
 
# File 'lib/prism/node.rb', line 11601

def operator_loc
  @operator_loc
end

#pattern ⇒ Object (readonly)

attr_reader pattern: Node



11598
11599
11600
 
# File 'lib/prism/node.rb', line 11598

def pattern
  @pattern
end

#value ⇒ Object (readonly)

attr_reader value: Node



11595
11596
11597
 
# File 'lib/prism/node.rb', line 11595

def value
  @value
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



11689
11690
11691
 
# File 'lib/prism/node.rb', line 11689

def self.type
  :match_predicate_node
end

Instance Method Details

#accept(visitor) ⇒ Object

def accept: (visitor: Visitor) -> void



11612
11613
11614
 
# File 'lib/prism/node.rb', line 11612

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

#child_nodes ⇒ Object Also known as: deconstruct

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



11617
11618
11619
 
# File 'lib/prism/node.rb', line 11617

def child_nodes
  [value, pattern]
end

#comment_targets ⇒ Object

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



11627
11628
11629
 
# File 'lib/prism/node.rb', line 11627

def comment_targets
  [value, pattern, operator_loc]
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



11622
11623
11624
 
# File 'lib/prism/node.rb', line 11622

def compact_child_nodes
  [value, pattern]
end

#copy(**params) ⇒ Object

def copy: (**params) -> MatchPredicateNode



11632
11633
11634
11635
11636
11637
11638
11639
 
# File 'lib/prism/node.rb', line 11632

def copy(**params)
  MatchPredicateNode.new(
    params.fetch(:value) { value },
    params.fetch(:pattern) { pattern },
    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]



11645
11646
11647
 
# File 'lib/prism/node.rb', line 11645

def deconstruct_keys(keys)
  { value: value, pattern: pattern, operator_loc: operator_loc, location: location }
end

#inspect(inspector = NodeInspector.new) ⇒ Object

def inspect(inspector: NodeInspector) -> String



11655
11656
11657
11658
11659
11660
11661
11662
11663
 
# File 'lib/prism/node.rb', line 11655

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

#operator ⇒ Object

def operator: () -> String



11650
11651
11652
 
# File 'lib/prism/node.rb', line 11650

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



11679
11680
11681
 
# File 'lib/prism/node.rb', line 11679

def type
  :match_predicate_node
end