Class: Prism::ArgumentsNode

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

Overview

Represents a set of arguments to a method or a keyword.

return foo, bar, baz
       ^^^^^^^^^^^^^

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(arguments, location) ⇒ ArgumentsNode

def initialize: (arguments: Array, location: Location) -> void



426
427
428
429
 
# File 'lib/prism/node.rb', line 426

def initialize(arguments, location)
  @arguments = arguments
  @location = location
end

Instance Attribute Details

#arguments ⇒ Object (readonly)

attr_reader arguments: Array



423
424
425
 
# File 'lib/prism/node.rb', line 423

def arguments
  @arguments
end

Instance Method Details

#accept(visitor) ⇒ Object

def accept: (visitor: Visitor) -> void



432
433
434
 
# File 'lib/prism/node.rb', line 432

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

#child_nodes ⇒ Object Also known as: deconstruct

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



437
438
439
 
# File 'lib/prism/node.rb', line 437

def child_nodes
  [*arguments]
end

#comment_targets ⇒ Object

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



447
448
449
 
# File 'lib/prism/node.rb', line 447

def comment_targets
  [*arguments]
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



442
443
444
 
# File 'lib/prism/node.rb', line 442

def compact_child_nodes
  [*arguments]
end

#copy(**params) ⇒ Object

def copy: (**params) -> ArgumentsNode



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

def copy(**params)
  ArgumentsNode.new(
    params.fetch(:arguments) { arguments },
    params.fetch(:location) { location },
  )
end

#deconstruct_keys(keys) ⇒ Object

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



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

def deconstruct_keys(keys)
  { arguments: arguments, location: location }
end

#inspect(inspector = NodeInspector.new) ⇒ Object 



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

def inspect(inspector = NodeInspector.new)
  inspector << inspector.header(self)
  inspector << "└── arguments: #{inspector.list("#{inspector.prefix}    ", arguments)}"
  inspector.to_str
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



487
488
489
 
# File 'lib/prism/node.rb', line 487

def type
  :arguments_node
end