Merge pull request #755 from Shopify/at-fix-abstract

Clear last_sigs when returning early on abstract

Author: Morriar

lib/spoom/sorbet/translate/sorbet_sigs_to_rbs_comments.rb

@@ -41,26 +41,25 @@ def visit_singleton_class_node(node)
         # @override
         #: (Prism::DefNode) -> void
         def visit_def_node(node)
-          return if @last_sigs.empty?
-          return if @last_sigs.any? { |_, sig| sig.is_abstract }
+          last_sigs = collect_last_sigs
+          return if last_sigs.empty?
+          return if last_sigs.any? { |_, sig| sig.is_abstract }
 
-          apply_member_annotations(@last_sigs)
+          apply_member_annotations(last_sigs)
 
           # Build the RBI::Method node so we can print the method signature as RBS.
           builder = RBI::Parser::TreeBuilder.new(@ruby_contents, comments: [], file: @file)
           builder.visit(node)
           rbi_node = builder.tree.nodes.first #: as RBI::Method
 
-          @last_sigs.each do |node, sig|
+          last_sigs.each do |node, sig|
             out = StringIO.new
             p = RBI::RBSPrinter.new(out: out, indent: node.location.start_column, positional_names: @positional_names)
             p.print("#: ")
             p.send(:print_method_sig, rbi_node, sig)
             p.print("\n")
             @rewriter << Source::Replace.new(node.location.start_offset, node.location.end_offset, out.string)
           end
-
-          @last_sigs.clear
         end
 
         # @override
@@ -155,25 +154,24 @@ def visit_attr(node)
             raise Error, "Expected attr_reader, attr_writer, or attr_accessor"
           end
 
-          return if @last_sigs.empty?
-          return if @last_sigs.any? { |_, sig| sig.is_abstract }
+          last_sigs = collect_last_sigs
+          return if last_sigs.empty?
+          return if last_sigs.any? { |_, sig| sig.is_abstract }
 
-          apply_member_annotations(@last_sigs)
+          apply_member_annotations(last_sigs)
 
           builder = RBI::Parser::TreeBuilder.new(@ruby_contents, comments: [], file: @file)
           builder.visit(node)
           rbi_node = builder.tree.nodes.first #: as RBI::Attr
 
-          @last_sigs.each do |node, sig|
+          last_sigs.each do |node, sig|
             out = StringIO.new
             p = RBI::RBSPrinter.new(out: out, indent: node.location.start_column, positional_names: @positional_names)
             p.print("#: ")
             p.print_attr_sig(rbi_node, sig)
             p.print("\n")
             @rewriter << Source::Replace.new(node.location.start_offset, node.location.end_offset, out.string)
           end
-
-          @last_sigs.clear
         end
 
         #: (Prism::CallNode node) -> void
@@ -336,6 +334,14 @@ def delete_extend_t_generics
 
           @extend_t_generics.clear
         end
+
+        # Collects the last signatures visited and clears the current list
+        #: -> Array[[Prism::CallNode, RBI::Sig]]
+        def collect_last_sigs
+          last_sigs = @last_sigs
+          @last_sigs = []
+          last_sigs
+        end
       end
     end
   end

rbi/spoom.rbi

@@ -2995,6 +2995,9 @@ class Spoom::Sorbet::Translate::SorbetSigsToRBSComments < ::Spoom::Sorbet::Trans
   sig { params(node: ::Prism::ConstantWriteNode).returns(::String) }
   def build_type_member_string(node); end
 
+  sig { returns(T::Array[[::Prism::CallNode, ::RBI::Sig]]) }
+  def collect_last_sigs; end
+
   sig { void }
   def delete_extend_t_generics; end
 

test/spoom/sorbet/translate/sorbet_sigs_to_rbs_comments_test.rb

@@ -76,11 +76,17 @@ def test_does_not_translate_to_rbs_abstract_methods
           contents = <<~RB
             sig { abstract.void }
             def foo; end
+
+            sig { void }
+            def bar; end
           RB
 
           assert_equal(<<~RBS, sorbet_sigs_to_rbs_comments(contents))
             sig { abstract.void }
             def foo; end
+
+            #: -> void
+            def bar; end
           RBS
         end