class Prism::ForNode

Represents the use of the ‘for` keyword.

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

Attributes

collection[R]

attr_reader collection: Prism::node

index[R]

attr_reader index: Prism::node

statements[R]

attr_reader statements: StatementsNode?

Public Class Methods

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

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

# File lib/prism/node.rb, line 7112
def initialize(source, index, collection, statements, for_keyword_loc, in_keyword_loc, do_keyword_loc, end_keyword_loc, location)
  @source = source
  @newline = false
  @location = 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
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 7254
def self.type
  :for_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 lib/prism/node.rb, line 7260
def ===(other)
  other.is_a?(ForNode) &&
    (index === other.index) &&
    (collection === other.collection) &&
    (statements === other.statements) &&
    (for_keyword_loc.nil? == other.for_keyword_loc.nil?) &&
    (in_keyword_loc.nil? == other.in_keyword_loc.nil?) &&
    (do_keyword_loc.nil? == other.do_keyword_loc.nil?) &&
    (end_keyword_loc.nil? == other.end_keyword_loc.nil?)
end

accept(visitor) click to toggle source

def accept: (Visitor visitor) -> void

# File lib/prism/node.rb, line 7126
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 7131
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 7145
def comment_targets
  [index, collection, *statements, for_keyword_loc, in_keyword_loc, *do_keyword_loc, end_keyword_loc] #: Array[Prism::node | Location]
end

compact_child_nodes() click to toggle source

def compact_child_nodes: () -> Array

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

copy(index: self.index, collection: self.collection, statements: self.statements, for_keyword_loc: self.for_keyword_loc, in_keyword_loc: self.in_keyword_loc, do_keyword_loc: self.do_keyword_loc, end_keyword_loc: self.end_keyword_loc, location: self.location) click to toggle source

def copy: (?index: Prism::node, ?collection: Prism::node, ?statements: StatementsNode?, ?for_keyword_loc: Location, ?in_keyword_loc: Location, ?do_keyword_loc: Location?, ?end_keyword_loc: Location, ?location: Location) -> ForNode

# File lib/prism/node.rb, line 7150
def copy(index: self.index, collection: self.collection, statements: self.statements, for_keyword_loc: self.for_keyword_loc, in_keyword_loc: self.in_keyword_loc, do_keyword_loc: self.do_keyword_loc, end_keyword_loc: self.end_keyword_loc, location: self.location)
  ForNode.new(source, index, collection, statements, for_keyword_loc, in_keyword_loc, do_keyword_loc, end_keyword_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) -> { index: Prism::node, collection: Prism::node, statements: StatementsNode?, for_keyword_loc: Location, in_keyword_loc: Location, do_keyword_loc: Location?, end_keyword_loc: Location, location: Location }

# File lib/prism/node.rb, line 7158
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 7216
def do_keyword
  do_keyword_loc&.slice
end

do_keyword_loc() click to toggle source

attr_reader do_keyword_loc: Location?

# File lib/prism/node.rb, line 7186
def do_keyword_loc
  location = @do_keyword_loc
  case location
  when nil
    nil
  when Location
    location
  else
    @do_keyword_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
  end
end

end_keyword() click to toggle source

def end_keyword: () -> String

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

end_keyword_loc() click to toggle source

attr_reader end_keyword_loc: Location

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

for_keyword() click to toggle source

def for_keyword: () -> String

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

for_keyword_loc() click to toggle source

attr_reader for_keyword_loc: Location

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

in_keyword() click to toggle source

def in_keyword: () -> String

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

in_keyword_loc() click to toggle source

attr_reader in_keyword_loc: Location

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

inspect() click to toggle source

def inspect -> String

# File lib/prism/node.rb, line 7226
def inspect
  InspectVisitor.compose(self)
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 7244
def type
  :for_node
end