spoom 1.0.5 → 1.1.0

data/lib/spoom/file_tree.rb

@@ -80,7 +80,7 @@ module Spoom
 
     private
 
-    sig { params(node: FileTree::Node, collected_nodes: T::Array[Node]).returns(T::Array[String]) }
+    sig { params(node: FileTree::Node, collected_nodes: T::Array[Node]).returns(T::Array[Node]) }
     def collect_nodes(node, collected_nodes = [])
       collected_nodes << node
       node.children.values.each { |child| collect_nodes(child, collected_nodes) }

data/lib/spoom/git.rb

@@ -14,11 +14,12 @@ module Spoom
       return "", "Error: `#{path}` is not a directory.", false unless File.directory?(path)
       opts = {}
       opts[:chdir] = path
-      _, o, e, s = Open3.popen3(*T.unsafe([command, *T.unsafe(arg), opts]))
+      i, o, e, s = Open3.popen3(*T.unsafe([command, *T.unsafe(arg), opts]))
       out = o.read.to_s
       o.close
       err = e.read.to_s
       e.close
+      i.close
       [out, err, T.cast(s.value, Process::Status).success?]
     end
 

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

@@ -11,73 +11,112 @@ require "open3"
 
 module Spoom
   module Sorbet
-    extend T::Sig
+    CONFIG_PATH = "sorbet/config"
+    GEM_PATH = Gem::Specification.find_by_name("sorbet-static").full_gem_path
+    BIN_PATH = (Pathname.new(GEM_PATH) / "libexec" / "sorbet").to_s
 
-    sig { params(arg: String, path: String, capture_err: T::Boolean).returns([String, T::Boolean]) }
-    def self.srb(*arg, path: '.', capture_err: false)
-      opts = {}
-      opts[:chdir] = path
-      out = T.let("", T.nilable(String))
-      res = T.let(false, T::Boolean)
-      if capture_err
-        Open3.popen2e(["bundle", "exec", "srb", *arg].join(" "), opts) do |_, o, t|
-          out = o.read
-          res = T.cast(t.value, Process::Status).success?
-        end
-      else
-        Open3.popen2(["bundle", "exec", "srb", *arg].join(" "), opts) do |_, o, t|
-          out = o.read
-          res = T.cast(t.value, Process::Status).success?
+    class << self
+      extend T::Sig
+
+      sig do
+        params(
+          arg: String,
+          path: String,
+          capture_err: T::Boolean,
+          sorbet_bin: T.nilable(String)
+        ).returns([String, T::Boolean])
+      end
+      def srb(*arg, path: '.', capture_err: false, sorbet_bin: nil)
+        if sorbet_bin
+          arg.prepend(sorbet_bin)
+        else
+          arg.prepend("bundle", "exec", "srb")
         end
+        T.unsafe(Spoom).exec(*arg, path: path, capture_err: capture_err)
       end
-      [out || "", res]
-    end
 
-    sig { params(arg: String, path: String, capture_err: T::Boolean).returns([String, T::Boolean]) }
-    def self.srb_tc(*arg, path: '.', capture_err: false)
-      srb(*T.unsafe(["tc", *arg]), path: path, capture_err: capture_err)
-    end
+      sig do
+        params(
+          arg: String,
+          path: String,
+          capture_err: T::Boolean,
+          sorbet_bin: T.nilable(String)
+        ).returns([String, T::Boolean])
+      end
+      def srb_tc(*arg, path: '.', capture_err: false, sorbet_bin: nil)
+        arg.prepend("tc") unless sorbet_bin
+        T.unsafe(self).srb(*arg, path: path, capture_err: capture_err, sorbet_bin: sorbet_bin)
+      end
 
-    # List all files typechecked by Sorbet from its `config`
-    sig { params(config: Config, path: String).returns(T::Array[String]) }
-    def self.srb_files(config, path: '.')
-      regs = config.ignore.map { |string| Regexp.new(Regexp.escape(string)) }
-      exts = config.allowed_extensions.empty? ? ['.rb', '.rbi'] : config.allowed_extensions
-      Dir.glob((Pathname.new(path) / "**/*{#{exts.join(',')}}").to_s).reject do |f|
-        regs.any? { |re| re.match?(f) }
-      end.sort
-    end
+      # List all files typechecked by Sorbet from its `config`
+      sig { params(config: Config, path: String).returns(T::Array[String]) }
+      def srb_files(config, path: '.')
+        regs = config.ignore.map { |string| Regexp.new(Regexp.escape(string)) }
+        exts = config.allowed_extensions.empty? ? ['.rb', '.rbi'] : config.allowed_extensions
+        Dir.glob((Pathname.new(path) / "**/*{#{exts.join(',')}}").to_s).reject do |f|
+          regs.any? { |re| re.match?(f) }
+        end.sort
+      end
 
-    sig { params(arg: String, path: String, capture_err: T::Boolean).returns(T.nilable(String)) }
-    def self.srb_version(*arg, path: '.', capture_err: false)
-      out, res = srb(*T.unsafe(["--version", *arg]), path: path, capture_err: capture_err)
-      return nil unless res
-      out.split(" ")[2]
-    end
+      sig do
+        params(
+          arg: String,
+          path: String,
+          capture_err: T::Boolean,
+          sorbet_bin: T.nilable(String)
+        ).returns(T.nilable(String))
+      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,
+          capture_err: capture_err,
+          sorbet_bin: sorbet_bin
+        )
+        return nil unless res
+        out.split(" ")[2]
+      end
 
-    sig { params(arg: String, path: String, capture_err: T::Boolean).returns(T.nilable(T::Hash[String, Integer])) }
-    def self.srb_metrics(*arg, path: '.', capture_err: false)
-      metrics_file = "metrics.tmp"
-      metrics_path = "#{path}/#{metrics_file}"
-      srb_tc(*T.unsafe(["--metrics-file=#{metrics_file}", *arg]), path: path, capture_err: capture_err)
-      if File.exist?(metrics_path)
-        metrics = Spoom::Sorbet::MetricsParser.parse_file(metrics_path)
-        File.delete(metrics_path)
-        return metrics
+      sig do
+        params(
+          arg: String,
+          path: String,
+          capture_err: T::Boolean,
+          sorbet_bin: T.nilable(String)
+        ).returns(T.nilable(T::Hash[String, Integer]))
+      end
+      def srb_metrics(*arg, path: '.', capture_err: false, sorbet_bin: nil)
+        metrics_file = "metrics.tmp"
+        metrics_path = "#{path}/#{metrics_file}"
+        T.unsafe(self).srb_tc(
+          "--metrics-file",
+          metrics_file,
+          *arg,
+          path: path,
+          capture_err: capture_err,
+          sorbet_bin: sorbet_bin
+        )
+        if File.exist?(metrics_path)
+          metrics = Spoom::Sorbet::MetricsParser.parse_file(metrics_path)
+          File.delete(metrics_path)
+          return metrics
+        end
+        nil
       end
-      nil
-    end
 
