class Prism::BlockNode - Documentation for Ruby 4.1
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 }
                   ^^^^^^^^^^^^^^

### Public Class Methods

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

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

### Public Instance Methods

body → StatementsNode | BeginNode | nil
Source

    # File lib/prism/node.rb, line 3111
    def body
      @body
    end

The body of the block.

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

locals → Array[Symbol]
Source

    # File lib/prism/node.rb, line 3081
    def locals
      @locals
    end

The local variables declared in the block.

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

parameters → BlockParametersNode | NumberedParametersNode | ItParametersNode | nil
Source

    # File lib/prism/node.rb, line 3098
    def parameters
      @parameters
    end

The parameters of the block.

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

## Locations

### Public Instance Methods

closing_loc → Location
Source

    # File lib/prism/node.rb, line 3150
    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 `}` or `end`.

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

opening_loc → Location
Source

    # File lib/prism/node.rb, line 3125
    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 `{` or `do`.

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

## Node Interface

These methods are present on all subclasses of `Node`. Read the node interface docs for more information.

### Public Class Methods

type ()
Source

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

See `Node.type`.

### Public Instance Methods

accept (visitor)
Source

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

See `Node.accept`.

child_nodes ()
Source

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

See `Node.child_nodes`.

Also aliased as: deconstruct
comment_targets ()
Source

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

See `Node.comment_targets`.

compact_child_nodes ()
Source

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

See `Node.compact_child_nodes`.

copy(**fields) → BlockNode
Source

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

Creates a copy of self with the given fields, using self as the template.

deconstruct ()
Alias for: child_nodes
each_child_node () { |parameters| ... }
Source

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

      if (parameters = self.parameters); yield parameters; end
      if (body = self.body); yield body; end
    end

See `Node.each_child_node`.

type ()
Source

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

See `Node#type`.

## Repository

Methods related to `Relocation`.

### Public Instance Methods

save_closing_loc (repository)
Source

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

## Slicing

### Public Instance Methods

closing → String
Source

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

Slice the location of `closing_loc` from the source.

opening → String
Source

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

Slice the location of `opening_loc` from the source.