spoom 1.1.15 → 1.1.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a61ae83fa56b7a78027c8954c5680d4784c5a3f8b2d717ed3ba49b36409ede2
-  data.tar.gz: b339a398e57f92f71b797dd8d427e18749d1afd6246be42fe549baf96563706e
+  metadata.gz: 9c41426fe9cc0e4f20115b5ce81ff2256d00f255acf59f29beb7e6ffeef16b0c
+  data.tar.gz: ea751643663fc13175ad1ec23c39872a7b963b2f6f619a497e4bc6fc51052e8f
 SHA512:
-  metadata.gz: 981c7b625e31b732ce731c600fd1291afb9635818918d77424750ba152633f06e8f4515037c5044badcc951ded1dd9fd768ae135ff2305359005a2cb7ad47a38
-  data.tar.gz: 123baadb32b3341271b323eab29a1ddb4561c74b9afbe6cfa71af61ff1547783a24a1d439406f482b3c40920b960e4b04fc19ca7c0423c18407af00bc35fa692
+  metadata.gz: 4503195f8c603f0148f9393a2fdfdb5667ef6b6a9d43917484952409cfa69ce5edc86fda0275144451790d5e2928fe33b7fd19597ab0f9500678185e65f65b33
+  data.tar.gz: 4eb49038a48389c0ac8160c1f9b7e37f80275c8d39fda35a8d08b1e75bae0e763382f24419a1fc51a3e2c7972d4e4d8e2ef22996961bb9a003ee7ad4bbb1abbb

data/Gemfile

@@ -6,7 +6,7 @@ source "https://rubygems.org"
 gemspec
 
 group :development do
-  gem "pry-byebug"
+  gem "debug"
   gem "ruby-lsp"
   gem "rubocop-shopify", require: false
   gem "rubocop-sorbet", require: false

data/lib/spoom/cli/bump.rb

@@ -13,20 +13,36 @@ module Spoom
       default_task :bump
 
       desc "bump DIRECTORY", "Change Sorbet sigils from one strictness to another when no errors"
-      option :from, type: :string, default: Spoom::Sorbet::Sigils::STRICTNESS_FALSE,
+      option :from,
+        type: :string,
+        default: Spoom::Sorbet::Sigils::STRICTNESS_FALSE,
         desc: "Change only files from this strictness"
-      option :to, type: :string, default: Spoom::Sorbet::Sigils::STRICTNESS_TRUE,
+      option :to,
+        type: :string,
+        default: Spoom::Sorbet::Sigils::STRICTNESS_TRUE,
         desc: "Change files to this strictness"
-      option :force, type: :boolean, default: false, aliases: :f,
+      option :force,
+        type: :boolean,
+        default: false,
+        aliases: :f,
         desc: "Change strictness without type checking"
       option :sorbet, type: :string, desc: "Path to custom Sorbet bin"
-      option :dry, type: :boolean, default: false, aliases: :d,
+      option :dry,
+        type: :boolean,
+        default: false,
+        aliases: :d,
         desc: "Only display what would happen, do not actually change sigils"
-      option :only, type: :string, default: nil, aliases: :o,
+      option :only,
+        type: :string,
+        default: nil,
+        aliases: :o,
         desc: "Only change specified list (one file by line)"
-      option :suggest_bump_command, type: :string,
+      option :suggest_bump_command,
+        type: :string,
         desc: "Command to suggest if files can be bumped"
-      option :count_errors, type: :boolean, default: false,
+      option :count_errors,
+        type: :boolean,
+        default: false,
         desc: "Count the number of errors if all files were bumped"
       option :sorbet_options, type: :string, default: "", desc: "Pass options to Sorbet"
       sig { params(directory: String).void }
@@ -85,20 +101,33 @@ module Spoom
         end
 
         error_url_base = Spoom::Sorbet::Errors::DEFAULT_ERROR_URL_BASE
