class Prism::ConstantWriteNode

Represents writing to a constant.

Foo = 1
^^^^^^^

Attributes

name[R]

The name of the [constant](github.com/ruby/prism/blob/main/docs/parsing_rules.md#constants).

Foo = :bar # name `:Foo`

XYZ = 1    # name `:XYZ`

value[R]

The value to write to the constant. It can be any [non-void expression](github.com/ruby/prism/blob/main/docs/parsing_rules.md#non-void-expression).

FOO = :bar
      ^^^^

MyClass = Class.new
          ^^^^^^^^^

Public Class Methods

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

Initialize a new ConstantWriteNode node.

# File prism/node.rb, line 5758
def initialize(source, node_id, location, flags, name, name_loc, value, operator_loc)
  @source = source
  @node_id = node_id
  @location = location
  @flags = flags
  @name = name
  @name_loc = name_loc
  @value = value
  @operator_loc = operator_loc
end

type() click to toggle source

Return a symbol representation of this node type. See ‘Node::type`.

# File prism/node.rb, line 5866
def self.type
  :constant_write_node
end

Public Instance Methods

===(other) click to toggle source

Implements case-equality for the node. This is effectively == but without comparing the value of locations. Locations are checked only for presence.

# File prism/node.rb, line 5872
def ===(other)
  other.is_a?(ConstantWriteNode) &&
    (name === other.name) &&
    (name_loc.nil? == other.name_loc.nil?) &&
    (value === other.value) &&
    (operator_loc.nil? == other.operator_loc.nil?)
end

accept(visitor) click to toggle source

def accept: (Visitor visitor) -> void

# File prism/node.rb, line 5770
def accept(visitor)
  visitor.visit_constant_write_node(self)
end

child_nodes() click to toggle source

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

# File prism/node.rb, line 5775
def child_nodes
  [value]
end

Also aliased as: deconstruct

comment_targets() click to toggle source

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

# File prism/node.rb, line 5785
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 prism/node.rb, line 5780
def compact_child_nodes
  [value]
end

copy(node_id: self.node_id, location: self.location, flags: self.flags, name: self.name, name_loc: self.name_loc, value: self.value, operator_loc: self.operator_loc) click to toggle source

def copy: (?node_id: Integer, ?location: Location, ?flags: Integer, ?name: Symbol, ?name_loc: Location, ?value: Prism::node, ?operator_loc: Location) -> ConstantWriteNode

# File prism/node.rb, line 5790
def copy(node_id: self.node_id, location: self.location, flags: self.flags, name: self.name, name_loc: self.name_loc, value: self.value, operator_loc: self.operator_loc)
  ConstantWriteNode.new(source, node_id, location, flags, name, name_loc, value, operator_loc)
end

deconstruct()

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

Alias for: child_nodes

deconstruct_keys(keys) click to toggle source

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

# File prism/node.rb, line 5798
def deconstruct_keys(keys)
  { node_id: node_id, location: location, name: name, name_loc: name_loc, value: value, operator_loc: operator_loc }
end

full_name() click to toggle source

Returns the full name of this constant. For example: “Foo”

# File prism/node_ext.rb, line 152
def full_name
  name.to_s
end

full_name_parts() click to toggle source

Returns the list of parts for the full name of this constant. For example: [:Foo]

# File prism/node_ext.rb, line 147
def full_name_parts
  [name]
end

inspect() click to toggle source

def inspect -> String

# File prism/node.rb, line 5856
def inspect
  InspectVisitor.compose(self)
end

name_loc() click to toggle source

The location of the constant name.

FOO = 1
^^^

# File prism/node.rb, line 5813
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 prism/node.rb, line 5851
def operator
  operator_loc.slice
end

operator_loc() click to toggle source

The location of the ‘=` operator.

FOO = :bar
    ^

# File prism/node.rb, line 5838
def operator_loc
  location = @operator_loc
  return location if location.is_a?(Location)
  @operator_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end

save_name_loc(repository) click to toggle source

Save the name_loc location using the given saved source so that it can be retrieved later.

# File prism/node.rb, line 5821
def save_name_loc(repository)
  repository.enter(node_id, :name_loc)
end

save_operator_loc(repository) click to toggle source

Save the operator_loc location using the given saved source so that it can be retrieved later.

# File prism/node.rb, line 5846
def save_operator_loc(repository)
  repository.enter(node_id, :operator_loc)
end

type() click to toggle source

Return a symbol representation of this node type. See ‘Node#type`.

# File prism/node.rb, line 5861
def type
  :constant_write_node
end