class Prism::BlockArgumentNode

Represents block method arguments.

bar(&args)
^^^^^^^^^^

Attributes

expression[R]

attr_reader expression: Node?

operator_loc[R]

attr_reader operator_loc: Location

Public Class Methods

new(expression, operator_loc, location) click to toggle source

def initialize: (expression: Node?, operator_loc: Location, location: Location) -> void

# File lib/prism/node.rb, line 1311
def initialize(expression, operator_loc, location)
  @expression = expression
  @operator_loc = operator_loc
  @location = location
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 1398
def self.type
  :block_argument_node
end

Public Instance Methods

accept(visitor) click to toggle source

def accept: (visitor: Visitor) -> void

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

child_nodes() click to toggle source

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

# File lib/prism/node.rb, line 1323
def child_nodes
  [expression]
end

Also aliased as: deconstruct

comment_targets() click to toggle source

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

# File lib/prism/node.rb, line 1335
def comment_targets
  [*expression, operator_loc]
end

compact_child_nodes() click to toggle source

def compact_child_nodes: () -> Array

# File lib/prism/node.rb, line 1328
def compact_child_nodes
  compact = []
  compact << expression if expression
  compact
end

copy(**params) click to toggle source

def copy: (**params) -> BlockArgumentNode

# File lib/prism/node.rb, line 1340
def copy(**params)
  BlockArgumentNode.new(
    params.fetch(:expression) { expression },
    params.fetch(:operator_loc) { operator_loc },
    params.fetch(:location) { location },
  )
end

deconstruct()

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

Alias for: child_nodes

deconstruct_keys(keys) click to toggle source

# File lib/prism/node.rb, line 1352
def deconstruct_keys(keys)
  { expression: expression, operator_loc: operator_loc, location: location }
end

inspect(inspector = NodeInspector.new) click to toggle source

def inspect(inspector: NodeInspector) -> String

# File lib/prism/node.rb, line 1362
def inspect(inspector = NodeInspector.new)
  inspector << inspector.header(self)
  if (expression = self.expression).nil?
    inspector << "├── expression: ∅\n"
  else
    inspector << "├── expression:\n"
    inspector << expression.inspect(inspector.child_inspector("│   ")).delete_prefix(inspector.prefix)
  end
  inspector << "└── operator_loc: #{inspector.location(operator_loc)}\n"
  inspector.to_str
end

operator() click to toggle source

def operator: () -> String

# File lib/prism/node.rb, line 1357
def operator
  operator_loc.slice
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 1388
def type
  :block_argument_node
end