Class: Spoom::Deadcode::Remover::NodeContext

Inherits:
Object
  • Object
show all
Defined in:
lib/spoom/deadcode/remover.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(source, comments, node, nesting) ⇒ NodeContext

Returns a new instance of NodeContext.

Signature:

  • (String source, Hash[Integer, Prism::Comment] comments, Prism::Node node, Array[Prism::Node] nesting) -> void



480
481
482
483
484
485
 
# File 'lib/spoom/deadcode/remover.rb', line 480

def initialize(source, comments, node, nesting)
  @source = source
  @comments = comments
  @node = node
  @nesting = nesting
end

Instance Attribute Details

#comments ⇒ Object (readonly)

Signature:

  • Hash[Integer, Prism::Comment]



471
472
473
 
# File 'lib/spoom/deadcode/remover.rb', line 471

def comments
  @comments
end

#nesting ⇒ Object

Signature:

  • Array[Prism::Node]



477
478
479
 
# File 'lib/spoom/deadcode/remover.rb', line 477

def nesting
  @nesting
end

#node ⇒ Object (readonly)

Signature:

  • Prism::Node



474
475
476
 
# File 'lib/spoom/deadcode/remover.rb', line 474

def node
  @node
end

Instance Method Details

#attached_comments(node) ⇒ Object

Signature:

  • (Prism::Node node) -> Array[Prism::Comment]



594
595
596
597
598
599
600
601
602
603
604
605
606
 
# File 'lib/spoom/deadcode/remover.rb', line 594

def attached_comments(node)
  comments = [] #: Array[Prism::Comment]

  start_line = node.location.start_line - 1
  start_line.downto(1) do |line|
    comment = @comments[line]
    break unless comment

    comments << comment
  end

  comments.reverse
end

#attached_sig ⇒ Object

Signature:

  • -> Prism::CallNode?



622
623
624
625
626
627
628
629
630
631
632
633
634
 
# File 'lib/spoom/deadcode/remover.rb', line 622

def attached_sig
  previous_nodes.reverse_each do |node|
    if node.is_a?(Prism::Comment)
      next
    elsif sorbet_signature?(node)
      return T.cast(node, Prism::CallNode)
    else
      break
    end
  end

  nil
end

#attached_sigs ⇒ Object

Signature:

  • -> Array[Prism::Node]



609
610
611
612
613
614
615
616
617
618
619
 
# File 'lib/spoom/deadcode/remover.rb', line 609

def attached_sigs
  nodes = [] #: Array[Prism::Node]

  previous_nodes.reverse_each do |prev_node|
    break unless sorbet_signature?(prev_node)

    nodes << prev_node
  end

  nodes.reverse
end

#comments_between_lines(start_line, end_line) ⇒ Object

Signature:

  • (Integer start_line, Integer end_line) -> Array[Prism::Comment]



582
583
584
585
586
587
588
589
590
591
 
# File 'lib/spoom/deadcode/remover.rb', line 582

def comments_between_lines(start_line, end_line)
  comments = [] #: Array[Prism::Comment]

  (start_line + 1).upto(end_line - 1) do |line|
    comment = @comments[line]
    comments << comment if comment
  end

  comments
end

#next_node ⇒ Object

Signature:

  • -> Prism::Node?



532
533
534
 
# File 'lib/spoom/deadcode/remover.rb', line 532

def next_node
  next_nodes.first
end

#next_nodes ⇒ Object

Signature:

  • -> Array[Prism::Node]

Raises:



521
522
523
524
525
526
527
528
529
 
# File 'lib/spoom/deadcode/remover.rb', line 521

def next_nodes
  parent = parent_node
  child_nodes = parent.child_nodes.compact

  index = child_nodes.index(node)
  raise Error, "Node #{@node} not found in nesting node #{parent}" unless index

  T.must(child_nodes.compact[(index + 1)..-1])
end

#parent_context ⇒ Object

Signature:

  • -> NodeContext

Raises:



496
497
498
499
500
501
502
 
# File 'lib/spoom/deadcode/remover.rb', line 496

def parent_context
  nesting = @nesting.dup
  parent = nesting.pop
  raise Error, "No parent context for node #{@node}" unless parent

  NodeContext.new(@source, @comments, parent, nesting)
end

#parent_node ⇒ Object

Signature:

  • -> Prism::Node

Raises:



488
489
490
491
492
493
 
# File 'lib/spoom/deadcode/remover.rb', line 488

def parent_node
  parent = @nesting.last
  raise Error, "No parent for node #{node}" unless parent

  parent
end

#previous_node ⇒ Object

Signature:

  • -> Prism::Node?



516
517
518
 
# File 'lib/spoom/deadcode/remover.rb', line 516

def previous_node
  previous_nodes.last
end

#previous_nodes ⇒ Object

Signature:

  • -> Array[Prism::Node]

Raises:



505
506
507
508
509
510
511
512
513
 
# File 'lib/spoom/deadcode/remover.rb', line 505

def previous_nodes
  parent = parent_node
  child_nodes = parent.child_nodes.compact

  index = child_nodes.index(@node)
  raise Error, "Node #{@node} not found in parent #{parent}" unless index

  T.must(child_nodes[0...index])
end

#sclass_context ⇒ Object

Signature:

  • -> NodeContext?



537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
 
# File 'lib/spoom/deadcode/remover.rb', line 537

def sclass_context
  sclass = nil #: Prism::SingletonClassNode?

  nesting = @nesting.dup
  until nesting.empty? || sclass
    node = nesting.pop
    next unless node.is_a?(Prism::SingletonClassNode)

    sclass = node
  end

  return unless sclass.is_a?(Prism::SingletonClassNode)

  body = sclass.body
  return NodeContext.new(@source, @comments, sclass, nesting) unless body.is_a?(Prism::StatementsNode)

  nodes = body.child_nodes.reject do |node|
    sorbet_signature?(node) || sorbet_extend_sig?(node)
  end

  if nodes.size <= 1
    return NodeContext.new(@source, @comments, sclass, nesting)
  end

  nil
end

#sorbet_extend_sig?(node) ⇒ Boolean

Signature:

  • (Prism::Node? node) -> bool

Returns:

  • (Boolean) 


570
571
572
573
574
575
576
577
578
579
 
# File 'lib/spoom/deadcode/remover.rb', line 570

def sorbet_extend_sig?(node)
  return false unless node.is_a?(Prism::CallNode)
  return false unless node.name == :extend

  args = node.arguments
  return false unless args
  return false unless args.arguments.size == 1

  args.arguments.first&.slice == "T::Sig"
end

#sorbet_signature?(node) ⇒ Boolean

Signature:

  • (Prism::Node? node) -> bool

Returns:

  • (Boolean) 


565
566
567
 
# File 'lib/spoom/deadcode/remover.rb', line 565

def sorbet_signature?(node)
  node.is_a?(Prism::CallNode) && node.name == :sig
end