-        result = Sorbet.srb_tc(
-          *options[:sorbet_options].split(" "),
-          "--error-url-base=#{error_url_base}",
-          path: exec_path,
-          capture_err: true,
-          sorbet_bin: options[:sorbet],
-        )
-
-        check_sorbet_segfault(result.exit_code) do
+        result = begin
+          Sorbet.srb_tc(
+            *options[:sorbet_options].split(" "),
+            "--error-url-base=#{error_url_base}",
+            path: exec_path,
+            capture_err: true,
+            sorbet_bin: options[:sorbet],
+          )
+        rescue Spoom::Sorbet::Error::Segfault => error
           say_error(<<~ERR, status: nil)
+            !!! Sorbet exited with code #{Spoom::Sorbet::SEGFAULT_CODE} - SEGFAULT !!!
+
+            This is most likely related to a bug in Sorbet.
             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)
+            !!! Sorbet exited with code #{Spoom::Sorbet::KILLED_CODE} - KILLED !!!
+
+            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)
         end
 
         if result.status

data/lib/spoom/cli/coverage.rb

@@ -115,17 +115,30 @@ module Spoom
 
       desc "report", "Produce a typing coverage report"
       option :data, type: :string, default: DATA_DIR, desc: "Snapshots JSON data"
-      option :file, type: :string, default: "spoom_report.html", aliases: :f,
+      option :file,
+        type: :string,
+        default: "spoom_report.html",
+        aliases: :f,
         desc: "Save report to file"
-      option :color_ignore, type: :string, default: Spoom::Coverage::D3::COLOR_IGNORE,
+      option :color_ignore,
+        type: :string,
+        default: Spoom::Coverage::D3::COLOR_IGNORE,
         desc: "Color used for typed: ignore"
-      option :color_false, type: :string, default: Spoom::Coverage::D3::COLOR_FALSE,
+      option :color_false,
+        type: :string,
+        default: Spoom::Coverage::D3::COLOR_FALSE,
         desc: "Color used for typed: false"
-      option :color_true, type: :string, default: Spoom::Coverage::D3::COLOR_TRUE,
+      option :color_true,
+        type: :string,
+        default: Spoom::Coverage::D3::COLOR_TRUE,
         desc: "Color used for typed: true"
-      option :color_strict, type: :string, default: Spoom::Coverage::D3::COLOR_STRICT,
+      option :color_strict,
+        type: :string,
+        default: Spoom::Coverage::D3::COLOR_STRICT,
         desc: "Color used for typed: strict"
-      option :color_strong, type: :string, default: Spoom::Coverage::D3::COLOR_STRONG,
+      option :color_strong,
+        type: :string,
+        default: Spoom::Coverage::D3::COLOR_STRONG,
         desc: "Color used for typed: strong"
       def report
         in_sorbet_project!

data/lib/spoom/cli/helper.rb

@@ -83,20 +83,6 @@ 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

data/lib/spoom/cli/run.rb

@@ -43,7 +43,6 @@ module Spoom
             sorbet_bin: sorbet,
           )
 
-          check_sorbet_segfault(result.code)
           say_error(result.err, status: nil, nl: false)
           exit(result.status)
         end
@@ -57,8 +56,6 @@ module Spoom
           sorbet_bin: sorbet,
         )
 
-        check_sorbet_segfault(result.exit_code)
-
         if result.status
           say_error(result.err, status: nil, nl: false)
           exit(0)
@@ -109,6 +106,20 @@ module Spoom
         end
 
         exit(1)
+      rescue Spoom::Sorbet::Error::Segfault => error
+        say_error(<<~ERR, status: nil)
+          #{red("!!! Sorbet exited with code #{error.result.exit_code} - SEGFAULT !!!")}
+
+          This is most likely related to a bug in Sorbet.
+        ERR
+
+        exit(error.result.exit_code)
+      rescue Spoom::Sorbet::Error::Killed => error
+        say_error(<<~ERR, status: nil)
+          #{red("!!! Sorbet exited with code #{error.result.exit_code} - KILLED !!!")}
+        ERR
+
+        exit(error.result.exit_code)
       end
 
       no_commands do

data/lib/spoom/context.rb

@@ -3,6 +3,7 @@
 
 require "fileutils"
 require "open3"
