Class: Prism::LocalVariableOperatorWriteNode

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

Overview

Represents assigning to a local variable using an operator that isn’t ‘=`.

target += value
^^^^^^^^^^^^^^^

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

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



10895
10896
10897
10898
10899
10900
10901
10902
10903
 
# File 'lib/prism/node.rb', line 10895

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

Instance Attribute Details

#depth ⇒ Object (readonly)

attr_reader depth: Integer



10892
10893
10894
 
# File 'lib/prism/node.rb', line 10892

def depth
  @depth
end

#name ⇒ Object (readonly)

attr_reader name: Symbol



10886
10887
10888
 
# File 'lib/prism/node.rb', line 10886

def name
  @name
end

#name_loc ⇒ Object (readonly)

attr_reader name_loc: Location



10877
10878
10879
 
# File 'lib/prism/node.rb', line 10877

def name_loc
  @name_loc
end

#operator ⇒ Object (readonly)

attr_reader operator: Symbol



10889
10890
10891
 
# File 'lib/prism/node.rb', line 10889

def operator
  @operator
end

#operator_loc ⇒ Object (readonly)

attr_reader operator_loc: Location



10880
10881
10882
 
# File 'lib/prism/node.rb', line 10880

def operator_loc
  @operator_loc
end

#value ⇒ Object (readonly)

attr_reader value: Node



10883
10884
10885
 
# File 'lib/prism/node.rb', line 10883

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



10983
10984
10985
 
# File 'lib/prism/node.rb', line 10983

def self.type
  :local_variable_operator_write_node
end

Instance Method Details

#accept(visitor) ⇒ Object

def accept: (visitor: Visitor) -> void



10906
10907
10908
 
# File 'lib/prism/node.rb', line 10906

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

#child_nodes ⇒ Object Also known as: deconstruct

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



10911
10912
10913
 
# File 'lib/prism/node.rb', line 10911

def child_nodes
  [value]
end

#comment_targets ⇒ Object

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



10921
10922
10923
 
# File 'lib/prism/node.rb', line 10921

def comment_targets
  [name_loc, operator_loc, value]
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



10916
10917
10918
 
# File 'lib/prism/node.rb', line 10916

def compact_child_nodes
  [value]
end

#copy(**params) ⇒ Object

def copy: (**params) -> LocalVariableOperatorWriteNode



10926
10927
10928
10929
10930
10931
10932
10933
10934
10935
10936
 
# File 'lib/prism/node.rb', line 10926

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



10942
10943
10944
 
# File 'lib/prism/node.rb', line 10942

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

#inspect(inspector = NodeInspector.new) ⇒ Object

def inspect(inspector: NodeInspector) -> String



10947
10948
10949
10950
10951
10952
10953
10954
10955
10956
10957
 
# File 'lib/prism/node.rb', line 10947

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 << "├── operator: #{operator.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



10973
10974
10975
 
# File 'lib/prism/node.rb', line 10973

def type
  :local_variable_operator_write_node
end