spoom 1.8.2 → 1.8.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9bf4851363229baee651a7eba14d9f45464db177f094f3b4da791a8b06b82d39
-  data.tar.gz: 6aae091a64fb4cb9a55cea3b82307bd413e544c424bd160599eee48cfeefa1e0
+  metadata.gz: 6f138cb37a9cdcc10a7195440a948f6f9a3d2225ac032e2179823cf327b3d803
+  data.tar.gz: 9d8b55599e6de489d29362353f9ac3802b12ad85b6e9e34b40c09b07127ace47
 SHA512:
-  metadata.gz: ac5bbdffd2be7bb1c8c795eff3e8c332212fd19f033805076af2eee3c11d39ac1d614927dda68997498ed2dc96d929b71c865b7b2f5babbf52283085a807f1c9
-  data.tar.gz: 86d82cbeb9b56c7d4046c474e1880fb25c3dd32522a88f39fd3c0bb697b81d17641a4a5a7ac1603bcf319f18d513d429bbaea0ad1653cd29433ad51b0c9da195
+  metadata.gz: 708cb8b80b385e27c7d5a3e9cc05fbc475df994977a3cbf3ef4a1ea2cf592c91376bf9f1000aa7991ed0c154bb0e3ecc5120bd5ab01c94ca6e20a9a1bac98322
+  data.tar.gz: 262a4f6b42009e39c91a6e312ed54aba0056e6dd71d5ce136448c4f1343ee1037159a13ebb77d6f68113d64db7ebc3de61bad289440f0fa8b5efcca5e3444ee6

data/lib/spoom/cli/srb/bump.rb

@@ -3,6 +3,8 @@
 
 require "find"
 require "open3"
+require "tempfile"
+require "yaml"
 
 module Spoom
   module Cli
@@ -72,6 +74,11 @@ module Spoom
             exit(1)
           end
 
+          unless context.sorbet_config.typed_overrides.empty?
+            say_error("Cannot run `spoom bump` on a project that already uses Sorbet's `--typed-override` option")
+            exit(1)
+          end
+
           say("Checking files...")
 
           files_to_bump = context.srb_files_with_strictness(from, include_rbis: false)
@@ -90,18 +97,18 @@ module Spoom
             exit(0)
           end
 
-          Sorbet::Sigils.change_sigil_in_files(files_to_bump, to)
-
           if force
+            Sorbet::Sigils.change_sigil_in_files(files_to_bump, to) unless dry
             print_changes(files_to_bump, command: cmd, from: from, to: to, dry: dry, path: exec_path)
-            undo_changes(files_to_bump, from) if dry
             exit(files_to_bump.empty?)
           end
 
           error_url_base = Spoom::Sorbet::Errors::DEFAULT_ERROR_URL_BASE
