Class: Prism::LocalVariableOrWriteNode

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

Overview

Represents the use of the ‘||=` operator for assignment to a local variable.

target ||= value
^^^^^^^^^^^^^^^^

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name_loc, operator_loc, value, name, depth, location) ⇒ LocalVariableOrWriteNode

def initialize: (name_loc: Location, operator_loc: Location, value: Node, name: Symbol, depth: Integer, location: Location) -> void



11009
11010
11011
11012
11013
11014
11015
11016
 
# File 'lib/prism/node.rb', line 11009

def initialize(name_loc, operator_loc, value, name, depth, location)
  @name_loc = name_loc
  @operator_loc = operator_loc
  @value = value
  @name = name
  @depth = depth
  @location = location
end

Instance Attribute Details

#depth ⇒ Object (readonly)

attr_reader depth: Integer



11006
11007
11008
 
# File 'lib/prism/node.rb', line 11006

def depth
  @depth
end

#name ⇒ Object (readonly)

attr_reader name: Symbol



11003
11004
11005
 
# File 'lib/prism/node.rb', line 11003

def name
  @name
end

#name_loc ⇒ Object (readonly)

attr_reader name_loc: Location



10994
10995
10996
 
# File 'lib/prism/node.rb', line 10994

def name_loc
  @name_loc
end

#operator_loc ⇒ Object (readonly)

attr_reader operator_loc: Location



10997
10998
10999
 
# File 'lib/prism/node.rb', line 10997

def operator_loc
  @operator_loc
end

#value ⇒ Object (readonly)

attr_reader value: Node



11000
11001
11002
 
# File 'lib/prism/node.rb', line 11000

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



11099
11100
11101
 
# File 'lib/prism/node.rb', line 11099

def self.type
  :local_variable_or_write_node
end

Instance Method Details

#accept(visitor) ⇒ Object

def accept: (visitor: Visitor) -> void



11019
11020
11021
 
# File 'lib/prism/node.rb', line 11019

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

#child_nodes ⇒ Object Also known as: deconstruct

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



11024
11025
11026
 
# File 'lib/prism/node.rb', line 11024

def child_nodes
  [value]
end

#comment_targets ⇒ Object

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



11034
11035
11036
 
# File 'lib/prism/node.rb', line 11034

def comment_targets
  [name_loc, operator_loc, value]
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



11029
11030
11031
 
# File 'lib/prism/node.rb', line 11029

def compact_child_nodes
  [value]
end

#copy(**params) ⇒ Object

def copy: (**params) -> LocalVariableOrWriteNode



11039
11040
11041
11042
11043
11044
11045
11046
11047
11048
 
# File 'lib/prism/node.rb', line 11039

def copy(**params)
  LocalVariableOrWriteNode.new(
    params.fetch(:name_loc) { name_loc },
    params.fetch(:operator_loc) { operator_loc },
    params.fetch(:value) { value },
    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]



11054
11055
11056
 
# File 'lib/prism/node.rb', line 11054

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

#inspect(inspector = NodeInspector.new) ⇒ Object

def inspect(inspector: NodeInspector) -> String



11064
11065
11066
11067
11068
11069
11070
11071
11072
11073
 
# File 'lib/prism/node.rb', line 11064

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

#operator ⇒ Object

def operator: () -> String



11059
11060
11061
 
# File 'lib/prism/node.rb', line 11059

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



11089
11090
11091
 
# File 'lib/prism/node.rb', line 11089

def type
  :local_variable_or_write_node
end