sorbet-progress 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f2b752c1402c88bae07c2dae86eda9bcbcff0de8654c7066391b21955120a95b
-  data.tar.gz: 969a4bea50f371d608815f3247bf25b372027448ec0c02254061e97e220787ae
+  metadata.gz: a0c93d4070d02f6d4bbecf66b9fb82fda2a295600e3bc6f2e1a9a1b24e02fc3b
+  data.tar.gz: 93401c06da1739b906d904487d5a26d37785b625156eb7652cfc3425950b1e11
 SHA512:
-  metadata.gz: e4a02e2780f150ae44354e74aaf892de8946b19c7fb33cc73d0b548ae66c7d87ecc63907493b76180816296b9d506095a079a652411d41b23f98254884ea1288
-  data.tar.gz: d472bdcf06b24cbfc3ed65df404c0c1f527786c7186479489a7d96416dfbbd55a28c5e64663c0c7064fd60fba9f6e3d601a691383c6504e83d9f66b777eff4ef
+  metadata.gz: 8231c1f39a740fc5882e6dc49ce0c25f15c834e72a7f55446c56afd0a6a7ed5dde217f612fddf8f469b6f03718dee3aafa237c070da92e8c6f709f12a74fe8d6
+  data.tar.gz: 3b26b8c21c39118bda7b3023338fc76956522df3ddaa85f54470726d7c1f5aa92a21b7ccb17a1c632eeb1af0569fcaf90e358a901b1489609e1c5b7a35b75564

data/.gitignore

@@ -8,3 +8,4 @@
 /tmp/
 /*.gem
 /Gemfile.lock
+/.idea

data/README.md

@@ -25,14 +25,21 @@ Or install it yourself:
 bundle exec srb tc --metrics-file /tmp/sorbet_metrics.json
 # No errors! Great job.
 bundle exec sorbet_progress /tmp/sorbet_metrics.json
-# SorbetProgress:
-# total_signatures 	1563
-# total_methods    	5267
-# total_classes    	3795
-# sigil_ignore     	unknown
-# sigil_false      	1
-# sigil_true       	12
-# sigil_strong     	unknown
+# Sorbet Progress
+
+# Progress for sig coverage
+# total_signatures 	7528
+# total_methods    	183447
+# total_classes    	112433
+
+# Progress for file coverage
+# sigil_ignore     	12	    0.20 %
+# sigil_false      	5466	    91.60 %
+# sigil_true       	460	    7.71 %
+# sigil_strict     	12	    0.20 %
+# sigil_strong     	17	    0.28 %
+# ---------------------------------------
+# Total: 		5967	100%
 # Keep up the good work 👍
 ```
 

data/lib/sorbet_progress/calculator.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+# typed: true
+
+module SorbetProgress
+  # Computes the percentage stats for sigil metrics as well as other stats.
+  class Calculator
+    extend T::Sig
+
+    attr_reader :total, :sigil_percentages, :coverage_metrics
+
+    sig { params(metrics: Metrics).void }
+    def initialize(metrics)
+      values = collect_values(sigil_breakdown_stats, metrics)
+      @total = values.delete(:total_files)
+
+      @sigil_percentages = values.map do |label, value|
+        percentage = value * 1.0 / @total if @total && value
+        {
+           label: label,
+           value: value,
+           percentage: percentage
+        }
+      end
+
+      @coverage_metrics = collect_values(coverage_stats, metrics)
+    end
+
+    private
+
+    # Mapping of general coverage stats to their actual metric names.
+    sig { returns(T::Hash[Symbol, String]) }
+    def coverage_stats
+      {
+          total_signatures: "ruby_typer.unknown..types.sig.count",
+          total_methods: "ruby_typer.unknown..types.input.methods.total",
+          total_classes: "ruby_typer.unknown..types.input.classes.total",
+      }
+    end
+
+    # Mapping of sigil stats to their actual metric names.
+    sig { returns(T::Hash[Symbol, String]) }
+    def sigil_breakdown_stats
+      {
+          total_files: "ruby_typer.unknown..types.input.files",
+          sigil_ignore: "ruby_typer.unknown..types.input.files.sigil.ignore",
+          sigil_false: "ruby_typer.unknown..types.input.files.sigil.false",
+          sigil_true: "ruby_typer.unknown..types.input.files.sigil.true",
+          sigil_strict: "ruby_typer.unknown..types.input.files.sigil.strict",
+          sigil_strong: "ruby_typer.unknown..types.input.files.sigil.strong"
+      }
+    end
+
+    # Extract the requested metric values.
+    sig { params(requested_stats: T::Hash[Symbol, String], metrics: Metrics).returns(T::Hash[Symbol, T.nilable(Integer)]) }
+    def collect_values(requested_stats, metrics)
+      result = {}
+      requested_stats.map do |label, name|
+        result[label] = metrics[name]&.value
+      end
+      result
+    end
+  end
+end

data/lib/sorbet_progress/cli.rb

@@ -2,6 +2,7 @@
 
 # typed: true
 
+require "sorbet_progress/calculator"
 require "sorbet_progress/error"
 require "sorbet_progress/metrics"
 require "sorbet_progress/parser"
@@ -26,24 +27,30 @@ module SorbetProgress
     sig { void }
     def run
       metrics = parse(@path)
-      puts "SorbetProgress:"
-      {
-        total_signatures: "ruby_typer.unknown..types.sig.count",
-        total_methods: "ruby_typer.unknown..types.input.methods.total",
-        total_classes: "ruby_typer.unknown..types.input.classes.total",
-        sigil_ignore: "ruby_typer.unknown..types.input.files.sigil.ignore",
-        sigil_false: "ruby_typer.unknown..types.input.files.sigil.false",
-        sigil_true: "ruby_typer.unknown..types.input.files.sigil.true",
-        sigil_strict: "ruby_typer.unknown..types.input.files.sigil.strict",
-        sigil_strong: "ruby_typer.unknown..types.input.files.sigil.strong"
-      }.each do |label, name|
-        metric = metrics[name]
-        if metric.nil?
-          print_metric_not_found(label)
-        else
-          print_metric(label, metric.value)
-        end
+      puts "Sorbet Progress\n\n"
+
+      stats_calculator = Calculator.new(metrics)
+
+      puts "Progress for sig coverage"
+      stats_calculator.coverage_metrics.each do |label, value|
+        puts format_metric(label, value)
+      end
+
+      puts "\nProgress for file coverage"
+
+      stats_calculator.sigil_percentages.each do |elem|
+        percentage =
+          if elem[:percentage]
+            elem[:percentage] * 100
+          else
+            0
+          end
+        puts format("%-17s\t%d\t%.2f %%", elem[:label], elem[:value] || 0, percentage)
       end
+
+      puts "---------------------------------------"
+      puts "Total: \t\t\t#{stats_calculator.total}\t100%"
+
       puts "Keep up the good work 👍"
     end
 
@@ -56,12 +63,14 @@ module SorbetProgress
       raise Error.new(2, "Metrics file not found: " + e.message)
     end
 
-    def print_metric(label, value)
-      puts format("%-17s\t%d", label, value)
-    end
-
-    def print_metric_not_found(label)
-      puts format("%-17s\tunknown", label)
+    # Format a label and metric value into a presentable String.
+    sig { params(label: Symbol, value: Integer).returns(String) }
+    def format_metric(label, value)
+      if value.nil?
+        format("%-17s\tunknown", label)
+      else
+        format("%-17s\t%d", label, value)
+      end
     end
   end
 end

data/lib/sorbet_progress/version.rb

@@ -4,6 +4,6 @@
 # :nodoc:
 module SorbetProgress
   def self.gem_version
-    Gem::Version.new("0.2.3")
+    Gem::Version.new("0.2.4")
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sorbet-progress
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors:
 - Jared Beck
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-08 00:00:00.000000000 Z
+date: 2019-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sorbet
@@ -112,6 +112,7 @@ files:
 - bin/sorbet_progress
 - bin/test.sh
 - lib/sorbet_progress.rb
+- lib/sorbet_progress/calculator.rb
 - lib/sorbet_progress/cli.rb
 - lib/sorbet_progress/error.rb
 - lib/sorbet_progress/metric.rb