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(source, node_id, location, flags, new_name, old_name, keyword_loc) ⇒ AliasMethodNode

Initialize a new AliasMethodNode node.



451
452
453
454
455
456
457
458
459
 
# File 'lib/prism/node.rb', line 451

def initialize(source, node_id, location, flags, new_name, old_name, keyword_loc)
  @source = source
  @node_id = node_id
  @location = location
  @flags = flags
  @new_name = new_name
  @old_name = old_name
  @keyword_loc = keyword_loc
end

Instance Attribute Details

#new_name ⇒ Object (readonly)

Represents the new name of the method that will be aliased.

alias foo bar
      ^^^

alias :foo :bar
      ^^^^

alias :"#{foo}" :"#{bar}"
      ^^^^^^^^^



512
513
514
 
# File 'lib/prism/node.rb', line 512

def new_name
  @new_name
end

#old_name ⇒ Object (readonly)

Represents the old name of the method that will be aliased.

alias foo bar
          ^^^

alias :foo :bar
           ^^^^

alias :"#{foo}" :"#{bar}"
                ^^^^^^^^^



524
525
526
 
# File 'lib/prism/node.rb', line 524

def old_name
  @old_name
end

Class Method Details

.type ⇒ Object

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



558
559
560
 
# File 'lib/prism/node.rb', line 558

def self.type
  :alias_method_node
end

Instance Method Details

#===(other) ⇒ Object

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



564
565
566
567
568
569
 
# File 'lib/prism/node.rb', line 564

def ===(other)
  other.is_a?(AliasMethodNode) &&
    (new_name === other.new_name) &&
    (old_name === other.old_name) &&
    (keyword_loc.nil? == other.keyword_loc.nil?)
end

#accept(visitor) ⇒ Object

def accept: (Visitor visitor) -> void



462
463
464
 
# File 'lib/prism/node.rb', line 462

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

#child_nodes ⇒ Object Also known as: deconstruct

def child_nodes: () -> Array



467
468
469
 
# File 'lib/prism/node.rb', line 467

def child_nodes
  [new_name, old_name]
end

#comment_targets ⇒ Object

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



485
486
487
 
# File 'lib/prism/node.rb', line 485

def comment_targets
  [new_name, old_name, keyword_loc] #: Array[Prism::node | Location]
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



480
481
482
 
# File 'lib/prism/node.rb', line 480

def compact_child_nodes
  [new_name, old_name]
end

#copy(node_id: self.node_id, location: self.location, flags: self.flags, new_name: self.new_name, old_name: self.old_name, keyword_loc: self.keyword_loc) ⇒ Object

def copy: (?node_id: Integer, ?location: Location, ?flags: Integer, ?new_name: SymbolNode | InterpolatedSymbolNode, ?old_name: SymbolNode | InterpolatedSymbolNode | GlobalVariableReadNode | MissingNode, ?keyword_loc: Location) -> AliasMethodNode



490
491
492
 
# File 'lib/prism/node.rb', line 490

def copy(node_id: self.node_id, location: self.location, flags: self.flags, new_name: self.new_name, old_name: self.old_name, keyword_loc: self.keyword_loc)
  AliasMethodNode.new(source, node_id, location, flags, new_name, old_name, keyword_loc)
end

#deconstruct_keys(keys) ⇒ Object

def deconstruct_keys: (Array keys) -> { node_id: Integer, location: Location, new_name: SymbolNode | InterpolatedSymbolNode, old_name: SymbolNode | InterpolatedSymbolNode | GlobalVariableReadNode | MissingNode, keyword_loc: Location }



498
499
500
 
# File 'lib/prism/node.rb', line 498

def deconstruct_keys(keys)
  { node_id: node_id, location: location, new_name: new_name, old_name: old_name, keyword_loc: keyword_loc }
end

#each_child_node {|new_name| ... } ⇒ Object

def each_child_node: () { (Prism::node) -> void } -> void | () -> Enumerator

Yields:



472
473
474
475
476
477
 
# File 'lib/prism/node.rb', line 472

def each_child_node
  return to_enum(:each_child_node) unless block_given?

  yield new_name
  yield old_name
end

#inspect ⇒ Object

def inspect -> String



548
549
550
 
# File 'lib/prism/node.rb', line 548

def inspect
  InspectVisitor.compose(self)
end

#keyword ⇒ Object

def keyword: () -> String



543
544
545
 
# File 'lib/prism/node.rb', line 543

def keyword
  keyword_loc.slice
end

#keyword_loc ⇒ Object

Represents the location of the alias keyword.

alias foo bar
^^^^^



530
531
532
533
534
 
# File 'lib/prism/node.rb', line 530

def keyword_loc
  location = @keyword_loc
  return location if location.is_a?(Location)
  @keyword_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end

#save_keyword_loc(repository) ⇒ Object

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



538
539
540
 
# File 'lib/prism/node.rb', line 538

def save_keyword_loc(repository)
  repository.enter(node_id, :keyword_loc)
end

#type ⇒ Object

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



553
554
555
 
# File 'lib/prism/node.rb', line 553

def type
  :alias_method_node
end