Class: SyntaxTree::For

Inherits:
Node
  • Object
show all
Defined in:
lib/syntax_tree/node.rb

Overview

For represents using a for loop.

for value in list do
end

Instance Attribute Summary collapse

Attributes inherited from Node

#location

Instance Method Summary collapse

Methods inherited from Node

#construct_keys, #pretty_print, #to_json

Constructor Details

#initialize(index:, collection:, statements:, location:, comments: []) ⇒ For

Returns a new instance of For.



4575
4576
4577
4578
4579
4580
4581
 
# File 'lib/syntax_tree/node.rb', line 4575

def initialize(index:, collection:, statements:, location:, comments: [])
  @index = index
  @collection = collection
  @statements = statements
  @location = location
  @comments = comments
end

Instance Attribute Details

#collection ⇒ Object (readonly)

untyped

the object being enumerated in the loop



4567
4568
4569
 
# File 'lib/syntax_tree/node.rb', line 4567

def collection
  @collection
end

#comments ⇒ Object (readonly)

Array[ Comment | EmbDoc ]

the comments attached to this node



4573
4574
4575
 
# File 'lib/syntax_tree/node.rb', line 4573

def comments
  @comments
end

#index ⇒ Object (readonly)

MLHS | VarField

the variable declaration being used to

pull values out of the object being enumerated



4564
4565
4566
 
# File 'lib/syntax_tree/node.rb', line 4564

def index
  @index
end

#statements ⇒ Object (readonly)

Statements

the statements to be executed



4570
4571
4572
 
# File 'lib/syntax_tree/node.rb', line 4570

def statements
  @statements
end

Instance Method Details

#accept(visitor) ⇒ Object 



4583
4584
4585
 
# File 'lib/syntax_tree/node.rb', line 4583

def accept(visitor)
  visitor.visit_for(self)
end

#child_nodes ⇒ Object Also known as: deconstruct 



4587
4588
4589
 
# File 'lib/syntax_tree/node.rb', line 4587

def child_nodes
  [index, collection, statements]
end

#deconstruct_keys(_keys) ⇒ Object 



4593
4594
4595
4596
4597
4598
4599
4600
4601
 
# File 'lib/syntax_tree/node.rb', line 4593

def deconstruct_keys(_keys)
  {
    index: index,
    collection: collection,
    statements: statements,
    location: location,
    comments: comments
  }
end

#format(q) ⇒ Object 



4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
 
# File 'lib/syntax_tree/node.rb', line 4603

def format(q)
  q.group do
    q.text("for ")
    q.group { q.format(index) }
    q.text(" in ")
    q.format(collection)

    unless statements.empty?
      q.indent do
        q.breakable(force: true)
        q.format(statements)
      end
    end

    q.breakable(force: true)
    q.text("end")
  end
end