-    # Get `gem` version from the `Gemfile.lock` content
-    #
-    # Returns `nil` if `gem` cannot be found in the Gemfile.
-    sig { params(gem: String, path: String).returns(T.nilable(String)) }
-    def self.version_from_gemfile_lock(gem: 'sorbet', path: '.')
-      gemfile_path = "#{path}/Gemfile.lock"
-      return nil unless File.exist?(gemfile_path)
-      content = File.read(gemfile_path).match(/^    #{gem} \(.*(\d+\.\d+\.\d+).*\)/)
-      return nil unless content
-      content[1]
+      # Get `gem` version from the `Gemfile.lock` content
+      #
+      # Returns `nil` if `gem` cannot be found in the Gemfile.
+      sig { params(gem: String, path: String).returns(T.nilable(String)) }
+      def version_from_gemfile_lock(gem: 'sorbet', path: '.')
+        gemfile_path = "#{path}/Gemfile.lock"
+        return nil unless File.exist?(gemfile_path)
+        content = File.read(gemfile_path).match(/^    #{gem} \(.*(\d+\.\d+\.\d+).*\)/)
+        return nil unless content
+        content[1]
+      end
     end
   end
 end

data/lib/spoom/sorbet/config.rb

@@ -36,6 +36,36 @@ module Spoom
         @allowed_extensions = T.let([], T::Array[String])
       end
 
+      sig { returns(Config) }
+      def copy
+        new_config = Sorbet::Config.new
+        new_config.paths.concat(@paths)
+        new_config.ignore.concat(@ignore)
+        new_config.allowed_extensions.concat(@allowed_extensions)
+        new_config
+      end
+
+      # Returns self as a string of options that can be passed to Sorbet
+      #
+      # Example:
+      # ~~~rb
+      # config = Sorbet::Config.new
+      # config.paths << "/foo"
+      # config.paths << "/bar"
+      # config.ignore << "/baz"
+      # config.allowed_extensions << ".rb"
+      #
+      # puts config.options_string # "/foo /bar --ignore /baz --allowed-extension .rb"
+      # ~~~
+      sig { returns(String) }
+      def options_string
+        opts = []
+        opts.concat(paths)
+        opts.concat(ignore.map { |p| "--ignore #{p}" })
+        opts.concat(allowed_extensions.map { |ext| "--allowed-extension #{ext}" })
+        opts.join(" ")
+      end
+
       class << self
         extend T::Sig
 

data/lib/spoom/sorbet/errors.rb

@@ -4,6 +4,8 @@
 module Spoom
   module Sorbet
     module Errors
+      extend T::Sig
+
       # Parse errors from Sorbet output
       class Parser
         extend T::Sig
@@ -123,6 +125,7 @@ module Spoom
           @more = more
         end
 
+        # By default errors are sorted by location
         sig { params(other: T.untyped).returns(Integer) }
         def <=>(other)
           return 0 unless other.is_a?(Error)
@@ -134,6 +137,11 @@ module Spoom
           "#{file}:#{line}: #{message} (#{code})"
         end
       end
+
+      sig { params(errors: T::Array[Error]).returns(T::Array[Error]) }
+      def self.sort_errors_by_code(errors)
+        errors.sort_by { |e| [e.code, e.file, e.line, e.message] }
+      end
     end
   end
 end

data/lib/spoom/sorbet/lsp.rb

@@ -11,13 +11,9 @@ require_relative 'lsp/errors'
 module Spoom
   module LSP
     class Client
-      def initialize(sorbet_cmd, *sorbet_args, path: ".")
+      def initialize(sorbet_bin, *sorbet_args, path: ".")
         @id = 0
-        Bundler.with_clean_env do
-          opts = {}
-          opts[:chdir] = path
-          @in, @out, @err, @status = Open3.popen3([sorbet_cmd, *sorbet_args].join(" "), opts)
-        end
+        @in, @out, @err, @status = T.unsafe(Open3).popen3(sorbet_bin, *sorbet_args, chdir: path)
       end
 
       def next_id

data/lib/spoom/sorbet/sigils.rb

@@ -56,14 +56,14 @@ module Spoom
       sig { params(path: T.any(String, Pathname)).returns(T.nilable(String)) }
       def self.file_strictness(path)
         return nil unless File.exist?(path)
-        content = File.read(path)
+        content = File.read(path, encoding: Encoding::ASCII_8BIT)
         strictness_in_content(content)
       end
 
       # changes the sigil in the file at the passed path to the specified new strictness
       sig { params(path: T.any(String, Pathname), new_strictness: String).returns(T::Boolean) }
       def self.change_sigil_in_file(path, new_strictness)
-        content = File.read(path)
+        content = File.read(path, encoding: Encoding::ASCII_8BIT)
         new_content = update_sigil(content, new_strictness)
 
         File.write(path, new_content)
@@ -87,7 +87,7 @@ module Spoom
           extension: String
         ).returns(T::Array[String])
       end
-      def self.files_with_sigil_strictness(directory, strictness, extension = ".rb")
+      def self.files_with_sigil_strictness(directory, strictness, extension: ".rb")
         paths = Dir.glob("#{File.expand_path(directory)}/**/*#{extension}").sort.uniq
         paths.filter do |path|
           file_strictness(path) == strictness

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

@@ -1,6 +1,6 @@
-# typed: true
+# typed: strict
 # frozen_string_literal: true
 
 module Spoom
-  VERSION = "1.0.5"
+  VERSION = "1.1.0"
 end

data/templates/card.erb

@@ -0,0 +1,8 @@
+<div class="card">
+  <% if title %>
+    <h5 class="card-header"><%= title %></h5>
+  <% end %>
+  <div class="card-body">
+    <%= body %>
+  </div>
+</div>

data/templates/card_snapshot.erb

@@ -0,0 +1,22 @@
+<div class="card">
+  <% if title %>
+    <h5 class="card-header"><%= title %></h5>
+  <% end %>
+  <div class="card-body">
+    <div class="container-fluid">
+      <div class="row justify-content-md-center">
+        <div class="col-12 col-sm-4 col-xl-3">
+          <%= pie_sigils.html %>
+        </div>
+        <div class="d-none d-xl-block col-xl-1"></div>
+        <div class="col-12 col-sm-4 col-xl-3">
+          <%= pie_calls.html %>
+        </div>
+        <div class="d-none d-xl-block col-xl-1"></div>
+        <div class="col-12 col-sm-4 col-xl-3">
+          <%= pie_sigs.html %>
+        </div>
+      </div>
+    </div>
+  </div>
+</div>

data/templates/page.erb

@@ -0,0 +1,50 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="utf-8" />
+  <meta http-equiv="x-ua-compatible" content="ie=edge" />
+  <meta name="viewport" content="width=device-width, initial-scale=1" />
+
+  <title><%= title %></title>
+  <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.5.0/css/bootstrap.min.css">
+
+  <style>
+    .card {
+      margin: 30px 0 0 0;
+    }
+
+    .footer {
+      color: #6c757d;
+      text-align: center;
+      margin: 30px 0 0 0;
+    }
+
+    <%= header_style %>
+  </style>
+</head>
+<body>
+  <script src="https://code.jquery.com/jquery-3.5.1.slim.min.js"></script>
+  <script src="https://stackpath.bootstrapcdn.com/bootstrap/4.5.0/js/bootstrap.min.js"></script>
+  <script src="https://d3js.org/d3.v4.min.js"></script>
+
+  <script>
+    <%= header_script %>
+  </script>
+
+  <div class="px-5 py-4 container-fluid">
+    <div class="row justify-content-center">
+      <div class="col-xs-12 col-md-12 col-lg-9 col-xl-8">
+        <div class="header">
+          <%= header_html %>
+        </div>
+        <div class="body">
+          <%= body_html %>
+        </div>
+        <div class="footer">
+          <%= footer_html %>
+        </div>
+      </div>
+    </div>
+  </div>
+</body>
+</html>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spoom
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.1.0
 platform: ruby
 authors:
 - Alexandre Terrasa
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-11-19 00:00:00.000000000 Z
+date: 2021-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -70,16 +70,16 @@ dependencies:
   name: sorbet
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.5
+        version: 0.5.6347
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.5
+        version: 0.5.6347
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -128,7 +128,6 @@ files:
 - lib/spoom/cli/helper.rb
 - lib/spoom/cli/lsp.rb
 - lib/spoom/cli/run.rb
-- lib/spoom/config.rb
 - lib/spoom/coverage.rb
 - lib/spoom/coverage/d3.rb
 - lib/spoom/coverage/d3/base.rb
@@ -152,6 +151,9 @@ files:
 - lib/spoom/test_helpers/project.rb
 - lib/spoom/timeline.rb
 - lib/spoom/version.rb
+- templates/card.erb
+- templates/card_snapshot.erb
+- templates/page.erb
 homepage: https://github.com/Shopify/spoom
 licenses:
 - MIT