Class: Prism::BlockArgumentNode

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

Overview

Represents block method arguments.

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(expression, operator_loc, location) ⇒ BlockArgumentNode

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



1311
1312
1313
1314
1315
 
# File 'lib/prism/node.rb', line 1311

def initialize(expression, operator_loc, location)
  @expression = expression
  @operator_loc = operator_loc
  @location = location
end

Instance Attribute Details

#expression ⇒ Object (readonly)

attr_reader expression: Node?



1305
1306
1307
 
# File 'lib/prism/node.rb', line 1305

def expression
  @expression
end

#operator_loc ⇒ Object (readonly)

attr_reader operator_loc: Location



1308
1309
1310
 
# File 'lib/prism/node.rb', line 1308

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



1398
1399
1400
 
# File 'lib/prism/node.rb', line 1398

def self.type
  :block_argument_node
end

Instance Method Details

#accept(visitor) ⇒ Object

def accept: (visitor: Visitor) -> void



1318
1319
1320
 
# File 'lib/prism/node.rb', line 1318

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

#child_nodes ⇒ Object Also known as: deconstruct

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



1323
1324
1325
 
# File 'lib/prism/node.rb', line 1323

def child_nodes
  [expression]
end

#comment_targets ⇒ Object

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



1335
1336
1337
 
# File 'lib/prism/node.rb', line 1335

def comment_targets
  [*expression, operator_loc]
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



1328
1329
1330
1331
1332
 
# File 'lib/prism/node.rb', line 1328

def compact_child_nodes
  compact = []
  compact << expression if expression
  compact
end

#copy(**params) ⇒ Object

def copy: (**params) -> BlockArgumentNode



1340
1341
1342
1343
1344
1345
1346
 
# 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_keys(keys) ⇒ Object

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



1352
1353
1354
 
# File 'lib/prism/node.rb', line 1352

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

#inspect(inspector = NodeInspector.new) ⇒ Object

def inspect(inspector: NodeInspector) -> String



1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
 
# 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 ⇒ Object

def operator: () -> String



1357
1358
1359
 
# File 'lib/prism/node.rb', line 1357

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



1388
1389
1390
 
# File 'lib/prism/node.rb', line 1388

def type
  :block_argument_node
end