sorbet_auto_typer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0da8912b32505d98bed3b009083eb99f6d6130dc3615cf02e511943fe4eb2923
+  data.tar.gz: c88e9338b3d3d2010acdfe09ccf4005a840f5ad3b6778d696f39a4c0ef1d9724
+SHA512:
+  metadata.gz: 6c6f759476c9f0f7c21ebf7eaaba6c6f359a0a652692f10c1d1c296911c920287691e3a18016bb90abc0f77f68f4223d6f3b2619a8594158e52c5166a791899d
+  data.tar.gz: f07876569f6b62e4272af5fc3bf1cbc7d110698087ee10817e51783e54c07a21cccb798d3ff87ded1207738d1db4213992f7feb297ad6fb85e4c3d3f0980a17a

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/Gemfile.lock

data/.ruby-version

@@ -0,0 +1 @@
+2.6.5

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.5
+before_install: gem install bundler -v 2.0.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at bo@stendal-sorensen.net. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in sorbet_auto_typer.gemspec
+gemspec
+
+gem 'pry-byebug'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Bo Stendal Sorensen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,106 @@
+# SorbetAutoTyper
+
+SorbetAutoTyper is a tool that is able to add sorbet signatures to files by instrumenting code, for example by running the test suite of a project.
+
+## Installation
+
+Add this line to your application's Gemfile (you probably want to add it in the development/test section):
+
+```ruby
+gem 'sorbet_auto_typer'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+SorbetAutoTyper works in two steps:
+
+1. Instrumentation
+2. Analysis
+
+### Instrumentation
+
+The first step is to instrument the code. To be able to instrument even a large codebase, SorbetAutoTyper will stop instrumenting a method after a specific amount of calls. Underneath the hood the ruby `TracePoint` API is used to ensure maximum speed.
+
+To instrument a codeblock, first configure the gem:
+
+```ruby
+SorbetAutoTyper.configure do |c|
+  c.output_file = File.join(Dir.pwd, 'tmp', "#{SecureRandom.uuid}.sig")
+  c.filter_path = File.join(Dir.pwd, 'lib')
+end
+```
+
+This will set up the gem to output a signature file with a random name to the `tmp` directory and only inspect files in the `lib` directory.
+This configuration only needs to be done once pr. process.
+
+Next we can start and stop SorbetAutoTyper using `SorbetAutoTyper.start!` and `SorbetAutoTyper.stop!`.
+
+Instrumenting a simple file could look like this:
+
+```ruby
+SorbetAutoTyper.start!
+a = MyModule::MyClass.new
+a.hello
+SorbetAutoTyper.stop!
+```
+
+In the context of a test runner like RSpec, the following could be added to the spec helper of the project:
+
+```ruby
+SorbetAutoTyper.configure do |c|
+  c.output_file = File.join(Dir.pwd, 'tmp', "#{SecureRandom.uuid}.sig")
+  c.filter_path = File.join(Dir.pwd, 'lib')
+end
+
+RSpec.configure do |config|
+  config.before(:suite) do
+    SorbetAutoTyper.start!
+  end
+
+  config.after(:suite) do
+    SorbetAutoTyper.stop!
+  end
+end
+```
+
+### Analysis
+
+Running the analysis is as simple as running the `sorbet-auto-typer` tool within your project. If you run it without any arguments, it will print a bit of help:
+
+```bash
+$ bundle exec sorbet-auto-typer
+Error: Please provide a SIGNATURE_FILE.
+
+sorbet-auto-typer [OPTIONS] ... SIGNATURE_FILE
+
+-h, --help:
+   show help
+
+--dry, -d:
+   do not overwrite files, only display desired changes
+
+--verbose, -v:
+   more verbose output
+
+SIGNATURE_FILE: Signature file to use for auto-generated types
+```
+
+The `--dry` and `--verbose` flags will make sure none of the source files are overwritten and provide a diff of the files. Those are recommended options on the first run.
+
+When you are ready to run `SorbetAutoTyper` on your project, simply run it without any options and it will add method signatures to the source files in the project.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/bss/sorbet_auto_typer. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the SorbetAutoTyper project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/bss/sorbet_auto_typer/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+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"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sorbet_auto_typer"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/rake

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/sorbet-auto-typer

@@ -0,0 +1,106 @@
+#!/usr/bin/env ruby
+require 'getoptlong'
+require 'bundler/setup'
+require 'parser'
+require 'parser/current'
+
+require 'diff-lcs'
+
+require 'sorbet_auto_typer'
+
+# Load up everything where this file is being run.
+Bundler.require(:default)
+
+LOOK_BEFORE = 1
+LOOK_AFTER = 1
+
+def print_help
+  puts <<-EOF
+#{File.basename($0)} [OPTIONS] ... SIGNATURE_FILE
+
+-h, --help:
+   show help
+
+--dry, -d:
+   do not overwrite files, only display desired changes
+
+--verbose, -v:
+   more verbose output
+
+SIGNATURE_FILE: Signature file to use for auto-generated types
+  EOF
+end
+
+opts = GetoptLong.new(
+  [ '--help', '-h', GetoptLong::NO_ARGUMENT ],
+  [ '--dry', '-d', GetoptLong::NO_ARGUMENT ],
+  [ '--verbose', '-v', GetoptLong::NO_ARGUMENT ],
+)
+
+dry_run = false
+verbose = false
+opts.each do |opt, arg|
+  case opt
+    when '--help'
+      print_help
+      Kernel.exit(0)
+    when '--dry'
+      dry_run = true
+    when '--verbose'
+      verbose = true
+  end
+end
+
+if ARGV.size < 1
+  puts "Error: Please provide a SIGNATURE_FILE."
+  puts
+  print_help
+  Kernel.exit(1)
+end
+
+trace_file = ARGV.first
+uniq_trace_lines = Set.new()
+
+File.foreach(trace_file) do |line|
+  uniq_trace_lines << line
+end
+
+traces = uniq_trace_lines.map do |l|
+  SorbetAutoTyper::MethodTrace.from_trace_line(l.strip)
+end.compact
+
+annotator = SorbetAutoTyper::Annotator.new(traces)
+
+all_files = traces.map(&:method_file).uniq
+all_files.each do |source_file|
+  puts "Annotating: #{source_file}"
+  new_source = annotator.annotate_file(source_file)
+
+  if verbose
+    puts "----"
+
+    original_source_lines = File.read(source_file).split("\n")
+    new_source_lines = new_source.split("\n")
+    diffs = Diff::LCS.sdiff(original_source_lines, new_source_lines)
+    changed_diffs = diffs.each_with_index.reject { |(d, idx)| d.unchanged? }
+    indexes_to_display = changed_diffs.flat_map { |(_, line)| (line-LOOK_BEFORE..line+LOOK_AFTER).to_a }.uniq
+    indexes_to_display.each do |idx|
+      dc = diffs[idx]
+      unless dc.nil?
+        if dc.unchanged?
+          puts "  #{dc.old_element}"
+        else
+          if dc.deleting? || dc.changed?
+            puts "+ #{dc.old_element}"
+          end
+
+          if dc.adding? || dc.changed?
+            puts "+ #{dc.new_element}"
+          end
+        end
+      end
+    end
+  end
+
+  File.write(source_file, new_source) unless dry_run
+end

data/lib/sorbet_auto_typer.rb

@@ -0,0 +1,57 @@
+# typed: ignore
+require 'sorbet-runtime'
+require "sorbet_auto_typer/version"
+require "sorbet_auto_typer/configuration"
+require "sorbet_auto_typer/tracer"
+require "sorbet_auto_typer/method_trace"
+require "sorbet_auto_typer/source_rewriter"
+require "sorbet_auto_typer/annotator"
+
+module SorbetAutoTyper
+  class Error < StandardError; end
+  class MissingConfigurationError < Error; end
+  class InvalidConfigurationError < Error; end
+  class TracerAlreadyRunning < Error; end
+
+  class << self
+    extend T::Sig
+
+    sig { void }
+    def start!
+      raise MissingConfigurationError.new if !@config
+      raise InvalidConfigurationError.new unless @config.valid?
+      raise TracerAlreadyRunning.new unless @current_tracer.nil?
+
+      output_file = File.open(T.must(@config.output_file), 'w')
+
+      @current_tracer = Tracer.new(output_file, T.must(@config.filter_path))
+      @current_tracer.start!
+    end
+
+    sig { void }
+    def stop!
+      @current_tracer = T.let(@current_tracer, T.nilable(Tracer))
+      unless @current_tracer.nil?
+        @current_tracer.stop!
+        @current_tracer = nil
+      end
+    end
+
+    sig { params(blk: T.proc.params(arg0: Configuration).void).void }
+    def configure(&blk)
+      config = Configuration.new(output_file: nil)
+      yield config
+      @config = T.let(config, T.nilable(Configuration))
+    end
+
+    sig { void }
+    def reset!
+      stop!
+      @config = nil
+    end
+
+    private
+    sig { returns(T.nilable(Configuration)) }
+    attr_reader :config
+  end
+end