class Prism::ArgumentsNode

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

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

Attributes

arguments[R]

attr_reader arguments: Array

flags[R]

protected attr_reader flags: Integer

Public Class Methods

new(source, flags, arguments, location) click to toggle source

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

# File lib/prism/node.rb, line 604
def initialize(source, flags, arguments, location)
  @source = source
  @newline = false
  @location = location
  @flags = flags
  @arguments = arguments
end

type() click to toggle source

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

# File lib/prism/node.rb, line 686
def self.type
  :arguments_node
end

Public Instance Methods

===(other) click to toggle source

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

# File lib/prism/node.rb, line 692
def ===(other)
  other.is_a?(ArgumentsNode) &&
    (flags === other.flags) &&
    (arguments.length == other.arguments.length) &&
    arguments.zip(other.arguments).all? { |left, right| left === right }
end

accept(visitor) click to toggle source

def accept: (Visitor visitor) -> void

# File lib/prism/node.rb, line 613
def accept(visitor)
  visitor.visit_arguments_node(self)
end

child_nodes() click to toggle source

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

# File lib/prism/node.rb, line 618
def child_nodes
  [*arguments]
end

Also aliased as: deconstruct

comment_targets() click to toggle source

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

# File lib/prism/node.rb, line 628
def comment_targets
  [*arguments] #: Array[Prism::node | Location]
end

compact_child_nodes() click to toggle source

def compact_child_nodes: () -> Array

# File lib/prism/node.rb, line 623
def compact_child_nodes
  [*arguments]
end

contains_keyword_splat?() click to toggle source

def contains_keyword_splat?: () -> bool

# File lib/prism/node.rb, line 653
def contains_keyword_splat?
  flags.anybits?(ArgumentsNodeFlags::CONTAINS_KEYWORD_SPLAT)
end

copy(flags: self.flags, arguments: self.arguments, location: self.location) click to toggle source

def copy: (?flags: Integer, ?arguments: Array, ?location: Location) -> ArgumentsNode

# File lib/prism/node.rb, line 633
def copy(flags: self.flags, arguments: self.arguments, location: self.location)
  ArgumentsNode.new(source, flags, arguments, location)
end

deconstruct()

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

Alias for: child_nodes

deconstruct_keys(keys) click to toggle source

def deconstruct_keys: (Array keys) -> { flags: Integer, arguments: Array, location: Location }

# File lib/prism/node.rb, line 641
def deconstruct_keys(keys)
  { flags: flags, arguments: arguments, location: location }
end

inspect() click to toggle source

def inspect -> String

# File lib/prism/node.rb, line 658
def inspect
  InspectVisitor.compose(self)
end

type() click to toggle source

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

# File lib/prism/node.rb, line 676
def type
  :arguments_node
end