Class: Prism::LocalVariableTargetNode

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

Overview

Represents writing to a local variable in a context that doesn’t have an explicit value.

foo, bar = baz
^^^  ^^^

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, depth, location) ⇒ LocalVariableTargetNode

def initialize: (name: Symbol, depth: Integer, location: Location) -> void



9209
9210
9211
9212
9213
 
# File 'lib/prism/node.rb', line 9209

def initialize(name, depth, location)
  @name = name
  @depth = depth
  @location = location
end

Instance Attribute Details

#depth ⇒ Object (readonly)

attr_reader depth: Integer



9206
9207
9208
 
# File 'lib/prism/node.rb', line 9206

def depth
  @depth
end

#name ⇒ Object (readonly)

attr_reader name: Symbol



9203
9204
9205
 
# File 'lib/prism/node.rb', line 9203

def name
  @name
end

Instance Method Details

#accept(visitor) ⇒ Object

def accept: (visitor: Visitor) -> void



9216
9217
9218
 
# File 'lib/prism/node.rb', line 9216

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

#child_nodes ⇒ Object Also known as: deconstruct

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



9221
9222
9223
 
# File 'lib/prism/node.rb', line 9221

def child_nodes
  []
end

#comment_targets ⇒ Object

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



9231
9232
9233
 
# File 'lib/prism/node.rb', line 9231

def comment_targets
  []
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



9226
9227
9228
 
# File 'lib/prism/node.rb', line 9226

def compact_child_nodes
  []
end

#copy(**params) ⇒ Object

def copy: (**params) -> LocalVariableTargetNode



9236
9237
9238
9239
9240
9241
9242
 
# File 'lib/prism/node.rb', line 9236

def copy(**params)
  LocalVariableTargetNode.new(
    params.fetch(:name) { name },
    params.fetch(:depth) { depth },
    params.fetch(:location) { location },
  )
end

#deconstruct_keys(keys) ⇒ Object

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



9248
9249
9250
 
# File 'lib/prism/node.rb', line 9248

def deconstruct_keys(keys)
  { name: name, depth: depth, location: location }
end

#inspect(inspector = NodeInspector.new) ⇒ Object 



9252
9253
9254
9255
9256
9257
 
# File 'lib/prism/node.rb', line 9252

def inspect(inspector = NodeInspector.new)
  inspector << inspector.header(self)
  inspector << "├── name: #{name.inspect}\n"
  inspector << "└── depth: #{depth.inspect}\n"
  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



9273
9274
9275
 
# File 'lib/prism/node.rb', line 9273

def type
  :local_variable_target_node
end