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

#pretty_print, #to_json

Constructor Details

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

Returns a new instance of HeredocBeg.



4818
4819
4820
4821
4822
 
# File 'lib/syntax_tree/node.rb', line 4818

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



4816
4817
4818
 
# File 'lib/syntax_tree/node.rb', line 4816

def comments
  @comments
end

#value ⇒ Object (readonly)

String

the opening declaration of the heredoc



4813
4814
4815
 
# File 'lib/syntax_tree/node.rb', line 4813

def value
  @value
end

Instance Method Details

#accept(visitor) ⇒ Object 



4824
4825
4826
 
# File 'lib/syntax_tree/node.rb', line 4824

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

#child_nodes ⇒ Object Also known as: deconstruct 



4828
4829
4830
 
# File 'lib/syntax_tree/node.rb', line 4828

def child_nodes
  []
end

#deconstruct_keys(keys) ⇒ Object 



4834
4835
4836
 
# File 'lib/syntax_tree/node.rb', line 4834

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

#format(q) ⇒ Object 



4838
4839
4840
 
# File 'lib/syntax_tree/node.rb', line 4838

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