+require "tmpdir"
 
 module Spoom
   # An abstraction to a Ruby project context
@@ -132,7 +133,7 @@ module Spoom
           ExecResult.new(out: out, err: err, status: T.must(status.success?), exit_code: T.must(status.exitstatus))
         else
           out, status = Open3.capture2(command, opts)
-          ExecResult.new(out: out, err: "", status: T.must(status.success?), exit_code: T.must(status.exitstatus))
+          ExecResult.new(out: out, err: nil, status: T.must(status.success?), exit_code: T.must(status.exitstatus))
         end
       end
     end
@@ -179,9 +180,16 @@ module Spoom
     end
 
     # Run `git init` in this context directory
-    sig { params(branch: String).void }
-    def git_init!(branch: "main")
-      git("init -q -b #{branch}")
+    #
+    # Warning: passing a branch will run `git init -b <branch>` which is only available in git 2.28+.
+    # In older versions, use `git_init!` followed by `git("checkout -b <branch>")`.
+    sig { params(branch: T.nilable(String)).returns(ExecResult) }
+    def git_init!(branch: nil)
+      if branch
+        git("init -b #{branch}")
+      else
+        git("init")
+      end
     end
 
     # Run `git checkout` in this context directory

data/lib/spoom/coverage/snapshot.rb

@@ -147,7 +147,7 @@ module Spoom
       def print_map(hash, total)
         indent
         hash.each do |key, value|
-          next unless value > 0
+          next if value <= 0
 
           printl("#{key}: #{value}#{percent(value, total)}")
         end

data/lib/spoom/coverage.rb

@@ -63,8 +63,10 @@ module Spoom
 
         if metrics_without_rbis
           snapshot.methods_with_sig_excluding_rbis = metrics_without_rbis.fetch("types.sig.count", 0)
-          snapshot.methods_without_sig_excluding_rbis = metrics_without_rbis.fetch("types.input.methods.total",
-            0) - snapshot.methods_with_sig_excluding_rbis
+          snapshot.methods_without_sig_excluding_rbis = metrics_without_rbis.fetch(
+            "types.input.methods.total",
+            0,
+          ) - snapshot.methods_with_sig_excluding_rbis
         end
 
         Snapshot::STRICTNESSES.each do |strictness|

data/lib/spoom/git.rb

@@ -21,52 +21,31 @@ module Spoom
     class << self
       extend T::Sig
 
-      # Execute a `command`
-      sig { params(command: String, arg: String, path: String).returns(ExecResult) }
-      def exec(command, *arg, path: ".")
-        return ExecResult.new(
-          out: "",
-          err: "Error: `#{path}` is not a directory.",
-          status: false,
-          exit_code: 1,
-        ) unless File.directory?(path)
-
-        T.unsafe(Open3).popen3(command, *arg, chdir: path) do |_, stdout, stderr, thread|
-          status = T.cast(thread.value, Process::Status)
-          ExecResult.new(
-            out: stdout.read,
-            err: stderr.read,
-            status: T.must(status.success?),
-            exit_code: T.must(status.exitstatus),
-          )
-        end
-      end
-
       # Git commands
 
       sig { params(arg: String, path: String).returns(ExecResult) }
       def checkout(*arg, path: ".")
-        exec("git checkout -q #{arg.join(" ")}", path: path)
+        Spoom.exec("git checkout -q #{arg.join(" ")}", path: path)
       end
 
       sig { params(arg: String, path: String).returns(ExecResult) }
       def diff(*arg, path: ".")
-        exec("git diff #{arg.join(" ")}", path: path)
+        Spoom.exec("git diff #{arg.join(" ")}", path: path)
       end
 
       sig { params(arg: String, path: String).returns(ExecResult) }
       def log(*arg, path: ".")
-        exec("git log #{arg.join(" ")}", path: path)
+        Spoom.exec("git log #{arg.join(" ")}", path: path)
       end
 
       sig { params(arg: String, path: String).returns(ExecResult) }
       def show(*arg, path: ".")
