class Prism::ForNode

Represents the use of the for keyword.

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

Attributes

collection[R]

The collection to iterate over.

for i in a end
         ^

index[R]

The index expression for for loops.

for i in a end
    ^

statements[R]

Represents the body of statements to execute for each iteration of the loop.

for i in a
  foo(i)
  ^^^^^^
end

Public Class Methods

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

Initialize a new ForNode node.

# File lib/prism/node.rb, line 6886
def initialize(source, node_id, location, flags, index, collection, statements, for_keyword_loc, in_keyword_loc, do_keyword_loc, end_keyword_loc)
  @source = source
  @node_id = node_id
  @location = location
  @flags = flags
  @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

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

# File lib/prism/node.rb, line 7058
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 7064
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 6901
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 6906
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 6920
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 6911
def compact_child_nodes
  compact = [] #: Array[Prism::node]
  compact << index
  compact << collection
  compact << statements if statements
  compact
end

copy(node_id: self.node_id, location: self.location, flags: self.flags, 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) click to toggle source

def copy: (?node_id: Integer, ?location: Location, ?flags: Integer, ?index: LocalVariableTargetNode | InstanceVariableTargetNode | ClassVariableTargetNode | GlobalVariableTargetNode | ConstantTargetNode | ConstantPathTargetNode | CallTargetNode | IndexTargetNode | MultiTargetNode | BackReferenceReadNode | NumberedReferenceReadNode | MissingNode, ?collection: Prism::node, ?statements: StatementsNode?, ?for_keyword_loc: Location, ?in_keyword_loc: Location, ?do_keyword_loc: Location?, ?end_keyword_loc: Location) -> ForNode

# File lib/prism/node.rb, line 6925
def copy(node_id: self.node_id, location: self.location, flags: self.flags, 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)
  ForNode.new(source, node_id, location, flags, index, collection, statements, for_keyword_loc, in_keyword_loc, do_keyword_loc, end_keyword_loc)
end

deconstruct()

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

Alias for: child_nodes

deconstruct_keys(keys) click to toggle source

def deconstruct_keys: (Array keys) -> { node_id: Integer, location: Location, index: LocalVariableTargetNode | InstanceVariableTargetNode | ClassVariableTargetNode | GlobalVariableTargetNode | ConstantTargetNode | ConstantPathTargetNode | CallTargetNode | IndexTargetNode | MultiTargetNode | BackReferenceReadNode | NumberedReferenceReadNode | MissingNode, collection: Prism::node, statements: StatementsNode?, for_keyword_loc: Location, in_keyword_loc: Location, do_keyword_loc: Location?, end_keyword_loc: Location }

# File lib/prism/node.rb, line 6933
def deconstruct_keys(keys)
  { node_id: node_id, 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

do_keyword() click to toggle source

def do_keyword: () -> String?

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

do_keyword_loc() click to toggle source

The location of the do keyword, if present.

for i in a do end
           ^^

# File lib/prism/node.rb, line 6993
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 7043
def end_keyword
  end_keyword_loc.slice
end

end_keyword_loc() click to toggle source

The location of the end keyword.

for i in a end
           ^^^

# File lib/prism/node.rb, line 7015
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 7028
def for_keyword
  for_keyword_loc.slice
end

for_keyword_loc() click to toggle source

The location of the for keyword.

for i in a end
^^^

# File lib/prism/node.rb, line 6961
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 7033
def in_keyword
  in_keyword_loc.slice
end

in_keyword_loc() click to toggle source

The location of the in keyword.

for i in a end
      ^^

# File lib/prism/node.rb, line 6977
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 7048
def inspect
  InspectVisitor.compose(self)
end

save_do_keyword_loc(repository) click to toggle source

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

# File lib/prism/node.rb, line 7007
def save_do_keyword_loc(repository)
  repository.enter(node_id, :do_keyword_loc) unless @do_keyword_loc.nil?
end

save_end_keyword_loc(repository) click to toggle source

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

# File lib/prism/node.rb, line 7023
def save_end_keyword_loc(repository)
  repository.enter(node_id, :end_keyword_loc)
end

save_for_keyword_loc(repository) click to toggle source

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

# File lib/prism/node.rb, line 6969
def save_for_keyword_loc(repository)
  repository.enter(node_id, :for_keyword_loc)
end

save_in_keyword_loc(repository) click to toggle source

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

# File lib/prism/node.rb, line 6985
def save_in_keyword_loc(repository)
  repository.enter(node_id, :in_keyword_loc)
end

type() click to toggle source

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

# File lib/prism/node.rb, line 7053
def type
  :for_node
end