class Prism::BlockNode - Documentation for Ruby 4.0
Description: class Prism::BlockNode: Represents a block of ruby code.
Keywords: ruby,class,Prism::BlockNode

🔍

No recent searches

# class Prism::BlockNode

Represents a block of ruby code.

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

### Attributes

body [R]

The body of the block.

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

locals [R]

The local variables declared in the block.

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

parameters [R]

The parameters of the block.

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

### Public Class Methods

new (source, node_id, location, flags, locals, parameters, body, opening_loc, closing_loc)
Source

    # File lib/prism/node.rb, line 1950
    def initialize(source, node_id, location, flags, locals, parameters, body, opening_loc, closing_loc)
      @source = source
      @node_id = node_id
      @location = location
      @flags = flags
      @locals = locals
      @parameters = parameters
      @body = body
      @opening_loc = opening_loc
      @closing_loc = closing_loc
    end

Initialize a new `BlockNode` node.

type ()
Source

    # File lib/prism/node.rb, line 2081
    def self.type
      :block_node
    end

Return a symbol representation of this node type. See `Node::type`.

### Public Instance Methods

=== (other)
Source

    # File lib/prism/node.rb, line 2087
    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

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

accept (visitor)
Source

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

def accept: (`Visitor` visitor) -> void

child_nodes ()
Source

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

def `child_nodes`: () -> Array

Also aliased as: deconstruct
closing ()
Source

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

def closing: () -> `String`

closing_loc ()
Source

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

Represents the location of the closing `|`.

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

comment_targets ()
Source

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

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

compact_child_nodes ()
Source

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

def `compact_child_nodes`: () -> Array

copy (node_id: self.node_id, location: self.location, flags: self.flags, locals: self.locals, parameters: self.parameters, body: self.body, opening_loc: self.opening_loc, closing_loc: self.closing_loc)
Source

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

def copy: (?node_id: `Integer`, ?location: `Location`, ?flags: `Integer`, ?locals: Array, ?parameters: `BlockParametersNode` | `NumberedParametersNode` | `ItParametersNode` | nil, ?body: `StatementsNode` | `BeginNode` | nil, ?opening_loc: `Location`, ?closing_loc: `Location`) -> `BlockNode`

deconstruct ()

def deconstruct: () -> Array

Alias for: child_nodes
deconstruct_keys (keys)
Source

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

def `deconstruct_keys`: (Array keys) -> { node_id: `Integer`, location: `Location`, locals: Array, parameters: `BlockParametersNode` | `NumberedParametersNode` | `ItParametersNode` | nil, body: `StatementsNode` | `BeginNode` | nil, `opening_loc`: `Location`, `closing_loc`: `Location` }

each_child_node () { |parameters| ... }
Source

    # File lib/prism/node.rb, line 1973
    def each_child_node
      return to_enum(:each_child_node) unless block_given?

      yield parameters if parameters
      yield body if body
    end

def `each_child_node`: () { (Prism::node) -> void } -> void | () -> Enumerator

inspect ()
Source

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

def inspect -> `String`

opening ()
Source

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

def opening: () -> `String`

opening_loc ()
Source

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

Represents the location of the opening `|`.

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

save_closing_loc (repository)
Source

    # File lib/prism/node.rb, line 2056
    def save_closing_loc(repository)
      repository.enter(node_id, :closing_loc)
    end

Save the `closing_loc` location using the given saved source so that it can be retrieved later.

save_opening_loc (repository)
Source

    # File lib/prism/node.rb, line 2040
    def save_opening_loc(repository)
      repository.enter(node_id, :opening_loc)
    end

Save the `opening_loc` location using the given saved source so that it can be retrieved later.

type ()
Source

    # File lib/prism/node.rb, line 2076
    def type
      :block_node
    end

Return a symbol representation of this node type. See `Node#type`.