Class: SyntaxTree::HeredocEnd

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

Overview

HeredocEnd represents the closing declaration of a heredoc.

"contents\n"

In the example above the HeredocEnd node represents the closing DOC.

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(value:, location:, comments: []) ⇒ HeredocEnd

Returns a new instance of HeredocEnd.



5106
5107
5108
5109
5110
 
# File 'lib/syntax_tree/node.rb', line 5106

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



5104
5105
5106
 
# File 'lib/syntax_tree/node.rb', line 5104

def comments
  @comments
end

#value ⇒ Object (readonly)

String

the closing declaration of the heredoc



5101
5102
5103
 
# File 'lib/syntax_tree/node.rb', line 5101

def value
  @value
end

Instance Method Details

#accept(visitor) ⇒ Object 



5112
5113
5114
 
# File 'lib/syntax_tree/node.rb', line 5112

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

#child_nodes ⇒ Object Also known as: deconstruct 



5116
5117
5118
 
# File 'lib/syntax_tree/node.rb', line 5116

def child_nodes
  []
end

#deconstruct_keys(_keys) ⇒ Object 



5122
5123
5124
 
# File 'lib/syntax_tree/node.rb', line 5122

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

#format(q) ⇒ Object 



5126
5127
5128
 
# File 'lib/syntax_tree/node.rb', line 5126

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