class Prism::ClassVariableWriteNode

Represents writing to a class variable.

@@foo = 1
^^^^^^^^^

Attributes

name[R]

The name of the class variable, which is a ‘@@` followed by an [identifier](github.com/ruby/prism/blob/main/docs/parsing_rules.md#identifiers).

@@abc = 123     # name `@@abc`

@@_test = :test # name `@@_test`
value[R]

The value to assign to the class variable. Can be any node that represents a non-void expression.

@@foo = :bar
        ^^^^

@@_xyz = 123
         ^^^

Public Class Methods

new(source, name, name_loc, value, operator_loc, location) click to toggle source

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

# File lib/prism/node.rb, line 4270
def initialize(source, name, name_loc, value, operator_loc, location)
  @source = source
  @newline = false
  @location = location
  @name = name
  @name_loc = name_loc
  @value = value
  @operator_loc = operator_loc
end
type() click to toggle source

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

# File lib/prism/node.rb, line 4391
def self.type
  :class_variable_write_node
end

Public Instance Methods

accept(visitor) click to toggle source

def accept: (Visitor visitor) -> void

# File lib/prism/node.rb, line 4281
def accept(visitor)
  visitor.visit_class_variable_write_node(self)
end
child_nodes() click to toggle source

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

# File lib/prism/node.rb, line 4286
def child_nodes
  [value]
end
Also aliased as: deconstruct
comment_targets() click to toggle source

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

# File lib/prism/node.rb, line 4296
def comment_targets
  [name_loc, value, operator_loc] #: Array[Prism::node | Location]
end
compact_child_nodes() click to toggle source

def compact_child_nodes: () -> Array

# File lib/prism/node.rb, line 4291
def compact_child_nodes
  [value]
end
copy(name: self.name, name_loc: self.name_loc, value: self.value, operator_loc: self.operator_loc, location: self.location) click to toggle source

def copy: (?name: Symbol, ?name_loc: Location, ?value: Prism::node, ?operator_loc: Location, ?location: Location) -> ClassVariableWriteNode

# File lib/prism/node.rb, line 4301
def copy(name: self.name, name_loc: self.name_loc, value: self.value, operator_loc: self.operator_loc, location: self.location)
  ClassVariableWriteNode.new(source, name, name_loc, value, operator_loc, location)
end
deconstruct()

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

Alias for: child_nodes
deconstruct_keys(keys) click to toggle source

def deconstruct_keys: (Array keys) -> { name: Symbol, name_loc: Location, value: Prism::node, operator_loc: Location, location: Location }

# File lib/prism/node.rb, line 4309
def deconstruct_keys(keys)
  { name: name, name_loc: name_loc, value: value, operator_loc: operator_loc, location: location }
end
inspect(inspector = NodeInspector.new) click to toggle source

def inspect(NodeInspector inspector) -> String

# File lib/prism/node.rb, line 4357
def inspect(inspector = NodeInspector.new)
  inspector << inspector.header(self)
  inspector << "├── name: #{name.inspect}\n"
  inspector << "├── name_loc: #{inspector.location(name_loc)}\n"
  inspector << "├── value:\n"
  inspector << inspector.child_node(value, "│   ")
  inspector << "└── operator_loc: #{inspector.location(operator_loc)}\n"
  inspector.to_str
end
name_loc() click to toggle source

The location of the variable name.

@@foo = :bar
^^^^^
# File lib/prism/node.rb, line 4324
def name_loc
  location = @name_loc
  return location if location.is_a?(Location)
  @name_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end
operator() click to toggle source

def operator: () -> String

# File lib/prism/node.rb, line 4352
def operator
  operator_loc.slice
end
operator_loc() click to toggle source

The location of the ‘=` operator.

@@foo = :bar
      ^
# File lib/prism/node.rb, line 4344
def operator_loc
  location = @operator_loc
  return location if location.is_a?(Location)
  @operator_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end
type() click to toggle source

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

# File lib/prism/node.rb, line 4381
def type
  :class_variable_write_node
end