Class: SyntaxTree::Return

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

Overview

Return represents using the return keyword with arguments.

return value

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(arguments:, location:, comments: []) ⇒ Return

Returns a new instance of Return.



7837
7838
7839
7840
7841
 
# File 'lib/syntax_tree/node.rb', line 7837

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

Instance Attribute Details

#arguments ⇒ Object (readonly)

Args

the arguments being passed to the keyword



7832
7833
7834
 
# File 'lib/syntax_tree/node.rb', line 7832

def arguments
  @arguments
end

#comments ⇒ Object (readonly)

Array[ Comment | EmbDoc ]

the comments attached to this node



7835
7836
7837
 
# File 'lib/syntax_tree/node.rb', line 7835

def comments
  @comments
end

Instance Method Details

#accept(visitor) ⇒ Object 



7843
7844
7845
 
# File 'lib/syntax_tree/node.rb', line 7843

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

#child_nodes ⇒ Object Also known as: deconstruct 



7847
7848
7849
 
# File 'lib/syntax_tree/node.rb', line 7847

def child_nodes
  [arguments]
end

#deconstruct_keys(_keys) ⇒ Object 



7853
7854
7855
 
# File 'lib/syntax_tree/node.rb', line 7853

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

#format(q) ⇒ Object 



7857
7858
7859
 
# File 'lib/syntax_tree/node.rb', line 7857

def format(q)
  FlowControlFormatter.new("return", self).format(q)
end