Merge pull request #761 from Shopify/at-rbs-multiline

Translate to RBS/RBI using multiline syntax when over --max-line-length

Author: Morriar

Gemfile.lock

@@ -52,7 +52,7 @@ GEM
     racc (1.8.1)
     rainbow (3.1.1)
     rake (13.3.0)
-    rbi (0.3.5)
+    rbi (0.3.6)
       prism (~> 1.0)
       rbs (>= 3.4.4)
     rbs (4.0.0.dev.4)

lib/spoom/cli/srb/sigs.rb

@@ -16,15 +16,26 @@ class Sigs < Thor
           desc: "Use positional names when translating from RBI to RBS",
           default: true
         option :include_rbi_files, type: :boolean, desc: "Include RBI files", default: false
+        option :max_line_length, type: :numeric, desc: "Max line length (pass 0 to disable)", default: 120
         def translate(*paths)
           from = options[:from]
           to = options[:to]
+          max_line_length = options[:max_line_length]
 
           if from == to
             say_error("Can't translate signatures from `#{from}` to `#{to}`")
             exit(1)
           end
 
+          if max_line_length.nil? || max_line_length.zero?
+            max_line_length = nil
+          elsif max_line_length.negative?
+            say_error("--max-line-length can't be negative")
+            exit(1)
+          else
+            max_line_length = max_line_length.to_i
+          end
+
           files = collect_files(paths, include_rbi_files: options[:include_rbi_files])
 
           say("Translating signatures from `#{from}` to `#{to}` " \
@@ -33,11 +44,20 @@ def translate(*paths)
           case from
           when "rbi"
             transformed_files = transform_files(files) do |file, contents|
-              Spoom::Sorbet::Translate.sorbet_sigs_to_rbs_comments(contents, file: file, positional_names: options[:positional_names])
+              Spoom::Sorbet::Translate.sorbet_sigs_to_rbs_comments(
+                contents,
+                file: file,
+                positional_names: options[:positional_names],
+                max_line_length: max_line_length,
+              )
             end
           when "rbs"
             transformed_files = transform_files(files) do |file, contents|
-              Spoom::Sorbet::Translate.rbs_comments_to_sorbet_sigs(contents, file: file)
+              Spoom::Sorbet::Translate.rbs_comments_to_sorbet_sigs(
+                contents,
+                file: file,
+                max_line_length: max_line_length,
+              )
             end
           end
 

lib/spoom/sorbet/translate.rb

@@ -25,16 +25,16 @@ def strip_sorbet_sigs(ruby_contents, file:)
 
         # Converts all `sig` nodes to RBS comments in the given Ruby code.
         # It also handles type members and class annotations.
-        #: (String ruby_contents, file: String, ?positional_names: bool) -> String
-        def sorbet_sigs_to_rbs_comments(ruby_contents, file:, positional_names: true)
-          SorbetSigsToRBSComments.new(ruby_contents, file: file, positional_names: positional_names).rewrite
+        #: (String ruby_contents, file: String, ?positional_names: bool, ?max_line_length: Integer?) -> String
+        def sorbet_sigs_to_rbs_comments(ruby_contents, file:, positional_names: true, max_line_length: nil)
+          SorbetSigsToRBSComments.new(ruby_contents, file: file, positional_names: positional_names, max_line_length: max_line_length).rewrite
         end
 
         # Converts all the RBS comments in the given Ruby code to `sig` nodes.
         # It also handles type members and class annotations.
-        #: (String ruby_contents, file: String) -> String
-        def rbs_comments_to_sorbet_sigs(ruby_contents, file:)
-          RBSCommentsToSorbetSigs.new(ruby_contents, file: file).rewrite
+        #: (String ruby_contents, file: String, ?max_line_length: Integer?) -> String
+        def rbs_comments_to_sorbet_sigs(ruby_contents, file:, max_line_length: nil)
+          RBSCommentsToSorbetSigs.new(ruby_contents, file: file, max_line_length: max_line_length).rewrite
         end
 
         # Converts all `T.let` and `T.cast` nodes to RBS comments in the given Ruby code.

lib/spoom/sorbet/translate/rbs_comments_to_sorbet_sigs.rb

@@ -7,6 +7,13 @@ module Translate
       class RBSCommentsToSorbetSigs < Translator
         include Spoom::RBS::ExtractRBSComments
 
+        #: (String, file: String, ?max_line_length: Integer?) -> void
+        def initialize(ruby_contents, file:, max_line_length: nil)
+          super(ruby_contents, file: file)
+
+          @max_line_length = max_line_length
+        end
+
         # @override
         #: (Prism::ClassNode node) -> void
         def visit_class_node(node)
@@ -53,7 +60,7 @@ def visit_def_node(node)
             @rewriter << Source::Replace.new(
               signature.location.start_offset,
               signature.location.end_offset,
-              sig.string,
+              sig.string(max_line_length: @max_line_length),
             )
           rescue ::RBS::ParsingError, ::RBI::Error
             # Ignore signatures with errors
@@ -104,7 +111,7 @@ def visit_attr(node)
             @rewriter << Source::Replace.new(
               signature.location.start_offset,
               signature.location.end_offset,
-              sig.string,
+              sig.string(max_line_length: @max_line_length),
             )
           rescue ::RBS::ParsingError, ::RBI::Error
             # Ignore signatures with errors

lib/spoom/sorbet/translate/sorbet_sigs_to_rbs_comments.rb

@@ -7,8 +7,8 @@ module Translate
       # Converts all `sig` nodes to RBS comments in the given Ruby code.
       # It also handles type members and class annotations.
       class SorbetSigsToRBSComments < Translator
-        #: (String, file: String, positional_names: bool) -> void
-        def initialize(ruby_contents, file:, positional_names:)
+        #: (String, file: String, positional_names: bool, ?max_line_length: Integer?) -> void
+        def initialize(ruby_contents, file:, positional_names:, max_line_length: nil)
           super(ruby_contents, file: file)
 
           @positional_names = positional_names #: bool
@@ -18,6 +18,7 @@ def initialize(ruby_contents, file:, positional_names:)
           @extend_t_helpers = [] #: Array[Prism::CallNode]
           @extend_t_generics = [] #: Array[Prism::CallNode]
           @seen_mixes_in_class_methods = false #: bool
+          @max_line_length = max_line_length #: Integer?
         end
 
         # @override
@@ -53,12 +54,10 @@ def visit_def_node(node)
           rbi_node = builder.tree.nodes.first #: as RBI::Method
 
           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)
