class Prism::BlockNode

Represents a block of ruby code.

[1, 2, 3].each { |i| puts x }
               ^^^^^^^^^^^^^^

Attributes

body[R]

attr_reader body: Prism::node?

locals[R]

attr_reader locals: Array

parameters[R]

attr_reader parameters: Prism::node?

Public Class Methods

new(source, locals, parameters, body, opening_loc, closing_loc, location) click to toggle source

def initialize: (Array locals, Prism::node? parameters, Prism::node? body, Location opening_loc, Location closing_loc, Location location) -> void

# File prism/node.rb, line 1746
def initialize(source, locals, parameters, body, opening_loc, closing_loc, location)
  @source = source
  @location = location
  @locals = locals
  @parameters = parameters
  @body = body
  @opening_loc = opening_loc
  @closing_loc = closing_loc
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 prism/node.rb, line 1854
def self.type
  :block_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 prism/node.rb, line 1860
def ===(other)
  other.is_a?(BlockNode) &&
    (locals.length == other.locals.length) &&
    locals.zip(other.locals).all? { |left, right| left === right } &&
    (parameters === other.parameters) &&
    (body === other.body) &&
    (opening_loc.nil? == other.opening_loc.nil?) &&
    (closing_loc.nil? == other.closing_loc.nil?)
end

accept(visitor) click to toggle source

def accept: (Visitor visitor) -> void

# File prism/node.rb, line 1757
def accept(visitor)
  visitor.visit_block_node(self)
end

child_nodes() click to toggle source

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

# File prism/node.rb, line 1762
def child_nodes
  [parameters, body]
end

Also aliased as: deconstruct

closing() click to toggle source

def closing: () -> String

# File prism/node.rb, line 1821
def closing
  closing_loc.slice
end

closing_loc() click to toggle source

attr_reader closing_loc: Location

# File prism/node.rb, line 1809
def closing_loc
  location = @closing_loc
  return location if location.is_a?(Location)
  @closing_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end

comment_targets() click to toggle source

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

# File prism/node.rb, line 1775
def comment_targets
  [*parameters, *body, opening_loc, closing_loc] #: Array[Prism::node | Location]
end

compact_child_nodes() click to toggle source

def compact_child_nodes: () -> Array

# File prism/node.rb, line 1767
def compact_child_nodes
  compact = [] #: Array[Prism::node]
  compact << parameters if parameters
  compact << body if body
  compact
end

copy(locals: self.locals, parameters: self.parameters, body: self.body, opening_loc: self.opening_loc, closing_loc: self.closing_loc, location: self.location) click to toggle source

def copy: (?locals: Array, ?parameters: Prism::node?, ?body: Prism::node?, ?opening_loc: Location, ?closing_loc: Location, ?location: Location) -> BlockNode

# File prism/node.rb, line 1780
def copy(locals: self.locals, parameters: self.parameters, body: self.body, opening_loc: self.opening_loc, closing_loc: self.closing_loc, location: self.location)
  BlockNode.new(source, locals, parameters, body, opening_loc, closing_loc, location)
end

deconstruct()

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

Alias for: child_nodes

deconstruct_keys(keys) click to toggle source

def deconstruct_keys: (Array keys) -> { locals: Array, parameters: Prism::node?, body: Prism::node?, opening_loc: Location, closing_loc: Location, location: Location }

# File prism/node.rb, line 1788
def deconstruct_keys(keys)
  { locals: locals, parameters: parameters, body: body, opening_loc: opening_loc, closing_loc: closing_loc, location: location }
end

inspect() click to toggle source

def inspect -> String

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

opening() click to toggle source

def opening: () -> String

# File prism/node.rb, line 1816
def opening
  opening_loc.slice
end

opening_loc() click to toggle source

attr_reader opening_loc: Location

# File prism/node.rb, line 1802
def opening_loc
  location = @opening_loc
  return location if location.is_a?(Location)
  @opening_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
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 prism/node.rb, line 1844
def type
  :block_node
end