+          typed_override_file = create_typed_override_file(context, files_to_bump, to)
           result = begin
             T.unsafe(context).srb_tc(
               *options[:sorbet_options].split(" "),
+              "--typed-override=#{T.must(typed_override_file.path)}",
               "--error-url-base=#{error_url_base}",
               capture_err: true,
               sorbet_bin: options[:sorbet],
@@ -114,7 +121,6 @@ module Spoom
               It means one of the file bumped to `typed: #{to}` made Sorbet crash.
               Run `spoom bump -f` locally followed by `bundle exec srb tc` to investigate the problem.
             ERR
-            undo_changes(files_to_bump, from)
             exit(error.result.exit_code)
           rescue Spoom::Sorbet::Error::Killed => error
             say_error(<<~ERR, status: nil)
@@ -123,13 +129,18 @@ module Spoom
               It means Sorbet was killed while executing. Changes to files have not been applied.
               Re-run `spoom bump` to try again.
             ERR
-            undo_changes(files_to_bump, from)
             exit(error.result.exit_code)
+          ensure
+            typed_override_file.close!
           end
 
           if result.status
+            parse_result = Sorbet::Errors::Parser.parse_result(result.err, error_url_base: error_url_base)
+            parse_result.warnings.each do |warning|
+              say_error(warning, status: nil, nl: false)
+            end
+            Sorbet::Sigils.change_sigil_in_files(files_to_bump, to) unless dry
             print_changes(files_to_bump, command: cmd, from: from, to: to, dry: dry, path: exec_path)
-            undo_changes(files_to_bump, from) if dry
             exit(files_to_bump.empty?)
           end
 
@@ -137,11 +148,14 @@ module Spoom
             # Sorbet will return exit code 100 if there are type checking errors.
             # If Sorbet returned something else, it means it didn't terminate normally.
             say_error(result.err, status: nil, nl: false)
-            undo_changes(files_to_bump, from)
             exit(1)
           end
 
-          errors = Sorbet::Errors::Parser.parse_string(result.err, error_url_base: error_url_base)
+          parse_result = Sorbet::Errors::Parser.parse_result(result.err, error_url_base: error_url_base)
+          parse_result.warnings.each do |warning|
+            say_error(warning, status: nil, nl: false)
+          end
+          errors = parse_result.errors
 
           all_files = errors.flat_map do |err|
             [err.file, *err.files_from_error_sections]
@@ -156,13 +170,11 @@ module Spoom
             path
           end.compact.uniq
 
-          undo_changes(files_with_errors, from)
-
           say("Found #{errors.length} type checking error#{"s" if errors.length > 1}") if options[:count_errors]
 
           files_changed = files_to_bump - files_with_errors
+          Sorbet::Sigils.change_sigil_in_files(files_changed, to) unless dry
           print_changes(files_changed, command: cmd, from: from, to: to, dry: dry, path: exec_path)
-          undo_changes(files_to_bump, from) if dry
           exit(files_changed.empty?)
         end
 
@@ -189,8 +201,16 @@ module Spoom
             end
           end
 
-          def undo_changes(files, from_strictness)
-            Sorbet::Sigils.change_sigil_in_files(files, from_strictness)
+          #: (Spoom::Context context, Array[String] files, String strictness) -> Tempfile
+          def create_typed_override_file(context, files, strictness)
+            relative_paths = files.map do |file|
+              relative_path = file.delete_prefix("#{context.absolute_path}/")
+              "./#{relative_path}"
+            end
+            typed_override_file = Tempfile.new(["spoom-typed-override", ".yml"])
+            typed_override_file.write(YAML.dump({ strictness => relative_paths }))
+            typed_override_file.flush
+            typed_override_file
           end
         end
       end

data/lib/spoom/cli/srb/sigs.rb

@@ -17,6 +17,10 @@ module Spoom
           aliases: :p,
           desc: "Use positional names when translating from RBI to RBS",
           default: true
+        option :preserve_multiline_signatures,
+          type: :boolean,
+          desc: "Preserve multiline sig formatting 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
         option :translate_generics, type: :boolean, desc: "Translate generics", default: false
@@ -53,6 +57,7 @@ module Spoom
                 contents,
                 file: file,
                 positional_names: options[:positional_names],
+                preserve_multiline_signatures: options[:preserve_multiline_signatures],
                 max_line_length: max_line_length,
                 translate_generics: options[:translate_generics],
                 translate_helpers: options[:translate_helpers],

data/lib/spoom/cli/srb/tc.rb

@@ -73,7 +73,11 @@ module Spoom
             exit(1)
           end
 
-          errors = Spoom::Sorbet::Errors::Parser.parse_string(result.err, error_url_base: error_url_base)
+          parse_result = Spoom::Sorbet::Errors::Parser.parse_result(result.err, error_url_base: error_url_base)
+          parse_result.warnings.each do |warning|
+            say_error(warning, status: nil, nl: false)
+          end
+          errors = parse_result.errors
           errors_count = errors.size
 
           errors = errors.select { |e| e.code == code } if code

data/lib/spoom/sorbet/config.rb

@@ -27,7 +27,7 @@ module Spoom
       DEFAULT_ALLOWED_EXTENSIONS = [".rb", ".rbi"].freeze #: Array[String]
 
       #: Array[String]
-      attr_accessor :paths, :ignore, :allowed_extensions
+      attr_accessor :paths, :ignore, :allowed_extensions, :typed_overrides
 
       #: bool
       attr_accessor :no_stdlib
@@ -37,6 +37,7 @@ module Spoom
         @paths = [] #: Array[String]
         @ignore = [] #: Array[String]
         @allowed_extensions = [] #: Array[String]
+        @typed_overrides = [] #: Array[String]
         @no_stdlib = false #: bool
       end
 
@@ -46,6 +47,7 @@ module Spoom
         @paths = @paths.dup
         @ignore = @ignore.dup
         @allowed_extensions = @allowed_extensions.dup
+        @typed_overrides = @typed_overrides.dup
       end
 
       # Returns self as a string of options that can be passed to Sorbet
@@ -66,6 +68,7 @@ module Spoom
         opts.concat(paths.map { |p| "'#{p}'" })
         opts.concat(ignore.map { |p| "--ignore '#{p}'" })
         opts.concat(allowed_extensions.map { |ext| "--allowed-extension '#{ext}'" })
+        opts.concat(typed_overrides.map { |path| "--typed-override '#{path}'" })
         opts << "--no-stdlib" if @no_stdlib
         opts.join(" ")
       end
@@ -95,6 +98,12 @@ module Spoom
             when /^--ignore=/
               config.ignore << parse_option(line)
               next
+            when /^--typed-override$/
+              state = :typed_override
+              next
+            when /^--typed-override=/
+              config.typed_overrides << parse_option(line)
+              next
             when /^--file$/
               next
             when /^--file=/
@@ -124,6 +133,8 @@ module Spoom
                 config.ignore << line
               when :extension
                 config.allowed_extensions << line
+              when :typed_override
+                config.typed_overrides << line
               when :skip
                 # nothing
               else

data/lib/spoom/sorbet/errors.rb

@@ -56,22 +56,35 @@ module Spoom
         ] #: Array[String]
 
         class << self
