Class: SyntaxTree::FndPtn

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

Overview

FndPtn represents matching against a pattern where you find a pattern in an array using the Ruby 3.0+ pattern matching syntax.

case value
in [*, 7, *]
end

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(constant:, left:, values:, right:, location:) ⇒ FndPtn

Returns a new instance of FndPtn.



5413
5414
5415
5416
5417
5418
5419
5420
 
# File 'lib/syntax_tree/node.rb', line 5413

def initialize(constant:, left:, values:, right:, location:)
  @constant = constant
  @left = left
  @values = values
  @right = right
  @location = location
  @comments = []
end

Instance Attribute Details

#comments ⇒ Object (readonly)

Array[ Comment | EmbDoc ]

the comments attached to this node



5411
5412
5413
 
# File 'lib/syntax_tree/node.rb', line 5411

def comments
  @comments
end

#constant ⇒ Object (readonly)

nil | Node

the optional constant wrapper



5398
5399
5400
 
# File 'lib/syntax_tree/node.rb', line 5398

def constant
  @constant
end

#left ⇒ Object (readonly)

VarField

the splat on the left-hand side



5401
5402
5403
 
# File 'lib/syntax_tree/node.rb', line 5401

def left
  @left
end

#right ⇒ Object (readonly)

VarField

the splat on the right-hand side



5408
5409
5410
 
# File 'lib/syntax_tree/node.rb', line 5408

def right
  @right
end

#values ⇒ Object (readonly)

Array[ Node ]

the list of positional expressions in the pattern that

are being matched



5405
5406
5407
 
# File 'lib/syntax_tree/node.rb', line 5405

def values
  @values
end

Instance Method Details

#===(other) ⇒ Object 



5482
5483
5484
5485
5486
 
# File 'lib/syntax_tree/node.rb', line 5482

def ===(other)
  other.is_a?(FndPtn) && constant === other.constant &&
    left === other.left && ArrayMatch.call(values, other.values) &&
    right === other.right
end

#accept(visitor) ⇒ Object 



5422
5423
5424
 
# File 'lib/syntax_tree/node.rb', line 5422

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

#child_nodes ⇒ Object Also known as: deconstruct 



5426
5427
5428
 
# File 'lib/syntax_tree/node.rb', line 5426

def child_nodes
  [constant, left, *values, right]
end

#copy(constant: nil, left: nil, values: nil, right: nil, location: nil) ⇒ Object 



5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
 
# File 'lib/syntax_tree/node.rb', line 5430

def copy(constant: nil, left: nil, values: nil, right: nil, location: nil)
  node =
    FndPtn.new(
      constant: constant || self.constant,
      left: left || self.left,
      values: values || self.values,
      right: right || self.right,
      location: location || self.location
    )

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

#deconstruct_keys(_keys) ⇒ Object 



5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
 
# File 'lib/syntax_tree/node.rb', line 5446

def deconstruct_keys(_keys)
  {
    constant: constant,
    left: left,
    values: values,
    right: right,
    location: location,
    comments: comments
  }
end

#format(q) ⇒ Object 



5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
 
# File 'lib/syntax_tree/node.rb', line 5457

def format(q)
  q.format(constant) if constant

  q.group do
    q.text("[")

    q.indent do
      q.breakable_empty

      q.text("*")
      q.format(left)
      q.comma_breakable

      q.seplist(values) { |value| q.format(value) }
      q.comma_breakable

      q.text("*")
      q.format(right)
    end

    q.breakable_empty
    q.text("]")
  end
end