spoom 1.0.8 → 1.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 866446fc75971d51c7a71d7ed713cf256f682ffbd0fabfaf97c95b601638876b
-  data.tar.gz: a38dd3b7859929349c2d84b4119e5f8d8d374c0cf5062adbb3904065a1d6f0f2
+  metadata.gz: 55531f68ca5416d234dc35cff63a0213a0f27ba0cf6fa840e183b90896661c3b
+  data.tar.gz: 2963d8788e5914ac38e00d30720d44a83691ef8c9165918cd2b7270b71775a3b
 SHA512:
-  metadata.gz: 257a78cbdf439ee83e23a823ed39918ada7a1b66786967a77604e5dca2bb825aeb8af2f5fcda6c497686f29f9d0c7dba1d051060d984694f22c0064dcbd8c1a9
-  data.tar.gz: 4a66b832da23c6237d1dedc16735cce058306ce66327fd2e074d72a481d55412aa7dc8047f0fa25957e1369747478347b77ccf8cd7c85cdb286fcff6a564a412
+  metadata.gz: 3b243083cf4ecae47f51bbfa6283e3272099c35ea28a7c471f731237eba01d5ce1f3634b9326ff3c19b7c36c58d38f97065e021e41070fd583efde13acfa2588
+  data.tar.gz: f0f2b0c272f46214a8d7bc21a9efc1e74f7646515a023a234612c96aaeb26c917c79a2db80169b275879c8da28cc57e49adf6e2f2a57c2f5e77abf0a018a6955

data/Gemfile

@@ -8,6 +8,5 @@ gemspec
 group(:development) do
   gem('rubocop-shopify', require: false)
   gem('rubocop-sorbet', require: false)
-  gem('byebug')
   gem('pry-byebug')
 end

data/lib/spoom.rb

@@ -1,6 +1,7 @@
 # typed: true
 # frozen_string_literal: true
 
+require "colorize"
 require "sorbet-runtime"
 
 module Spoom

data/lib/spoom/cli.rb

@@ -38,19 +38,29 @@ module Spoom
       subcommand "tc", Spoom::Cli::Run
 
       desc "files", "List all the files typechecked by Sorbet"
+      option :tree, type: :boolean, default: true, desc: "Display list as an indented tree"
+      option :rbi, type: :boolean, default: true, desc: "Show RBI files"
       def files
         in_sorbet_project!
 
         path = exec_path
-        config = Spoom::Sorbet::Config.parse_file(sorbet_config)
+        config = sorbet_config
         files = Spoom::Sorbet.srb_files(config, path: path)
 
-        say("Files matching `#{sorbet_config}`:")
+        unless options[:rbi]
+          files = files.reject { |file| file.end_with?(".rbi") }
+        end
+
         if files.empty?
-          say(" NONE")
-        else
+          say_error("No file matching `#{sorbet_config_file}`")
+          exit(1)
+        end
+
+        if options[:tree]
           tree = FileTree.new(files, strip_prefix: path)
-          tree.print(colors: options[:color], indent_level: 2)
+          tree.print(colors: options[:color], indent_level: 0)
+        else
+          puts files
         end
       end
 

data/lib/spoom/cli/bump.rb

@@ -24,6 +24,8 @@ module Spoom
         desc: "Only display what would happen, do not actually change sigils"
       option :only, type: :string, default: nil, aliases: :o,
         desc: "Only change specified list (one file by line)"
+      option :suggest_bump_command, type: :string,
+        desc: "Command to suggest if files can be bumped"
       sig { params(directory: String).void }
       def bump(directory = ".")
         in_sorbet_project!
@@ -33,35 +35,43 @@ module Spoom
         force = options[:force]
         dry = options[:dry]
         only = options[:only]
+        cmd = options[:suggest_bump_command]
         exec_path = File.expand_path(self.exec_path)
 
         unless Sorbet::Sigils.valid_strictness?(from)
