Class: SyntaxTree::UntilMod

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

Overview

UntilMod represents the modifier form of a until loop.

expression until predicate

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(statement:, predicate:, location:, comments: []) ⇒ UntilMod

Returns a new instance of UntilMod.



9297
9298
9299
9300
9301
9302
 
# File 'lib/syntax_tree/node.rb', line 9297

def initialize(statement:, predicate:, location:, comments: [])
  @statement = statement
  @predicate = predicate
  @location = location
  @comments = comments
end

Instance Attribute Details

#comments ⇒ Object (readonly)

Array[ Comment | EmbDoc ]

the comments attached to this node



9295
9296
9297
 
# File 'lib/syntax_tree/node.rb', line 9295

def comments
  @comments
end

#predicate ⇒ Object (readonly)

untyped

the expression to be checked



9292
9293
9294
 
# File 'lib/syntax_tree/node.rb', line 9292

def predicate
  @predicate
end

#statement ⇒ Object (readonly)

untyped

the expression to be executed



9289
9290
9291
 
# File 'lib/syntax_tree/node.rb', line 9289

def statement
  @statement
end

Instance Method Details

#accept(visitor) ⇒ Object 



9304
9305
9306
 
# File 'lib/syntax_tree/node.rb', line 9304

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

#child_nodes ⇒ Object Also known as: deconstruct 



9308
9309
9310
 
# File 'lib/syntax_tree/node.rb', line 9308

def child_nodes
  [statement, predicate]
end

#deconstruct_keys(_keys) ⇒ Object 



9314
9315
9316
9317
9318
9319
9320
9321
 
# File 'lib/syntax_tree/node.rb', line 9314

def deconstruct_keys(_keys)
  {
    statement: statement,
    predicate: predicate,
    location: location,
    comments: comments
  }
end

#format(q) ⇒ Object 



9323
9324
9325
9326
9327
9328
9329
9330
9331
9332
9333
9334
9335
9336
9337
9338
9339
9340
9341
9342
9343
9344
9345
 
# File 'lib/syntax_tree/node.rb', line 9323

def format(q)
  # If we're in the modifier form and we're modifying a `begin`, then this
  # is a special case where we need to explicitly use the modifier form
  # because otherwise the semantic meaning changes. This looks like:
  #
  #     begin
  #       foo
  #     end until bar
  #
  # Also, if the statement of the modifier includes an assignment, then we
  # can't know for certain that it won't impact the predicate, so we need to
  # force it to stay as it is. This looks like:
  #
  #     foo = bar until foo
  #
  if statement.is_a?(Begin) || ContainsAssignment.call(statement)
    q.format(statement)
    q.text(" until ")
    q.format(predicate)
  else
    LoopFormatter.new("until", self, statement).format(q)
  end
end