+          # Used when only Sorbet errors are needed and leading stderr warnings can be ignored.
           #: (String output, ?error_url_base: String) -> Array[Error]
           def parse_string(output, error_url_base: DEFAULT_ERROR_URL_BASE)
+            parse_result(output, error_url_base: error_url_base).errors
+          end
+
+          # Used when callers need both parsed Sorbet errors and leading stderr warnings.
+          #: (String output, ?error_url_base: String) -> ParseResult
+          def parse_result(output, error_url_base: DEFAULT_ERROR_URL_BASE)
             parser = Spoom::Sorbet::Errors::Parser.new(error_url_base: error_url_base)
-            parser.parse(output)
+            parser.parse_result(output)
           end
         end
 
         #: (?error_url_base: String) -> void
         def initialize(error_url_base: DEFAULT_ERROR_URL_BASE)
           @errors = [] #: Array[Error]
+          @warnings = [] #: Array[String]
           @error_line_match_regex = error_line_match_regexp(error_url_base) #: Regexp
           @current_error = nil #: Error?
         end
 
         #: (String output) -> Array[Error]
         def parse(output)
+          parse_result(output).errors
+        end
+
+        #: (String output) -> ParseResult
+        def parse_result(output)
           output.each_line do |line|
             break if /^No errors! Great job\./.match?(line)
             break if /^Errors: /.match?(line)
@@ -85,10 +98,14 @@ module Spoom
               next
             end
 
-            append_error(line) if @current_error
+            if @current_error
+              append_error(line)
+            else
+              append_warning(line)
+            end
           end
           close_error if @current_error
-          @errors
+          ParseResult.new(@errors, @warnings)
         end
 
         private
@@ -144,6 +161,11 @@ module Spoom
           end
           @current_error.more << line
         end
+
+        #: (String warning) -> void
+        def append_warning(warning)
+          @warnings << warning
+        end
       end
 
       class Error
@@ -214,6 +236,20 @@ module Spoom
           testcase_element
         end
       end
+
+      class ParseResult
+        #: Array[Error]
+        attr_reader :errors
+
+        #: Array[String]
+        attr_reader :warnings
+
+        #: (Array[Error] errors, Array[String] warnings) -> void
+        def initialize(errors, warnings)
+          @errors = errors
+          @warnings = warnings
+        end
+      end
     end
   end
 end

data/lib/spoom/sorbet/translate/sorbet_sigs_to_rbs_comments.rb

@@ -11,6 +11,7 @@ module Spoom
         #|   String,
         #|   file: String,
         #|   positional_names: bool,
+        #|   ?preserve_multiline_signatures: bool,
         #|   ?max_line_length: Integer?,
         #|   ?translate_generics: bool,
         #|   ?translate_helpers: bool,
@@ -20,6 +21,7 @@ module Spoom
           ruby_contents,
           file:,
           positional_names:,
+          preserve_multiline_signatures: true,
           max_line_length: nil,
           translate_generics: true,
           translate_helpers: true,
@@ -34,6 +36,8 @@ module Spoom
           @extend_t_helpers = [] #: Array[Prism::CallNode]
           @extend_t_generics = [] #: Array[Prism::CallNode]
           @seen_mixes_in_class_methods = false #: bool
+
+          @preserve_multiline_signatures = preserve_multiline_signatures
           @max_line_length = max_line_length #: Integer?
 
           @translate_generics = translate_generics #: bool
@@ -75,7 +79,12 @@ module Spoom
           last_sigs.each do |node, sig|
             next if sig.is_abstract && !@translate_abstract_methods
 
