Class: Prism::AliasGlobalVariableNode

Inherits:
PrismNode
  • Object
show all
Defined in:
lib/prism/node.rb,
ext/prism/api_node.c

Overview

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

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(new_name, old_name, keyword_loc, location) ⇒ AliasGlobalVariableNode

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



63
64
65
66
67
68
 
# 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

Instance Attribute Details

#keyword_loc ⇒ Object (readonly)

attr_reader keyword_loc: Location



60
61
62
 
# File 'lib/prism/node.rb', line 60

def keyword_loc
  @keyword_loc
end

#new_name ⇒ Object (readonly)

attr_reader new_name: Node



54
55
56
 
# File 'lib/prism/node.rb', line 54

def new_name
  @new_name
end

#old_name ⇒ Object (readonly)

attr_reader old_name: Node



57
58
59
 
# File 'lib/prism/node.rb', line 57

def old_name
  @old_name
end

Class Method Details

.type ⇒ Object

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



148
149
150
 
# File 'lib/prism/node.rb', line 148

def self.type
  :alias_global_variable_node
end

Instance Method Details

#accept(visitor) ⇒ Object

def accept: (visitor: Visitor) -> void



71
72
73
 
# File 'lib/prism/node.rb', line 71

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

#child_nodes ⇒ Object Also known as: deconstruct

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



76
77
78
 
# File 'lib/prism/node.rb', line 76

def child_nodes
  [new_name, old_name]
end

#comment_targets ⇒ Object

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



86
87
88
 
# File 'lib/prism/node.rb', line 86

def comment_targets
  [new_name, old_name, keyword_loc]
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



81
82
83
 
# File 'lib/prism/node.rb', line 81

def compact_child_nodes
  [new_name, old_name]
end

#copy(**params) ⇒ Object

def copy: (**params) -> AliasGlobalVariableNode



91
92
93
94
95
96
97
98
 
# 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_keys(keys) ⇒ Object

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



104
105
106
 
# 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) ⇒ Object

def inspect(inspector: NodeInspector) -> String



114
115
116
117
118
119
120
121
122
 
# 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 ⇒ Object

def keyword: () -> String



109
110
111
 
# File 'lib/prism/node.rb', line 109

def keyword
  keyword_loc.slice
end

#type ⇒ Object

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



138
139
140
 
# File 'lib/prism/node.rb', line 138

def type
  :alias_global_variable_node
end