-          say_error("Invalid strictness #{from} for option --from")
+          say_error("Invalid strictness `#{from}` for option `--from`")
           exit(1)
         end
 
         unless Sorbet::Sigils.valid_strictness?(to)
-          say_error("Invalid strictness #{to} for option --to")
+          say_error("Invalid strictness `#{to}` for option `--to`")
           exit(1)
         end
 
+        say("Checking files...")
+
         directory = File.expand_path(directory)
         files_to_bump = Sorbet::Sigils.files_with_sigil_strictness(directory, from)
 
+        files_from_config = config_files(path: exec_path)
+        files_to_bump.select! { |file| files_from_config.include?(file) }
+
         if only
           list = File.read(only).lines.map { |file| File.expand_path(file.strip) }
           files_to_bump.select! { |file| list.include?(File.expand_path(file)) }
         end
 
+        say("\n")
+
         if files_to_bump.empty?
-          $stderr.puts("No file to bump from #{from} to #{to}")
+          say("No file to bump from `#{from}` to `#{to}`")
           exit(0)
         end
 
         Sorbet::Sigils.change_sigil_in_files(files_to_bump, to)
 
         if force
-          print_changes(files_to_bump, from: from, to: to, dry: dry, path: exec_path)
+          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
@@ -69,7 +79,7 @@ module Spoom
         output, no_errors = Sorbet.srb_tc(path: exec_path, capture_err: true, sorbet_bin: options[:sorbet])
 
         if no_errors
-          print_changes(files_to_bump, from: from, to: to, dry: dry, path: exec_path)
+          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
@@ -86,32 +96,42 @@ module Spoom
         undo_changes(files_with_errors, from)
 
         files_changed = files_to_bump - files_with_errors
-        print_changes(files_changed, from: from, to: to, dry: dry, path: exec_path)
+        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
 
       no_commands do
-        def print_changes(files, from: "false", to: "true", dry: false, path: File.expand_path("."))
+        def print_changes(files, command:, from: "false", to: "true", dry: false, path: File.expand_path("."))
           if files.empty?
-            $stderr.puts("No file to bump from #{from} to #{to}")
+            say("No file to bump from `#{from}` to `#{to}`")
             return
           end
-          $stderr.write(dry ? "Can bump" : "Bumped")
-          $stderr.write(" #{files.size} file#{'s' if files.size > 1}")
-          $stderr.puts(" from #{from} to #{to}:")
+          message = StringIO.new
+          message << (dry ? "Can bump" : "Bumped")
+          message << " `#{files.size}` file#{'s' if files.size > 1}"
+          message << " from `#{from}` to `#{to}`:"
+          say(message.string)
           files.each do |file|
             file_path = Pathname.new(file).relative_path_from(path)
-            $stderr.puts(" + #{file_path}")
+            say(" + #{file_path}")
           end
-          if dry
-            $stderr.puts("\nRun `spoom bump --from #{from} --to #{to}` to bump them")
+          if dry && command
+            say("\nRun `#{command}` to bump them")
+          elsif dry
+            say("\nRun `spoom bump --from #{from} --to #{to}` to bump them")
           end
         end
 
         def undo_changes(files, from_strictness)
           Sorbet::Sigils.change_sigil_in_files(files, from_strictness)
         end
+
+        def config_files(path: ".")
+          config = sorbet_config
+          files = Sorbet.srb_files(config, path: path)
+          files.map { |file| File.expand_path(file) }
+        end
       end
     end
   end

data/lib/spoom/cli/config.rb

@@ -14,9 +14,9 @@ module Spoom
       desc "show", "Show Sorbet config"
       def show
         in_sorbet_project!
-        config = Spoom::Sorbet::Config.parse_file(sorbet_config)
+        config = sorbet_config
 
-        say("Found Sorbet config at `#{sorbet_config}`.")
+        say("Found Sorbet config at `#{sorbet_config_file}`.")
 
         say("\nPaths typechecked:")
         if config.paths.empty?

data/lib/spoom/cli/coverage.rb

