sorbet-progress 0.2.5 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d2b826258c3712e1cff93a6c4d1bb5320e2c5055a50fa043f891fa671229d5a9
-  data.tar.gz: fab043fa62f98888b302998ac6fe4edc128b7614e40c1c6053dc1de911a2d321
+  metadata.gz: c938c4ae474d8ad023f0ef18383a798d8633235b17586546408b30ea0b977910
+  data.tar.gz: 25efefcf057f061c85e5d63b342d20c423010b95be2b39ced6addf70a5d17de9
 SHA512:
-  metadata.gz: 8b90be69cf7bcf938efdd2047084b184641f1d536b94698226942773373e2d364fa2d46823d6cdfa90c68eae37582551af5dc0dc851257c76768e3d895f01919
-  data.tar.gz: f82accf24f92a0fbaecb343305db8699ca080fc02bb711fad1b4f2deb7ccb988fb9b93ecbbbf34bf73eef53512fdaafb24ffcc2998767572a71d93eda763a7a9
+  metadata.gz: 466d87c077a1d5914a9ca70475c707e3cdb8964332b65794a73f7d6cd660f06e2ce978086a0af502948ff3cb15989a82863096af5ca32a7560ca2f23324ef361
+  data.tar.gz: 945748ad566f6610f4f0ee0d2ee9038a97495786a25e0357b145b26f440838dcd5f61fb5b5b0bea550a17290de69b48455ab15610a812655af7bfabb42585649

data/.rubocop.yml

@@ -70,6 +70,10 @@ Layout/MultilineOperationIndentation:
 Lint/UnneededSplatExpansion:
   Enabled: false
 
+Metrics/AbcSize:
+  Exclude:
+    - test/**/*
+
 # Compared to metrics like `AbcSize` or `CyclomaticComplexity`, number of
 # lines is not a useful metric.
 Metrics/ClassLength:

data/CHANGELOG.md

@@ -12,6 +12,16 @@ recommendations of [keepachangelog.com](http://keepachangelog.com/).
 - Fixed
   - None
 
+## 0.3.0 (2020-01-24)
+
+- Breaking Changes
+  - None
+- Added
+  - `--reporter` CLI option
+  - `bar_chart` reporter
+- Fixed
+  - None
+
 ## 0.2.5 (2020-01-03)
 
 - Breaking Changes

data/README.md

@@ -46,6 +46,44 @@ bundle exec sorbet_progress /tmp/sorbet_metrics.json
 Not sure what the best format is. Pull requests welcome. It might be nice to
 have an overall percentage, for example.
 
+## Reporters
+
+### bar_chart
+
+```
+bundle exec sorbet_progress --reporter bar_chart /tmp/sorbet_metrics.json
+Sorbet progress: ignore | false | true | strict+
+|-0-|-2-|-------------32-------------|-------------------------61-------------------------|
+Keep up the good work 👍
+```
+
+The chart sums `strict` and `strong`, because `strict` is the highest reasonable
+goal for most applications.
+
+### verbose
+
+```
+bundle exec sorbet_progress --verbose /tmp/sorbet_metrics.json
+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 👍
+```
+
+See example 
+
 ## Contributing
 
 This project does not accept bug reports. Pull requests are welcome.

data/bin/test.sh

@@ -3,33 +3,6 @@
 set -e
 
 bundle exec srb tc --metrics-file /tmp/sorbet_metrics.json
-
-# TODO: Doesn't work on travis. No idea why.
-#
-# ```
-# Traceback (most recent call last):
-# 	4: from /home/travis/.rvm/rubies/ruby-2.6.5/lib/ruby/site_ruby/2.6.0/rubygems/core_ext/kernel_require.rb:54:in `require'
-# 	3: from /home/travis/.rvm/rubies/ruby-2.6.5/lib/ruby/site_ruby/2.6.0/rubygems/core_ext/kernel_require.rb:54:in `require'
-# 	2: from /home/travis/build/jaredbeck/sorbet-progress/lib/sorbet_progress.rb:4:in `<top (required)>'
-# 	1: from /home/travis/.rvm/rubies/ruby-2.6.5/lib/ruby/site_ruby/2.6.0/rubygems/core_ext/kernel_require.rb:54:in `require'
-# /home/travis/.rvm/rubies/ruby-2.6.5/lib/ruby/site_ruby/2.6.0/rubygems/core_ext/kernel_require.rb:54:in `require': cannot load such file -- sorbet-runtime
-# ```
-if [ "$TRAVIS" != 'true' ]; then
-  bundle exec ruby -I lib \
-    -r sorbet_progress \
-    -e 'SorbetProgress::CLI.new(["/tmp/sorbet_metrics.json"]).run'
-fi
-
+bundle exec bin/sorbet_progress --reporter bar_chart /tmp/sorbet_metrics.json
 bundle exec rubocop
-
-# TODO: This `bundle exec ruby` also doesn't work on travis.
-#
-# ```
-# home/travis/.rvm/gems/ruby-2.6.5/gems/bundler-2.1.3/lib/bundler/runtime.rb:312:in
-# `check_for_activated_spec!': You have already activated minitest 5.11.3, but
-# your Gemfile requires minitest 5.13.0. Prepending `bundle exec` to your
-# command may solve this. (Gem::LoadError)
-# ```
-if [ "$TRAVIS" != 'true' ]; then
-  bundle exec ruby -I lib:test -r 'minitest/autorun' test/all.rb
-fi
+bundle exec ruby -I lib:test test/all.rb

data/lib/sorbet_progress/cli.rb

@@ -6,6 +6,9 @@ require "sorbet_progress/calculator"
 require "sorbet_progress/error"
 require "sorbet_progress/metrics"
 require "sorbet_progress/parser"
+require "sorbet_progress/reporters/bar_chart"
+require "sorbet_progress/reporters/base"
+require "sorbet_progress/reporters/verbose"
 
 module SorbetProgress
   # Parses the provided metrics file and prints a report.
@@ -13,53 +16,32 @@ module SorbetProgress
     extend T::Sig
 
     USAGE = <<~EOS
-      Usage: sorbet_progress /path/to/sorbet_metrics.json
+      Usage: sorbet_progress [--reporter name] /path/to/sorbet_metrics.json
+      Reporters: bar_chart, verbose
     EOS
 
     sig { params(argv: T::Array[String]).void }
     def initialize(argv)
-      unless argv.length == 1
+      # TODO: use an actual CLI args parser, like optparse or trollop
+      case argv.length
+      when 1
+        @path = argv.first
+        @reporter_name = "verbose"
+      when 3
+        @path = argv.last
+        @reporter_name = argv[1]
+      else
         raise Error.new(1, USAGE)
       end
-      @path = argv.first
     end
 
     sig { void }
-    # rubocop:disable Metrics/AbcSize
     def run
       metrics = parse(@path)
-      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 👍"
+      calculator = Calculator.new(metrics)
+      reporter = reporter_class(@reporter_name).new(calculator)
+      puts reporter.report
     end
-    # rubocop:enable Metrics/AbcSize
 
     private
 
@@ -70,13 +52,15 @@ module SorbetProgress
       raise Error.new(2, "Metrics file not found: " + e.message)
     end
 
-    # 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)
+    sig { params(name: String).returns(T.class_of(Reporters::Base)) }
+    def reporter_class(name)
+      case name
+      when "verbose"
+        Reporters::Verbose
+      when "bar_chart"
+        Reporters::BarChart
       else
-        format("%-17s\t%d", label, value)
+        raise format("Invalid reporter name: %s", @reporter_name)
       end
     end
   end

data/lib/sorbet_progress/reporters/bar_chart.rb

@@ -0,0 +1,83 @@
+# typed: strict
+# frozen_string_literal: true
+
+require "rainbow"
+require "sorbet_progress/reporters/base"
+
+module SorbetProgress
+  module Reporters
+    # Produces output something like this:
+    #
+    # ```
+    # Sorbet progress: ignore | false | true | strict+
+    # |----------------50--------------|---------25--------|-5-|------20------|
+    # Keep up the good work 👍
+    # ```
+    #
+    # The chart is colored. Colorless terminals are not supported.
+    #
+    # Strict and strong are combined into one category because strong is not
+    # a reachable goal in most projects.
+    class BarChart < Base
+      extend T::Sig
+
+      COLORS = T.let(%w[red yellow green blue].freeze, T::Array[String])
+      LENGTH = 80
+
+      sig { params(calculator: Calculator).void }
+      def initialize(calculator)
+        @calculator = calculator
+      end
+
+      sig { override.returns(String) }
+      def report
+        [
+          "Sorbet progress: ignore | false | true | strict+",
+          bar_chart,
+          "Keep up the good work 👍"
+        ].flatten.join("\n")
+      end
+
+      private
+
+      sig { returns(String) }
+      def bar_chart
+        body = segments.each_with_index.each_with_object([]) { |(e, i), a|
+          a.push(segment(e, i))
+        }.join("|")
+        format("|%s|", body)
+      end
+
+      sig { params(fraction: Float, index: Integer).returns(String) }
+      def segment(fraction, index)
+        padding_max = (fraction * LENGTH / 2).round
+        padding_length = [1, padding_max].max
+        pad = "-" * padding_length
+        Rainbow(
+          format("%s%d%s", pad, fraction * 100, pad)
+        ).send(T.must(COLORS[index]))
+      end
+
+      sig { returns(T::Array[Float]) }
+      def segments
+        sigils = sigil_count_by_name
+        [
+          T.let(sigils.fetch(:sigil_ignore, 0.0), Float),
+          T.let(sigils.fetch(:sigil_false, 0.0), Float),
+          T.let(sigils.fetch(:sigil_true, 0.0), Float),
+          T.let(
+            sigils.fetch(:sigil_strict, 0.0) + sigils.fetch(:sigil_strong, 0.0),
+            Float
+          )
+        ]
+      end
+
+      sig { returns(T::Hash[Symbol, Float]) }
+      def sigil_count_by_name
+        @calculator.sigil_percentages.each_with_object({}) { |e, a|
+          a[e.fetch(:label)] = e.fetch(:percentage, 0.0).to_f
+        }
+      end
+    end
+  end
+end

data/lib/sorbet_progress/reporters/base.rb

@@ -0,0 +1,24 @@
+# typed: strict
+# frozen_string_literal: true
+
+require "rainbow"
+
+module SorbetProgress
+  module Reporters
+    # Abstract
+    class Base
+      extend T::Helpers
+      extend T::Sig
+      abstract!
+
+      sig { params(calculator: Calculator).void }
+      def initialize(calculator)
+        @calculator = calculator
+      end
+
+      sig { abstract.returns(String) }
+      def report
+      end
+    end
+  end
+end

data/lib/sorbet_progress/reporters/verbose.rb

@@ -0,0 +1,85 @@
+# typed: strict
+# frozen_string_literal: true
+
+require "sorbet_progress/reporters/base"
+
+module SorbetProgress
+  module Reporters
+    # The first reporter written. It's quite verbose, so I'm calling it ..
+    class Verbose < Base
+      extend T::Sig
+
+      sig { params(calculator: Calculator).void }
+      def initialize(calculator)
+        @calculator = calculator
+      end
+
+      sig { override.returns(String) }
+      def report
+        [
+          "Sorbet Progress\n",
+          "Progress for sig coverage",
+          coverage_metrics,
+          "\nProgress for file coverage",
+          sigil_percentages,
+          "---------------------------------------",
+          "Total: \t\t\t#{@calculator.total}\t100%",
+          "Keep up the good work 👍"
+        ].flatten.join("\n")
+      end
+
+      private
+
+      # Example output:
+      #
+      # ```
+      # total_signatures  7528
+      # total_methods     183447
+      # total_classes     112433
+      # ```
+      sig { returns(T::Array[String]) }
+      def coverage_metrics
+        @calculator.coverage_metrics.map do |label, value|
+          format_metric(label, value)
+        end
+      end
+
+      # 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
+
+      # Example output:
+      #
+      # ```
+      # 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 %
+      # ```
+      sig { returns(T::Array[String]) }
+      def sigil_percentages
+        @calculator.sigil_percentages.map do |elem|
+          percentage =
+            if elem[:percentage]
+              elem[:percentage] * 100
+            else
+              0
+            end
+          format(
+            "%-17s\t%d\t%.2f %%",
+            elem[:label],
+            elem[:value] || 0,
+            percentage
+          )
+        end
+      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.5")
+    Gem::Version.new("0.3.0")
   end
 end

data/sorbet-progress.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = ">= 2.6.3"
   spec.required_rubygems_version = ">= 3.0.3"
 
+  spec.add_runtime_dependency "rainbow", "3.0"
   lambda {
     requirements = ">= 0.4.4314"
     spec.add_runtime_dependency "sorbet", requirements

data/sorbet/rbi/gems/minitest.rbi

@@ -11,7 +11,10 @@
 module Minitest
   def self.__run(reporter, options); end
   def self.after_run(&block); end
+
+  sig { void }
   def self.autorun; end
+
   def self.backtrace_filter; end
   def self.backtrace_filter=(arg0); end
   def self.clock_time; end
@@ -27,7 +30,10 @@ module Minitest
   def self.process_args(args = nil); end
   def self.reporter; end
   def self.reporter=(arg0); end
-  def self.run(args = nil); end
+
+  sig { params(args: T::Array[String]).returns(T::Boolean) }
+  def self.run(args = []); end
+
   def self.run_one_method(klass, method_name); end
 end
 module Minitest::Parallel

data/sorbet/rbi/hidden-definitions/hidden.rbi

@@ -2670,8 +2670,6 @@ module Enumerable
   def to_set(klass=T.unsafe(nil), *args, &block); end
 
   def uniq(); end
-
-  def zip(*_); end
 end
 
 class Enumerator
@@ -3495,8 +3493,6 @@ module MonitorMixin
   def synchronize(); end
 
   def try_mon_enter(); end
-  EXCEPTION_IMMEDIATE = ::T.let(nil, ::T.untyped)
-  EXCEPTION_NEVER = ::T.let(nil, ::T.untyped)
 end
 
 class MonitorMixin::ConditionVariable
@@ -3817,11 +3813,7 @@ class OpenSSL::KDF::KDFError
 end
 
 module OpenSSL::KDF
-  def self.hkdf(*_); end
-
   def self.pbkdf2_hmac(*_); end
-
-  def self.scrypt(*_); end
 end
 
 class OpenSSL::OCSP::Request
@@ -3830,10 +3822,6 @@ end
 
 OpenSSL::PKCS7::Signer = OpenSSL::PKCS7::SignerInfo
 
-class OpenSSL::PKey::EC
-  EXPLICIT_CURVE = ::T.let(nil, ::T.untyped)
-end
-
 class OpenSSL::PKey::EC::Point
   def to_octet_string(_); end
 end
@@ -3845,20 +3833,15 @@ class OpenSSL::PKey::RSA
 end
 
 module OpenSSL::SSL
-  OP_ALLOW_NO_DHE_KEX = ::T.let(nil, ::T.untyped)
   OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION = ::T.let(nil, ::T.untyped)
   OP_CRYPTOPRO_TLSEXT_BUG = ::T.let(nil, ::T.untyped)
   OP_LEGACY_SERVER_CONNECT = ::T.let(nil, ::T.untyped)
-  OP_NO_ENCRYPT_THEN_MAC = ::T.let(nil, ::T.untyped)
-  OP_NO_RENEGOTIATION = ::T.let(nil, ::T.untyped)
-  OP_NO_TLSv1_3 = ::T.let(nil, ::T.untyped)
   OP_SAFARI_ECDHE_ECDSA_BUG = ::T.let(nil, ::T.untyped)
   OP_TLSEXT_PADDING = ::T.let(nil, ::T.untyped)
   SSL2_VERSION = ::T.let(nil, ::T.untyped)
   SSL3_VERSION = ::T.let(nil, ::T.untyped)
   TLS1_1_VERSION = ::T.let(nil, ::T.untyped)
   TLS1_2_VERSION = ::T.let(nil, ::T.untyped)
-  TLS1_3_VERSION = ::T.let(nil, ::T.untyped)
   TLS1_VERSION = ::T.let(nil, ::T.untyped)
 end
 
@@ -3888,7 +3871,6 @@ class OpenSSL::SSL::SSLSocket
 end
 
 module OpenSSL::X509
-  V_FLAG_NO_CHECK_TIME = ::T.let(nil, ::T.untyped)
   V_FLAG_TRUSTED_FIRST = ::T.let(nil, ::T.untyped)
 end
 

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: sorbet-progress
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.3.0
 platform: ruby
 authors:
 - Jared Beck
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-03 00:00:00.000000000 Z
+date: 2020-01-25 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: sorbet
   requirement: !ruby/object:Gem::Requirement
@@ -106,6 +120,9 @@ files:
 - lib/sorbet_progress/metric.rb
 - lib/sorbet_progress/metrics.rb
 - lib/sorbet_progress/parser.rb
+- lib/sorbet_progress/reporters/bar_chart.rb
+- lib/sorbet_progress/reporters/base.rb
+- lib/sorbet_progress/reporters/verbose.rb
 - lib/sorbet_progress/version.rb
 - sorbet-progress.gemspec
 - sorbet/config