-        exec("git show #{arg.join(" ")}", path: path)
+        Spoom.exec("git show #{arg.join(" ")}", path: path)
       end
 
       sig { params(path: String).returns(T.nilable(String)) }
       def current_branch(path: ".")
-        result = exec("git branch --show-current", path: path)
+        result = Spoom.exec("git branch --show-current", path: path)
         return nil unless result.status
 
         result.out.strip

data/lib/spoom/sorbet/errors.rb

@@ -18,13 +18,16 @@ module Spoom
       class Parser
         extend T::Sig
 
-        HEADER = T.let([
-          "👋 Hey there! Heads up that this is not a release build of sorbet.",
-          "Release builds are faster and more well-supported by the Sorbet team.",
-          "Check out the README to learn how to build Sorbet in release mode.",
-          "To forcibly silence this error, either pass --silence-dev-message,",
-          "or set SORBET_SILENCE_DEV_MESSAGE=1 in your shell environment.",
-        ], T::Array[String])
+        HEADER = T.let(
+          [
+            "👋 Hey there! Heads up that this is not a release build of sorbet.",
+            "Release builds are faster and more well-supported by the Sorbet team.",
+            "Check out the README to learn how to build Sorbet in release mode.",
+            "To forcibly silence this error, either pass --silence-dev-message,",
+            "or set SORBET_SILENCE_DEV_MESSAGE=1 in your shell environment.",
+          ],
+          T::Array[String],
+        )
 
         class << self
           extend T::Sig

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

@@ -273,34 +273,37 @@ module Spoom
         SYMBOL_KINDS[kind] || "<unknown:#{kind}>"
       end
 
-      SYMBOL_KINDS = T.let({
-        1 => "file",
-        2 => "module",
-        3 => "namespace",
-        4 => "package",
-        5 => "class",
-        6 => "def",
-        7 => "property",
-        8 => "field",
-        9 => "constructor",
-        10 => "enum",
-        11 => "interface",
-        12 => "function",
-        13 => "variable",
-        14 => "const",
-        15 => "string",
-        16 => "number",
-        17 => "boolean",
-        18 => "array",
-        19 => "object",
-        20 => "key",
-        21 => "null",
-        22 => "enum_member",
-        23 => "struct",
-        24 => "event",
-        25 => "operator",
-        26 => "type_parameter",
-      }, T::Hash[Integer, String])
+      SYMBOL_KINDS = T.let(
+        {
+          1 => "file",
+          2 => "module",
+          3 => "namespace",
+          4 => "package",
+          5 => "class",
+          6 => "def",
+          7 => "property",
+          8 => "field",
+          9 => "constructor",
+          10 => "enum",
+          11 => "interface",
+          12 => "function",
+          13 => "variable",
+          14 => "const",
+          15 => "string",
+          16 => "number",
+          17 => "boolean",
+          18 => "array",
+          19 => "object",
+          20 => "key",
+          21 => "null",
+          22 => "enum_member",
+          23 => "struct",
+          24 => "event",
+          25 => "operator",
+          26 => "type_parameter",
+        },
+        T::Hash[Integer, String],
+      )
     end
 
     class SymbolPrinter < Printer

data/lib/spoom/sorbet/sigils.rb

@@ -16,14 +16,17 @@ module Spoom
       STRICTNESS_STRONG = "strong"
       STRICTNESS_INTERNAL = "__STDLIB_INTERNAL"
 