@@ -30,7 +30,7 @@ module Spoom
         FileUtils.mkdir_p(save_dir)
         file = "#{save_dir}/#{snapshot.commit_sha || snapshot.timestamp}.json"
         File.write(file, snapshot.to_json)
-        puts "\nSnapshot data saved under #{file}"
+        say("\nSnapshot data saved under `#{file}`")
       end
 
       desc "timeline", "Replay a project and collect metrics"
@@ -47,14 +47,18 @@ module Spoom
         sha_before = Spoom::Git.last_commit(path: path)
         unless sha_before
           say_error("Not in a git repository")
-          $stderr.puts "\nSpoom needs to checkout into your previous commits to build the timeline."
+          say_error("\nSpoom needs to checkout into your previous commits to build the timeline.", status: nil)
           exit(1)
         end
 
         unless Spoom::Git.workdir_clean?(path: path)
           say_error("Uncommited changes")
-          $stderr.puts "\nSpoom needs to checkout into your previous commits to build the timeline."
-          $stderr.puts "\nPlease git commit or git stash your changes then try again."
+          say_error(<<~ERR, status: nil)
+
+            Spoom needs to checkout into your previous commits to build the timeline."
+
+            Please `git commit` or `git stash` your changes then try again
+          ERR
           exit(1)
         end
 
@@ -74,13 +78,13 @@ module Spoom
         ticks = timeline.ticks
 
         if ticks.empty?
-          say_error("No commits to replay, try different --from and --to options")
+          say_error("No commits to replay, try different `--from` and `--to` options")
           exit(1)
         end
 
         ticks.each_with_index do |sha, i|
           date = Spoom::Git.commit_time(sha, path: path)
-          puts "Analyzing commit #{sha} - #{date&.strftime('%F')} (#{i + 1} / #{ticks.size})"
+          say("Analyzing commit `#{sha}` - #{date&.strftime('%F')} (#{i + 1} / #{ticks.size})")
 
           Spoom::Git.checkout(sha, path: path)
 
@@ -96,12 +100,12 @@ module Spoom
           next unless snapshot
 
           snapshot.print(indent_level: 2)
-          puts "\n"
+          say("\n")
 
           next unless save_dir
           file = "#{save_dir}/#{sha}.json"
           File.write(file, snapshot.to_json)
-          puts "  Snapshot data saved under #{file}\n\n"
+          say("  Snapshot data saved under `#{file}`\n\n")
         end
         Spoom::Git.checkout(sha_before, path: path)
       end
@@ -146,20 +150,20 @@ module Spoom
         report = Spoom::Coverage.report(snapshots, palette: palette, path: exec_path)
         file = options[:file]
         File.write(file, report.html)
-        puts "Report generated under #{file}"
-        puts "\nUse #{colorize('spoom coverage open', :blue)} to open it."
+        say("Report generated under `#{file}`")
+        say("\nUse `spoom coverage open` to open it.")
       end
 
       desc "open", "Open the typing coverage report"
       def open(file = "spoom_report.html")
         unless File.exist?(file)
-          say_error("No report file to open #{colorize(file, :blue)}")
-          $stderr.puts <<~OUT
+          say_error("No report file to open `#{file}`")
+          say_error(<<~ERR, status: nil)
 
-            If you already generated a report under another name use #{colorize('spoom coverage open PATH', :blue)}.
+            If you already generated a report under another name use #{blue('spoom coverage open PATH')}.
 
-            To generate a report run #{colorize('spoom coverage report', :blue)}.
-          OUT
+            To generate a report run #{blue('spoom coverage report')}.
+          ERR
           exit(1)
         end
 
@@ -171,7 +175,7 @@ module Spoom
           return nil unless string
           Time.parse(string)
         rescue ArgumentError
-          say_error("Invalid date `#{string}` for option #{option} (expected format YYYY-MM-DD)")
+          say_error("Invalid date `#{string}` for option `#{option}` (expected format `YYYY-MM-DD`)")
           exit(1)
         end
 
@@ -180,21 +184,21 @@ module Spoom
           opts[:chdir] = path
           out, status = Open3.capture2e("bundle install", opts)
           unless status.success?
-            say_error("Can't run `bundle install` for commit #{sha}. Skipping snapshot")
-            $stderr.puts(out)
+            say_error("Can't run `bundle install` for commit `#{sha}`. Skipping snapshot")
+            say_error(out, status: nil)
             return false
           end
           true
         end
 
         def message_no_data(file)
-          say_error("No snapshot files found in #{colorize(file, :blue)}")
-          $stderr.puts <<~OUT
+          say_error("No snapshot files found in `#{file}`")
+          say_error(<<~ERR, status: nil)
 
-            If you already generated snapshot files under another directory use #{colorize('spoom coverage report PATH', :blue)}.
+            If you already generated snapshot files under another directory use #{blue('spoom coverage report PATH')}.
 
-            To generate snapshot files run #{colorize('spoom coverage timeline --save-dir spoom_data', :blue)}.
-          OUT
+            To generate snapshot files run #{blue('spoom coverage timeline --save-dir spoom_data')}.
+          ERR
         end
       end
     end

data/lib/spoom/cli/helper.rb

@@ -11,16 +11,32 @@ module Spoom
       extend T::Sig
       include Thor::Shell
 
+      # Print `message` on `$stdout`
+      sig { params(message: String).void }
+      def say(message)
+        buffer = StringIO.new
+        buffer << highlight(message)
+        buffer << "\n" unless message.end_with?("\n")
+
+        $stdout.print(buffer.string)
+        $stdout.flush
+      end
+
       # Print `message` on `$stderr`
       #
       # The message is prefixed by a status (default: `Error`).
-      sig { params(message: String, status: String).void }
-      def say_error(message, status = "Error")
-        status = set_color(status, :red)
-
+      sig do
+        params(
+          message: String,
+          status: T.nilable(String),
+          nl: T::Boolean
+        ).void
+      end
+      def say_error(message, status: "Error", nl: true)
         buffer = StringIO.new
-        buffer << "#{status}: #{message}"
-        buffer << "\n" unless message.end_with?("\n")
+        buffer << "#{red(status)}: " if status
+        buffer << highlight(message)
+        buffer << "\n" if nl && !message.end_with?("\n")
 
         $stderr.print(buffer.string)
         $stderr.flush
@@ -29,7 +45,7 @@ module Spoom
       # Is `spoom` ran inside a project with a `sorbet/config` file?
       sig { returns(T::Boolean) }
       def in_sorbet_project?
-        File.file?(sorbet_config)
+        File.file?(sorbet_config_file)
       end
 
       # Enforce that `spoom` is ran inside a project with a `sorbet/config` file
@@ -39,9 +55,9 @@ module Spoom
       def in_sorbet_project!
         unless in_sorbet_project?
           say_error(
-            "not in a Sorbet project (#{colorize(sorbet_config, :yellow)} not found)\n\n" \
+            "not in a Sorbet project (`#{sorbet_config_file}` not found)\n\n" \
             "When running spoom from another path than the project's root, " \
-            "use #{colorize('--path PATH', :blue)} to specify the path to the root."
+            "use `--path PATH` to specify the path to the root."
           )
           Kernel.exit(1)
         end
@@ -54,22 +70,80 @@ module Spoom
       end
 
       sig { returns(String) }
-      def sorbet_config
+      def sorbet_config_file
         Pathname.new("#{exec_path}/#{Spoom::Sorbet::CONFIG_PATH}").cleanpath.to_s
       end
 
+      sig { returns(Sorbet::Config) }
+      def sorbet_config
+        Sorbet::Config.parse_file(sorbet_config_file)
+      end
+
+      # Colors
+
+      # Color used to highlight expressions in backticks
+      HIGHLIGHT_COLOR = :blue
+
       # Is the `--color` option true?
       sig { returns(T::Boolean) }
       def color?
         T.unsafe(self).options[:color] # TODO: requires_ancestor
       end
 
