Class: Prism::AliasMethodNode

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 method.

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) ⇒ AliasMethodNode

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



168
169
170
171
172
173
 
# File 'lib/prism/node.rb', line 168

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



165
166
167
 
# File 'lib/prism/node.rb', line 165

def keyword_loc
  @keyword_loc
end

#new_name ⇒ Object (readonly)

attr_reader new_name: Node



159
160
161
 
# File 'lib/prism/node.rb', line 159

def new_name
  @new_name
end

#old_name ⇒ Object (readonly)

attr_reader old_name: Node



162
163
164
 
# File 'lib/prism/node.rb', line 162

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



253
254
255
 
# File 'lib/prism/node.rb', line 253

def self.type
  :alias_method_node
end

Instance Method Details

#accept(visitor) ⇒ Object

def accept: (visitor: Visitor) -> void



176
177
178
 
# File 'lib/prism/node.rb', line 176

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

#child_nodes ⇒ Object Also known as: deconstruct

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



181
182
183
 
# File 'lib/prism/node.rb', line 181

def child_nodes
  [new_name, old_name]
end

#comment_targets ⇒ Object

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



191
192
193
 
# File 'lib/prism/node.rb', line 191

def comment_targets
  [new_name, old_name, keyword_loc]
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



186
187
188
 
# File 'lib/prism/node.rb', line 186

def compact_child_nodes
  [new_name, old_name]
end

#copy(**params) ⇒ Object

def copy: (**params) -> AliasMethodNode



196
197
198
199
200
201
202
203
 
# File 'lib/prism/node.rb', line 196

def copy(**params)
  AliasMethodNode.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]



209
210
211
 
# File 'lib/prism/node.rb', line 209

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



219
220
221
222
223
224
225
226
227
 
# File 'lib/prism/node.rb', line 219

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



214
215
216
 
# File 'lib/prism/node.rb', line 214

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



243
244
245
 
# File 'lib/prism/node.rb', line 243

def type
  :alias_method_node
end