class Prism::AliasGlobalVariableNode

Represents the use of the ‘alias` keyword to alias a global variable.

alias $foo $bar
^^^^^^^^^^^^^^^

Attributes

keyword_loc[R]

attr_reader keyword_loc: Location

new_name[R]

attr_reader new_name: Node

old_name[R]

attr_reader old_name: Node

Public Class Methods

new(new_name, old_name, keyword_loc, location) click to toggle source

def initialize: (new_name: Node, old_name: Node, keyword_loc: Location, location: Location) -> void

# File lib/prism/node.rb, line 63
def initialize(new_name, old_name, keyword_loc, location)
  @new_name = new_name
  @old_name = old_name
  @keyword_loc = keyword_loc
  @location = location
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 148
def self.type
  :alias_global_variable_node
end

Public Instance Methods

accept(visitor) click to toggle source

def accept: (visitor: Visitor) -> void

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

child_nodes() click to toggle source

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

# File lib/prism/node.rb, line 76
def child_nodes
  [new_name, old_name]
end

Also aliased as: deconstruct

comment_targets() click to toggle source

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

# File lib/prism/node.rb, line 86
def comment_targets
  [new_name, old_name, keyword_loc]
end

compact_child_nodes() click to toggle source

def compact_child_nodes: () -> Array

# File lib/prism/node.rb, line 81
def compact_child_nodes
  [new_name, old_name]
end

copy(**params) click to toggle source

def copy: (**params) -> AliasGlobalVariableNode

# File lib/prism/node.rb, line 91
def copy(**params)
  AliasGlobalVariableNode.new(
    params.fetch(:new_name) { new_name },
    params.fetch(:old_name) { old_name },
    params.fetch(:keyword_loc) { keyword_loc },
    params.fetch(:location) { location },
  )
end

deconstruct()

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

Alias for: child_nodes

deconstruct_keys(keys) click to toggle source

# File lib/prism/node.rb, line 104
def deconstruct_keys(keys)
  { new_name: new_name, old_name: old_name, keyword_loc: keyword_loc, location: location }
end

inspect(inspector = NodeInspector.new) click to toggle source

def inspect(inspector: NodeInspector) -> String

# File lib/prism/node.rb, line 114
def inspect(inspector = NodeInspector.new)
  inspector << inspector.header(self)
  inspector << "├── new_name:\n"
  inspector << inspector.child_node(new_name, "│   ")
  inspector << "├── old_name:\n"
  inspector << inspector.child_node(old_name, "│   ")
  inspector << "└── keyword_loc: #{inspector.location(keyword_loc)}\n"
  inspector.to_str
end

keyword() click to toggle source

def keyword: () -> String

# File lib/prism/node.rb, line 109
def keyword
  keyword_loc.slice
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 138
def type
  :alias_global_variable_node
end