-      VALID_STRICTNESS = T.let([
-        STRICTNESS_IGNORE,
-        STRICTNESS_FALSE,
-        STRICTNESS_TRUE,
-        STRICTNESS_STRICT,
-        STRICTNESS_STRONG,
-        STRICTNESS_INTERNAL,
-      ].freeze, T::Array[String])
+      VALID_STRICTNESS = T.let(
+        [
+          STRICTNESS_IGNORE,
+          STRICTNESS_FALSE,
+          STRICTNESS_TRUE,
+          STRICTNESS_STRICT,
+          STRICTNESS_STRONG,
+          STRICTNESS_INTERNAL,
+        ].freeze,
+        T::Array[String],
+      )
 
       SIGIL_REGEXP = T.let(/^#[\ t]*typed[\ t]*:[ \t]*(\w*)[ \t]*/.freeze, Regexp)
 

data/lib/spoom/sorbet.rb

@@ -11,10 +11,33 @@ require "open3"
 
 module Spoom
   module Sorbet
+    class Error < StandardError
+      extend T::Sig
+
+      class Killed < Error; end
+      class Segfault < Error; end
+
+      sig { returns(ExecResult) }
+      attr_reader :result
+
+      sig do
+        params(
+          message: String,
+          result: ExecResult,
+        ).void
+      end
+      def initialize(message, result)
+        super(message)
+
+        @result = result
+      end
+    end
+
     CONFIG_PATH = "sorbet/config"
     GEM_PATH = T.let(Gem::Specification.find_by_name("sorbet-static").full_gem_path, String)
     BIN_PATH = T.let((Pathname.new(GEM_PATH) / "libexec" / "sorbet").to_s, String)
 
+    KILLED_CODE = 137
     SEGFAULT_CODE = 139
 
     class << self
@@ -34,7 +57,16 @@ module Spoom
         else
           arg.prepend("bundle", "exec", "srb")
         end
-        Spoom.exec(*T.unsafe(arg), path: path, capture_err: capture_err)
+        result = Spoom.exec(*T.unsafe(arg), path: path, capture_err: capture_err)
+
+        case result.exit_code
+        when KILLED_CODE
+          raise Error::Killed.new("Sorbet was killed.", result)
+        when SEGFAULT_CODE
+          raise Error::Segfault.new("Sorbet segfaulted.", result)
+        end
+
+        result
       end
 
       sig do
@@ -69,14 +101,17 @@ module Spoom
         ).returns(T.nilable(String))
       end
       def srb_version(*arg, path: ".", capture_err: false, sorbet_bin: nil)
-        result = T.let(T.unsafe(self).srb_tc(
-          "--no-config",
-          "--version",
-          *arg,
-          path: path,
-          capture_err: capture_err,
-          sorbet_bin: sorbet_bin,
-        ), ExecResult)
+        result = T.let(
+          T.unsafe(self).srb_tc(
+            "--no-config",
+            "--version",
+            *arg,
+            path: path,
+            capture_err: capture_err,
+            sorbet_bin: sorbet_bin,
+          ),
+          ExecResult,
+        )
         return nil unless result.status
 
         result.out.split(" ")[2]

data/lib/spoom/version.rb

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

data/lib/spoom.rb

@@ -15,7 +15,7 @@ module Spoom
     extend T::Sig
 
     const :out, String
-    const :err, String
+    const :err, T.nilable(String)
     const :status, T::Boolean
     const :exit_code, Integer
 
@@ -25,7 +25,7 @@ module Spoom
         ########## STDOUT ##########
         #{out.empty? ? "<empty>" : out}
         ########## STDERR ##########
-        #{err.empty? ? "<empty>" : err}
+        #{err&.empty? ? "<empty>" : err}
         ########## STATUS: #{status} ##########
       STR
     end
@@ -42,7 +42,7 @@ module Spoom
         capture_err: T::Boolean,
       ).returns(ExecResult)
     end
-    def exec(cmd, *arg, path: ".", capture_err: false)
+    def exec(cmd, *arg, path: ".", capture_err: true)
       if capture_err
         stdout, stderr, status = T.unsafe(Open3).capture3([cmd, *arg].join(" "), chdir: path)
         ExecResult.new(
@@ -55,7 +55,7 @@ module Spoom
         stdout, status = T.unsafe(Open3).capture2([cmd, *arg].join(" "), chdir: path)
         ExecResult.new(
           out: stdout,
-          err: "",
+          err: nil,
           status: status.success?,
           exit_code: status.exitstatus,
         )

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spoom
 version: !ruby/object:Gem::Version
-  version: 1.1.15
+  version: 1.1.16
 platform: ruby
 authors:
 - Alexandre Terrasa
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-12-14 00:00:00.000000000 Z
+date: 2023-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler