Class: Prism::StatementsNode

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

Overview

Represents a set of statements contained within some scope.

foo; bar; baz
^^^^^^^^^^^^^

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(body, location) ⇒ StatementsNode

def initialize: (body: Array, location: Location) -> void



15777
15778
15779
15780
 
# File 'lib/prism/node.rb', line 15777

def initialize(body, location)
  @body = body
  @location = location
end

Instance Attribute Details

#body ⇒ Object (readonly)

attr_reader body: Array



15774
15775
15776
 
# File 'lib/prism/node.rb', line 15774

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



15849
15850
15851
 
# File 'lib/prism/node.rb', line 15849

def self.type
  :statements_node
end

Instance Method Details

#accept(visitor) ⇒ Object

def accept: (visitor: Visitor) -> void



15783
15784
15785
 
# File 'lib/prism/node.rb', line 15783

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

#child_nodes ⇒ Object Also known as: deconstruct

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



15788
15789
15790
 
# File 'lib/prism/node.rb', line 15788

def child_nodes
  [*body]
end

#comment_targets ⇒ Object

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



15798
15799
15800
 
# File 'lib/prism/node.rb', line 15798

def comment_targets
  [*body]
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



15793
15794
15795
 
# File 'lib/prism/node.rb', line 15793

def compact_child_nodes
  [*body]
end

#copy(**params) ⇒ Object

def copy: (**params) -> StatementsNode



15803
15804
15805
15806
15807
15808
 
# File 'lib/prism/node.rb', line 15803

def copy(**params)
  StatementsNode.new(
    params.fetch(:body) { body },
    params.fetch(:location) { location },
  )
end

#deconstruct_keys(keys) ⇒ Object

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



15814
15815
15816
 
# File 'lib/prism/node.rb', line 15814

def deconstruct_keys(keys)
  { body: body, location: location }
end

#inspect(inspector = NodeInspector.new) ⇒ Object

def inspect(inspector: NodeInspector) -> String



15819
15820
15821
15822
15823
 
# File 'lib/prism/node.rb', line 15819

def inspect(inspector = NodeInspector.new)
  inspector << inspector.header(self)
  inspector << "└── body: #{inspector.list("#{inspector.prefix}    ", body)}"
  inspector.to_str
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



15839
15840
15841
 
# File 'lib/prism/node.rb', line 15839

def type
  :statements_node
end