sorbet-progress 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 07e527046e92f1f1e2495f003b8aa2609b9ff195661887a8c81c0c67d4345c5f
-  data.tar.gz: bbdb474efbac72727561ae902917ae921095b5db2a7968dd7a6a2c75e585418b
+  metadata.gz: 85820701fa4e8dd96cd436463b04a7f0129f52db846c9cd0c87dd3ec476dd446
+  data.tar.gz: 35e929c43bd16c3bbffb339639357351da157c67c1d52a496d3ace5148330092
 SHA512:
-  metadata.gz: de774283bbc2b6554bc3a8444326697448a679ec27bae757c5b5069dd279fb9886f2e7d0191d6bd88aaaa9948f60849f776d9e81a1a0b9b819b4d071cc25303c
-  data.tar.gz: fc65da32aa0fff16fa567515a41883bea8a0ab0d146079acbae96d16edeb7364bd125d31b60e8727e14e73c76b183049493fa156d7ee958c1a62129c2b578073
+  metadata.gz: 2e48f41d883f5f894bb70e4b6afa7ef804c14a190631413057b7a743d76c397e5de43a209fbf444def88a2960b0e8a0b62e73ad987b4448e95b73e1bc689651d
+  data.tar.gz: 112e4c7582cbf78d7cb78dbef6d33e6a3d0352fb086784451bd5fd6b0ebd05ab6702a6cd8dceca10643fc9e77b809529f28a68cfefe883b33bda7a9fb5efce62

data/.gitignore

@@ -6,3 +6,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+/*.gem

data/.rubocop.yml

@@ -214,6 +214,9 @@ Style/SingleLineBlockParams:
         - a
         - e
 
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
 Style/TernaryParentheses:
   EnforcedStyle: require_parentheses_when_complex
 

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+# Changelog
+
+This project follows [semver 2.0.0](http://semver.org/spec/v2.0.0.html) and the
+recommendations of [keepachangelog.com](http://keepachangelog.com/).
+
+## Unreleased
+
+- Breaking Changes
+  - None
+- Added
+  - None
+- Fixed
+  - None
+
+## 0.2.0 (2019-07-02)
+
+First working proof of concept.

data/Gemfile

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 

data/Gemfile.lock

@@ -39,4 +39,4 @@ DEPENDENCIES
   sorbet-progress!
 
 BUNDLED WITH
-   1.17.3
+   2.0.2

data/README.md

@@ -21,7 +21,10 @@ Or install it yourself:
 
 ## Usage
 
-TBD
+```bash
+srb tc --metrics-file /tmp/sorbet_metrics.json
+sorbet_progress /tmp/sorbet_metrics.json
+```
 
 ## Contributing
 

data/Rakefile

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
-require 'bundler/gem_tasks'
-require 'rake/testtask'
+require "bundler/gem_tasks"
+require "rake/testtask"
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << 'test'
-  t.libs << 'lib'
-  t.test_files = FileList['test/**/*_test.rb']
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
 end
 
 task default: :test

data/bin/sorbet_progress

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+# typed: ignore
+
+require 'sorbet_progress'
+SorbetProgress::CLI.new(ARGV).run

data/bin/test.sh

@@ -1,6 +1,9 @@
 #!/usr/bin/env bash
 
 set -e
-bundle exec srb tc
+bundle exec srb tc --metrics-file /tmp/sorbet_metrics.json
+ruby -I lib \
+  -r sorbet_progress \
+  -e 'SorbetProgress::CLI.new(["/tmp/sorbet_metrics.json"]).run'
 bundle exec rubocop
 ruby -I lib:test -r 'minitest/autorun' test/all.rb

