tapioca 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 81caba98bdbde19ffbb78a1860f994a8b5c39a82dcd48832ce0daabcd9f6d77b
-  data.tar.gz: 803fe5c9b0ac3838f984455adf53fd2a470e13a877ea218d80bb74b2c309afbe
+  metadata.gz: 6aedd5a0415cca7e554021e114401254561649803acceed6caaa2cb24b9b4c8c
+  data.tar.gz: 376290c5b3cad6f082e9fc186cbb2ed32a9bb239c5c37bc8f9f464c78a2d951e
 SHA512:
-  metadata.gz: 75c2b49c410a6b9f558470a5ab6b59f464b41e4b03a88344fd8967d06e3b36b8b29669bd92c8103d106e234a91fb4ead51d617a365059342e03542cfe113c497
-  data.tar.gz: 4261f1657b92a65ba119f95e1e9be3211af056fe2ba5a5b225b0d920a2adda1fd7619d9e21bb8e034c3946b4cb931d8ef45beebd3bb429c2c5d8446bce09efa8
+  metadata.gz: e65c8822f8312788075a84f24d5b9c95221bba2ced2dd877f150a377696fd70eff96bc936fdd3cf482fa6d4ac1b2d86a0201ed91c386c1ee1ce0bd19e8defd9c
+  data.tar.gz: bace8a6fca5ca72789c5fdfa121fb7b30bf415e9f04d6c715f43237f4d022c4507a6d6182161c4928a7258f9759c957a22c2559cc73ebc56d093f5864dcd872f

data/README.md

@@ -2,7 +2,7 @@
 
 [![Build Status](https://travis-ci.org/Shopify/tapioca.svg?branch=master)](https://travis-ci.org/Shopify/tapioca)
 
-Tapioca is a library used to generate RBI (Ruby interface) files for use with [Sorbet](https://sorbet.org). RBI files provide the structure (classes, modules, methods, parameters) of the gem/library to Sorbet to assist with typechecking. 
+Tapioca is a library used to generate RBI (Ruby interface) files for use with [Sorbet](https://sorbet.org). RBI files provide the structure (classes, modules, methods, parameters) of the gem/library to Sorbet to assist with typechecking.
 
 As yet, no gem exports type information in a consumable format and it would be a huge effort to manually maintain such an interface file for all the gems that your codebase depends on. Thus, there is a need for an automated way to generate the appropriate RBI file for a given gem. The `tapioca` gem, developed at Shopify, is able to do exactly that to almost 99% accuracy. It can generate the definitions for all statically defined types and most of the runtime defined types exported from Ruby gems (non-Ruby gems are not handled yet).
 
@@ -27,7 +27,7 @@ from (pry):3:in `__pry__`
 => BetterHtml::Parser
 ```
 
-In order to make sure that `tapioca` can reflect on that type, we need to add the line `require "better_html/parser"` to the `sorbet/tapioca/require.rb` file. This will make sure `BetterHtml::Parser` is loaded into memory and a type annotation is generated for it in the `better_html.rbi` file. If this extra `require` line is not added to `sorbet/tapioca/require.rb` file, then the definition for that type will be missing from the RBI file. 
+In order to make sure that `tapioca` can reflect on that type, we need to add the line `require "better_html/parser"` to the `sorbet/tapioca/require.rb` file. This will make sure `BetterHtml::Parser` is loaded into memory and a type annotation is generated for it in the `better_html.rbi` file. If this extra `require` line is not added to `sorbet/tapioca/require.rb` file, then the definition for that type will be missing from the RBI file.
 
 If you ever run into a case, where you add a gem or update the version of a gem and run `tapioca sync` but don't have some types you expect in the generated gem RBI files, you will need to make sure you have added the necessary requires to the `sorbet/tapioca/require.rb` file.
 
@@ -50,6 +50,7 @@ Commands:
   tapioca help [COMMAND]     # Describe available commands or one specific command
   tapioca init               # initializes folder structure
   tapioca sync               # sync RBIs to Gemfile
+  tapioca todo               # generate the list of unresolved constants
 
 Options:
   --pre, -b, [--prerequire=file]              # A file to be required before Bundler.require is called
@@ -80,6 +81,12 @@ Command: `tapioca sync`
 
 This will sync the RBIs with the gems in the Gemfile and will add, update, and remove RBIs as necessary.
 
+### Generate the list of all unresolved constants
+
+Command: `tapioca todo`
+
+This will generate the file `sorbet/rbi/todo.rbi` defining all unresolved constants as empty modules.
+
 ### Flags
 
 - `--prerequire [file]`: A file to be required before `Bundler.require` is called.

data/lib/tapioca.rb

@@ -35,7 +35,9 @@ require "tapioca/config_builder"
 require "tapioca/generator"
 require "tapioca/cli"
 require "tapioca/gemfile"
+require "tapioca/compilers/sorbet"
 require "tapioca/compilers/symbol_table_compiler"
 require "tapioca/compilers/symbol_table/symbol_generator"
 require "tapioca/compilers/symbol_table/symbol_loader"
+require "tapioca/compilers/todos_compiler"
 require "tapioca/version"

data/lib/tapioca/cli.rb

@@ -52,6 +52,13 @@ module Tapioca
       end
     end
 
+    desc "todo", "generate the list of unresolved constants"
+    def todo
+      Tapioca.silence_warnings do
+        generator.build_todos
+      end
+    end
+
     desc "generate [gem...]", "generate RBIs from gems"
     def generate(*gems)
       Tapioca.silence_warnings do

data/lib/tapioca/compilers/sorbet.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+# typed: true
+
+require 'pathname'
+require 'shellwords'
+
+module Tapioca
+  module Compilers
+    module Sorbet
+      SORBET = Pathname.new(Gem::Specification.find_by_name("sorbet-static").full_gem_path) / "libexec" / "sorbet"
+
+      class << self
+        extend(T::Sig)
+
+        sig { params(args: String).returns(String) }
+        def run(*args)
+          IO.popen(
+            [
+              sorbet_path,
+              "--quiet",
+              *args,
+            ].join(' '),
+            err: "/dev/null"
+          ).read
+        end
+
+        sig { returns(String) }
+        def sorbet_path
+          SORBET.to_s.shellescape
+        end
+      end
+    end
+  end
+end

data/lib/tapioca/compilers/symbol_table/symbol_generator.rb

@@ -287,6 +287,7 @@ module Tapioca
             end
 
           prepends = prepend
+            .reverse
             .select { |mod| (name = name_of(mod)) && !name.start_with?("T::") }
             .select(&method(:public_module?))
             .map do |mod|
@@ -297,6 +298,7 @@ module Tapioca
             end
 
           includes = include
+            .reverse
             .select { |mod| (name = name_of(mod)) && !name.start_with?("T::") }
             .select(&method(:public_module?))
             .map do |mod|
@@ -304,6 +306,7 @@ module Tapioca
             end
 
           extends = extend
+            .reverse
             .select { |mod| (name = name_of(mod)) && !name.start_with?("T::") }
             .select(&method(:public_module?))
             .map do |mod|

data/lib/tapioca/compilers/symbol_table/symbol_loader.rb

@@ -2,16 +2,12 @@
 # typed: true
 
 require 'json'
-require 'pathname'
 require 'tempfile'
-require 'shellwords'
 
 module Tapioca
   module Compilers
     module SymbolTable
       module SymbolLoader
-        SORBET = Pathname.new(Gem::Specification.find_by_name("sorbet-static").full_gem_path) / "libexec" / "sorbet"
-
         class << self
           extend(T::Sig)
 
@@ -53,22 +49,7 @@ module Tapioca
           end
 
           def symbol_table_json_from(input, table_type: "symbol-table-json")
-            IO.popen(
-              [
-                sorbet_path,
-                # We don't want to pick up any sorbet/config files in cwd
-                "--no-config",
-                "--print=#{table_type}",
-                "--quiet",
-                input,
-              ].join(' '),
-              err: "/dev/null"
-            ).read
-          end
-
-          sig { returns(String) }
-          def sorbet_path
-            SORBET.to_s.shellescape
+            Tapioca::Compilers::Sorbet.run("--no-config", "--print=#{table_type}", input)
           end
         end
 

data/lib/tapioca/compilers/todos_compiler.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+# typed: strong
+
+module Tapioca
+  module Compilers
+    # Taken from https://github.com/sorbet/sorbet/blob/master/gems/sorbet/lib/todo-rbi.rb
+    class TodosCompiler
+      extend(T::Sig)
+
+      sig do
+        returns(String)
+      end
+      def compile
+        list_todos.each_line.map do |line|
+          next if line.include?("<") || line.include?("class_of")
+          "module #{line.strip.gsub('T.untyped::', '')}; end"
+        end.compact.join("\n")
+      end
+
+      private
+
+      sig { returns(String) }
+      def list_todos
+        Tapioca::Compilers::Sorbet.run(
+          "--print=missing-constants",
+          "--stdout-hup-hack",
+          "--no-error-count"
+        ).strip
+      end
+    end
+  end
+end

data/lib/tapioca/config.rb

@@ -11,11 +11,12 @@ module Tapioca
     const(:generate_command, String)
     const(:exclude, T::Array[String])
     const(:typed_overrides, T::Hash[String, String])
+    const(:todos_path, String)
 
     sig { returns(Pathname) }
     def outpath
-      @outpath ||= T.let(Pathname.new(outdir), T.nilable(Pathname))
-      T.must(@outpath)
+      @outpath = T.let(@outpath, T.nilable(Pathname))
+      @outpath ||= Pathname.new(outdir)
     end
 
     private_class_method :new
@@ -24,11 +25,13 @@ module Tapioca
     SORBET_CONFIG = "sorbet/config"
 
     DEFAULT_POSTREQUIRE = "sorbet/tapioca/require.rb"
-    DEFAULT_OUTDIR = "sorbet/rbi/gems"
+    DEFAULT_RBIDIR = "sorbet/rbi"
+    DEFAULT_OUTDIR = T.let("#{DEFAULT_RBIDIR}/gems", String)
     DEFAULT_OVERRIDES = T.let({
       # ActiveSupport overrides some core methods with different signatures
       # so we generate a typed: false RBI for it to suppress errors
       "activesupport" => "false",
     }.freeze, T::Hash[String, String])
+    DEFAULT_TODOSPATH = T.let("#{DEFAULT_RBIDIR}/todo.rbi", String)
   end
 end

data/lib/tapioca/config_builder.rb

@@ -1,6 +1,8 @@
 # typed: strict
 # frozen_string_literal: true
 
+require 'yaml'
+
 module Tapioca
   class ConfigBuilder
     class << self
@@ -57,6 +59,7 @@ module Tapioca
       "generate_command" => default_command,
       "exclude" => [],
       "typed_overrides" => Config::DEFAULT_OVERRIDES,
+      "todos_path" => Config::DEFAULT_TODOSPATH,
     }.freeze, T::Hash[String, T.untyped])
   end
 end

data/lib/tapioca/generator.rb

@@ -44,6 +44,38 @@ module Tapioca
       say("Please review changes and commit them.", [:green, :bold])
     end
 
+    sig { void }
+    def build_todos
+      todos_path = config.todos_path
+      compiler = Compilers::TodosCompiler.new
+      name = set_color(todos_path, :yellow, :bold)
+      say("Compiling #{name}, this may take a few seconds... ")
+
+      # Clean all existing unresolved constants before regenerating the list
+      # so Sorbet won't grab them as already resolved.
+      File.delete(todos_path) if File.exist?(todos_path)
+
+      rbi_string = compiler.compile
+      if rbi_string.empty?
+        say("Nothing to do", :green)
+        return
+      end
+
+      content = String.new
+      content << rbi_header(config.generate_command, "false")
+      content << rbi_string
+      content << "\n"
+
+      outdir = File.dirname(todos_path)
+      FileUtils.mkdir_p(outdir)
+      File.write(todos_path, content)
+
+      say("Done", :green)
+
+      say("All unresolved constants have been written to #{name}.", [:green, :bold])
+      say("Please review changes and commit them.", [:green, :bold])
+    end
+
     sig { void }
     def sync_rbis_with_gemfile
       anything_done = [

data/lib/tapioca/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module Tapioca
-  VERSION = "0.3.1"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tapioca
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Ufuk Kayserilioglu
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-29 00:00:00.000000000 Z
+date: 2020-05-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -139,9 +139,11 @@ files:
 - exe/tapioca
 - lib/tapioca.rb
 - lib/tapioca/cli.rb
+- lib/tapioca/compilers/sorbet.rb
 - lib/tapioca/compilers/symbol_table/symbol_generator.rb
 - lib/tapioca/compilers/symbol_table/symbol_loader.rb
 - lib/tapioca/compilers/symbol_table_compiler.rb
+- lib/tapioca/compilers/todos_compiler.rb
 - lib/tapioca/config.rb
 - lib/tapioca/config_builder.rb
 - lib/tapioca/constant_locator.rb