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, #end_char, #pretty_print, #start_char, #to_json, #to_mermaid

Constructor Details

#initialize(value:, location:) ⇒ HeredocBeg

Returns a new instance of HeredocBeg.



5871
5872
5873
5874
5875
 
# File 'lib/syntax_tree/node.rb', line 5871

def initialize(value:, location:)
  @value = value
  @location = location
  @comments = []
end

Instance Attribute Details

#comments ⇒ Object (readonly)

Array[ Comment | EmbDoc ]

the comments attached to this node



5869
5870
5871
 
# File 'lib/syntax_tree/node.rb', line 5869

def comments
  @comments
end

#value ⇒ Object (readonly)

String

the opening declaration of the heredoc



5866
5867
5868
 
# File 'lib/syntax_tree/node.rb', line 5866

def value
  @value
end

Instance Method Details

#===(other) ⇒ Object 



5906
5907
5908
 
# File 'lib/syntax_tree/node.rb', line 5906

def ===(other)
  other.is_a?(HeredocBeg) && value === other.value
end

#accept(visitor) ⇒ Object 



5877
5878
5879
 
# File 'lib/syntax_tree/node.rb', line 5877

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

#child_nodes ⇒ Object Also known as: deconstruct 



5881
5882
5883
 
# File 'lib/syntax_tree/node.rb', line 5881

def child_nodes
  []
end

#copy(value: nil, location: nil) ⇒ Object 



5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
 
# File 'lib/syntax_tree/node.rb', line 5885

def copy(value: nil, location: nil)
  node =
    HeredocBeg.new(
      value: value || self.value,
      location: location || self.location
    )

  node.comments.concat(comments.map(&:copy))
  node
end

#deconstruct_keys(_keys) ⇒ Object 



5898
5899
5900
 
# File 'lib/syntax_tree/node.rb', line 5898

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

#format(q) ⇒ Object 



5902
5903
5904
 
# File 'lib/syntax_tree/node.rb', line 5902

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