+            out = rbs_print(node.location.start_column) do |printer|
+              printer.print_method_sig(rbi_node, sig)
+            end
+            @rewriter << Source::Replace.new(node.location.start_offset, node.location.end_offset, out)
           end
         end
 
@@ -165,12 +164,10 @@ def visit_attr(node)
           rbi_node = builder.tree.nodes.first #: as RBI::Attr
 
           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)
+            out = rbs_print(node.location.start_column) do |printer|
+              printer.print_attr_sig(rbi_node, sig)
+            end
+            @rewriter << Source::Replace.new(node.location.start_offset, node.location.end_offset, out)
           end
         end
 
@@ -342,6 +339,22 @@ def collect_last_sigs
           @last_sigs = []
           last_sigs
         end
+
+        #: (Integer) { (RBI::RBSPrinter) -> void } -> String
+        def rbs_print(indent, &block)
+          out = StringIO.new
+          p = RBI::RBSPrinter.new(out: out, positional_names: @positional_names, max_line_length: @max_line_length)
+          block.call(p)
+          string = out.string
+
+          string.lines.map.with_index do |line, index|
+            if index == 0
+              "#: #{line}"
+            else
+              "#{" " * indent}#| #{line}"
+            end
+          end.join + "\n"
+        end
       end
     end
   end

rbi/spoom.rbi

@@ -2839,14 +2839,21 @@ Spoom::Sorbet::Sigils::VALID_STRICTNESS = T.let(T.unsafe(nil), Array)
 
 module Spoom::Sorbet::Translate
   class << self
-    sig { params(ruby_contents: ::String, file: ::String).returns(::String) }
-    def rbs_comments_to_sorbet_sigs(ruby_contents, file:); end
+    sig { params(ruby_contents: ::String, file: ::String, max_line_length: T.nilable(::Integer)).returns(::String) }
+    def rbs_comments_to_sorbet_sigs(ruby_contents, file:, max_line_length: T.unsafe(nil)); end
 
     sig { params(ruby_contents: ::String, file: ::String).returns(::String) }
     def sorbet_assertions_to_rbs_comments(ruby_contents, file:); end
 
-    sig { params(ruby_contents: ::String, file: ::String, positional_names: T::Boolean).returns(::String) }
-    def sorbet_sigs_to_rbs_comments(ruby_contents, file:, positional_names: T.unsafe(nil)); end
+    sig do
+      params(
+        ruby_contents: ::String,
+        file: ::String,
+        positional_names: T::Boolean,
+        max_line_length: T.nilable(::Integer)
+      ).returns(::String)
+    end
+    def sorbet_sigs_to_rbs_comments(ruby_contents, file:, positional_names: T.unsafe(nil), max_line_length: T.unsafe(nil)); end
 
     sig { params(ruby_contents: ::String, file: ::String).returns(::String) }
     def strip_sorbet_sigs(ruby_contents, file:); end
@@ -2858,6 +2865,9 @@ class Spoom::Sorbet::Translate::Error < ::Spoom::Error; end
 class Spoom::Sorbet::Translate::RBSCommentsToSorbetSigs < ::Spoom::Sorbet::Translate::Translator
   include ::Spoom::RBS::ExtractRBSComments
 
+  sig { params(ruby_contents: ::String, file: ::String, max_line_length: T.nilable(::Integer)).void }
+  def initialize(ruby_contents, file:, max_line_length: T.unsafe(nil)); end
+
   sig { override.params(node: ::Prism::CallNode).void }
   def visit_call_node(node); end
 
@@ -2924,8 +2934,15 @@ end
 Spoom::Sorbet::Translate::SorbetAssertionsToRBSComments::LINE_BREAK = T.let(T.unsafe(nil), Integer)
 
 class Spoom::Sorbet::Translate::SorbetSigsToRBSComments < ::Spoom::Sorbet::Translate::Translator
-  sig { params(ruby_contents: ::String, file: ::String, positional_names: T::Boolean).void }
-  def initialize(ruby_contents, file:, positional_names:); end
+  sig do
+    params(
+      ruby_contents: ::String,
+      file: ::String,
+      positional_names: T::Boolean,
+      max_line_length: T.nilable(::Integer)
+    ).void
+  end
+  def initialize(ruby_contents, file:, positional_names:, max_line_length: T.unsafe(nil)); end
 
   sig { override.params(node: ::Prism::CallNode).void }
   def visit_call_node(node); end
@@ -2970,6 +2987,9 @@ class Spoom::Sorbet::Translate::SorbetSigsToRBSComments < ::Spoom::Sorbet::Trans
   sig { void }
   def delete_extend_t_helpers; end
 
+  sig { params(indent: ::Integer, block: T.proc.params(arg0: ::RBI::RBSPrinter).void).returns(::String) }
+  def rbs_print(indent, &block); end
+
   sig { params(node: ::Prism::CallNode).void }
   def visit_attr(node); end