+      sig { params(string: String).returns(String) }
+      def highlight(string)
+        return string unless color?
+
+        res = StringIO.new
+        word = StringIO.new
+        in_ticks = T.let(false, T::Boolean)
+        string.chars.each do |c|
+          if c == '`' && !in_ticks
+            in_ticks = true
+          elsif c == '`' && in_ticks
+            in_ticks = false
+            res << colorize(word.string, HIGHLIGHT_COLOR)
+            word = StringIO.new
+          elsif in_ticks
+            word << c
+          else
+            res << c
+          end
+        end
+        res.string
+      end
+
       # Colorize a string if `color?`
       sig { params(string: String, color: Symbol).returns(String) }
       def colorize(string, color)
         return string unless color?
         string.colorize(color)
       end
+
+      sig { params(string: String).returns(String) }
+      def blue(string)
+        colorize(string, :blue)
+      end
+
+      sig { params(string: String).returns(String) }
+      def gray(string)
+        colorize(string, :light_black)
+      end
+
+      sig { params(string: String).returns(String) }
+      def green(string)
+        colorize(string, :green)
+      end
+
+      sig { params(string: String).returns(String) }
+      def red(string)
+        colorize(string, :red)
+      end
+
+      sig { params(string: String).returns(String) }
+      def yellow(string)
+        colorize(string, :yellow)
+      end
     end
   end
 end

data/lib/spoom/cli/lsp.rb

@@ -28,7 +28,7 @@ module Spoom
           Dir["**/*.rb"].each do |file|
             res = client.document_symbols(to_uri(file))
             next if res.empty?
-            puts "Symbols from `#{file}`:"
+            say("Symbols from `#{file}`:")
             printer.print_objects(res)
           end
         end
@@ -39,11 +39,11 @@ module Spoom
       def hover(file, line, col)
         run do |client|
           res = client.hover(to_uri(file), line.to_i, col.to_i)
-          say "Hovering `#{file}:#{line}:#{col}`:"
+          say("Hovering `#{file}:#{line}:#{col}`:")
           if res
             symbol_printer.print_object(res)
           else
-            puts "<no data>"
+            say("<no data>")
           end
         end
       end
@@ -53,7 +53,7 @@ module Spoom
       def defs(file, line, col)
         run do |client|
           res = client.definitions(to_uri(file), line.to_i, col.to_i)
-          puts "Definitions for `#{file}:#{line}:#{col}`:"
+          say("Definitions for `#{file}:#{line}:#{col}`:")
           symbol_printer.print_list(res)
         end
       end
@@ -63,7 +63,7 @@ module Spoom
       def find(query)
         run do |client|
           res = client.symbols(query).reject { |symbol| symbol.location.uri.start_with?("https") }
-          puts "Symbols matching `#{query}`:"
+          say("Symbols matching `#{query}`:")
           symbol_printer.print_objects(res)
         end
       end
@@ -73,7 +73,7 @@ module Spoom
       def symbols(file)
         run do |client|
           res = client.document_symbols(to_uri(file))
-          puts "Symbols from `#{file}`:"
+          say("Symbols from `#{file}`:")
           symbol_printer.print_objects(res)
         end
       end
@@ -83,7 +83,7 @@ module Spoom
       def refs(file, line, col)
         run do |client|
           res = client.references(to_uri(file), line.to_i, col.to_i)
-          puts "References to `#{file}:#{line}:#{col}`:"
+          say("References to `#{file}:#{line}:#{col}`:")
           symbol_printer.print_list(res)
         end
       end
@@ -93,7 +93,7 @@ module Spoom
       def sigs(file, line, col)
         run do |client|
           res = client.signatures(to_uri(file), line.to_i, col.to_i)
-          puts "Signature for `#{file}:#{line}:#{col}`:"
+          say("Signature for `#{file}:#{line}:#{col}`:")
           symbol_printer.print_list(res)
         end
       end
@@ -103,7 +103,7 @@ module Spoom
       def types(file, line, col)
         run do |client|
           res = client.type_definitions(to_uri(file), line.to_i, col.to_i)
-          say "Type for `#{file}:#{line}:#{col}`:"
+          say("Type for `#{file}:#{line}:#{col}`:")
           symbol_printer.print_list(res)
         end
       end
@@ -137,7 +137,7 @@ module Spoom
         rescue Spoom::LSP::Error::Diagnostics => err
           say_error("Sorbet returned typechecking errors for `#{symbol_printer.clean_uri(err.uri)}`")
           err.diagnostics.each do |d|
-            say_error("#{d.message} (#{d.code})", "  #{d.range}")
+            say_error("#{d.message} (#{d.code})", status: "  #{d.range}")
           end
           exit(1)
         rescue Spoom::LSP::Error::BadHeaders => err

data/lib/spoom/cli/run.rb

@@ -36,13 +36,13 @@ module Spoom
 
         unless limit || code || sort
           output, status = T.unsafe(Spoom::Sorbet).srb_tc(*arg, path: path, capture_err: false, sorbet_bin: sorbet)
-          $stderr.print(output)
+          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)
         if status
-          $stderr.print(output)
+          say_error(output, status: nil, nl: false)
           exit(0)
         end
 
@@ -65,14 +65,14 @@ module Spoom
         lines = lines.uniq if uniq
 
         lines.each do |line|
-          $stderr.puts line
+          say_error(line, status: nil)
         end
 
         if count
           if errors_count == errors.size
-            $stderr.puts "Errors: #{errors_count}"
+            say_error("Errors: #{errors_count}", status: nil)
           else
-            $stderr.puts "Errors: #{errors.size} shown, #{errors_count} total"
+            say_error("Errors: #{errors.size} shown, #{errors_count} total", status: nil)
           end
         end
 
@@ -82,7 +82,7 @@ module Spoom
       no_commands do
         def format_error(error, format)
           line = format
-          line = line.gsub(/%C/, colorize(error.code.to_s, :yellow))
+          line = line.gsub(/%C/, yellow(error.code.to_s))
           line = line.gsub(/%F/, error.file)
           line = line.gsub(/%L/, error.line.to_s)
           line = line.gsub(/%M/, colorize_message(error.message))

data/lib/spoom/printer.rb

@@ -1,7 +1,6 @@
 # typed: strict
 # frozen_string_literal: true
 
-require "colorize"
 require "stringio"
 
 module Spoom

data/lib/spoom/sorbet.rb

@@ -68,6 +68,7 @@ module Spoom
       end
       def srb_version(*arg, path: '.', capture_err: false, sorbet_bin: nil)
         out, res = T.unsafe(self).srb_tc(
+          "--no-config",
           "--version",
           *arg,
           path: path,

data/lib/spoom/test_helpers/project.rb

@@ -76,6 +76,15 @@ module Spoom
         Spoom::Git.exec("GIT_COMMITTER_DATE=\"#{date}\" git commit -m '#{message}' --date '#{date}'", path: path)
       end
 
+      # Run `bundle install` in this project
+      sig { returns([T.nilable(String), T.nilable(String), T::Boolean]) }
+      def bundle_install
+        opts = {}
+        opts[:chdir] = path
+        out, err, status = Open3.capture3("bundle", "install", opts)
+        [out, err, status.success?]
+      end
+
       # Run a command with `bundle exec` in this project
       sig { params(cmd: String, args: String).returns([T.nilable(String), T.nilable(String), T::Boolean]) }
       def bundle_exec(cmd, *args)

data/lib/spoom/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spoom
 version: !ruby/object:Gem::Version
-  version: 1.0.8
+  version: 1.0.9
 platform: ruby
 authors:
 - Alexandre Terrasa
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-01-22 00:00:00.000000000 Z
+date: 2021-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler