spoom 1.0.4 → 1.0.5

data/lib/spoom/sorbet/metrics.rb

@@ -1,102 +1,33 @@
 # typed: strict
 # frozen_string_literal: true
 
+require_relative "sigils"
+
 module Spoom
   module Sorbet
-    class Metrics < T::Struct
+    module MetricsParser
       extend T::Sig
 
       DEFAULT_PREFIX = "ruby_typer.unknown.."
-      SIGILS = T.let(["ignore", "false", "true", "strict", "strong", "__STDLIB_INTERNAL"], T::Array[String])
-
-      const :repo, String
-      const :sha, String
-      const :status, String
-      const :branch, String
-      const :timestamp, Integer
-      const :uuid, String
-      const :metrics, T::Hash[String, T.nilable(Integer)]
 
-      sig { params(path: String, prefix: String).returns(Metrics) }
+      sig { params(path: String, prefix: String).returns(T::Hash[String, Integer]) }
       def self.parse_file(path, prefix = DEFAULT_PREFIX)
         parse_string(File.read(path), prefix)
       end
 
-      sig { params(string: String, prefix: String).returns(Metrics) }
+      sig { params(string: String, prefix: String).returns(T::Hash[String, Integer]) }
       def self.parse_string(string, prefix = DEFAULT_PREFIX)
         parse_hash(JSON.parse(string), prefix)
       end
 
-      sig { params(obj: T::Hash[String, T.untyped], prefix: String).returns(Metrics) }
+      sig { params(obj: T::Hash[String, T.untyped], prefix: String).returns(T::Hash[String, Integer]) }
       def self.parse_hash(obj, prefix = DEFAULT_PREFIX)
-        Metrics.new(
-          repo: obj.fetch("repo"),
-          sha: obj.fetch("sha"),
-          status: obj.fetch("status"),
-          branch: obj.fetch("branch"),
-          timestamp: obj.fetch("timestamp").to_i,
-          uuid: obj.fetch("uuid"),
-          metrics: obj["metrics"].each_with_object({}) do |metric, all|
-            name = metric["name"]
-            name = name.sub(prefix, '')
-            all[name] = metric["value"].to_i
-          end,
-        )
-      end
-
-      sig { returns(T::Hash[String, T.nilable(Integer)]) }
-      def files_by_strictness
-        SIGILS.each_with_object({}) do |sigil, map|
-          map[sigil] = metrics["types.input.files.sigil.#{sigil}"]
+        obj["metrics"].each_with_object(Hash.new(0)) do |metric, metrics|
+          name = metric["name"]
+          name = name.sub(prefix, '')
+          metrics[name] = metric["value"] || 0
         end
       end
-
-      sig { returns(Integer) }
-      def files_count
-        files_by_strictness.values.compact.sum
-      end
-
-      sig { params(key: String).returns(T.nilable(Integer)) }
-      def [](key)
-        metrics[key]
-      end
-
-      sig { returns(String) }
-      def to_s
-        "Metrics<#{repo}-#{timestamp}-#{status}>"
-      end
-
-      sig { params(out: T.any(IO, StringIO)).void }
-      def show(out = $stdout)
-        files = files_count
-
-        out.puts "Sigils:"
-        out.puts "  files: #{files}"
-        files_by_strictness.each do |sigil, value|
-          next unless value
-          out.puts "  #{sigil}: #{value}#{percent(value, files)}"
-        end
-
-        out.puts "\nMethods:"
-        m = metrics['types.input.methods.total']
-        s = metrics['types.sig.count']
-        out.puts "  methods: #{m}"
-        out.puts "  signatures: #{s}#{percent(s, m)}"
-
-        out.puts "\nSends:"
-        t = metrics['types.input.sends.typed']
-        s = metrics['types.input.sends.total']
-        out.puts "  sends: #{s}"
-        out.puts "  typed: #{t}#{percent(t, s)}"
-      end
-
-      private
-
-      sig { params(value: T.nilable(Integer), total: T.nilable(Integer)).returns(String) }
-      def percent(value, total)
-        return "" if value.nil? || total.nil? || total == 0
-        " (#{value * 100 / total}%)"
-      end
     end
   end
 end

data/lib/spoom/sorbet/sigils.rb

@@ -0,0 +1,98 @@
+# typed: strict
+# frozen_string_literal: true
+
+# The term "sigil" refers to the magic comment at the top of the file that has the form `# typed: <strictness>`,
+# where "strictness" represents the level at which Sorbet will report errors
+# See https://sorbet.org/docs/static for a more complete explanation
+module Spoom
+  module Sorbet
+    module Sigils
+      extend T::Sig
+
+      STRICTNESS_IGNORE = "ignore"
+      STRICTNESS_FALSE = "false"
+      STRICTNESS_TRUE = "true"
+      STRICTNESS_STRICT = "strict"
+      STRICTNESS_STRONG = "strong"
+      STRICTNESS_INTERNAL = "__STDLIB_INTERNAL"
+
+      VALID_STRICTNESS = T.let([
+        STRICTNESS_IGNORE,
+        STRICTNESS_FALSE,
+        STRICTNESS_TRUE,
+        STRICTNESS_STRICT,
+        STRICTNESS_STRONG,
+        STRICTNESS_INTERNAL,
+      ].freeze, T::Array[String])
+
+      SIGIL_REGEXP = T.let(/^#\s*typed\s*:\s*(\w*)\s*$/.freeze, Regexp)
+
+      # returns the full sigil comment string for the passed strictness
+      sig { params(strictness: String).returns(String) }
+      def self.sigil_string(strictness)
+        "# typed: #{strictness}"
+      end
+
+      # returns true if the passed string is a valid strictness (else false)
+      sig { params(strictness: String).returns(T::Boolean) }
+      def self.valid_strictness?(strictness)
+        VALID_STRICTNESS.include?(strictness.strip)
+      end
+
+      # returns the strictness of a sigil in the passed file content string (nil if no sigil)
+      sig { params(content: String).returns(T.nilable(String)) }
+      def self.strictness_in_content(content)
+        SIGIL_REGEXP.match(content)&.[](1)
+      end
+
+      # returns a string which is the passed content but with the sigil updated to a new strictness
+      sig { params(content: String, new_strictness: String).returns(String) }
+      def self.update_sigil(content, new_strictness)
+        content.sub(SIGIL_REGEXP, sigil_string(new_strictness))
+      end
+
+      # returns a string containing the strictness of a sigil in a file at the passed path
+      # * 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)
+        content = File.read(path)
+        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)
+        new_content = update_sigil(content, new_strictness)
+
+        File.write(path, new_content)
+
+        strictness_in_content(new_content) == new_strictness
+      end
+
+      # changes the sigil to have a new strictness in a list of files
+      sig { params(path_list: T::Array[String], new_strictness: String).returns(T::Array[String]) }
+      def self.change_sigil_in_files(path_list, new_strictness)
+        path_list.filter do |path|
+          change_sigil_in_file(path, new_strictness)
+        end
+      end
+
+      # finds all files in the specified directory with the passed strictness
+      sig do
+        params(
+          directory: T.any(String, Pathname),
+          strictness: String,
+          extension: String
+        ).returns(T::Array[String])
+      end
+      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
+        end
+      end
+    end
+  end
+end

data/lib/spoom/test_helpers/project.rb

@@ -0,0 +1,103 @@
+# 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
+
+      # Actions
+
+      # Run `git init` in this project
+      sig { void }
+      def git_init
+        Spoom::Git.exec("git init -q", 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 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)
+        opts = {}
+        opts[:chdir] = path
+        out, err, status = Open3.capture3(["bundle", "exec", cmd, *args].join(' '), opts)
+        [out, err, status.success?]
+      end
+
+      # Delete this project and its content
+      sig { void }
+      def destroy
+        FileUtils.rm_rf(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

data/lib/spoom/timeline.rb

@@ -0,0 +1,53 @@
+# typed: strict
+# frozen_string_literal: true
+
+require_relative "git"
+
+module Spoom
+  class Timeline
+    extend T::Sig
+
+    sig { params(from: Time, to: Time, path: String).void }
+    def initialize(from, to, path: ".")
+      @from = from
+      @to = to
+      @path = path
+    end
+
+    # Return one commit for each month between `from` and `to`
+    sig { returns(T::Array[String]) }
+    def ticks
+      commits_for_dates(months)
+    end
+
+    # Return all months between `from` and `to`
+    sig { returns(T::Array[Time]) }
+    def months
+      d = Date.new(@from.year, @from.month, 1)
+      to = Date.new(@to.year, @to.month, 1)
+      res = [d.to_time]
+      while d < to
+        d = d.next_month
+        res << d.to_time
+      end
+      res
+    end
+
+    # Return one commit for each date in `dates`
+    sig { params(dates: T::Array[Time]).returns(T::Array[String]) }
+    def commits_for_dates(dates)
+      dates.map do |t|
+        out, _, _ = Spoom::Git.log(
+          "--since='#{t}'",
+          "--until='#{t.to_date.next_month}'",
+          "--format='format:%h'",
+          "--author-date-order",
+          "-1",
+          path: @path,
+        )
+        next if out.empty?
+        out
+      end.compact.uniq
+    end
+  end
+end

data/lib/spoom/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spoom
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.5
 platform: ruby
 authors:
 - Alexandre Terrasa
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-05 00:00:00.000000000 Z
+date: 2020-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 13.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 13.0.1
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -110,7 +110,7 @@ dependencies:
         version: '0'
 description: 
 email:
-- alexandre.terrasa@shopify.com
+- ruby@shopify.com
 executables:
 - spoom
 extensions: []
@@ -122,12 +122,24 @@ files:
 - exe/spoom
 - lib/spoom.rb
 - lib/spoom/cli.rb
-- lib/spoom/cli/commands/base.rb
-- lib/spoom/cli/commands/config.rb
-- lib/spoom/cli/commands/lsp.rb
-- lib/spoom/cli/commands/run.rb
-- lib/spoom/cli/symbol_printer.rb
+- lib/spoom/cli/bump.rb
+- lib/spoom/cli/config.rb
+- lib/spoom/cli/coverage.rb
+- 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
+- lib/spoom/coverage/d3/circle_map.rb
+- lib/spoom/coverage/d3/pie.rb
+- lib/spoom/coverage/d3/timeline.rb
+- lib/spoom/coverage/report.rb
+- lib/spoom/coverage/snapshot.rb
+- lib/spoom/file_tree.rb
+- lib/spoom/git.rb
+- lib/spoom/printer.rb
 - lib/spoom/sorbet.rb
 - lib/spoom/sorbet/config.rb
 - lib/spoom/sorbet/errors.rb
@@ -136,6 +148,9 @@ files:
 - lib/spoom/sorbet/lsp/errors.rb
 - 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
 homepage: https://github.com/Shopify/spoom
 licenses: