spoom 1.1.11 → 1.1.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b239fa524447d3a3cd6290f8fa373cdaf9a1b3b76bacbbf290519820fe31f542
-  data.tar.gz: 389b772cafcc6658f6033707ec1696cc1221aab64efc8c0c4bef984e672e1ea4
+  metadata.gz: 5cad6017cf76302bc359d170fce6c2e33c4ff5923a564b26e2f270b42c102e3d
+  data.tar.gz: 734654483394f8520346d0ddab7872e1c7f42de4eed7523e503264f8045bf2c9
 SHA512:
-  metadata.gz: df641a876db23dd5aac45965adbae953ba43ae2fb20720498d6760843212a3541b4d3396401ad9cccb99db58830d3bec7124e32a27372496c61fd896517be126
-  data.tar.gz: 4f1b7fe4cd814333c449820bbd24f4fd3ca4883986b3d6f3c0c6f59dada06e136114930a9e8e20a72beb85854ef5f240d7dd6d6c0c5c0c28f5b70fc01185045a
+  metadata.gz: a67da9fa2811e15d5bfc5f554a2b1cb23bed4a0744617d1168b3d3d4c08f4f6828b207142996fb8cebc57ca8732d901e3e390c43939eaa504a2ed1cc1fe611b4
+  data.tar.gz: 1b98af8f37acd554f908fdde1257f9c53eaab0a37b21847e619caee5cdda44e9f06e248545ec247cb43c6ac434d5e00bce4b6731eb434c62bd3a60a72c67313f

data/Gemfile

@@ -7,6 +7,7 @@ gemspec
 
 group :development do
   gem "pry-byebug"
+  gem "ruby-lsp"
   gem "rubocop-shopify", require: false
   gem "rubocop-sorbet", require: false
   gem "tapioca", require: false

data/README.md

@@ -121,6 +121,12 @@ Hide the `Errors: X` at the end of the list:
 $ spoom tc --no-count
 ```
 
+List only the errors comming from specific directories or files:
+
+```
+$ spoom tc file1.rb path1/ path2/
+```
+
 #### Typing coverage
 
 Show metrics about the project contents and the typing coverage:

data/Rakefile

@@ -1,5 +1,6 @@
 # typed: strict
 # frozen_string_literal: true
+
 require "bundler/gem_tasks"
 require "rake/testtask"
 

data/lib/spoom/cli/bump.rb

@@ -1,8 +1,8 @@
 # typed: true
 # frozen_string_literal: true
 
-require 'find'
-require 'open3'
+require "find"
+require "open3"
 
 module Spoom
   module Cli
@@ -71,7 +71,7 @@ module Spoom
         say("\n")
 
         if files_to_bump.empty?
-          say("No file to bump from `#{from}` to `#{to}`")
+          say("No files to bump from `#{from}` to `#{to}`")
           exit(0)
         end
 
@@ -85,11 +85,10 @@ module Spoom
 
         error_url_base = Spoom::Sorbet::Errors::DEFAULT_ERROR_URL_BASE
         result = Sorbet.srb_tc(
-          "--no-error-sections",
           "--error-url-base=#{error_url_base}",
           path: exec_path,
           capture_err: true,
-          sorbet_bin: options[:sorbet]
+          sorbet_bin: options[:sorbet],
         )
 
         check_sorbet_segfault(result.exit_code) do
@@ -108,17 +107,22 @@ module Spoom
 
         errors = Sorbet::Errors::Parser.parse_string(result.err, error_url_base: error_url_base)
 
-        files_with_errors = errors.map do |err|
-          path = File.expand_path(err.file)
+        all_files = errors.flat_map do |err|
+          [err.file, *err.files_from_error_sections]
+        end
+
+        files_with_errors = all_files.map do |file|
+          path = File.expand_path(file)
           next unless path.start_with?(directory)
           next unless File.file?(path)
           next unless files_to_bump.include?(path)
+
           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]
