Class: Prism::GlobalVariableOperatorWriteNode

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

Overview

Represents assigning to a global 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, name_loc, operator_loc, value, operator, location) ⇒ GlobalVariableOperatorWriteNode

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



6979
6980
6981
6982
6983
6984
6985
6986
 
# File 'lib/prism/node.rb', line 6979

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

Instance Attribute Details

#name ⇒ Object (readonly)

attr_reader name: Symbol



6964
6965
6966
 
# File 'lib/prism/node.rb', line 6964

def name
  @name
end

#name_loc ⇒ Object (readonly)

attr_reader name_loc: Location



6967
6968
6969
 
# File 'lib/prism/node.rb', line 6967

def name_loc
  @name_loc
end

#operator ⇒ Object (readonly)

attr_reader operator: Symbol



6976
6977
6978
 
# File 'lib/prism/node.rb', line 6976

def operator
  @operator
end

#operator_loc ⇒ Object (readonly)

attr_reader operator_loc: Location



6970
6971
6972
 
# File 'lib/prism/node.rb', line 6970

def operator_loc
  @operator_loc
end

#value ⇒ Object (readonly)

attr_reader value: Node



6973
6974
6975
 
# File 'lib/prism/node.rb', line 6973

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



7064
7065
7066
 
# File 'lib/prism/node.rb', line 7064

def self.type
  :global_variable_operator_write_node
end

Instance Method Details

#accept(visitor) ⇒ Object

def accept: (visitor: Visitor) -> void



6989
6990
6991
 
# File 'lib/prism/node.rb', line 6989

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

#child_nodes ⇒ Object Also known as: deconstruct

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



6994
6995
6996
 
# File 'lib/prism/node.rb', line 6994

def child_nodes
  [value]
end

#comment_targets ⇒ Object

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



7004
7005
7006
 
# File 'lib/prism/node.rb', line 7004

def comment_targets
  [name_loc, operator_loc, value]
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



6999
7000
7001
 
# File 'lib/prism/node.rb', line 6999

def compact_child_nodes
  [value]
end

#copy(**params) ⇒ Object

def copy: (**params) -> GlobalVariableOperatorWriteNode



7009
7010
7011
7012
7013
7014
7015
7016
7017
7018
 
# File 'lib/prism/node.rb', line 7009

def copy(**params)
  GlobalVariableOperatorWriteNode.new(
    params.fetch(:name) { name },
    params.fetch(:name_loc) { name_loc },
    params.fetch(:operator_loc) { operator_loc },
    params.fetch(:value) { value },
    params.fetch(:operator) { operator },
    params.fetch(:location) { location },
  )
end

#deconstruct_keys(keys) ⇒ Object

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



7024
7025
7026
 
# File 'lib/prism/node.rb', line 7024

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

#inspect(inspector = NodeInspector.new) ⇒ Object

def inspect(inspector: NodeInspector) -> String



7029
7030
7031
7032
7033
7034
7035
7036
7037
7038
 
# File 'lib/prism/node.rb', line 7029

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



7054
7055
7056
 
# File 'lib/prism/node.rb', line 7054

def type
  :global_variable_operator_write_node
end