Class: SyntaxTree::Rescue

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

Overview

Rescue represents the use of the rescue keyword inside of a BodyStmt node.

begin
rescue
end

Instance Attribute Summary collapse

Attributes inherited from Node

#location

Instance Method Summary collapse

Methods inherited from Node

#construct_keys, #end_char, #pretty_print, #start_char, #to_json, #to_mermaid

Constructor Details

#initialize(keyword:, exception:, statements:, consequent:, location:) ⇒ Rescue

Returns a new instance of Rescue.



9407
9408
9409
9410
9411
9412
9413
9414
 
# File 'lib/syntax_tree/node.rb', line 9407

def initialize(keyword:, exception:, statements:, consequent:, location:)
  @keyword = keyword
  @exception = exception
  @statements = statements
  @consequent = consequent
  @location = location
  @comments = []
end

Instance Attribute Details

#comments ⇒ Object (readonly)

Array[ Comment | EmbDoc ]

the comments attached to this node



9405
9406
9407
 
# File 'lib/syntax_tree/node.rb', line 9405

def comments
  @comments
end

#consequent ⇒ Object (readonly)

nil | Rescue

the optional next clause in the chain



9402
9403
9404
 
# File 'lib/syntax_tree/node.rb', line 9402

def consequent
  @consequent
end

#exception ⇒ Object (readonly)

nil | RescueEx

the exceptions being rescued



9396
9397
9398
 
# File 'lib/syntax_tree/node.rb', line 9396

def exception
  @exception
end

#keyword ⇒ Object (readonly)

Kw

the rescue keyword



9393
9394
9395
 
# File 'lib/syntax_tree/node.rb', line 9393

def keyword
  @keyword
end

#statements ⇒ Object (readonly)

Statements

the expressions to evaluate when an error is rescued



9399
9400
9401
 
# File 'lib/syntax_tree/node.rb', line 9399

def statements
  @statements
end

Instance Method Details

#===(other) ⇒ Object 



9503
9504
9505
9506
9507
 
# File 'lib/syntax_tree/node.rb', line 9503

def ===(other)
  other.is_a?(Rescue) && keyword === other.keyword &&
    exception === other.exception && statements === other.statements &&
    consequent === other.consequent
end

#accept(visitor) ⇒ Object 



9438
9439
9440
 
# File 'lib/syntax_tree/node.rb', line 9438

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

#bind_end(end_char, end_column) ⇒ Object 



9416
9417
9418
9419
9420
9421
9422
9423
9424
9425
9426
9427
9428
9429
9430
9431
9432
9433
9434
9435
9436
 
# File 'lib/syntax_tree/node.rb', line 9416

def bind_end(end_char, end_column)
  @location =
    Location.new(
      start_line: location.start_line,
      start_char: location.start_char,
      start_column: location.start_column,
      end_line: location.end_line,
      end_char: end_char,
      end_column: end_column
    )

  if consequent
    consequent.bind_end(end_char, end_column)
    statements.bind_end(
      consequent.location.start_char,
      consequent.location.start_column
    )
  else
    statements.bind_end(end_char, end_column)
  end
end

#child_nodes ⇒ Object Also known as: deconstruct 



9442
9443
9444
 
# File 'lib/syntax_tree/node.rb', line 9442

def child_nodes
  [keyword, exception, statements, consequent]
end

#copy(keyword: nil, exception: nil, statements: nil, consequent: nil, location: nil) ⇒ Object 



9446
9447
9448
9449
9450
9451
9452
9453
9454
9455
9456
9457
9458
9459
9460
9461
9462
9463
9464
 
# File 'lib/syntax_tree/node.rb', line 9446

def copy(
  keyword: nil,
  exception: nil,
  statements: nil,
  consequent: nil,
  location: nil
)
  node =
    Rescue.new(
      keyword: keyword || self.keyword,
      exception: exception || self.exception,
      statements: statements || self.statements,
      consequent: consequent || self.consequent,
      location: location || self.location
    )

  node.comments.concat(comments.map(&:copy))
  node
end

#deconstruct_keys(_keys) ⇒ Object 



9468
9469
9470
9471
9472
9473
9474
9475
9476
9477
 
# File 'lib/syntax_tree/node.rb', line 9468

def deconstruct_keys(_keys)
  {
    keyword: keyword,
    exception: exception,
    statements: statements,
    consequent: consequent,
    location: location,
    comments: comments
  }
end

#format(q) ⇒ Object 



9479
9480
9481
9482
9483
9484
9485
9486
9487
9488
9489
9490
9491
9492
9493
9494
9495
9496
9497
9498
9499
9500
9501
 
# File 'lib/syntax_tree/node.rb', line 9479

def format(q)
  q.group do
    q.format(keyword)

    if exception
      q.nest(keyword.value.length + 1) { q.format(exception) }
    else
      q.text(" StandardError")
    end

    unless statements.empty?
      q.indent do
        q.breakable_force
        q.format(statements)
      end
    end

    if consequent
      q.breakable_force
      q.format(consequent)
    end
  end
end