Class: SyntaxTree::HeredocEnd

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

Overview

HeredocEnd represents the closing declaration of a heredoc.

<<~DOC
  contents
DOC

In the example above the HeredocEnd node represents the closing 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:) ⇒ HeredocEnd

Returns a new instance of HeredocEnd.



5962
5963
5964
5965
5966
 
# File 'lib/syntax_tree/node.rb', line 5962

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



5960
5961
5962
 
# File 'lib/syntax_tree/node.rb', line 5960

def comments
  @comments
end

#value ⇒ Object (readonly)

String

the closing declaration of the heredoc



5957
5958
5959
 
# File 'lib/syntax_tree/node.rb', line 5957

def value
  @value
end

Instance Method Details

#===(other) ⇒ Object 



5997
5998
5999
 
# File 'lib/syntax_tree/node.rb', line 5997

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

#accept(visitor) ⇒ Object 



5968
5969
5970
 
# File 'lib/syntax_tree/node.rb', line 5968

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

#child_nodes ⇒ Object Also known as: deconstruct 



5972
5973
5974
 
# File 'lib/syntax_tree/node.rb', line 5972

def child_nodes
  []
end

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



5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
 
# File 'lib/syntax_tree/node.rb', line 5976

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

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

#deconstruct_keys(_keys) ⇒ Object 



5989
5990
5991
 
# File 'lib/syntax_tree/node.rb', line 5989

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

#format(q) ⇒ Object 



5993
5994
5995
 
# File 'lib/syntax_tree/node.rb', line 5993

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