Represents a block of ruby code.
[1, 2, 3].each { |i| puts x }
^^^^^^^^^^^^^^
attr_reader locals_body_index: Integer
attr_reader parameters: Node?
attr_reader opening_loc: Location
attr_reader closing_loc: Location
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 1513
def initialize(locals, locals_body_index, parameters, body, opening_loc, closing_loc, location)
@locals = locals
@locals_body_index = locals_body_index
@parameters = parameters
@body = body
@opening_loc = opening_loc
@closing_loc = closing_loc
@location = location
end
def initialize: (locals: Array, locals_body_index: Integer, parameters: Node?, body: Node?, opening_loc: Location, closing_loc: Location, location: Location) -> void
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 1623
def self.type
:block_node
end
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 tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 1524
def accept(visitor)
visitor.visit_block_node(self)
end
def accept: (visitor: Visitor) -> void
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 1529
def child_nodes
[parameters, body]
end
def child_nodes: () -> Array[nil | Node]
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 1573
def closing
closing_loc.slice
end
def closing: () -> String
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 1542
def comment_targets
[*parameters, *body, opening_loc, closing_loc]
end
def comment_targets: () -> Array[Node | Location]
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 1534
def compact_child_nodes
compact = []
compact << parameters if parameters
compact << body if body
compact
end
def compact_child_nodes: () -> Array
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 1547
def copy(**params)
BlockNode.new(
params.fetch(:locals) { locals },
params.fetch(:locals_body_index) { locals_body_index },
params.fetch(:parameters) { parameters },
params.fetch(:body) { body },
params.fetch(:opening_loc) { opening_loc },
params.fetch(:closing_loc) { closing_loc },
params.fetch(:location) { location },
)
end
def copy: (**params) -> BlockNode
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 1563
def deconstruct_keys(keys)
{ locals: locals, locals_body_index: locals_body_index, parameters: parameters, body: body, opening_loc: opening_loc, closing_loc: closing_loc, location: location }
end
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 1578
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "├── locals: #{locals.inspect}\n"
inspector << "├── locals_body_index: #{locals_body_index.inspect}\n"
if (parameters = self.parameters).nil?
inspector << "├── parameters: ∅\n"
else
inspector << "├── parameters:\n"
inspector << parameters.inspect(inspector.child_inspector("│ ")).delete_prefix(inspector.prefix)
end
if (body = self.body).nil?
inspector << "├── body: ∅\n"
else
inspector << "├── body:\n"
inspector << body.inspect(inspector.child_inspector("│ ")).delete_prefix(inspector.prefix)
end
inspector << "├── opening_loc: #{inspector.location(opening_loc)}\n"
inspector << "└── closing_loc: #{inspector.location(closing_loc)}\n"
inspector.to_str
end
def inspect(inspector: NodeInspector) -> String
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 1568
def opening
opening_loc.slice
end
def opening: () -> String
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 1613
def type
:block_node
end
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