spoom 1.1.4 → 1.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c138290b530402f788fd25c8238340609f68e370cdfce7166f82f910f6352125
-  data.tar.gz: '08595ccc6f1485d1b935c98a318daf9de6475d2fbcc742efafd955679e372cd3'
+  metadata.gz: 859ebe3fbc7461a158b56eba3eaaa938df4fcc8fec0c91d40c2a1986b28eec72
+  data.tar.gz: 953222ea44625ba7aeefcb7e19c8bff30a94fcaedd95c31784cce7ffcf768250
 SHA512:
-  metadata.gz: 8617496b57ade807623ef5cad109d20ff1024c8b6125c6286092859c69aab3e34f2a367fcb3ed531f425425af41cbc04492c0fd098f6e42170a9edf4bb41d120
-  data.tar.gz: b8040df444748a8769739caf0699d784ffcc4518e1a55c152d72f2073ae5a62d08ef02085aaa8808eb48c078baba7655e3880700ca8fb0b79830a52d66f95c7d
+  metadata.gz: 3baf1551ea1d40e6ea17bacaf67dd6361fe36e07b50edb2de6b0b3905e03ef7de568d877f51a2bbc9272c180f96ad7657a924a3465c39adb8fe5f23d658f0cd9
+  data.tar.gz: 3fcd666d6d2e32af0f3ce6792fe1ce4572811d6bc52fd81532f5b5754dd4d82df61a85759e14410e4abb6948754dd0a087498d3a162c154021496096acc5b1ed

data/Gemfile

@@ -5,8 +5,9 @@ source "https://rubygems.org"
 
 gemspec
 
-group(:development) do
-  gem('rubocop-shopify', require: false)
-  gem('rubocop-sorbet', require: false)
-  gem('pry-byebug')
+group :development do
+  gem "pry-byebug"
+  gem "rubocop-shopify", require: false
+  gem "rubocop-sorbet", require: false
+  gem "tapioca", require: false
 end

data/README.md

@@ -358,4 +358,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Spoom project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/Shopify/spoom/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Spoom project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/Shopify/spoom/blob/main/CODE_OF_CONDUCT.md).

data/lib/spoom/cli/bump.rb

@@ -83,20 +83,30 @@ module Spoom
           exit(files_to_bump.empty?)
         end
 
-        output, no_errors = Sorbet.srb_tc(
+        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]
         )
 
-        if no_errors
+        check_sorbet_segfault(exit_code) do
+          say_error(<<~ERR, status: nil)
+            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)
+        end
+
+        if status
           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
 
-        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)

data/lib/spoom/cli/helper.rb

@@ -10,7 +10,8 @@ module Spoom
     module Helper
       extend T::Sig
       extend T::Helpers
-      include Thor::Shell
+
+      include Colorize
 
       requires_ancestor { Thor }
 
@@ -82,10 +83,24 @@ module Spoom
         Sorbet::Config.parse_file(sorbet_config_file)
       end
 
+      sig { params(exit_code: Integer, block: T.nilable(T.proc.void)).void }
+      def check_sorbet_segfault(exit_code, &block)
+        return unless exit_code == Spoom::Sorbet::SEGFAULT_CODE
+
+        say_error(<<~ERR, status: nil)
+          #{red("!!! Sorbet exited with code #{exit_code} - SEGFAULT !!!")}
+
+          This is most likely related to a bug in Sorbet.
+        ERR
+
+        block&.call
+        exit(exit_code)
+      end
+
       # Colors
 
       # Color used to highlight expressions in backticks
-      HIGHLIGHT_COLOR = :blue
+      HIGHLIGHT_COLOR = T.let(Spoom::Color::BLUE, Spoom::Color)
 
       # Is the `--color` option true?
       sig { returns(T::Boolean) }
@@ -117,35 +132,40 @@ module Spoom
       end
 
       # Colorize a string if `color?`
-      sig { params(string: String, color: Symbol).returns(String) }
-      def colorize(string, color)
+      sig { params(string: String, color: Color).returns(String) }
+      def colorize(string, *color)
         return string unless color?