-            out = rbs_print(node.location.start_column) do |printer|
+            preserve_multiline_signatures = !!(@preserve_multiline_signatures && sig.loc&.multiline?)
+
+            out = rbs_print(
+              node.location.start_column,
+              preserve_multiline_signatures: preserve_multiline_signatures,
+            ) do |printer|
               printer.print_method_sig(rbi_node, sig)
             end
             @rewriter << Source::Replace.new(node.location.start_offset, node.location.end_offset, out)
@@ -180,7 +189,7 @@ module Spoom
           return unless sorbet_sig?(node)
 
           builder = RBI::Parser::SigBuilder.new(@ruby_contents, file: @file)
-          builder.current.loc = node.location
+          builder.current.loc = RBI::Loc.from_prism(@file, node.location)
           builder.visit_call_node(node)
           builder.current.comments = []
 
@@ -204,7 +213,7 @@ module Spoom
           rbi_node = builder.tree.nodes.first #: as RBI::Attr
 
           last_sigs.each do |node, sig|
-            out = rbs_print(node.location.start_column) do |printer|
+            out = rbs_print(node.location.start_column, preserve_multiline_signatures: false) do |printer|
               printer.print_attr_sig(rbi_node, sig)
             end
             @rewriter << Source::Replace.new(node.location.start_offset, node.location.end_offset, out)
@@ -387,10 +396,16 @@ module Spoom
           last_sigs
         end
 
-        #: (Integer) { (RBI::RBSPrinter) -> void } -> String
-        def rbs_print(indent, &block)
+        #: (Integer, preserve_multiline_signatures: bool) { (RBI::RBSPrinter) -> void } -> String
+        def rbs_print(indent, preserve_multiline_signatures:, &block)
           out = StringIO.new
-          p = RBI::RBSPrinter.new(out: out, positional_names: @positional_names, max_line_length: @max_line_length)
+
+          p = RBI::RBSPrinter.new(
+            out: out,
+            positional_names: @positional_names,
+            max_line_length: @max_line_length,
+            force_multiline_signatures: preserve_multiline_signatures,
+          )
           block.call(p)
           string = out.string
 

data/lib/spoom/sorbet/translate.rb

@@ -30,13 +30,17 @@ module Spoom
         #|   String,
         #|   file: String,
         #|   ?positional_names: bool,
+        #|   ?preserve_multiline_signatures: bool,
         #|   ?max_line_length: Integer?,
         #|   ?translate_generics: bool,
         #|   ?translate_helpers: bool,
         #|   ?translate_abstract_methods: bool
         #| ) -> String
         def sorbet_sigs_to_rbs_comments(
-          ruby_contents, file:, positional_names: true, max_line_length: nil,
+          ruby_contents, file:,
+          positional_names: true,
+          preserve_multiline_signatures: true,
+          max_line_length: nil,
           translate_generics: true,
           translate_helpers: true,
           translate_abstract_methods: true
@@ -45,6 +49,7 @@ module Spoom
             ruby_contents,
             file: file,
             positional_names: positional_names,
+            preserve_multiline_signatures: preserve_multiline_signatures,
             max_line_length: max_line_length,
             translate_generics: translate_generics,
             translate_helpers: translate_helpers,

data/lib/spoom/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module Spoom
-  VERSION = "1.8.2"
+  VERSION = "1.8.4"
 end

data/rbi/spoom.rbi

@@ -126,9 +126,11 @@ class Spoom::Cli::Srb::Bump < ::Thor
   sig { params(directory: ::String).void }
   def bump(directory = T.unsafe(nil)); end
 
+  sig { params(context: ::Spoom::Context, files: T::Array[::String], strictness: ::String).returns(::Tempfile) }
+  def create_typed_override_file(context, files, strictness); end
+
   def help(command = T.unsafe(nil), subcommand = T.unsafe(nil)); end
   def print_changes(files, command:, from: T.unsafe(nil), to: T.unsafe(nil), dry: T.unsafe(nil), path: T.unsafe(nil)); end
-  def undo_changes(files, from_strictness); end
 end
 
 class Spoom::Cli::Srb::Coverage < ::Thor
@@ -2661,6 +2663,8 @@ class Spoom::Sorbet::Config
   def paths; end
 
   def paths=(_arg0); end
+  def typed_overrides; end
+  def typed_overrides=(_arg0); end
 
   private
 
@@ -2749,6 +2753,17 @@ class Spoom::Sorbet::Errors::Error
   def to_s; end
 end
 
+class Spoom::Sorbet::Errors::ParseResult
+  sig { params(errors: T::Array[::Spoom::Sorbet::Errors::Error], warnings: T::Array[::String]).void }
+  def initialize(errors, warnings); end
+
+  sig { returns(T::Array[::Spoom::Sorbet::Errors::Error]) }
+  def errors; end
+
+  sig { returns(T::Array[::String]) }
+  def warnings; end
+end
+
 class Spoom::Sorbet::Errors::Parser
   sig { params(error_url_base: ::String).void }
   def initialize(error_url_base: T.unsafe(nil)); end
@@ -2756,11 +2771,17 @@ class Spoom::Sorbet::Errors::Parser
   sig { params(output: ::String).returns(T::Array[::Spoom::Sorbet::Errors::Error]) }
   def parse(output); end
 
+  sig { params(output: ::String).returns(::Spoom::Sorbet::Errors::ParseResult) }
+  def parse_result(output); end
+
   private
 
   sig { params(line: ::String).void }
   def append_error(line); end
 
+  sig { params(warning: ::String).void }
+  def append_warning(warning); end
+
   sig { void }
   def close_error; end
 
@@ -2774,6 +2795,9 @@ class Spoom::Sorbet::Errors::Parser
   def open_error(error); end
 
   class << self
+    sig { params(output: ::String, error_url_base: ::String).returns(::Spoom::Sorbet::Errors::ParseResult) }
+    def parse_result(output, error_url_base: T.unsafe(nil)); end
+
     sig { params(output: ::String, error_url_base: ::String).returns(T::Array[::Spoom::Sorbet::Errors::Error]) }
     def parse_string(output, error_url_base: T.unsafe(nil)); end
   end
@@ -2925,13 +2949,14 @@ module Spoom::Sorbet::Translate
         ruby_contents: ::String,
         file: ::String,
         positional_names: T::Boolean,
+        preserve_multiline_signatures: T::Boolean,
         max_line_length: T.nilable(::Integer),
         translate_generics: T::Boolean,
         translate_helpers: T::Boolean,
         translate_abstract_methods: T::Boolean
       ).returns(::String)
     end
-    def sorbet_sigs_to_rbs_comments(ruby_contents, file:, positional_names: T.unsafe(nil), max_line_length: T.unsafe(nil), translate_generics: T.unsafe(nil), translate_helpers: T.unsafe(nil), translate_abstract_methods: T.unsafe(nil)); end
+    def sorbet_sigs_to_rbs_comments(ruby_contents, file:, positional_names: T.unsafe(nil), preserve_multiline_signatures: T.unsafe(nil), max_line_length: T.unsafe(nil), translate_generics: T.unsafe(nil), translate_helpers: T.unsafe(nil), translate_abstract_methods: T.unsafe(nil)); end
 
     sig { params(ruby_contents: ::String, file: ::String).returns(::String) }
     def strip_sorbet_sigs(ruby_contents, file:); end
@@ -3300,13 +3325,14 @@ class Spoom::Sorbet::Translate::SorbetSigsToRBSComments < ::Spoom::Sorbet::Trans
       ruby_contents: ::String,
       file: ::String,
       positional_names: T::Boolean,
+      preserve_multiline_signatures: T::Boolean,
       max_line_length: T.nilable(::Integer),
       translate_generics: T::Boolean,
       translate_helpers: T::Boolean,
       translate_abstract_methods: T::Boolean
     ).void
   end
-  def initialize(ruby_contents, file:, positional_names:, max_line_length: T.unsafe(nil), translate_generics: T.unsafe(nil), translate_helpers: T.unsafe(nil), translate_abstract_methods: T.unsafe(nil)); end
+  def initialize(ruby_contents, file:, positional_names:, preserve_multiline_signatures: T.unsafe(nil), max_line_length: T.unsafe(nil), translate_generics: T.unsafe(nil), translate_helpers: T.unsafe(nil), translate_abstract_methods: T.unsafe(nil)); end
 
   sig { override.params(node: ::Prism::CallNode).void }
   def visit_call_node(node); end
@@ -3351,8 +3377,14 @@ 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 do
+    params(
+      indent: ::Integer,
+      preserve_multiline_signatures: T::Boolean,
+      block: T.proc.params(arg0: ::RBI::RBSPrinter).void
+    ).returns(::String)
+  end
+  def rbs_print(indent, preserve_multiline_signatures:, &block); end
 
   sig { params(node: ::Prism::CallNode).void }
   def visit_attr(node); end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spoom
 version: !ruby/object:Gem::Version
-  version: 1.8.2
+  version: 1.8.4
 platform: ruby
 authors:
 - Alexandre Terrasa
@@ -85,14 +85,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.14
+        version: 0.3.15
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.3.14
+        version: 0.3.15
 - !ruby/object:Gem::Dependency
   name: rbs
   requirement: !ruby/object:Gem::Requirement