Class: Prism::InterpolatedStringNode

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

Overview

Represents a string literal that contains interpolation.

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(opening_loc, parts, closing_loc, location) ⇒ InterpolatedStringNode

def initialize: (opening_loc: Location?, parts: Array, closing_loc: Location?, location: Location) -> void



10075
10076
10077
10078
10079
10080
 
# File 'lib/prism/node.rb', line 10075

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

Instance Attribute Details

#closing_loc ⇒ Object (readonly)

attr_reader closing_loc: Location?



10072
10073
10074
 
# File 'lib/prism/node.rb', line 10072

def closing_loc
  @closing_loc
end

#opening_loc ⇒ Object (readonly)

attr_reader opening_loc: Location?



10066
10067
10068
 
# File 'lib/prism/node.rb', line 10066

def opening_loc
  @opening_loc
end

#parts ⇒ Object (readonly)

attr_reader parts: Array



10069
10070
10071
 
# File 'lib/prism/node.rb', line 10069

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



10168
10169
10170
 
# File 'lib/prism/node.rb', line 10168

def self.type
  :interpolated_string_node
end

Instance Method Details

#accept(visitor) ⇒ Object

def accept: (visitor: Visitor) -> void



10083
10084
10085
 
# File 'lib/prism/node.rb', line 10083

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

#child_nodes ⇒ Object Also known as: deconstruct

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



10093
10094
10095
 
# File 'lib/prism/node.rb', line 10093

def child_nodes
  [*parts]
end

#closing ⇒ Object

def closing: () -> String?



10131
10132
10133
 
# File 'lib/prism/node.rb', line 10131

def closing
  closing_loc&.slice
end

#comment_targets ⇒ Object

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



10103
10104
10105
 
# File 'lib/prism/node.rb', line 10103

def comment_targets
  [*opening_loc, *parts, *closing_loc]
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



10098
10099
10100
 
# File 'lib/prism/node.rb', line 10098

def compact_child_nodes
  [*parts]
end

#copy(**params) ⇒ Object

def copy: (**params) -> InterpolatedStringNode



10108
10109
10110
10111
10112
10113
10114
10115
 
# File 'lib/prism/node.rb', line 10108

def copy(**params)
  InterpolatedStringNode.new(
    params.fetch(:opening_loc) { opening_loc },
    params.fetch(:parts) { parts },
    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]



10121
10122
10123
 
# File 'lib/prism/node.rb', line 10121

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

#inspect(inspector = NodeInspector.new) ⇒ Object

def inspect(inspector: NodeInspector) -> String



10136
10137
10138
10139
10140
10141
10142
 
# File 'lib/prism/node.rb', line 10136

def inspect(inspector = NodeInspector.new)
  inspector << inspector.header(self)
  inspector << "├── opening_loc: #{inspector.location(opening_loc)}\n"
  inspector << "├── parts: #{inspector.list("#{inspector.prefix}│   ", parts)}"
  inspector << "└── closing_loc: #{inspector.location(closing_loc)}\n"
  inspector.to_str
end

#opening ⇒ Object

def opening: () -> String?



10126
10127
10128
 
# File 'lib/prism/node.rb', line 10126

def opening
  opening_loc&.slice
end

#set_newline_flag(newline_marked) ⇒ Object

:nodoc:



10087
10088
10089
10090
 
# File 'lib/prism/node.rb', line 10087

def set_newline_flag(newline_marked) # :nodoc:
  first = parts.first
  first.set_newline_flag(newline_marked) if first
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



10158
10159
10160
 
# File 'lib/prism/node.rb', line 10158

def type
  :interpolated_string_node
end