Add RBS_WRITTEN_ANNOTATION prefix to multiline annotations

Author: vinistock

lib/spoom/rbs.rb

@@ -69,7 +69,20 @@ def initialize(string, location)
     end
 
     class Annotation < Comment; end
-    class Signature < Comment; end
+
+    class Signature < Comment
+      # Locations of the `#|` continuation comment lines that make up a multiline signature,
+      # in addition to the `#:` line tracked by `location`.
+      #: Array[Prism::Location]
+      attr_reader :continuation_locations
+
+      #: (String, Prism::Location, ?continuation_locations: Array[Prism::Location]) -> void
+      def initialize(string, location, continuation_locations: [])
+        super(string, location)
+        @continuation_locations = continuation_locations
+      end
+    end
+
     class TypeAlias < Comment; end
 
     module ExtractRBSComments
@@ -99,16 +112,18 @@ def node_rbs_comments(node)
           elsif string.start_with?("#: ")
             string = string.delete_prefix("#:").strip
             location = comment.location
+            continuation_locations = [] #: Array[Prism::Location]
 
             continuation_comments.reverse_each do |continuation_comment|
               string = "#{string}#{continuation_comment.slice.delete_prefix("#|")}"
               location = location.join(continuation_comment.location)
+              continuation_locations << continuation_comment.location
             end
             continuation_comments.clear
 
             next if string.start_with?("type ")
 
-            res.signatures.prepend(Signature.new(string, location))
+            res.signatures.prepend(Signature.new(string, location, continuation_locations:))
           elsif string.start_with?("#|")
             continuation_comments << comment
           end

lib/spoom/sorbet/translate/rbs_comments_to_sorbet_sigs/line_matching_translator.rb

@@ -16,6 +16,10 @@ class LineMatchingTranslator < BaseTranslator
           #: (Spoom::RBS::Signature) -> void
           def rewrite_discarded_overload(signature)
             @rewriter << Source::Insert.new(signature.location.start_offset + 1, " RBS_DISCARDED_OVERLOAD")
+
+            signature.continuation_locations.each do |location|
+              @rewriter << Source::Insert.new(location.start_offset + 1, " RBS_DISCARDED_OVERLOAD:")
+            end
           end
 
           # @override
@@ -51,6 +55,15 @@ def rewrite_type_params_signature(signature, type_params:)
               signature.location.start_offset + 1, # the `#:` prefix
               "# RBS_WRITTEN_ANNOTATION:",
             )
+
+            # Rewrite each continuation line `#| B]` into `# RBS_WRITTEN_ANNOTATION: B]`
+            signature.continuation_locations.each do |location|
+              @rewriter << Source::Replace.new(
+                location.start_offset,
+                location.start_offset + 1, # the `#|` continuation prefix
+                "# RBS_WRITTEN_ANNOTATION:",
+              )
+            end
           end
 
           # @override

rbi/spoom.rbi

@@ -2613,7 +2613,20 @@ module Spoom::RBS::ExtractRBSComments
   def node_rbs_comments(node); end
 end
 
-class Spoom::RBS::Signature < ::Spoom::RBS::Comment; end
+class Spoom::RBS::Signature < ::Spoom::RBS::Comment
+  sig do
+    params(
+      string: ::String,
+      location: ::Prism::Location,
+      continuation_locations: T::Array[::Prism::Location]
+    ).void
+  end
+  def initialize(string, location, continuation_locations: T.unsafe(nil)); end
+
+  sig { returns(T::Array[::Prism::Location]) }
+  def continuation_locations; end
+end
+
 class Spoom::RBS::TypeAlias < ::Spoom::RBS::Comment; end
 Spoom::SPOOM_PATH = T.let(T.unsafe(nil), String)
 module Spoom::Sorbet; end

test/spoom/sorbet/translate/rbs_comments_to_sorbet_sigs_test.rb

@@ -1050,6 +1050,63 @@ def bar(a, b); end
           )
         end
 
+        def test_translate_multiline_type_parameters
+          assert_rewrites_rbs(
+            from: <<~RUBY,
+              #: [A,
+              #| B]
+              class Foo
+              end
+            RUBY
+            to_pretty_format_for_humans: <<~RUBY,
+              class Foo
+                extend T::Generic
+
+                A = type_member
+                B = type_member
+              end
+            RUBY
+            to_line_matched_format_for_machines: <<~RUBY,
+              # RBS_WRITTEN_ANNOTATION: [A,
+              # RBS_WRITTEN_ANNOTATION: B]
+              class Foo; extend T::Generic; A = type_member; B = type_member
+              end
+            RUBY
+          )
+        end
+
+        def test_translate_last_multiline_overloads_marks_entire_discarded_signature
+          assert_rewrites_rbs(
+            from: <<~RUBY,
+              class Foo
+                #: (
+                #|   Integer,
+                #|   String
+                #| ) -> void
+                #: (String) -> void
+                def foo(x); end
+              end
+            RUBY
+            to_pretty_format_for_humans: <<~RUBY,
+              class Foo
+                sig { params(x: String).void }
+                def foo(x); end
+              end
+            RUBY
+            to_line_matched_format_for_machines: <<~RUBY,
+              class Foo
+                # RBS_DISCARDED_OVERLOAD: (
+                # RBS_DISCARDED_OVERLOAD:|   Integer,
+                # RBS_DISCARDED_OVERLOAD:|   String
+                # RBS_DISCARDED_OVERLOAD:| ) -> void
+                sig { params(x: String).void }
+                def foo(x); end
+              end
+            RUBY
+            overloads_strategy: :translate_last,
+          )
+        end
+
         def test_translate_overloads_raise
           contents = <<~RB
             class Foo