Class: SyntaxTree::ExcessedComma

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

Overview

ExcessedComma represents a trailing comma in a list of block parameters. It changes the block parameters such that they will destructure.

[[1, 2, 3], [2, 3, 4]].each do |first, second,|
end

In the above example, an ExcessedComma node would appear in the third position of the Params node that is used to declare that block. The third position typically represents a rest-type parameter, but in this case is used to indicate that a trailing comma was used.

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:) ⇒ ExcessedComma

Returns a new instance of ExcessedComma.



5246
5247
5248
5249
5250
 
# File 'lib/syntax_tree/node.rb', line 5246

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



5244
5245
5246
 
# File 'lib/syntax_tree/node.rb', line 5244

def comments
  @comments
end

#value ⇒ Object (readonly)

String

the comma



5241
5242
5243
 
# File 'lib/syntax_tree/node.rb', line 5241

def value
  @value
end

Instance Method Details

#===(other) ⇒ Object 



5281
5282
5283
 
# File 'lib/syntax_tree/node.rb', line 5281

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

#accept(visitor) ⇒ Object 



5252
5253
5254
 
# File 'lib/syntax_tree/node.rb', line 5252

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

#child_nodes ⇒ Object Also known as: deconstruct 



5256
5257
5258
 
# File 'lib/syntax_tree/node.rb', line 5256

def child_nodes
  []
end

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



5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
 
# File 'lib/syntax_tree/node.rb', line 5260

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

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

#deconstruct_keys(_keys) ⇒ Object 



5273
5274
5275
 
# File 'lib/syntax_tree/node.rb', line 5273

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

#format(q) ⇒ Object 



5277
5278
5279
 
# File 'lib/syntax_tree/node.rb', line 5277

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