spoom 1.1.11 → 1.1.12

data/lib/spoom/sorbet.rb

@@ -28,7 +28,7 @@ module Spoom
           sorbet_bin: T.nilable(String)
         ).returns(ExecResult)
       end
-      def srb(*arg, path: '.', capture_err: false, sorbet_bin: nil)
+      def srb(*arg, path: ".", capture_err: false, sorbet_bin: nil)
         if sorbet_bin
           arg.prepend(sorbet_bin)
         else
@@ -45,17 +45,17 @@ module Spoom
           sorbet_bin: T.nilable(String)
         ).returns(ExecResult)
       end
-      def srb_tc(*arg, path: '.', capture_err: false, sorbet_bin: nil)
+      def srb_tc(*arg, path: ".", capture_err: false, sorbet_bin: nil)
         arg.prepend("tc") unless sorbet_bin
         srb(*T.unsafe(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 srb_files(config, path: '.')
+      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|
+        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
@@ -68,7 +68,7 @@ module Spoom
           sorbet_bin: T.nilable(String)
         ).returns(T.nilable(String))
       end
-      def srb_version(*arg, path: '.', capture_err: false, sorbet_bin: nil)
+      def srb_version(*arg, path: ".", capture_err: false, sorbet_bin: nil)
         result = T.let(T.unsafe(self).srb_tc(
           "--no-config",
           "--version",
@@ -78,6 +78,7 @@ module Spoom
           sorbet_bin: sorbet_bin
         ), ExecResult)
         return nil unless result.status
+
         result.out.split(" ")[2]
       end
 
@@ -89,7 +90,7 @@ module Spoom
           sorbet_bin: T.nilable(String)
         ).returns(T.nilable(T::Hash[String, Integer]))
       end
-      def srb_metrics(*arg, path: '.', capture_err: false, sorbet_bin: nil)
+      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(
@@ -112,11 +113,13 @@ module Spoom
       #
       # 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: '.')
+      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

data/lib/spoom/timeline.rb

@@ -46,6 +46,7 @@ module Spoom
           path: @path,
         )
         next if result.out.empty?
+
         result.out
       end.compact.uniq
     end

data/lib/spoom/version.rb

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

data/lib/spoom.rb

@@ -12,41 +12,59 @@ module Spoom
   class Error < StandardError; end
 
   class ExecResult < T::Struct
+    extend T::Sig
+
     const :out, String
     const :err, String
     const :status, T::Boolean
     const :exit_code, Integer
-  end
 
-  sig do
-    params(
-      cmd: String,
-      arg: String,
-      path: String,
-      capture_err: T::Boolean
-    ).returns(ExecResult)
+    sig { returns(String) }
+    def to_s
+      <<~STR
+        ########## STDOUT ##########
+        #{out.empty? ? "<empty>" : out}
+        ########## STDERR ##########
+        #{err.empty? ? "<empty>" : err}
+        ########## STATUS: #{status} ##########
+      STR
+    end
   end
-  def self.exec(cmd, *arg, path: '.', capture_err: false)
-    if capture_err
-      stdout, stderr, status = T.unsafe(Open3).capture3([cmd, *arg].join(" "), chdir: path)
-      ExecResult.new(
-        out: stdout,
-        err: stderr,
-        status: status.success?,
-        exit_code: status.exitstatus
-      )
-    else
-      stdout, status = T.unsafe(Open3).capture2([cmd, *arg].join(" "), chdir: path)
-      ExecResult.new(
-        out: stdout,
-        err: "",
-        status: status.success?,
-        exit_code: status.exitstatus
-      )
+
+  class << self
+    extend T::Sig
+
+    sig do
+      params(
+        cmd: String,
+        arg: String,
+        path: String,
+        capture_err: T::Boolean
+      ).returns(ExecResult)
+    end
+    def exec(cmd, *arg, path: ".", capture_err: false)
+      if capture_err
+        stdout, stderr, status = T.unsafe(Open3).capture3([cmd, *arg].join(" "), chdir: path)
+        ExecResult.new(
+          out: stdout,
+          err: stderr,
+          status: status.success?,
+          exit_code: status.exitstatus
+        )
+      else
+        stdout, status = T.unsafe(Open3).capture2([cmd, *arg].join(" "), chdir: path)
+        ExecResult.new(
+          out: stdout,
+          err: "",
+          status: status.success?,
+          exit_code: status.exitstatus
+        )
+      end
     end
   end
 end
 
+require "spoom/context"
 require "spoom/colors"
 require "spoom/sorbet"
 require "spoom/cli"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spoom
 version: !ruby/object:Gem::Version
-  version: 1.1.11
+  version: 1.1.12
 platform: ruby
 authors:
 - Alexandre Terrasa
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-04-05 00:00:00.000000000 Z
+date: 2022-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -25,49 +25,49 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 2.2.10
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 13.0.1
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 13.0.1
+        version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: minitest-reporters
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest-reporters
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 13.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 13.0.1
 - !ruby/object:Gem::Dependency
-  name: sorbet-runtime
+  name: sorbet
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.5.9204
 - !ruby/object:Gem::Dependency
-  name: sorbet
+  name: sorbet-runtime
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -129,6 +129,7 @@ files:
 - lib/spoom/cli/lsp.rb
 - lib/spoom/cli/run.rb
 - lib/spoom/colors.rb
+- lib/spoom/context.rb
 - lib/spoom/coverage.rb
 - lib/spoom/coverage/d3.rb
 - lib/spoom/coverage/d3/base.rb
@@ -149,7 +150,6 @@ files:
 - lib/spoom/sorbet/lsp/structures.rb
 - lib/spoom/sorbet/metrics.rb
 - lib/spoom/sorbet/sigils.rb
-- lib/spoom/test_helpers/project.rb
 - lib/spoom/timeline.rb
 - lib/spoom/version.rb
 - templates/card.erb
@@ -168,14 +168,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.7
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.20
+rubygems_version: 3.3.3
 signing_key: 
 specification_version: 4
 summary: Useful tools for Sorbet enthusiasts.

data/lib/spoom/test_helpers/project.rb

@@ -1,138 +0,0 @@
-# typed: strict
-# frozen_string_literal: true
-
-require "fileutils"
-require "open3"
-require "pathname"
-
-require_relative "../git"
-
-module Spoom
-  module TestHelpers
-    # A simple project abstraction for testing purposes
-    class Project
-      extend T::Sig
-
-      # The absolute path to this test project
-      sig { returns(String) }
-      attr_reader :path
-
-      # Create a new test project at `path`
-      sig { params(path: String).void }
-      def initialize(path)
-        @path = path
-        FileUtils.rm_rf(@path)
-        FileUtils.mkdir_p(@path)
-      end
-
-      # Content
-
-      # Set the content of the Gemfile in this project
-      sig { params(content: String).void }
-      def gemfile(content)
-        write("Gemfile", content)
-      end
-
-      # Set the content of `sorbet/config` in this project
-      sig { params(content: String).void }
-      def sorbet_config(content)
-        write("sorbet/config", content)
-      end
-
-      # Write `content` in the file at `rel_path`
-      sig { params(rel_path: String, content: String).void }
-      def write(rel_path, content = "")
-        path = absolute_path(rel_path)
-        FileUtils.mkdir_p(File.dirname(path))
-        File.write(path, content)
-      end
-
-      # Remove `rel_path`
-      sig { params(rel_path: String).void }
-      def remove(rel_path)
-        FileUtils.rm_rf(absolute_path(rel_path))
-      end
-
-      # List all files in this project
-      sig { returns(T::Array[String]) }
-      def files
-        Dir.glob("#{@path}/**/*").sort
-      end
-
-      # Return the content of the file at `rel_path`
-      sig { params(rel_path: String).returns(String) }
-      def read(rel_path)
-        File.read(absolute_path(rel_path))
-      end
-
-      # Actions
-
-      # Run `git init` in this project
-      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
-
-      # Commit all new changes in this project
-      sig { params(message: String, date: Time).void }
-      def commit(message = "message", date: Time.now.utc)
-        Spoom::Git.exec("git add --all", path: path)
-        Spoom::Git.exec("GIT_COMMITTER_DATE=\"#{date}\" git commit -m '#{message}' --date '#{date}'", path: path)
-      end
-
-      # Run `bundle install` in this project
-      sig { returns(ExecResult) }
-      def bundle_install
-        opts = {}
-        opts[:chdir] = path
-        out, err, status = Open3.capture3("bundle", "install", opts)
-        ExecResult.new(
-          out: out,
-          err: err,
-          status: T.must(status.success?),
-          exit_code: T.must(status.exitstatus)
-        )
-      end
-
-      # Run a command with `bundle exec` in this project
-      sig { params(cmd: String, args: String).returns(ExecResult) }
-      def bundle_exec(cmd, *args)
-        opts = {}
-        opts[:chdir] = path
-        out, err, status = Open3.capture3(["bundle", "exec", cmd, *args].join(' '), opts)
-        ExecResult.new(
-          out: out,
-          err: err,
-          status: T.must(status.success?),
-          exit_code: T.must(status.exitstatus)
-        )
-      end
-
-      # Delete this project and its content
-      sig { void }
-      def destroy
-        FileUtils.rm_rf(path)
-      end
-
-      sig { params(name: String).void }
-      def create_and_checkout_branch(name)
-        Spoom::Git.exec("git checkout -b #{name}", path: path)
-      end
-
-      sig { returns(T.nilable(String)) }
-      def current_branch
-        Spoom::Git.current_branch(path: path)
-      end
-
-      private
-
-      # Create an absolute path from `self.path` and `rel_path`
-      sig { params(rel_path: String).returns(String) }
-      def absolute_path(rel_path)
-        (Pathname.new(path) / rel_path).to_s
-      end
-    end
-  end
-end