Class: Prism::EmbeddedStatementsNode

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

Overview

Represents an interpolated set of statements.

"foo #{bar}"
     ^^^^^^

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(opening_loc, statements, closing_loc, location) ⇒ EmbeddedStatementsNode

def initialize: (opening_loc: Location, statements: StatementsNode?, closing_loc: Location, location: Location) -> void



5690
5691
5692
5693
5694
5695
 
# File 'lib/prism/node.rb', line 5690

def initialize(opening_loc, statements, closing_loc, location)
  @opening_loc = opening_loc
  @statements = statements
  @closing_loc = closing_loc
  @location = location
end

Instance Attribute Details

#closing_loc ⇒ Object (readonly)

attr_reader closing_loc: Location



5687
5688
5689
 
# File 'lib/prism/node.rb', line 5687

def closing_loc
  @closing_loc
end

#opening_loc ⇒ Object (readonly)

attr_reader opening_loc: Location



5681
5682
5683
 
# File 'lib/prism/node.rb', line 5681

def opening_loc
  @opening_loc
end

#statements ⇒ Object (readonly)

attr_reader statements: StatementsNode?



5684
5685
5686
 
# File 'lib/prism/node.rb', line 5684

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



5785
5786
5787
 
# File 'lib/prism/node.rb', line 5785

def self.type
  :embedded_statements_node
end

Instance Method Details

#accept(visitor) ⇒ Object

def accept: (visitor: Visitor) -> void



5698
5699
5700
 
# File 'lib/prism/node.rb', line 5698

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

#child_nodes ⇒ Object Also known as: deconstruct

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



5703
5704
5705
 
# File 'lib/prism/node.rb', line 5703

def child_nodes
  [statements]
end

#closing ⇒ Object

def closing: () -> String



5743
5744
5745
 
# File 'lib/prism/node.rb', line 5743

def closing
  closing_loc.slice
end

#comment_targets ⇒ Object

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



5715
5716
5717
 
# File 'lib/prism/node.rb', line 5715

def comment_targets
  [opening_loc, *statements, closing_loc]
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



5708
5709
5710
5711
5712
 
# File 'lib/prism/node.rb', line 5708

def compact_child_nodes
  compact = []
  compact << statements if statements
  compact
end

#copy(**params) ⇒ Object

def copy: (**params) -> EmbeddedStatementsNode



5720
5721
5722
5723
5724
5725
5726
5727
 
# File 'lib/prism/node.rb', line 5720

def copy(**params)
  EmbeddedStatementsNode.new(
    params.fetch(:opening_loc) { opening_loc },
    params.fetch(:statements) { statements },
    params.fetch(:closing_loc) { closing_loc },
    params.fetch(:location) { location },
  )
end

#deconstruct_keys(keys) ⇒ Object

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



5733
5734
5735
 
# File 'lib/prism/node.rb', line 5733

def deconstruct_keys(keys)
  { opening_loc: opening_loc, statements: statements, closing_loc: closing_loc, location: location }
end

#inspect(inspector = NodeInspector.new) ⇒ Object

def inspect(inspector: NodeInspector) -> String



5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
 
# File 'lib/prism/node.rb', line 5748

def inspect(inspector = NodeInspector.new)
  inspector << inspector.header(self)
  inspector << "├── opening_loc: #{inspector.location(opening_loc)}\n"
  if (statements = self.statements).nil?
    inspector << "├── statements: ∅\n"
  else
    inspector << "├── statements:\n"
    inspector << statements.inspect(inspector.child_inspector("│   ")).delete_prefix(inspector.prefix)
  end
  inspector << "└── closing_loc: #{inspector.location(closing_loc)}\n"
  inspector.to_str
end

#opening ⇒ Object

def opening: () -> String



5738
5739
5740
 
# File 'lib/prism/node.rb', line 5738

def opening
  opening_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



5775
5776
5777
 
# File 'lib/prism/node.rb', line 5775

def type
  :embedded_statements_node
end