data/lib/sorbet_progress/cli.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+# typed: true
+
+require "sorbet_progress/error"
+require "sorbet_progress/metrics"
+require "sorbet_progress/parser"
+
+module SorbetProgress
+  # Parses the provided metrics file and prints a report.
+  class CLI
+    extend T::Sig
+
+    USAGE = <<~EOS
+      Usage: sorbet_progress /path/to/sorbet_metrics.json
+    EOS
+
+    sig { params(argv: T::Array[String]).void }
+    def initialize(argv)
+      unless argv.length == 1
+        raise Error.new(1, USAGE)
+      end
+      @path = argv.first
+    end
+
+    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_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
+      end
+      puts "Keep up the good work 👍"
+    end
+
+    private
+
+    sig { params(path: String).returns(Metrics) }
+    def parse(path)
+      Parser.new.parse(File.read(path))
+    rescue Errno::ENOENT => e
+      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)
+    end
+  end
+end

data/lib/sorbet_progress/error.rb

@@ -0,0 +1,21 @@
+# typed: true
+# frozen_string_literal: true
+
+module SorbetProgress
+  # Parent class of all errors raised by SorbetProgress.
+  # Every error should have a unique number.
+  class Error < StandardError
+    extend T::Sig
+
+    sig { params(number: Integer, message: String).void }
+    def initialize(number, message)
+      super(
+        format(
+          "%s (SPE%d)",
+          message,
+          number
+        )
+      )
+    end
+  end
+end

data/lib/sorbet_progress/metric.rb

@@ -0,0 +1,18 @@
+# typed: true
+# frozen_string_literal: true
+
+module SorbetProgress
+  # Just a simple key-value pair, though sorbet could decide to do something
+  # more complicated in the future.
+  class Metric
+    extend T::Sig
+
+    attr_reader :name, :value
+
+    sig { params(name: String, value: Integer).void }
+    def initialize(name, value)
+      @name = name
+      @value = value
+    end
+  end
+end

data/lib/sorbet_progress/metrics.rb

@@ -0,0 +1,33 @@
+# typed: true
+# frozen_string_literal: true
+
+require "sorbet_progress/error"
+require "sorbet_progress/metric"
+
+module SorbetProgress
+  # A collection of `Metric`s. Acts like a Hash, though sorbet actually gives
+  # us an array.
+  class Metrics
+    extend T::Sig
+
+    sig { params(array: T::Array[Metric]).void }
+    def initialize(array)
+      @array = array
+    end
+
+    sig { params(name: String).returns(T.nilable(Metric)) }
+    def [](name)
+      @array.find { |metric| metric.name == name }
+    end
+
+    sig { params(name: String).returns(Metric) }
+    def fetch(name)
+      result = @array.find { |metric| metric.name == name }
+      if result.nil?
+        raise Error.new(5, "Metric not found: " + name)
+      else
+        result
+      end
+    end
+  end
+end

data/lib/sorbet_progress/parser.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+# typed: true
+
+require "json"
+require "sorbet_progress/error"
+require "sorbet_progress/metric"
+require "sorbet_progress/metrics"
+
+module SorbetProgress
+  # Parse Sorbet's JSON metrics file.
+  class Parser
+    extend T::Sig
+
+    sig { params(json: String).returns(Metrics) }
+    def parse(json)
+      transform(parse_json(json))
+    end
+
+    private
+
+    sig { params(json: String).returns(Hash) }
+    def parse_json(json)
+      JSON.parse(json)
+    rescue JSON::ParserError => e
+      raise Error.new(3, "Metrics file is not valid JSON: " + e.message)
+    end
+
+    sig { params(parsed: Hash).returns(Metrics) }
+    def transform(parsed)
+      Metrics.new(
+        parsed.
+          fetch("metrics").
+          map { |metric|
+            next unless metric.key?("value")
+            Metric.new(
+              metric.fetch("name"),
+              metric.fetch("value")
+            )
+          }.
+          compact
+      )
+    rescue KeyError => e
+      raise Error.new(4, "Expected file to have key: metrics: " + e.message)
+    end
+  end
+end

data/lib/sorbet_progress/version.rb

@@ -3,6 +3,6 @@
 # typed: true
 module SorbetProgress
   def self.gem_version
