Merge pull request #114 from Shopify/at-fix-bump

Fix bump command when called with a custom `--error-url-base`

Author: Morriar

lib/spoom/cli/bump.rb

@@ -83,8 +83,10 @@ def bump(directory = ".")
           exit(files_to_bump.empty?)
         end
 
+        error_url_base = Spoom::Sorbet::Errors::DEFAULT_ERROR_URL_BASE
         output, status, exit_code = Sorbet.srb_tc(
           "--no-error-sections",
+          "--error-url-base=#{error_url_base}",
           path: exec_path,
           capture_err: true,
           sorbet_bin: options[:sorbet]
@@ -104,7 +106,7 @@ def bump(directory = ".")
           exit(files_to_bump.empty?)
         end
 
-        errors = Sorbet::Errors::Parser.parse_string(output)
+        errors = Sorbet::Errors::Parser.parse_string(output, error_url_base: error_url_base)
 
         files_with_errors = errors.map do |err|
           path = File.expand_path(err.file)

lib/spoom/sorbet/errors.rb

@@ -6,6 +6,8 @@ module Sorbet
     module Errors
       extend T::Sig
 
+      DEFAULT_ERROR_URL_BASE = "https://srb.help/"
+
       # Parse errors from Sorbet output
       class Parser
         extend T::Sig
@@ -18,28 +20,16 @@ class Parser
           "or set SORBET_SILENCE_DEV_MESSAGE=1 in your shell environment.",
         ]
 
-        ERROR_LINE_MATCH_REGEX = %r{
-          ^         # match beginning of line
-          (\S[^:]*) # capture filename as something that starts with a non-space character
-                    # followed by anything that is not a colon character
-          :         # match the filename - line number seperator
-          (\d+)     # capture the line number
-          :\s       # match the line number - error message separator
-          (.*)      # capture the error message
-          \shttps://srb.help/ # match the error code url prefix
-          (\d+)     # capture the error code
-          $         # match end of line
-        }x.freeze
-
-        sig { params(output: String).returns(T::Array[Error]) }
-        def self.parse_string(output)
-          parser = Spoom::Sorbet::Errors::Parser.new
+        sig { params(output: String, error_url_base: String).returns(T::Array[Error]) }
+        def self.parse_string(output, error_url_base: DEFAULT_ERROR_URL_BASE)
+          parser = Spoom::Sorbet::Errors::Parser.new(error_url_base: error_url_base)
           parser.parse(output)
         end
 
-        sig { void }
-        def initialize
+        sig { params(error_url_base: String).void }
+        def initialize(error_url_base: DEFAULT_ERROR_URL_BASE)
           @errors = []
+          @error_line_match_regex = error_line_match_regexp(error_url_base)
           @current_error = nil
         end
 
@@ -66,9 +56,26 @@ def parse(output)
 
         private
 
+        sig { params(error_url_base: String).returns(Regexp) }
+        def error_line_match_regexp(error_url_base)
+          url = Regexp.escape(error_url_base)
+          %r{
+            ^         # match beginning of line
+            (\S[^:]*) # capture filename as something that starts with a non-space character
+                      # followed by anything that is not a colon character
+            :         # match the filename - line number seperator
+            (\d+)     # capture the line number
+            :\s       # match the line number - error message separator
+            (.*)      # capture the error message
+            \s#{url}  # match the error code url prefix
+            (\d+)     # capture the error code
+            $         # match end of line
+          }x
+        end
+
         sig { params(line: String).returns(T.nilable(Error)) }
         def match_error_line(line)
-          match = line.match(ERROR_LINE_MATCH_REGEX)
+          match = line.match(@error_line_match_regex)
           return unless match
 
           file, line, message, code = match.captures

test/spoom/cli/bump_test.rb

@@ -184,6 +184,41 @@ def self.something_else; end
         assert_equal("true", Sorbet::Sigils.file_strictness("#{@project.path}/file.rb"))
       end
 
+      def test_bump_with_custom_error_url_base
+        @project.sorbet_config(<<~CONFIG)
+          .
+          --error-url-base="https://docs.org#"
+        CONFIG
+
+        @project.write("file.rb", <<~RB)
+          # typed: true
+          require "test_helper"
+
+          class Test
+            def self.foo(*arg); end
+            def self.something; end
+            def self.something_else; end
+
+            foo "foo" do
+              q = something do
+                q = something_else.new
+              end
+            end
+          end
+        RB
+
+        out, err, status = @project.bundle_exec("spoom bump --no-color --from true --to strict")
+        assert_empty(err)
+        assert_equal(<<~OUT, out)
+          Checking files...
+
+          No file to bump from `true` to `strict`
+        OUT
+        assert(status)
+
+        assert_equal("true", Sorbet::Sigils.file_strictness("#{@project.path}/file.rb"))
+      end
+
       def test_bump_preserve_file_encoding
         string = <<~RB
           # typed: false

test/spoom/sorbet/errors_test.rb

@@ -248,6 +248,30 @@ def test_parses_errors_with_multiple_blank_lines
         assert_equal([7003, 7001, 7002], errors.map(&:code))
       end
 
+      def test_parses_errors_with_custom_error_url_base
+        errors = Spoom::Sorbet::Errors::Parser.parse_string(<<~ERR, error_url_base: "https://custom-url#")
+          a.rb:80: unexpected token "end" https://custom-url#2001
+              80 |end
+                  ^^^
+
+          b.rb:28: Not enough arguments provided for method Foo#bar. Expected: 1..2, got: 1 https://custom-url#7004
+              28 |              bar "hello"
+                                ^^^^^^^^^^^
+
+          c.rb:100: Method Foo#initialize redefined without matching argument count. Expected: 0, got: 2 https://custom-url#4010
+               100 |    class Foo < T::Struct
+               101 |    end
+
+          d.rb:105: Method foo does not exist on String https://custom-url#7003
+               105 |        printer.print "foo".light_black
+                                          ^^^^^^^^^^^^^^^^^
+        ERR
+        assert_equal(4, errors.size)
+        assert_equal(["a.rb", "b.rb", "c.rb", "d.rb"], errors.map(&:file))
+        assert_equal([80, 28, 100, 105], errors.map(&:line))
+        assert_equal([2001, 7004, 4010, 7003], errors.map(&:code))
+      end
+
       def test_sort_errors
         errors = Spoom::Sorbet::Errors::Parser.parse_string(<<~ERR)
           z.rb:80: unexpected token "end" https://srb.help/2001