+        say("Found #{errors.length} type checking error#{"s" if errors.length > 1}") if options[:count_errors]
 
         files_changed = files_to_bump - files_with_errors
         print_changes(files_changed, command: cmd, from: from, to: to, dry: dry, path: exec_path)
@@ -128,13 +132,14 @@ module Spoom
 
       no_commands do
         def print_changes(files, command:, from: "false", to: "true", dry: false, path: File.expand_path("."))
-          if files.empty?
-            say("No file to bump from `#{from}` to `#{to}`")
+          files_count = files.size
+          if files_count.zero?
+            say("No files to bump from `#{from}` to `#{to}`")
             return
           end
           message = StringIO.new
           message << (dry ? "Can bump" : "Bumped")
-          message << " `#{files.size}` file#{'s' if files.size > 1}"
+          message << " `#{files_count}` file#{"s" if files_count > 1}"
           message << " from `#{from}` to `#{to}`:"
           say(message.string)
           files.each do |file|
@@ -142,7 +147,7 @@ module Spoom
             say(" + #{file_path}")
           end
           if dry && command
-            say("\nRun `#{command}` to bump them")
+            say("\nRun `#{command}` to bump #{files_count > 1 ? "them" : "it"}")
           elsif dry
             say("\nRun `spoom bump --from #{from} --to #{to}` locally then `commit the changes` and `push them`")
           end

data/lib/spoom/cli/coverage.rb

@@ -1,8 +1,8 @@
 # typed: true
 # frozen_string_literal: true
 
-require_relative '../coverage'
-require_relative '../timeline'
+require_relative "../coverage"
+require_relative "../timeline"
 
 module Spoom
   module Cli
@@ -27,6 +27,7 @@ module Spoom
 
         save_dir = options[:save]
         return unless save_dir
+
         FileUtils.mkdir_p(save_dir)
         file = "#{save_dir}/#{snapshot.commit_sha || snapshot.timestamp}.json"
         File.write(file, snapshot.to_json)
@@ -45,7 +46,7 @@ module Spoom
         sorbet = options[:sorbet]
 
         ref_before = Spoom::Git.current_branch
-        ref_before = Spoom::Git.last_commit(path: path) unless ref_before
+        ref_before = Spoom::Git.last_commit(path: path)&.sha unless ref_before
         unless ref_before
           say_error("Not in a git repository")
           say_error("\nSpoom needs to checkout into your previous commits to build the timeline.", status: nil)
@@ -70,9 +71,9 @@ module Spoom
         to = parse_time(options[:to], "--to")
 
         unless from
-          intro_sha = Spoom::Git.sorbet_intro_commit(path: path)
-          intro_sha = T.must(intro_sha) # we know it's in there since in_sorbet_project!
-          from = Spoom::Git.commit_time(intro_sha, path: path)
+          intro_commit = Spoom::Git.sorbet_intro_commit(path: path)
+          intro_commit = T.must(intro_commit) # we know it's in there since in_sorbet_project!
+          from = intro_commit.time
         end
 
         timeline = Spoom::Timeline.new(from, to, path: path)
@@ -83,16 +84,16 @@ module Spoom
           exit(1)
         end
 
-        ticks.each_with_index do |sha, i|
-          date = Spoom::Git.commit_time(sha, path: path)
-          say("Analyzing commit `#{sha}` - #{date&.strftime('%F')} (#{i + 1} / #{ticks.size})")
+        ticks.each_with_index do |commit, i|
+          say("Analyzing commit `#{commit.sha}` - #{commit.time.strftime("%F")} (#{i + 1} / #{ticks.size})")
 
-          Spoom::Git.checkout(sha, path: path)
+          Spoom::Git.checkout(commit.sha, path: path)
 
           snapshot = T.let(nil, T.nilable(Spoom::Coverage::Snapshot))
           if options[:bundle_install]
             Bundler.with_unbundled_env do
-              next unless bundle_install(path, sha)
+              next unless bundle_install(path, commit.sha)
+
               snapshot = Spoom::Coverage.snapshot(path: path, sorbet_bin: sorbet)
             end
           else
@@ -104,7 +105,8 @@ module Spoom
           say("\n")
 
           next unless save_dir
-          file = "#{save_dir}/#{sha}.json"
+
+          file = "#{save_dir}/#{commit.sha}.json"
           File.write(file, snapshot.to_json)
           say("  Snapshot data saved under `#{file}`\n\n")
         end
@@ -145,7 +147,7 @@ module Spoom
           false: options[:color_false],
           true: options[:color_true],
           strict: options[:color_strict],
-          strong: options[:color_strong]
+          strong: options[:color_strong],
         )
 
         report = Spoom::Coverage.report(snapshots, palette: palette, path: exec_path)
@@ -161,9 +163,9 @@ module Spoom
           say_error("No report file to open `#{file}`")
           say_error(<<~ERR, status: nil)
 
-            If you already generated a report under another name use #{blue('spoom coverage open PATH')}.
+            If you already generated a report under another name use #{blue("spoom coverage open PATH")}.
 
-            To generate a report run #{blue('spoom coverage report')}.
+            To generate a report run #{blue("spoom coverage report")}.
           ERR
           exit(1)
         end
@@ -174,6 +176,7 @@ module Spoom
       no_commands do
         def parse_time(string, option)
           return nil unless string
+
           Time.parse(string)
         rescue ArgumentError
           say_error("Invalid date `#{string}` for option `#{option}` (expected format `YYYY-MM-DD`)")
@@ -196,9 +199,9 @@ module Spoom
           say_error("No snapshot files found in `#{file}`")
           say_error(<<~ERR, status: nil)
 
-            If you already generated snapshot files under another directory use #{blue('spoom coverage report PATH')}.
+            If you already generated snapshot files under another directory use #{blue("spoom coverage report PATH")}.
 
-            To generate snapshot files run #{blue('spoom coverage timeline --save-dir spoom_data')}.
+            To generate snapshot files run #{blue("spoom coverage timeline --save")}.
           ERR
         end
       end

data/lib/spoom/cli/helper.rb

@@ -33,7 +33,7 @@ module Spoom
         params(
           message: String,
           status: T.nilable(String),
-          nl: T::Boolean
+          nl: T::Boolean,
         ).void
       end
       def say_error(message, status: "Error", nl: true)
@@ -60,8 +60,8 @@ module Spoom
         unless in_sorbet_project?
           say_error(
             "not in a Sorbet project (`#{sorbet_config_file}` not found)\n\n" \
-            "When running spoom from another path than the project's root, " \
-            "use `--path PATH` to specify the path to the root."
+              "When running spoom from another path than the project's root, " \
+              "use `--path PATH` to specify the path to the root.",
           )
           Kernel.exit(1)
         end
@@ -116,9 +116,9 @@ module Spoom
         word = StringIO.new
         in_ticks = T.let(false, T::Boolean)
         string.chars.each do |c|
-          if c == '`' && !in_ticks
+          if c == "`" && !in_ticks
             in_ticks = true
-          elsif c == '`' && in_ticks
+          elsif c == "`" && in_ticks
             in_ticks = false
             res << colorize(word.string, HIGHLIGHT_COLOR)
             word = StringIO.new
@@ -135,6 +135,7 @@ module Spoom
       sig { params(string: String, color: Color).returns(String) }
       def colorize(string, *color)
         return string unless color?
+
         T.unsafe(self).set_color(string, *color)
       end
 

data/lib/spoom/cli/lsp.rb

@@ -1,7 +1,7 @@
 # typed: true
 # frozen_string_literal: true
 
-require 'shellwords'
+require "shellwords"
 
 require_relative "../sorbet/lsp"
 
@@ -28,6 +28,7 @@ module Spoom
           Dir["**/*.rb"].each do |file|
             res = client.document_symbols(to_uri(file))
             next if res.empty?
+
             say("Symbols from `#{file}`:")
             printer.print_objects(res)
           end
@@ -117,7 +118,7 @@ module Spoom
             "--lsp",
             "--enable-all-experimental-lsp-features",
             "--disable-watchman",
-            path: path
+            path: path,
           )
           client.open(File.expand_path(path))
           client
@@ -127,7 +128,7 @@ module Spoom
           Spoom::LSP::SymbolPrinter.new(
             indent_level: 2,
             colors: options[:color],
-            prefix: "file://#{File.expand_path(exec_path)}"
+            prefix: "file://#{File.expand_path(exec_path)}",
           )
         end
 

data/lib/spoom/cli/run.rb

@@ -22,7 +22,8 @@ module Spoom
       option :uniq, type: :boolean, aliases: :u, desc: "Remove duplicated lines"
       option :count, type: :boolean, default: true, desc: "Show errors count"
       option :sorbet, type: :string, desc: "Path to custom Sorbet bin"
-      def tc(*arg)
+      option :sorbet_options, type: :string, default: "", desc: "Pass options to Sorbet"
+      def tc(*paths_to_select)
         in_sorbet_project!
 
         path = exec_path
@@ -36,10 +37,10 @@ module Spoom
 
         unless limit || code || sort
           result = T.unsafe(Spoom::Sorbet).srb_tc(
-            *arg,
+            *options[:sorbet_options].split(" "),
             path: path,
             capture_err: false,
-            sorbet_bin: sorbet
+            sorbet_bin: sorbet,
           )
 
           check_sorbet_segfault(result.code)
@@ -47,11 +48,13 @@ module Spoom
           exit(result.status)
         end
 
+        error_url_base = Spoom::Sorbet::Errors::DEFAULT_ERROR_URL_BASE
         result = T.unsafe(Spoom::Sorbet).srb_tc(
-          *arg,
+          *options[:sorbet_options].split(" "),
+          "--error-url-base=#{error_url_base}",
           path: path,
           capture_err: true,
-          sorbet_bin: sorbet
+          sorbet_bin: sorbet,
         )
 
         check_sorbet_segfault(result.exit_code)
@@ -61,9 +64,17 @@ module Spoom
           exit(0)
         end
 
-        errors = Spoom::Sorbet::Errors::Parser.parse_string(result.err)
+        errors = Spoom::Sorbet::Errors::Parser.parse_string(result.err, error_url_base: error_url_base)
         errors_count = errors.size
 
+        errors = errors.select { |e| e.code == code } if code
+
+        unless paths_to_select.empty?
+          errors.select! do |error|
+            paths_to_select.any? { |path_to_select| error.file&.start_with?(path_to_select) }
+          end
+        end
+
         errors = case sort
         when SORT_CODE
           Spoom::Sorbet::Errors.sort_errors_by_code(errors)
@@ -73,7 +84,6 @@ module Spoom
           errors # preserve natural sort
         end
 
-        errors = errors.select { |e| e.code == code } if code
         errors = T.must(errors.slice(0, limit)) if limit
 
         lines = errors.map { |e| format_error(e, format || DEFAULT_FORMAT) }
@@ -110,7 +120,7 @@ module Spoom
           cyan = T.let(false, T::Boolean)
           word = StringIO.new
           message.chars.each do |c|
-            if c == '`'
+            if c == "`"
               cyan = !cyan
               next
             end

data/lib/spoom/cli.rb

@@ -3,7 +3,7 @@
 
 require "thor"
 
-require_relative 'cli/helper'
+require_relative "cli/helper"
 
 require_relative "cli/bump"
 require_relative "cli/config"
@@ -20,7 +20,7 @@ module Spoom
       class_option :color, type: :boolean, default: true, desc: "Use colors"
       class_option :path, type: :string, default: ".", aliases: :p, desc: "Run spoom in a specific path"
 
-      map T.unsafe(%w[--version -v] => :__print_version)
+      map T.unsafe(["--version", "-v"] => :__print_version)
 
       desc "bump", "Bump Sorbet sigils from `false` to `true` when no errors"
       subcommand "bump", Spoom::Cli::Bump