-    Gem::Version.new('0.1.0')
+    Gem::Version.new("0.2.0")
   end
 end

data/lib/sorbet_progress.rb

@@ -1,8 +1,10 @@
+# typed: true
 # frozen_string_literal: true
 
-# typed: strong
-require 'sorbet_progress/version'
+require "sorbet-runtime"
+require "sorbet_progress/cli"
+require "sorbet_progress/version"
 
+# :nodoc:
 module SorbetProgress
-  class Error < StandardError; end
 end

data/sorbet/rbi/sorbet-typed/lib/ruby/all/open3.rbi

@@ -5,7 +5,7 @@
 #
 #   https://github.com/sorbet/sorbet-typed/edit/master/lib/ruby/all/open3.rbi
 #
-# typed: strong
+# typed: true
 
 module Open3
   sig do

data/sorbet/rbi/sorbet-typed/lib/ruby/all/resolv.rbi

@@ -5,7 +5,7 @@
 #
 #   https://github.com/sorbet/sorbet-typed/edit/master/lib/ruby/all/resolv.rbi
 #
-# typed: strong
+# typed: true
 
 class Resolv
   sig { params(name: String).returns(String) }

data/sorbet-progress.gemspec

@@ -1,31 +1,33 @@
 # frozen_string_literal: true
 
-lib = File.expand_path('lib', __dir__)
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'sorbet_progress/version'
+require "sorbet_progress/version"
 
 Gem::Specification.new do |spec|
-  spec.name = 'sorbet-progress'
+  spec.name = "sorbet-progress"
   spec.version = SorbetProgress.gem_version.to_s
-  spec.licenses = ['AGPL-3.0-only']
-  spec.authors = ['Jared Beck']
-  spec.email = ['jared@jaredbeck.com']
-  spec.summary = 'Measure sorbet adoption progress'
-  spec.homepage = 'https://github.com/jaredbeck/sorbet-progress'
+  spec.licenses = ["AGPL-3.0-only"]
+  spec.authors = ["Jared Beck"]
+  spec.email = ["jared@jaredbeck.com"]
+  spec.summary = "Measure sorbet adoption progress"
+  spec.homepage = "https://github.com/jaredbeck/sorbet-progress"
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^test/}) }
   end
-  spec.bindir = 'bin'
+  spec.bindir = "bin"
   spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
+  spec.require_paths = ["lib"]
+  spec.required_ruby_version = ">= 2.6.3"
+  spec.required_rubygems_version = ">= 3.0.3"
 
   lambda {
-    requirements = ['>= 0.4.4365', '<= 0.4.4366']
-    spec.add_runtime_dependency 'sorbet', requirements
-    spec.add_runtime_dependency 'sorbet-runtime', requirements
+    requirements = [">= 0.4.4365", "<= 0.4.4366"]
+    spec.add_runtime_dependency "sorbet", requirements
+    spec.add_runtime_dependency "sorbet-runtime", requirements
   }.call
 
-  spec.add_development_dependency 'bundler', '~> 1.17'
-  spec.add_development_dependency 'minitest', '~> 5.0'
-  spec.add_development_dependency 'rubocop', '~> 0.72.0'
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "rubocop", "~> 0.72.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sorbet-progress
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Jared Beck
@@ -102,14 +102,21 @@ files:
 - ".gitignore"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
 - README.md
 - Rakefile
 - bin/console
+- bin/sorbet_progress
 - bin/test.sh
 - lib/sorbet_progress.rb
+- lib/sorbet_progress/cli.rb
+- lib/sorbet_progress/error.rb
+- lib/sorbet_progress/metric.rb
+- lib/sorbet_progress/metrics.rb
+- lib/sorbet_progress/parser.rb
 - lib/sorbet_progress/version.rb
 - sorbet-progress.gemspec
 - sorbet/config
@@ -131,12 +138,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.6.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 3.0.3
 requirements: []
 rubygems_version: 3.0.3
 signing_key: