Class: Prism::KeywordRestParameterNode

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

Overview

Represents a keyword rest parameter to a method, block, or lambda definition.

def a(**b)
      ^^^
end

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, name_loc, operator_loc, location) ⇒ KeywordRestParameterNode

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



10513
10514
10515
10516
10517
10518
 
# File 'lib/prism/node.rb', line 10513

def initialize(name, name_loc, operator_loc, location)
  @name = name
  @name_loc = name_loc
  @operator_loc = operator_loc
  @location = location
end

Instance Attribute Details

#name ⇒ Object (readonly)

attr_reader name: Symbol?



10504
10505
10506
 
# File 'lib/prism/node.rb', line 10504

def name
  @name
end

#name_loc ⇒ Object (readonly)

attr_reader name_loc: Location?



10507
10508
10509
 
# File 'lib/prism/node.rb', line 10507

def name_loc
  @name_loc
end

#operator_loc ⇒ Object (readonly)

attr_reader operator_loc: Location



10510
10511
10512
 
# File 'lib/prism/node.rb', line 10510

def operator_loc
  @operator_loc
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



10600
10601
10602
 
# File 'lib/prism/node.rb', line 10600

def self.type
  :keyword_rest_parameter_node
end

Instance Method Details

#accept(visitor) ⇒ Object

def accept: (visitor: Visitor) -> void



10521
10522
10523
 
# File 'lib/prism/node.rb', line 10521

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

#child_nodes ⇒ Object Also known as: deconstruct

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



10526
10527
10528
 
# File 'lib/prism/node.rb', line 10526

def child_nodes
  []
end

#comment_targets ⇒ Object

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



10536
10537
10538
 
# File 'lib/prism/node.rb', line 10536

def comment_targets
  [*name_loc, operator_loc]
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



10531
10532
10533
 
# File 'lib/prism/node.rb', line 10531

def compact_child_nodes
  []
end

#copy(**params) ⇒ Object

def copy: (**params) -> KeywordRestParameterNode



10541
10542
10543
10544
10545
10546
10547
10548
 
# File 'lib/prism/node.rb', line 10541

def copy(**params)
  KeywordRestParameterNode.new(
    params.fetch(:name) { name },
    params.fetch(:name_loc) { name_loc },
    params.fetch(:operator_loc) { operator_loc },
    params.fetch(:location) { location },
  )
end

#deconstruct_keys(keys) ⇒ Object

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



10554
10555
10556
 
# File 'lib/prism/node.rb', line 10554

def deconstruct_keys(keys)
  { name: name, name_loc: name_loc, operator_loc: operator_loc, location: location }
end

#inspect(inspector = NodeInspector.new) ⇒ Object

def inspect(inspector: NodeInspector) -> String



10564
10565
10566
10567
10568
10569
10570
10571
10572
10573
10574
 
# File 'lib/prism/node.rb', line 10564

def inspect(inspector = NodeInspector.new)
  inspector << inspector.header(self)
  if (name = self.name).nil?
    inspector << "├── name: ∅\n"
  else
    inspector << "├── name: #{name.inspect}\n"
  end
  inspector << "├── name_loc: #{inspector.location(name_loc)}\n"
  inspector << "└── operator_loc: #{inspector.location(operator_loc)}\n"
  inspector.to_str
end

#operator ⇒ Object

def operator: () -> String



10559
10560
10561
 
# File 'lib/prism/node.rb', line 10559

def operator
  operator_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



10590
10591
10592
 
# File 'lib/prism/node.rb', line 10590

def type
  :keyword_rest_parameter_node
end