123456789_123456789_123456789_123456789_123456789_

Class: Prism::ClassVariableOperatorWriteNode

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, Node
Instance Chain:
self, Node
Inherits: Prism::Node
  • Object
Defined in: lib/prism/node.rb,
lib/prism/desugar_compiler.rb,
lib/prism/node_ext.rb

Overview

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

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

Class Method Summary

Instance Attribute Summary

  • #name readonly

    attr_reader name: Symbol.

  • #name_loc readonly

    attr_reader name_loc: Location.

  • #operator readonly

    Returns the binary operator used to modify the receiver.

  • #operator_loc readonly

    Returns the location of the binary operator used to modify the receiver.

  • #value readonly

    attr_reader value: Node.

Node - Inherited

#location

A Location instance that represents the location of this node in the source.
#newline?

See additional method definition at file lib/prism/node.rb line 16.

Instance Method Summary

Node - Inherited

#pretty_print

Similar to inspect, but respects the current level of indentation given by the pretty print object.
#slice

Slice the location of the node from the source.
#to_dot

Convert this node into a graphviz dot graph string.
#deprecated, #newline!, #set_newline_flag

Constructor Details

.new(name, name_loc, operator_loc, value, operator, location) ⇒ ClassVariableOperatorWriteNode

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

[ GitHub ] 

  


# File 'lib/prism/node.rb', line 3486



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


  







Class Method Details



  

    .type  
  



  

    

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


  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 3571



def self.type
  :class_variable_operator_write_node
end


  







Instance Attribute Details



  

    #name   (readonly)
  



  

    

attr_reader name: Symbol


  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 3471



attr_reader :name


  








  

    #name_loc   (readonly)
  



  

    

attr_reader name_loc: Location


  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 3474



attr_reader :name_loc


  








  

    #operator   (readonly)
  



  

    

Returns the binary operator used to modify the receiver. This method is deprecated in favor of #binary_operator.


  



  [ GitHub ]


  

  


# File 'lib/prism/node_ext.rb', line 323



attr_reader :operator


  








  

    #operator_loc   (readonly)
  



  

    

Returns the location of the binary operator used to modify the receiver. This method is deprecated in favor of #binary_operator_loc.


  



  [ GitHub ]


  

  


# File 'lib/prism/node_ext.rb', line 330



attr_reader :operator_loc


  








  

    #value   (readonly)
  



  

    

attr_reader value: Node


  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 3480



attr_reader :value


  







Instance Method Details



  

    #accept(visitor)  
  



  

    

def accept: (visitor: Visitor) -> void


  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 3496



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


  








  

    #child_nodes  
    Also known as: #deconstruct
  



  

    

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


  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 3501



def child_nodes
  [value]
end


  








  

    #comment_targets  
  



  

    

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


  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 3511



def comment_targets
  [name_loc, operator_loc, value]
end


  








  

    #compact_child_nodes  
  



  

    

def compact_child_nodes: () -> Array


  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 3506



def compact_child_nodes
  [value]
end


  








  

    #copy(**params)  
  



  

    

def copy: (**params) -> ClassVariableOperatorWriteNode


  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 3516



def copy(**params)
  ClassVariableOperatorWriteNode.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  
  



  

    

Alias for #child_nodes.


  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 3528



alias deconstruct child_nodes


  








  

    #deconstruct_keys(keys)  
  



  

    

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


  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 3531



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


  








  

    #desugar  
  

  

    This method is for internal use only.
  

  [ GitHub ]


  

  


# File 'lib/prism/desugar_compiler.rb', line 139



def desugar # :nodoc:
  DesugarOperatorWriteNode.new(self, source, ClassVariableReadNode, ClassVariableWriteNode, name).compile
end


  








  

    #inspect(inspector = NodeInspector.new)  
  



  

    

def inspect(inspector: NodeInspector) -> String


  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 3536



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  
  



  

    

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


  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 3561



def type
  :class_variable_operator_write_node
end