class Prism::ConstantReadNode

Represents referencing a constant.

Foo
^^^

Attributes

name[R]

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

X              # name `:X`

SOME_CONSTANT  # name `:SOME_CONSTANT`

Public Class Methods

new(source, name, location) click to toggle source

def initialize: (Symbol name, Location location) -> void

# File lib/prism/node.rb, line 5482
def initialize(source, name, location)
  @source = source
  @newline = false
  @location = location
  @name = name
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 5558
def self.type
  :constant_read_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 lib/prism/node.rb, line 5564
def ===(other)
  other.is_a?(ConstantReadNode) &&
    (name === other.name)
end

accept(visitor) click to toggle source

def accept: (Visitor visitor) -> void

# File lib/prism/node.rb, line 5490
def accept(visitor)
  visitor.visit_constant_read_node(self)
end

child_nodes() click to toggle source

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

# File lib/prism/node.rb, line 5495
def child_nodes
  []
end

Also aliased as: deconstruct

comment_targets() click to toggle source

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

# File lib/prism/node.rb, line 5505
def comment_targets
  [] #: Array[Prism::node | Location]
end

compact_child_nodes() click to toggle source

def compact_child_nodes: () -> Array

# File lib/prism/node.rb, line 5500
def compact_child_nodes
  []
end

copy(name: self.name, location: self.location) click to toggle source

def copy: (?name: Symbol, ?location: Location) -> ConstantReadNode

# File lib/prism/node.rb, line 5510
def copy(name: self.name, location: self.location)
  ConstantReadNode.new(source, name, 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, location: Location }

# File lib/prism/node.rb, line 5518
def deconstruct_keys(keys)
  { name: name, location: location }
end

full_name() click to toggle source

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

# File lib/prism/node_ext.rb, line 107
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 lib/prism/node_ext.rb, line 102
def full_name_parts
  [name]
end

inspect() click to toggle source

def inspect -> String

# File lib/prism/node.rb, line 5530
def inspect
  InspectVisitor.compose(self)
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 5548
def type
  :constant_read_node
end