Class: SyntaxTree::HeredocBeg

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

Overview

HeredocBeg represents the beginning declaration of a heredoc.

"contents\n"

In the example above the HeredocBeg node represents <<~DOC.

Instance Attribute Summary collapse

Attributes inherited from Node

#location

Instance Method Summary collapse

Methods inherited from Node

#pretty_print, #to_json

Constructor Details

#initialize(value:, location:, comments: []) ⇒ HeredocBeg

Returns a new instance of HeredocBeg.



4418
4419
4420
4421
4422
 
# File 'lib/syntax_tree/node.rb', line 4418

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

Instance Attribute Details

#comments ⇒ Object (readonly)

Array[ Comment | EmbDoc ]

the comments attached to this node



4416
4417
4418
 
# File 'lib/syntax_tree/node.rb', line 4416

def comments
  @comments
end

#value ⇒ Object (readonly)

String

the opening declaration of the heredoc



4413
4414
4415
 
# File 'lib/syntax_tree/node.rb', line 4413

def value
  @value
end

Instance Method Details

#accept(visitor) ⇒ Object 



4424
4425
4426
 
# File 'lib/syntax_tree/node.rb', line 4424

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

#child_nodes ⇒ Object Also known as: deconstruct 



4428
4429
4430
 
# File 'lib/syntax_tree/node.rb', line 4428

def child_nodes
  []
end

#deconstruct_keys(keys) ⇒ Object 



4434
4435
4436
 
# File 'lib/syntax_tree/node.rb', line 4434

def deconstruct_keys(keys)
  { value: value, location: location, comments: comments }
end

#format(q) ⇒ Object 



4438
4439
4440
 
# File 'lib/syntax_tree/node.rb', line 4438

def format(q)
  q.text(value)
end