Class: SyntaxTree::HeredocBeg
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
-
#comments ⇒ Object
readonly
- Array[ Comment | EmbDoc ]
-
the comments attached to this node.
-
#value ⇒ Object
readonly
- String
-
the opening declaration of the heredoc.
Attributes inherited from Node
Instance Method Summary collapse
- #accept(visitor) ⇒ Object
- #child_nodes ⇒ Object (also: #deconstruct)
- #deconstruct_keys(_keys) ⇒ Object
- #format(q) ⇒ Object
-
#initialize(value:, location:, comments: []) ⇒ HeredocBeg
constructor
A new instance of HeredocBeg.
Methods inherited from Node
#construct_keys, #pretty_print, #to_json
Constructor Details
#initialize(value:, location:, comments: []) ⇒ HeredocBeg
Returns a new instance of HeredocBeg.
4907 4908 4909 4910 4911 |
# File 'lib/syntax_tree/node.rb', line 4907 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
4905 4906 4907 |
# File 'lib/syntax_tree/node.rb', line 4905 def comments @comments end |
#value ⇒ Object (readonly)
- String
-
the opening declaration of the heredoc
4902 4903 4904 |
# File 'lib/syntax_tree/node.rb', line 4902 def value @value end |
Instance Method Details
#accept(visitor) ⇒ Object
4913 4914 4915 |
# File 'lib/syntax_tree/node.rb', line 4913 def accept(visitor) visitor.visit_heredoc_beg(self) end |
#child_nodes ⇒ Object Also known as: deconstruct
4917 4918 4919 |
# File 'lib/syntax_tree/node.rb', line 4917 def child_nodes [] end |
#deconstruct_keys(_keys) ⇒ Object
4923 4924 4925 |
# File 'lib/syntax_tree/node.rb', line 4923 def deconstruct_keys(_keys) { value: value, location: location, comments: comments } end |
#format(q) ⇒ Object
4927 4928 4929 |
# File 'lib/syntax_tree/node.rb', line 4927 def format(q) q.text(value) end |