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

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(flags, arguments, location) ⇒ ArgumentsNode

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



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

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

Instance Attribute Details

#arguments ⇒ Object (readonly)

attr_reader arguments: Array



477
478
479
 
# File 'lib/prism/node.rb', line 477

def arguments
  @arguments
end

#flags ⇒ Object (readonly)

Returns the value of attribute flags.



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

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



561
562
563
 
# File 'lib/prism/node.rb', line 561

def self.type
  :arguments_node
end

Instance Method Details

#accept(visitor) ⇒ Object

def accept: (visitor: Visitor) -> void



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

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

#child_nodes ⇒ Object Also known as: deconstruct

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



492
493
494
 
# File 'lib/prism/node.rb', line 492

def child_nodes
  [*arguments]
end

#comment_targets ⇒ Object

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



502
503
504
 
# File 'lib/prism/node.rb', line 502

def comment_targets
  [*arguments]
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



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

def compact_child_nodes
  [*arguments]
end

#contains_keyword_splat? ⇒ Boolean

def contains_keyword_splat?: () -> bool

Returns:

  • (Boolean) 


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

def contains_keyword_splat?
  flags.anybits?(ArgumentsNodeFlags::CONTAINS_KEYWORD_SPLAT)
end

#copy(**params) ⇒ Object

def copy: (**params) -> ArgumentsNode



507
508
509
510
511
512
513
 
# File 'lib/prism/node.rb', line 507

def copy(**params)
  ArgumentsNode.new(
    params.fetch(:flags) { flags },
    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]



519
520
521
 
# File 'lib/prism/node.rb', line 519

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

#inspect(inspector = NodeInspector.new) ⇒ Object

def inspect(inspector: NodeInspector) -> String



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

def inspect(inspector = NodeInspector.new)
  inspector << inspector.header(self)
  flags = [("contains_keyword_splat" if contains_keyword_splat?)].compact
  inspector << "├── flags: #{flags.empty? ? "∅" : flags.join(", ")}\n"
  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



551
552
553
 
# File 'lib/prism/node.rb', line 551

def type
  :arguments_node
end