@@ -71,8 +71,10 @@ module Spoom
 
       # Utils
 
-      def self.exit_on_failure?
-        true
+      class << self
+        def exit_on_failure?
+          true
+        end
       end
     end
   end

data/lib/spoom/context.rb

@@ -0,0 +1,219 @@
+# typed: strict
+# frozen_string_literal: true
+
+require "fileutils"
+require "open3"
+
+module Spoom
+  # An abstraction to a Ruby project context
+  #
+  # A context maps to a directory in the file system.
+  # It is used to manipulate files and run commands in the context of this directory.
+  class Context
+    extend T::Sig
+
+    # The absolute path to the directory this context is about
+    sig { returns(String) }
+    attr_reader :absolute_path
+
+    class << self
+      extend T::Sig
+
+      # Create a new context in the system's temporary directory
+      #
+      # `name` is used as prefix to the temporary directory name.
+      # The directory will be created if it doesn't exist.
+      sig { params(name: T.nilable(String)).returns(T.attached_class) }
+      def mktmp!(name = nil)
+        new(::Dir.mktmpdir(name))
+      end
+    end
+
+    # Create a new context about `absolute_path`
+    #
+    # The directory will not be created if it doesn't exist.
+    # Call `#make!` to create it.
+    sig { params(absolute_path: String).void }
+    def initialize(absolute_path)
+      @absolute_path = T.let(::File.expand_path(absolute_path), String)
+    end
+
+    # Returns the absolute path to `relative_path` in the context's directory
+    sig { params(relative_path: String).returns(String) }
+    def absolute_path_to(relative_path)
+      File.join(@absolute_path, relative_path)
+    end
+
+    # File System
+
+    # Create the context directory at `absolute_path`
+    sig { void }
+    def mkdir!
+      FileUtils.rm_rf(@absolute_path)
+      FileUtils.mkdir_p(@absolute_path)
+    end
+
+    # List all files in this context matching `pattern`
+    sig { params(pattern: String).returns(T::Array[String]) }
+    def glob(pattern = "**/*")
+      Dir.glob(absolute_path_to(pattern)).map do |path|
+        Pathname.new(path).relative_path_from(@absolute_path).to_s
+      end.sort
+    end
+
+    # List all files at the top level of this context directory
+    sig { returns(T::Array[String]) }
+    def list
+      glob("*")
+    end
+
+    # Does `relative_path` point to an existing file in this context directory?
+    sig { params(relative_path: String).returns(T::Boolean) }
+    def file?(relative_path)
+      File.file?(absolute_path_to(relative_path))
+    end
+
+    # Return the contents of the file at `relative_path` in this context directory
+    #
+    # Will raise if the file doesn't exist.
+    sig { params(relative_path: String).returns(String) }
+    def read(relative_path)
+      File.read(absolute_path_to(relative_path))
+    end
+
+    # Write `contents` in the file at `relative_path` in this context directory
+    #
+    # Append to the file if `append` is true.
+    sig { params(relative_path: String, contents: String, append: T::Boolean).void }
+    def write!(relative_path, contents = "", append: false)
+      absolute_path = absolute_path_to(relative_path)
+      FileUtils.mkdir_p(File.dirname(absolute_path))
+      File.write(absolute_path, contents, mode: append ? "a" : "w")
+    end
+
+    # Remove the path at `relative_path` (recursive + force) in this context directory
+    sig { params(relative_path: String).void }
+    def remove!(relative_path)
+      FileUtils.rm_rf(absolute_path_to(relative_path))
+    end
+
+    # Move the file or directory from `from_relative_path` to `to_relative_path`
+    sig { params(from_relative_path: String, to_relative_path: String).void }
+    def move!(from_relative_path, to_relative_path)
+      destination_path = absolute_path_to(to_relative_path)
+      FileUtils.mkdir_p(File.dirname(destination_path))
+      FileUtils.mv(absolute_path_to(from_relative_path), destination_path)
+    end
+
+    # Delete this context and its content
+    #
+    # Warning: it will `rm -rf` the context directory on the file system.
+    sig { void }
+    def destroy!
+      FileUtils.rm_rf(@absolute_path)
+    end
+
+    # Execution
+
+    # Run a command in this context directory
+    sig { params(command: String, capture_err: T::Boolean).returns(ExecResult) }
+    def exec(command, capture_err: true)
+      Bundler.with_unbundled_env do
+        opts = T.let({ chdir: @absolute_path }, T::Hash[Symbol, T.untyped])
+
+        if capture_err
+          out, err, status = Open3.capture3(command, opts)
+          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))
+        end
+      end
+    end
+
+    # Bundle
+
+    # Read the `contents` of the Gemfile in this context directory
+    sig { returns(T.nilable(String)) }
+    def read_gemfile
+      read("Gemfile")
+    end
+
+    # Set the `contents` of the Gemfile in this context directory
+    sig { params(contents: String, append: T::Boolean).void }
+    def write_gemfile!(contents, append: false)
+      write!("Gemfile", contents, append: append)
+    end
+
+    # Run a command with `bundle` in this context directory
+    sig { params(command: String, version: T.nilable(String)).returns(ExecResult) }
+    def bundle(command, version: nil)
+      command = "_#{version}_ #{command}" if version
+      exec("bundle #{command}")
+    end
+
+    # Run `bundle install` in this context directory
+    sig { params(version: T.nilable(String)).returns(ExecResult) }
+    def bundle_install!(version: nil)
+      bundle("install", version: version)
+    end
+
+    # Run a command `bundle exec` in this context directory
+    sig { params(command: String, version: T.nilable(String)).returns(ExecResult) }
+    def bundle_exec(command, version: nil)
+      bundle("exec #{command}", version: version)
+    end
+
+    # Git
+
+    # Run a command prefixed by `git` in this context directory
+    sig { params(command: String).returns(ExecResult) }
+    def git(command)
+      exec("git #{command}")
+    end
+
+    # Run `git init` in this context directory
+    sig { params(branch: String).void }
+    def git_init!(branch: "main")
+      git("init -q -b #{branch}")
+    end
+
+    # Run `git checkout` in this context directory
+    sig { params(ref: String).returns(ExecResult) }
+    def git_checkout!(ref: "main")
+      git("checkout #{ref}")
+    end
+
+    # Get the current git branch in this context directory
+    sig { returns(T.nilable(String)) }
+    def git_current_branch
+      Spoom::Git.current_branch(path: @absolute_path)
+    end
+
+    # Sorbet
+
+    # Run `bundle exec srb` in this context directory
+    sig { params(command: String).returns(ExecResult) }
+    def srb(command)
+      bundle_exec("srb #{command}")
+    end
+
+    # Read the contents of `sorbet/config` in this context directory
+    sig { returns(String) }
+    def read_sorbet_config
+      read(Spoom::Sorbet::CONFIG_PATH)
+    end
+
+    # Set the `contents` of `sorbet/config` in this context directory
+    sig { params(contents: String, append: T::Boolean).void }
+    def write_sorbet_config!(contents, append: false)
+      write!(Spoom::Sorbet::CONFIG_PATH, contents, append: append)
+    end
+
+    # Read the strictness sigil from the file at `relative_path` (returns `nil` if no sigil)
+    sig { params(relative_path: String).returns(T.nilable(String)) }
+    def read_file_strictness(relative_path)
+      Spoom::Sorbet::Sigils.file_strictness(absolute_path_to(relative_path))
+    end
+  end
+end

data/lib/spoom/coverage/d3/base.rb

@@ -19,14 +19,18 @@ module Spoom
           @data = data
         end
 
-        sig { returns(String) }
-        def self.header_style
-          ""
-        end
-
-        sig { returns(String) }
-        def self.header_script
-          ""
+        class << self
+          extend T::Sig
+
+          sig { returns(String) }
+          def header_style
+            ""
+          end
+
+          sig { returns(String) }
+          def header_script
+            ""
+          end
         end
 
         sig { returns(String) }