-        string.colorize(color)
+        T.unsafe(self).set_color(string, *color)
       end
 
       sig { params(string: String).returns(String) }
       def blue(string)
-        colorize(string, :blue)
+        colorize(string, Color::BLUE)
+      end
+
+      sig { params(string: String).returns(String) }
+      def cyan(string)
+        colorize(string, Color::CYAN)
       end
 
       sig { params(string: String).returns(String) }
       def gray(string)
-        colorize(string, :light_black)
+        colorize(string, Color::LIGHT_BLACK)
       end
 
       sig { params(string: String).returns(String) }
       def green(string)
-        colorize(string, :green)
+        colorize(string, Color::GREEN)
       end
 
       sig { params(string: String).returns(String) }
       def red(string)
-        colorize(string, :red)
+        colorize(string, Color::RED)
       end
 
       sig { params(string: String).returns(String) }
       def yellow(string)
-        colorize(string, :yellow)
+        colorize(string, Color::YELLOW)
       end
     end
   end

data/lib/spoom/cli/run.rb

@@ -35,12 +35,27 @@ module Spoom
         sorbet = options[:sorbet]
 
         unless limit || code || sort
-          output, status = T.unsafe(Spoom::Sorbet).srb_tc(*arg, path: path, capture_err: false, sorbet_bin: sorbet)
+          output, status, exit_code = T.unsafe(Spoom::Sorbet).srb_tc(
+            *arg,
+            path: path,
+            capture_err: false,
+            sorbet_bin: sorbet
+          )
+
+          check_sorbet_segfault(exit_code)
           say_error(output, status: nil, nl: false)
           exit(status)
         end
 
-        output, status = T.unsafe(Spoom::Sorbet).srb_tc(*arg, path: path, capture_err: true, sorbet_bin: sorbet)
+        output, status, exit_code = T.unsafe(Spoom::Sorbet).srb_tc(
+          *arg,
+          path: path,
+          capture_err: true,
+          sorbet_bin: sorbet
+        )
+
+        check_sorbet_segfault(exit_code)
+
         if status
           say_error(output, status: nil, nl: false)
           exit(0)
@@ -99,7 +114,7 @@ module Spoom
               cyan = !cyan
               next
             end
-            word << (cyan ? c.cyan : c.red)
+            word << (cyan ? cyan(c) : red(c))
           end
           word.string
         end

data/lib/spoom/colors.rb

@@ -0,0 +1,45 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Spoom
+  class Color < T::Enum
+    extend T::Sig
+
+    enums do
+      CLEAR           = new("\e[0m")
+      BOLD            = new("\e[1m")
+
+      BLACK           = new("\e[30m")
+      RED             = new("\e[31m")
+      GREEN           = new("\e[32m")
+      YELLOW          = new("\e[33m")
+      BLUE            = new("\e[34m")
+      MAGENTA         = new("\e[35m")
+      CYAN            = new("\e[36m")
+      WHITE           = new("\e[37m")
+
+      LIGHT_BLACK     = new("\e[90m")
+      LIGHT_RED       = new("\e[91m")
+      LIGHT_GREEN     = new("\e[92m")
+      LIGHT_YELLOW    = new("\e[93m")
+      LIGHT_BLUE      = new("\e[94m")
+      LIGHT_MAGENTA   = new("\e[95m")
+      LIGHT_CYAN      = new("\e[96m")
+      LIGHT_WHITE     = new("\e[97m")
+    end
+
+    sig { returns(String) }
+    def ansi_code
+      serialize
+    end
+  end
+
+  module Colorize
+    extend T::Sig
+
+    sig { params(string: String, color: Color).returns(String) }
+    def set_color(string, *color)
+      "#{color.map(&:ansi_code).join}#{string}#{Color::CLEAR.ansi_code}"
+    end
+  end
+end

data/lib/spoom/file_tree.rb

@@ -156,7 +156,7 @@ module Spoom
           end
           print("\n")
         else
-          print_colored(node.name, :blue)
+          print_colored(node.name, Color::BLUE)
           print("/")
           printn
           indent
@@ -180,15 +180,15 @@ module Spoom
         Spoom::Sorbet::Sigils.file_strictness(path)
       end
 
-      sig { params(strictness: T.nilable(String)).returns(Symbol) }
+      sig { params(strictness: T.nilable(String)).returns(Color) }
       def strictness_color(strictness)
         case strictness
         when "false"
-          :red
+          Color::RED
         when "true", "strict", "strong"
-          :green
+          Color::GREEN
         else
-          :uncolored
+          Color::CLEAR
         end
       end
     end

data/lib/spoom/printer.rb

@@ -8,6 +8,8 @@ module Spoom
     extend T::Sig
     extend T::Helpers
 
+    include Colorize
+
     abstract!
 
     sig { returns(T.any(IO, StringIO)) }
@@ -42,11 +44,10 @@ module Spoom
     # Print `string` colored with `color` into `out`
     #
     # Does not use colors unless `@colors`.
-    sig { params(string: T.nilable(String), color: Symbol, colors: Symbol).void }
-    def print_colored(string, color, *colors)
+    sig { params(string: T.nilable(String), color: Color).void }
+    def print_colored(string, *color)
       return unless string
-      string = colorize(string, color)
-      colors.each { |c| string = colorize(string, c) }
+      string = T.unsafe(self).colorize(string, *color)
       @out.print(string)
     end
 
@@ -72,9 +73,10 @@ module Spoom
     end
 
     # Colorize `string` with color if `@colors`
-    sig { params(string: String, color: Symbol).returns(String) }
-    def colorize(string, color)
-      @colors ? string.colorize(color) : string
+    sig { params(string: String, color: Spoom::Color).returns(String) }
+    def colorize(string, *color)
+      return string unless @colors
+      T.unsafe(self).set_color(string, *color)
     end
   end
 end

data/lib/spoom/sorbet/errors.rb

@@ -6,6 +6,8 @@ module Spoom
     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 @@ module Spoom
           "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 @@ module Spoom
 
         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

data/lib/spoom/sorbet/lsp/structures.rb

@@ -2,6 +2,7 @@
 # frozen_string_literal: true
 
 require_relative "../../printer"
+require "set"
 
 module Spoom
   module LSP
@@ -56,7 +57,7 @@ module Spoom
 
       sig { override.params(printer: SymbolPrinter).void }
       def accept_printer(printer)
-        printer.print_colored("#{line}:#{char}", :light_black)
+        printer.print_colored("#{line}:#{char}", Color::LIGHT_BLACK)
       end
 
       def to_s
@@ -81,7 +82,7 @@ module Spoom
       sig { override.params(printer: SymbolPrinter).void }
       def accept_printer(printer)
         printer.print_object(start)
-        printer.print_colored("-", :light_black)
+        printer.print_colored("-", Color::LIGHT_BLACK)
         printer.print_object(self.end)
       end
 
@@ -106,7 +107,7 @@ module Spoom
 
       sig { override.params(printer: SymbolPrinter).void }
       def accept_printer(printer)
-        printer.print_colored("#{printer.clean_uri(uri)}:", :light_black)
+        printer.print_colored("#{printer.clean_uri(uri)}:", Color::LIGHT_BLACK)
         printer.print_object(range)
       end
 
@@ -203,14 +204,14 @@ module Spoom
         printer.printt
         printer.print(kind_string)
         printer.print(' ')
-        printer.print_colored(name, :blue, :bold)
-        printer.print_colored(' (', :light_black)
+        printer.print_colored(name, Color::BLUE, Color::BOLD)
+        printer.print_colored(' (', Color::LIGHT_BLACK)
         if range
           printer.print_object(range)
         elsif location
           printer.print_object(location)
         end
-        printer.print_colored(')', :light_black)
+        printer.print_colored(')', Color::LIGHT_BLACK)
         printer.printn
         unless children.empty?
           printer.indent

data/lib/spoom/sorbet.rb

@@ -15,6 +15,8 @@ module Spoom
     GEM_PATH = Gem::Specification.find_by_name("sorbet-static").full_gem_path
     BIN_PATH = (Pathname.new(GEM_PATH) / "libexec" / "sorbet").to_s
 
+    SEGFAULT_CODE = 139
+
     class << self
       extend T::Sig
 
@@ -24,7 +26,7 @@ module Spoom
           path: String,
           capture_err: T::Boolean,
           sorbet_bin: T.nilable(String)
-        ).returns([String, T::Boolean])
+        ).returns([String, T::Boolean, Integer])
       end
       def srb(*arg, path: '.', capture_err: false, sorbet_bin: nil)
         if sorbet_bin
@@ -41,7 +43,7 @@ module Spoom
           path: String,
           capture_err: T::Boolean,
           sorbet_bin: T.nilable(String)
-        ).returns([String, T::Boolean])
+        ).returns([String, T::Boolean, Integer])
       end
       def srb_tc(*arg, path: '.', capture_err: false, sorbet_bin: nil)
         arg.prepend("tc") unless sorbet_bin

data/lib/spoom/test_helpers/project.rb

@@ -62,9 +62,9 @@ module Spoom
       # Actions
 
       # Run `git init` in this project
-      sig { void }
-      def git_init
-        Spoom::Git.exec("git init -q", path: path)
+      sig { params(branch: String).void }
+      def git_init(branch: "main")
+        Spoom::Git.exec("git init -q -b #{branch}", path: path)
         Spoom::Git.exec("git config user.name 'spoom-tests'", path: path)
         Spoom::Git.exec("git config user.email 'spoom@shopify.com'", path: path)
       end

data/lib/spoom/version.rb

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

data/lib/spoom.rb

@@ -1,8 +1,8 @@
 # typed: true
 # frozen_string_literal: true
 
-require "colorize"
 require "sorbet-runtime"
+require "pathname"
 
 module Spoom
   extend T::Sig
@@ -17,16 +17,19 @@ module Spoom
       arg: String,
       path: String,
       capture_err: T::Boolean
-    ).returns([String, T::Boolean])
+    ).returns([String, T::Boolean, Integer])
   end
   def self.exec(cmd, *arg, path: '.', capture_err: false)
     method = capture_err ? "popen2e" : "popen2"
-    Open3.send(method, [cmd, *arg].join(" "), chdir: path) do |_, o, t|
-      [o.read, T.cast(t.value, Process::Status).success?]
+    Open3.send(method, [cmd, *arg].join(" "), chdir: path) do |_, stdout, thread|
+      out = stdout.read
+      status = T.cast(thread.value, Process::Status)
+      [out, status.success?, status.exitstatus]
     end
   end
 end
 
+require "spoom/colors"
 require "spoom/sorbet"
 require "spoom/cli"
 require "spoom/version"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spoom
 version: !ruby/object:Gem::Version
-  version: 1.1.4
+  version: 1.1.8
 platform: ruby
 authors:
 - Alexandre Terrasa
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-10-06 00:00:00.000000000 Z
+date: 2022-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -53,21 +53,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: sorbet-runtime
+  name: minitest-reporters
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.9204
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.9204
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: sorbet
+  name: sorbet-runtime
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,33 +81,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.5.9204
 - !ruby/object:Gem::Dependency
-  name: thor
+  name: sorbet
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.19.2
+        version: 0.5.9204
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.19.2
+        version: 0.5.9204
 - !ruby/object:Gem::Dependency
-  name: colorize
+  name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.19.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.19.2
 description: 
 email:
 - ruby@shopify.com
@@ -128,6 +128,7 @@ files:
 - lib/spoom/cli/helper.rb
 - lib/spoom/cli/lsp.rb
 - lib/spoom/cli/run.rb
+- lib/spoom/colors.rb
 - lib/spoom/coverage.rb
 - lib/spoom/coverage/d3.rb
 - lib/spoom/coverage/d3/base.rb