class Prism::ForNode - Documentation for Ruby 3.3

# class Prism::ForNode

Represents the use of the ‘for` keyword.

    for i in a end
    ^^^^^^^^^^^^^^

### Attributes

collection[R]

attr_reader collection: `Node`

do_keyword_loc[R]

attr_reader `do_keyword_loc`: `Location`?

end_keyword_loc[R]

attr_reader `end_keyword_loc`: `Location`

for_keyword_loc[R]

attr_reader `for_keyword_loc`: `Location`

in_keyword_loc[R]

attr_reader `in_keyword_loc`: `Location`

index[R]

attr_reader index: `Node`

statements[R]

attr_reader statements: `StatementsNode`?

### Public Class Methods

new(index, collection, statements, for_keyword_loc, in_keyword_loc, do_keyword_loc, end_keyword_loc, location) click to toggle source

def initialize: (index: `Node`, collection: `Node`, statements: `StatementsNode`?, `for_keyword_loc`: `Location`, `in_keyword_loc`: `Location`, `do_keyword_loc`: `Location`?, `end_keyword_loc`: `Location`, location: `Location`) -> void

    # File lib/prism/node.rb, line 6466
    def initialize(index, collection, statements, for_keyword_loc, in_keyword_loc, do_keyword_loc, end_keyword_loc, location)
      @index = index
      @collection = collection
      @statements = statements
      @for_keyword_loc = for_keyword_loc
      @in_keyword_loc = in_keyword_loc
      @do_keyword_loc = do_keyword_loc
      @end_keyword_loc = end_keyword_loc
      @location = location
    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 lib/prism/node.rb, line 6587
    def self.type
      :for_node
    end

### Public Instance Methods

accept(visitor) click to toggle source

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

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

child_nodes() click to toggle source

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

    # File lib/prism/node.rb, line 6483
    def child_nodes
      [index, collection, statements]
    end

Also aliased as: deconstruct
comment_targets() click to toggle source

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

    # File lib/prism/node.rb, line 6497
    def comment_targets
      [index, collection, *statements, for_keyword_loc, in_keyword_loc, *do_keyword_loc, end_keyword_loc]
    end

compact_child_nodes() click to toggle source

def `compact_child_nodes`: () -> Array

    # File lib/prism/node.rb, line 6488
    def compact_child_nodes
      compact = []
      compact << index
      compact << collection
      compact << statements if statements
      compact
    end

copy(**params) click to toggle source

def copy: (**params) -> `ForNode`

    # File lib/prism/node.rb, line 6502
    def copy(**params)
      ForNode.new(
        params.fetch(:index) { index },
        params.fetch(:collection) { collection },
        params.fetch(:statements) { statements },
        params.fetch(:for_keyword_loc) { for_keyword_loc },
        params.fetch(:in_keyword_loc) { in_keyword_loc },
        params.fetch(:do_keyword_loc) { do_keyword_loc },
        params.fetch(:end_keyword_loc) { end_keyword_loc },
        params.fetch(:location) { location },
      )
    end

deconstruct()

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

Alias for: child_nodes
deconstruct_keys(keys) click to toggle source

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

    # File lib/prism/node.rb, line 6519
    def deconstruct_keys(keys)
      { index: index, collection: collection, statements: statements, for_keyword_loc: for_keyword_loc, in_keyword_loc: in_keyword_loc, do_keyword_loc: do_keyword_loc, end_keyword_loc: end_keyword_loc, location: location }
    end

do_keyword() click to toggle source

def `do_keyword`: () -> `String`?

    # File lib/prism/node.rb, line 6534
    def do_keyword
      do_keyword_loc&.slice
    end

end_keyword() click to toggle source

def `end_keyword`: () -> `String`

    # File lib/prism/node.rb, line 6539
    def end_keyword
      end_keyword_loc.slice
    end

for_keyword() click to toggle source

def `for_keyword`: () -> `String`

    # File lib/prism/node.rb, line 6524
    def for_keyword
      for_keyword_loc.slice
    end

in_keyword() click to toggle source

def `in_keyword`: () -> `String`

    # File lib/prism/node.rb, line 6529
    def in_keyword
      in_keyword_loc.slice
    end

inspect(inspector = NodeInspector.new) click to toggle source

def inspect(inspector: NodeInspector) -> `String`

    # File lib/prism/node.rb, line 6544
    def inspect(inspector = NodeInspector.new)
      inspector << inspector.header(self)
      inspector << "├── index:\n"
      inspector << inspector.child_node(index, "│   ")
      inspector << "├── collection:\n"
      inspector << inspector.child_node(collection, "│   ")
      if (statements = self.statements).nil?
        inspector << "├── statements: ∅\n"
      else
        inspector << "├── statements:\n"
        inspector << statements.inspect(inspector.child_inspector("│   ")).delete_prefix(inspector.prefix)
      end
      inspector << "├── for_keyword_loc: #{inspector.location(for_keyword_loc)}\n"
      inspector << "├── in_keyword_loc: #{inspector.location(in_keyword_loc)}\n"
      inspector << "├── do_keyword_loc: #{inspector.location(do_keyword_loc)}\n"
      inspector << "└── end_keyword_loc: #{inspector.location(end_keyword_loc)}\n"
      inspector.to_str
    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 lib/prism/node.rb, line 6577
    def type
      :for_node
    end