spoom 1.1.0 → 1.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c8ab95447c622919ce44c084fd3a3e6cfeb6c239f466bf956ba408909c4765b8
-  data.tar.gz: 52ec4172e6b9ac96ab64c813bcd92ac71912903d64e2af850864454820f20a09
+  metadata.gz: c138290b530402f788fd25c8238340609f68e370cdfce7166f82f910f6352125
+  data.tar.gz: '08595ccc6f1485d1b935c98a318daf9de6475d2fbcc742efafd955679e372cd3'
 SHA512:
-  metadata.gz: 19f29b380868435e4fb21d27004541a4a319a6c4eae1df5603a22f11698b0ef814bb4a6175a3932a9288ec92f7f8998e961735033992cbfa91d64a7f1ee1b438
-  data.tar.gz: 2da177e08833e1310d280bbf228e6763fbd3085e7d10780925acca0d50293062186f4b64b971e2ab436bae6f8120bbdd6c26bf6b04e25c92906a9f2cefa68751
+  metadata.gz: 8617496b57ade807623ef5cad109d20ff1024c8b6125c6286092859c69aab3e34f2a367fcb3ed531f425425af41cbc04492c0fd098f6e42170a9edf4bb41d120
+  data.tar.gz: b8040df444748a8769739caf0699d784ffcc4518e1a55c152d72f2073ae5a62d08ef02085aaa8808eb48c078baba7655e3880700ca8fb0b79830a52d66f95c7d

data/README.md

@@ -226,6 +226,12 @@ Bump files using a custom instance of Sorbet:
 $ spoom bump --from false --to true --sorbet /path/to/sorbet/bin
 ```
 
+Count the number of type-checking errors if all files were bumped to true:
+
+```
+$ spoom bump --count-errors --dry
+```
+
 #### Interact with Sorbet LSP mode
 
 **Experimental**

data/lib/spoom/cli/bump.rb

@@ -102,6 +102,7 @@ module Spoom
           path = File.expand_path(err.file)
           next unless path.start_with?(directory)
           next unless File.file?(path)
+          next unless files_to_bump.include?(path)
           path
         end.compact.uniq
 
@@ -133,7 +134,7 @@ module Spoom
           if dry && command
             say("\nRun `#{command}` to bump them")
           elsif dry
-            say("\nRun `spoom bump --from #{from} --to #{to}` to bump them")
+            say("\nRun `spoom bump --from #{from} --to #{to}` locally then `commit the changes` and `push them`")
           end
         end
 

data/lib/spoom/cli/coverage.rb

@@ -15,7 +15,7 @@ module Spoom
 
       desc "snapshot", "Run srb tc and display metrics"
       option :save, type: :string, lazy_default: DATA_DIR, desc: "Save snapshot data as json"
-      option :rbi, type: :boolean, default: true, desc: "Exclude RBI files from metrics"
+      option :rbi, type: :boolean, default: true, desc: "Include RBI files in metrics"
       option :sorbet, type: :string, desc: "Path to custom Sorbet bin"
       def snapshot
         in_sorbet_project!
@@ -44,8 +44,9 @@ module Spoom
         path = exec_path
         sorbet = options[:sorbet]
 
-        sha_before = Spoom::Git.last_commit(path: path)
-        unless sha_before
+        ref_before = Spoom::Git.current_branch
+        ref_before = Spoom::Git.last_commit(path: path) 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)
           exit(1)
@@ -90,7 +91,7 @@ module Spoom
 
           snapshot = T.let(nil, T.nilable(Spoom::Coverage::Snapshot))
           if options[:bundle_install]
-            Bundler.with_clean_env do
+            Bundler.with_unbundled_env do
               next unless bundle_install(path, sha)
               snapshot = Spoom::Coverage.snapshot(path: path, sorbet_bin: sorbet)
             end
@@ -107,7 +108,7 @@ module Spoom
           File.write(file, snapshot.to_json)
           say("  Snapshot data saved under `#{file}`\n\n")
         end
-        Spoom::Git.checkout(sha_before, path: path)
+        Spoom::Git.checkout(ref_before, path: path)
       end
 
       desc "report", "Produce a typing coverage report"

data/lib/spoom/cli/helper.rb

@@ -9,8 +9,11 @@ module Spoom
   module Cli
     module Helper
       extend T::Sig
+      extend T::Helpers
       include Thor::Shell
 
+      requires_ancestor { Thor }
+
       # Print `message` on `$stdout`
       sig { params(message: String).void }
       def say(message)
@@ -66,7 +69,7 @@ module Spoom
       # Return the path specified through `--path`
       sig { returns(String) }
       def exec_path
-        T.unsafe(self).options[:path] # TODO: requires_ancestor
+        options[:path]
       end
 
       sig { returns(String) }
@@ -87,7 +90,7 @@ module Spoom
       # Is the `--color` option true?
       sig { returns(T::Boolean) }
       def color?
-        T.unsafe(self).options[:color] # TODO: requires_ancestor
+        options[:color]
       end
 
       sig { params(string: String).returns(String) }

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

@@ -36,10 +36,28 @@ module Spoom
               pointer-events: none;
             }
 
+            .area {
+              fill-opacity: 0.5;
+            }
+
+            .line {
+              stroke-width: 2;
+              fill: transparent;
+            }
+
+            .dot {
+              r: 2;
+              fill: #888;
+            }
+
             .inverted .grid line {
               stroke: #777;
             }
 
+            .inverted .area {
+              fill-opacity: 0.9;
+            }
+
             .inverted .axis text {
               fill: #fff;
             }
@@ -47,6 +65,10 @@ module Spoom
             .inverted .axis line {
               stroke: #fff;
             }
+
+            .inverted .dot {
+              fill: #fff;
+            }
           CSS
         end
 
@@ -170,7 +192,6 @@ module Spoom
                 .y1((d) => yScale_#{id}(#{y}))
                 .curve(d3.#{curve}))
               .attr("fill", "#{color}")
-              .attr("fill-opacity", 0.5)
           HTML
         end
 
@@ -185,8 +206,6 @@ module Spoom
                  .y((d) => yScale_#{id}(#{y}))
                  .curve(d3.#{curve}))
                .attr("stroke", "#{color}")
-               .attr("stroke-width", 3)
-               .attr("fill", "transparent")
           HTML
         end
 
@@ -198,10 +217,8 @@ module Spoom
               .enter()
                 .append("circle")
                 .attr("class", "dot")
-                .attr("r", 3)
                 .attr("cx", (d) => xScale_#{id}(parseDate(d.timestamp)))
                 .attr("cy", (d, i) => yScale_#{id}(#{y}))
-                .attr("fill", "#aaa")
                 .on("mouseover", (d) => tooltip.style("opacity", 1))
                 .on("mousemove", tooltip_#{id})
                 .on("mouseleave", (d) => tooltip.style("opacity", 0));
@@ -381,18 +398,15 @@ module Spoom
               layer.append("path")
                 .attr("class", "area")
                 .attr("d", area_#{id})
-                .attr("fill", (d) => strictnessColor(d.key))
-                .attr("fill-opacity", 0.9)
+                .attr("fill", (d) => #{color})
 
               svg_#{id}.selectAll("circle")
                 .data(points_#{id})
                 .enter()
                   .append("circle")
                   .attr("class", "dot")
-                  .attr("r", 2)
                   .attr("cx", (d) => xScale_#{id}(parseDate(#{y})))
                   .attr("cy", (d, i) => yScale_#{id}(d[1]))
-                  .attr("fill", "#fff")
                   .on("mouseover", (d) => tooltip.style("opacity", 1))
                   .on("mousemove", tooltip_#{id})
                   .on("mouseleave", (d) => tooltip.style("opacity", 0));
@@ -480,6 +494,129 @@ module Spoom
             JS
           end
         end
+
+        class RBIs < Stacked
+          extend T::Sig
+
+          sig { params(id: String, snapshots: T::Array[Snapshot]).void }
+          def initialize(id, snapshots)
+            keys = ['rbis', 'files']
+            data = snapshots.map do |snapshot|
+              {
+                timestamp: snapshot.commit_timestamp,
+                commit: snapshot.commit_sha,
+                total: snapshot.files,
+                values: { files: snapshot.files - snapshot.rbi_files, rbis: snapshot.rbi_files },
+              }
+            end
+            super(id, data, keys)
+          end
+
+          sig { override.returns(String) }
+          def tooltip
+            <<~JS
+              function tooltip_#{id}(d) {
+                moveTooltip(d)
+                  .html("commit <b>" + d.data.commit + "</b><br>"
+                    + d3.timeFormat("%y/%m/%d")(parseDate(d.data.timestamp)) + "<br><br>"
+                    + "Files: <b>" + d.data.values.files + "</b><br>"
+                    + "RBIs: <b>" + d.data.values.rbis + "</b><br><br>"
+                    + "Total: <b>" + d.data.total + "</b>")
+              }
+            JS
+          end
+
+          sig { override.returns(String) }
+          def script
+            <<~JS
+              #{tooltip}
+
+              var data_#{id} = #{@data.to_json};
+              var keys_#{id} = #{T.unsafe(@keys).to_json};
+
+              var stack_#{id} = d3.stack()
+                .keys(keys_#{id})
+                .value((d, key) => d.values[key]);
+
+              var layers_#{id} = stack_#{id}(data_#{id});
+
+              var points_#{id} = []
+              layers_#{id}.forEach(function(d) {
+                d.forEach(function(p) {
+                  p.key = d.key
+                  points_#{id}.push(p);
+                });
+              })
+
+              function draw_#{id}() {
+                var width_#{id} = document.getElementById("#{id}").clientWidth;
+                var height_#{id} = 200;
+
+                d3.select("##{id}").selectAll("*").remove()
+
+                var svg_#{id} = d3.select("##{id}")
+                  .attr("width", width_#{id})
+                  .attr("height", height_#{id});
+
+                #{plot}
+              }
+
+              draw_#{id}();
+              window.addEventListener("resize", draw_#{id});
+            JS
+          end
+
+          sig { override.params(y: String, color: String, curve: String).returns(String) }
+          def line(y:, color: 'strictnessColor(d.key)', curve: 'curveCatmullRom.alpha(1)')
+            <<~JS
+              var area_#{id} = d3.area()
+                .x((d) => xScale_#{id}(parseDate(#{y})))
+                .y0((d) => yScale_#{id}(d[0]))
+                .y1((d) => yScale_#{id}(d[1]))
+                .curve(d3.#{curve});
+
+              var layer = svg_#{id}.selectAll(".layer")
+                .data(layers_#{id})
+                .enter().append("g")
+                  .attr("class", "layer")
+
+              layer.append("path")
+                .attr("class", "area")
+                .attr("d", area_#{id})
+                .attr("fill", (d) => #{color})
+
+              layer.append("path")
+                .attr("class", "line")
+                .attr("d", d3.line()
+                  .x((d) => xScale_#{id}(parseDate(#{y})))
+                  .y((d, i) => yScale_#{id}(d[1]))
+                  .curve(d3.#{curve}))
+                .attr("stroke", (d) => #{color})
+
+              svg_#{id}.selectAll("circle")
+                .data(points_#{id})
+                .enter()
+                  .append("circle")
+                  .attr("class", "dot")
+                  .attr("cx", (d) => xScale_#{id}(parseDate(#{y})))
+                  .attr("cy", (d, i) => yScale_#{id}(d[1]))
+                  .on("mouseover", (d) => tooltip.style("opacity", 1))
+                  .on("mousemove", tooltip_#{id})
+                  .on("mouseleave", (d) => tooltip.style("opacity", 0));
+            JS
+          end
+
+          sig { override.returns(String) }
+          def plot
+            <<~JS
+              #{x_scale}
+              #{y_scale(min: '0', max: "d3.max(data_#{id}, (d) => d.total + 10)", ticks: 'tickValues([0, 25, 50, 75, 100])')}
+              #{line(y: 'd.data.timestamp', color: "d.key == 'rbis' ? '#8673ff' : '#007bff'")}
+              #{x_ticks}
+              #{y_ticks(ticks: 'tickValues([25, 50, 75])', format: 'd', padding: 20)}
+            JS
+          end
+        end
       end
     end
   end

data/lib/spoom/coverage/report.rb

@@ -194,6 +194,15 @@ module Spoom
           end
         end
 
+        class RBIs < Timeline
+          extend T::Sig
+
+          sig { params(snapshots: T::Array[Coverage::Snapshot], title: String).void }
+          def initialize(snapshots:, title: "RBIs Timeline")
+            super(title: title, timeline: D3::Timeline::RBIs.new("timeline_rbis", snapshots))
+          end
+        end
+
         class Versions < Timeline
           extend T::Sig
 
@@ -298,6 +307,7 @@ module Spoom
         cards << Cards::Timeline::Sigils.new(snapshots: snapshots)
         cards << Cards::Timeline::Calls.new(snapshots: snapshots)
         cards << Cards::Timeline::Sigs.new(snapshots: snapshots)
+        cards << Cards::Timeline::RBIs.new(snapshots: snapshots)
         cards << Cards::Timeline::Versions.new(snapshots: snapshots)
         cards << Cards::Timeline::Runtimes.new(snapshots: snapshots)
         cards << Cards::SorbetIntro.new(sorbet_intro_commit: sorbet_intro_commit, sorbet_intro_date: sorbet_intro_date)

data/lib/spoom/coverage/snapshot.rb

@@ -13,6 +13,7 @@ module Spoom
       prop :commit_sha, T.nilable(String), default: nil
       prop :commit_timestamp, T.nilable(Integer), default: nil
       prop :files, Integer, default: 0
+      prop :rbi_files, Integer, default: 0
       prop :modules, Integer, default: 0
       prop :classes, Integer, default: 0
       prop :singleton_classes, Integer, default: 0
@@ -46,6 +47,7 @@ module Spoom
         snapshot.commit_sha = obj.fetch("commit_sha", nil)
         snapshot.commit_timestamp = obj.fetch("commit_timestamp", nil)
         snapshot.files = obj.fetch("files", 0)
+        snapshot.rbi_files = obj.fetch("rbi_files", 0)
         snapshot.modules = obj.fetch("modules", 0)
         snapshot.classes = obj.fetch("classes", 0)
         snapshot.singleton_classes = obj.fetch("singleton_classes", 0)
@@ -86,7 +88,7 @@ module Spoom
         end
         printl("Content:")
         indent
-        printl("files: #{snapshot.files}")
+        printl("files: #{snapshot.files} (including #{snapshot.rbi_files} RBIs)")
         printl("modules: #{snapshot.modules}")
         printl("classes: #{snapshot.classes - snapshot.singleton_classes}")
         printl("methods: #{methods}")

data/lib/spoom/coverage.rb

@@ -21,6 +21,9 @@ module Spoom
 
       metrics = Spoom::Sorbet.srb_metrics(
         "--no-config",
+        "--no-error-sections",
+        "--no-error-count",
+        "--isolate-error-code=0",
         new_config.options_string,
         path: path,
         capture_err: true,
@@ -54,6 +57,9 @@ module Spoom
       snapshot.version_static = Spoom::Sorbet.version_from_gemfile_lock(gem: "sorbet-static", path: path)
       snapshot.version_runtime = Spoom::Sorbet.version_from_gemfile_lock(gem: "sorbet-runtime", path: path)
 
+      files = Spoom::Sorbet.srb_files(new_config, path: path)
+      snapshot.rbi_files = files.count { |file| file.end_with?(".rbi") }
+
       snapshot
     end
 
@@ -81,8 +87,15 @@ module Spoom
     def self.sigils_tree(path: ".")
       config = sorbet_config(path: path)
       files = Sorbet.srb_files(config, path: path)
-      files.select! { |file| file =~ /\.rb$/ }
+
+      extensions = config.allowed_extensions
+      extensions = [".rb"] if extensions.empty?
+      extensions -= [".rbi"]
+
+      pattern = /\.(#{Regexp.union(extensions.map { |ext| ext[1..-1] })})$/
+      files.select! { |file| file =~ pattern }
       files.reject! { |file| file =~ %r{/test/} }
+
       FileTree.new(files, strip_prefix: path)
     end
   end

data/lib/spoom/git.rb

@@ -20,7 +20,7 @@ module Spoom
       err = e.read.to_s
       e.close
       i.close
-      [out, err, T.cast(s.value, Process::Status).success?]
+      [out, err, s.value.success?]
     end
 
     # Git commands
@@ -50,6 +50,13 @@ module Spoom
       exec("git show #{arg.join(' ')}", path: path)
     end
 
+    sig { params(path: String).returns(T.nilable(String)) }
+    def self.current_branch(path: ".")
+      out, _, status = exec("git branch --show-current", path: path)
+      return nil unless status
+      out.strip
+    end
+
     # Utils
 
     # Get the commit epoch timestamp for a `sha`
@@ -93,7 +100,19 @@ module Spoom
     def self.sorbet_intro_commit(path: ".")
       res, _, status = Spoom::Git.log("--diff-filter=A --format='%h' -1 -- sorbet/config", path: path)
       return nil unless status
-      res.strip
+      res.strip!
+      return nil if res.empty?
+      res
+    end
+
+    # Get the hash of the commit removing the `sorbet/config` file
+    sig { params(path: String).returns(T.nilable(String)) }
+    def self.sorbet_removal_commit(path: ".")
+      res, _, status = Spoom::Git.log("--diff-filter=D --format='%h' -1 -- sorbet/config", path: path)
+      return nil unless status
+      res.strip!
+      return nil if res.empty?
+      res
     end
   end
 end

data/lib/spoom/sorbet/config.rb

@@ -29,11 +29,15 @@ module Spoom
       sig { returns(T::Array[String]) }
       attr_reader :paths, :ignore, :allowed_extensions
 
+      sig { returns(T::Boolean) }
+      attr_accessor :no_stdlib
+
       sig { void }
       def initialize
         @paths = T.let([], T::Array[String])
         @ignore = T.let([], T::Array[String])
         @allowed_extensions = T.let([], T::Array[String])
+        @no_stdlib = T.let(false, T::Boolean)
       end
 
       sig { returns(Config) }
@@ -42,6 +46,7 @@ module Spoom
         new_config.paths.concat(@paths)
         new_config.ignore.concat(@ignore)
         new_config.allowed_extensions.concat(@allowed_extensions)
+        new_config.no_stdlib = @no_stdlib
         new_config
       end
 
@@ -63,6 +68,7 @@ module Spoom
         opts.concat(paths)
         opts.concat(ignore.map { |p| "--ignore #{p}" })
         opts.concat(allowed_extensions.map { |ext| "--allowed-extension #{ext}" })
+        opts << "--no-stdlib" if @no_stdlib
         opts.join(" ")
       end
 
@@ -106,12 +112,19 @@ module Spoom
             when /^--dir=/
               config.paths << parse_option(line)
               next
+            when /^--no-stdlib$/
+              config.no_stdlib = true
+              next
             when /^--.*=/
               next
             when /^--/
               state = :skip
             when /^-.*=?/
               next
+            when /^#/
+              next
+            when /^$/
+              next
             else
               case state
               when :ignore

data/lib/spoom/sorbet/sigils.rb

@@ -55,7 +55,7 @@ module Spoom
       # * returns nil if no sigil
       sig { params(path: T.any(String, Pathname)).returns(T.nilable(String)) }
       def self.file_strictness(path)
-        return nil unless File.exist?(path)
+        return nil unless File.file?(path)
         content = File.read(path, encoding: Encoding::ASCII_8BIT)
         strictness_in_content(content)
       end

data/lib/spoom/test_helpers/project.rb

@@ -82,7 +82,7 @@ module Spoom
         opts = {}
         opts[:chdir] = path
         out, err, status = Open3.capture3("bundle", "install", opts)
-        [out, err, status.success?]
+        [out, err, T.must(status.success?)]
       end
 
       # Run a command with `bundle exec` in this project
@@ -91,7 +91,7 @@ module Spoom
         opts = {}
         opts[:chdir] = path
         out, err, status = Open3.capture3(["bundle", "exec", cmd, *args].join(' '), opts)
-        [out, err, status.success?]
+        [out, err, T.must(status.success?)]
       end
 
       # Delete this project and its content
@@ -100,6 +100,16 @@ module Spoom
         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`

data/lib/spoom/version.rb

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

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: spoom
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.4
 platform: ruby
 authors:
 - Alexandre Terrasa
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-03-19 00:00:00.000000000 Z
+date: 2021-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: 2.2.10
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: 2.2.10
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -58,28 +58,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.5.9204
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.5.9204
 - !ruby/object:Gem::Dependency
   name: sorbet
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.6347
+        version: 0.5.9204
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.5.6347
+        version: 0.5.9204
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -174,7 +174,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.20
 signing_key: 
 specification_version: 4
 summary: Useful tools for Sorbet enthusiasts.