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.



4898
4899
4900
4901
4902
 
# File 'lib/syntax_tree/node.rb', line 4898

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



4896
4897
4898
 
# File 'lib/syntax_tree/node.rb', line 4896

def comments
  @comments
end

#value ⇒ Object (readonly)

[String] the opening declaration of the heredoc



4893
4894
4895
 
# File 'lib/syntax_tree/node.rb', line 4893

def value
  @value
end

Instance Method Details

#accept(visitor) ⇒ Object 



4904
4905
4906
 
# File 'lib/syntax_tree/node.rb', line 4904

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

#child_nodes ⇒ Object Also known as: deconstruct 



4908
4909
4910
 
# File 'lib/syntax_tree/node.rb', line 4908

def child_nodes
  []
end

#deconstruct_keys(_keys) ⇒ Object 



4914
4915
4916
 
# File 'lib/syntax_tree/node.rb', line 4914

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

#format(q) ⇒ Object 



4918
4919
4920
 
# File 'lib/syntax_tree/node.rb', line 4918

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