Class: Prism::MatchRequiredNode

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

Overview

Represents the use of the ‘=>` operator.

foo => bar
^^^^^^^^^^

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

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



11709
11710
11711
11712
11713
11714
 
# File 'lib/prism/node.rb', line 11709

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



11706
11707
11708
 
# File 'lib/prism/node.rb', line 11706

def operator_loc
  @operator_loc
end

#pattern ⇒ Object (readonly)

attr_reader pattern: Node



11703
11704
11705
 
# File 'lib/prism/node.rb', line 11703

def pattern
  @pattern
end

#value ⇒ Object (readonly)

attr_reader value: Node



11700
11701
11702
 
# File 'lib/prism/node.rb', line 11700

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



11794
11795
11796
 
# File 'lib/prism/node.rb', line 11794

def self.type
  :match_required_node
end

Instance Method Details

#accept(visitor) ⇒ Object

def accept: (visitor: Visitor) -> void



11717
11718
11719
 
# File 'lib/prism/node.rb', line 11717

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

#child_nodes ⇒ Object Also known as: deconstruct

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



11722
11723
11724
 
# File 'lib/prism/node.rb', line 11722

def child_nodes
  [value, pattern]
end

#comment_targets ⇒ Object

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



11732
11733
11734
 
# File 'lib/prism/node.rb', line 11732

def comment_targets
  [value, pattern, operator_loc]
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



11727
11728
11729
 
# File 'lib/prism/node.rb', line 11727

def compact_child_nodes
  [value, pattern]
end

#copy(**params) ⇒ Object

def copy: (**params) -> MatchRequiredNode



11737
11738
11739
11740
11741
11742
11743
11744
 
# File 'lib/prism/node.rb', line 11737

def copy(**params)
  MatchRequiredNode.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]



11750
11751
11752
 
# File 'lib/prism/node.rb', line 11750

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



11760
11761
11762
11763
11764
11765
11766
11767
11768
 
# File 'lib/prism/node.rb', line 11760

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



11755
11756
11757
 
# File 'lib/prism/node.rb', line 11755

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



11784
11785
11786
 
# File 'lib/prism/node.rb', line 11784

def type
  :match_required_node
end