Class: SyntaxTree::HeredocBeg

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

Overview

HeredocBeg represents the beginning declaration of a heredoc.

<<~DOC
  contents
DOC

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

#construct_keys, #pretty_print, #to_json

Constructor Details

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

Returns a new instance of HeredocBeg.



4863
4864
4865
4866
4867
 
# File 'lib/syntax_tree/node.rb', line 4863

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



4861
4862
4863
 
# File 'lib/syntax_tree/node.rb', line 4861

def comments
  @comments
end

#value ⇒ Object (readonly)

String

the opening declaration of the heredoc



4858
4859
4860
 
# File 'lib/syntax_tree/node.rb', line 4858

def value
  @value
end

Instance Method Details

#accept(visitor) ⇒ Object 



4869
4870
4871
 
# File 'lib/syntax_tree/node.rb', line 4869

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

#child_nodes ⇒ Object Also known as: deconstruct 



4873
4874
4875
 
# File 'lib/syntax_tree/node.rb', line 4873

def child_nodes
  []
end

#deconstruct_keys(_keys) ⇒ Object 



4879
4880
4881
 
# File 'lib/syntax_tree/node.rb', line 4879

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

#format(q) ⇒ Object 



4883
4884
4885
 
# File 'lib/syntax_tree/node.rb', line 4883

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