Class: Prism::EmbeddedVariableNode

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

Overview

Represents an interpolated variable.

"foo #@bar"
     ^^^^^

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(operator_loc, variable, location) ⇒ EmbeddedVariableNode

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



5044
5045
5046
5047
5048
 
# File 'lib/prism/node.rb', line 5044

def initialize(operator_loc, variable, location)
  @operator_loc = operator_loc
  @variable = variable
  @location = location
end

Instance Attribute Details

#operator_loc ⇒ Object (readonly)

attr_reader operator_loc: Location



5038
5039
5040
 
# File 'lib/prism/node.rb', line 5038

def operator_loc
  @operator_loc
end

#variable ⇒ Object (readonly)

attr_reader variable: Node



5041
5042
5043
 
# File 'lib/prism/node.rb', line 5041

def variable
  @variable
end

Instance Method Details

#accept(visitor) ⇒ Object

def accept: (visitor: Visitor) -> void



5051
5052
5053
 
# File 'lib/prism/node.rb', line 5051

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

#child_nodes ⇒ Object Also known as: deconstruct

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



5056
5057
5058
 
# File 'lib/prism/node.rb', line 5056

def child_nodes
  [variable]
end

#comment_targets ⇒ Object

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



5066
5067
5068
 
# File 'lib/prism/node.rb', line 5066

def comment_targets
  [operator_loc, variable]
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



5061
5062
5063
 
# File 'lib/prism/node.rb', line 5061

def compact_child_nodes
  [variable]
end

#copy(**params) ⇒ Object

def copy: (**params) -> EmbeddedVariableNode



5071
5072
5073
5074
5075
5076
5077
 
# File 'lib/prism/node.rb', line 5071

def copy(**params)
  EmbeddedVariableNode.new(
    params.fetch(:operator_loc) { operator_loc },
    params.fetch(:variable) { variable },
    params.fetch(:location) { location },
  )
end

#deconstruct_keys(keys) ⇒ Object

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



5083
5084
5085
 
# File 'lib/prism/node.rb', line 5083

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

#inspect(inspector = NodeInspector.new) ⇒ Object 



5092
5093
5094
5095
5096
5097
5098
 
# File 'lib/prism/node.rb', line 5092

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

#operator ⇒ Object

def operator: () -> String



5088
5089
5090
 
# File 'lib/prism/node.rb', line 5088

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



5114
5115
5116
 
# File 'lib/prism/node.rb', line 5114

def type
  :embedded_variable_node
end