tapioca 0.0.1 → 0.1.2

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

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+# 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)
+
+          sig { params(paths: T::Array[Pathname]).returns(T::Set[String]) }
+          def list_from_paths(paths)
+            load_symbols(paths.map(&:to_s))
+          end
+
+          def ignore_symbol?(symbol)
+            ignored_symbols.include?(symbol)
+          end
+
+          private
+
+          sig { params(paths: T::Array[String]).returns(T::Set[String]) }
+          def load_symbols(paths)
+            output = T.cast(Tempfile.create('sorbet') do |file|
+              file.write(Array(paths).join("\n"))
+              file.flush
+
+              symbol_table_json_from("@#{file.path}")
+            end, T.nilable(String))
+
+            return Set.new if output.nil? || output.empty?
+
+            json = JSON.parse(output)
+            SymbolTableParser.parse(json)
+          end
+
+          def ignored_symbols
+            unless @ignored_symbols
+              output = symbol_table_json_from("''", table_type: "symbol-table-full-json")
+              json = JSON.parse(output)
+              @ignored_symbols = SymbolTableParser.parse(json)
+            end
+
+            @ignored_symbols
+          end
+
+          def symbol_table_json_from(input, table_type: "symbol-table-json")
+            IO.popen(
+              [
+                SORBET,
+                # We don't want to pick up any sorbet/config files in cwd
+                "--no-config",
+                "--print=#{table_type}",
+                "--quiet",
+                input,
+              ].shelljoin,
+              err: "/dev/null"
+            ).read
+          end
+        end
+
+        class SymbolTableParser
+          def self.parse(object, parents = [])
+            symbols = Set.new
+
+            children = object.fetch("children", [])
+
+            children.each do |child|
+              kind = child.fetch("kind")
+              name = child.fetch("name")
+              name = name.fetch("name") if name.is_a?(Hash)
+
+              next if kind.nil? || name.nil?
+
+              next unless %w[CLASS STATIC_FIELD].include?(kind)
+              next if name =~ /[<>()$]/
+              next if name =~ /^[0-9]+$/
+              next if name == "T::Helpers"
+
+              parents << name
+
+              symbols.add(parents.join("::"))
+              symbols.merge(parse(child, parents))
+
+              parents.pop
+            end
+            symbols
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tapioca/compilers/symbol_table_compiler.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+# typed: strong
+
+module Tapioca
+  module Compilers
+    class SymbolTableCompiler
+      extend(T::Sig)
+
+      sig do
+        params(
+          gem: Gemfile::Gem,
+          indent: Integer
+        ).returns(String)
+      end
+      def compile(
+        gem,
+        indent = 0
+      )
+        Tapioca::Compilers::SymbolTable::SymbolGenerator.new(gem, indent).generate
+      end
+    end
+  end
+end

data/lib/tapioca/gemfile.rb

@@ -0,0 +1,136 @@
+# frozen_string_literal: true
+# typed: strict
+
+require "bundler"
+
+module Tapioca
+  class Gemfile
+    extend(T::Sig)
+
+    Spec = T.type_alias(T.any(::Bundler::StubSpecification, ::Gem::Specification))
+
+    sig { void }
+    def initialize
+      @gemfile = T.let(File.new(Bundler.default_gemfile), File)
+      @lockfile = T.let(File.new(Bundler.default_lockfile), File)
+      @dependencies = T.let(nil, T.nilable(T::Array[Gem]))
+      @definition = T.let(nil, T.nilable(Bundler::Definition))
+    end
+
+    sig { returns(T::Array[Gem]) }
+    def dependencies
+      @dependencies ||= begin
+        specs = definition.specs.to_a
+
+        definition
+          .resolve
+          .materialize(specs)
+          .reject { |spec| ignore_gem_spec?(spec) }
+          .map { |spec| Gem.new(spec) }
+          .uniq(&:rbi_file_name)
+          .sort_by(&:rbi_file_name)
+      end
+    end
+
+    sig { params(gem_name: String).returns(T.nilable(Gem)) }
+    def gem(gem_name)
+      dependencies.detect { |dep| dep.name == gem_name }
+    end
+
+    sig { params(initialize_file: T.nilable(String), require_file: T.nilable(String)).void }
+    def require_bundle(initialize_file, require_file)
+      require(initialize_file) if initialize_file && File.exist?(initialize_file)
+
+      runtime = Bundler::Runtime.new(File.dirname(gemfile.path), definition)
+      groups = Bundler.definition.groups
+      runtime.setup(*groups).require(*groups)
+
+      require(require_file) if require_file && File.exist?(require_file)
+
+      load_rails_engines
+    end
+
+    private
+
+    sig { returns(File) }
+    attr_reader(:gemfile, :lockfile)
+
+    sig { returns(Bundler::Definition) }
+    def definition
+      @definition ||= Bundler::Dsl.evaluate(gemfile, lockfile, {})
+    end
+
+    sig { params(spec: Spec).returns(T::Boolean) }
+    def ignore_gem_spec?(spec)
+      spec.name == "sorbet" ||
+        spec.full_gem_path.start_with?(gemfile_dir)
+    end
+
+    sig { returns(String) }
+    def gemfile_dir
+      File.expand_path(gemfile.path + "/..")
+    end
+
+    sig { void }
+    def load_rails_engines
+      return unless Object.const_defined?("Rails::Engine")
+      engines = Object.const_get("Rails::Engine").descendants.reject(&:abstract_railtie?)
+
+      engines.each do |engine|
+        errored_files = []
+
+        engine.config.eager_load_paths.each do |load_path|
+          Dir.glob("#{load_path}/**/*.rb").sort.each do |file|
+            require(file)
+          rescue LoadError, StandardError
+            errored_files << file
+          end
+        end
+
+        # Try files that have errored one more time
+        # It might have been a load order problem
+        errored_files.each do |file|
+          require(file)
+        rescue LoadError, StandardError
+          nil
+        end
+      end
+    end
+
+    class Gem
+      extend(T::Sig)
+
+      sig { params(spec: Spec).void }
+      def initialize(spec)
+        @spec = T.let(spec, Spec)
+      end
+
+      sig { returns(String) }
+      def full_gem_path
+        @spec.full_gem_path.to_s
+      end
+
+      sig { returns(T::Array[Pathname]) }
+      def files
+        @spec.full_require_paths.flat_map do |path|
+          Pathname.new(path).glob("**/*.rb")
+        end
+      end
+
+      sig { returns(String) }
+      def name
+        @spec.name
+      end
+
+      sig { returns(::Gem::Version) }
+      def version
+        @spec.version
+      end
+
+      sig { returns(String) }
+      def rbi_file_name
+        "#{name}@#{version}.rbi"
+      end
+    end
+  end
+end

data/lib/tapioca/generator.rb

@@ -0,0 +1,286 @@
+# frozen_string_literal: true
+# typed: strict
+
+require 'pathname'
+require 'thor'
+
+module Tapioca
+  class Generator < ::Thor::Shell::Color
+    extend(T::Sig)
+
+    DEFAULT_OUTDIR = "sorbet/rbi/gems"
+
+    sig { returns(Pathname) }
+    attr_reader :outdir
+    sig { returns(T.nilable(String)) }
+    attr_reader :prerequire
+    sig { returns(T.nilable(String)) }
+    attr_reader :postrequire
+    sig { returns(String) }
+    attr_reader :command
+    sig { returns(T::Hash[String, String]) }
+    attr_reader :typed_overrides
+
+    sig do
+      params(
+        outdir: T.nilable(String),
+        prerequire: T.nilable(String),
+        postrequire: T.nilable(String),
+        command: T.nilable(String),
+        typed_overrides: T.nilable(T::Hash[String, String])
+      ).void
+    end
+    def initialize(outdir: nil, prerequire: nil, postrequire: nil, command: nil, typed_overrides: nil)
+      @outdir = T.let(Pathname.new(outdir || DEFAULT_OUTDIR), Pathname)
+      @prerequire = T.let(prerequire, T.nilable(String))
+      @postrequire = T.let(postrequire, T.nilable(String))
+      @command = T.let(command || default_command, String)
+      @typed_overrides = T.let(typed_overrides || {}, T::Hash[String, String])
+      @bundle = T.let(nil, T.nilable(Gemfile))
+      @compiler = T.let(nil, T.nilable(Compilers::SymbolTableCompiler))
+      @existing_rbis = T.let(nil, T.nilable(T::Hash[String, String]))
+      @expected_rbis = T.let(nil, T.nilable(T::Hash[String, String]))
+      super()
+    end
+
+    sig { params(gem_names: T::Array[String]).void }
+    def build_gem_rbis(gem_names)
+      require_gem_file
+
+      gems_to_generate(gem_names).map do |gem|
+        say("Processing '#{gem.name}' gem:", :green)
+        indent do
+          compile_rbi(gem)
+          puts
+        end
+      end
+
+      say("All operations performed in working directory.", [:green, :bold])
+      say("Please review changes and commit them.", [:green, :bold])
+    end
+
+    sig { void }
+    def sync_rbis_with_gemfile
+      anything_done = [
+        perform_removals,
+        perform_additions,
+      ].any?
+
+      if anything_done
+        say("All operations performed in working directory.", [:green, :bold])
+        say("Please review changes and commit them.", [:green, :bold])
+      else
+        say("No operations performed, all RBIs are up-to-date.", [:green, :bold])
+      end
+
+      puts
+    end
+
+    private
+
+    sig { returns(String) }
+    def default_command
+      command = File.basename($PROGRAM_NAME)
+      args = ARGV.join(" ")
+
+      "#{command} #{args}"
+    end
+
+    sig { returns(Gemfile) }
+    def bundle
+      @bundle ||= Gemfile.new
+    end
+
+    sig { returns(Compilers::SymbolTableCompiler) }
+    def compiler
+      @compiler ||= Compilers::SymbolTableCompiler.new
+    end
+
+    sig { void }
+    def require_gem_file
+      say("Requiring all gems to prepare for compiling... ")
+      bundle.require_bundle(prerequire, postrequire)
+      say(" Done", :green)
+      puts
+    end
+
+    sig { returns(T::Hash[String, String]) }
+    def existing_rbis
+      @existing_rbis ||= Dir.glob("*@*.rbi", T.unsafe(base: outdir))
+        .map { |f| File.basename(f, ".*").split('@') }
+        .to_h
+    end
+
+    sig { returns(T::Hash[String, String]) }
+    def expected_rbis
+      @expected_rbis ||= bundle.dependencies
+        .map { |gem| [gem.name, gem.version.to_s] }
+        .to_h
+    end
+
+    sig { params(gem_name: String, version: String).returns(Pathname) }
+    def rbi_filename(gem_name, version)
+      outdir / "#{gem_name}@#{version}.rbi"
+    end
+
+    sig { params(gem_name: String).returns(Pathname) }
+    def existing_rbi(gem_name)
+      rbi_filename(gem_name, T.must(existing_rbis[gem_name]))
+    end
+
+    sig { params(gem_name: String).returns(Pathname) }
+    def expected_rbi(gem_name)
+      rbi_filename(gem_name, T.must(expected_rbis[gem_name]))
+    end
+
+    sig { params(gem_name: String).returns(T::Boolean) }
+    def rbi_exists?(gem_name)
+      existing_rbis.key?(gem_name)
+    end
+
+    sig { returns(T::Array[String]) }
+    def removed_rbis
+      (existing_rbis.keys - expected_rbis.keys).sort
+    end
+
+    sig { returns(T::Array[String]) }
+    def added_rbis
+      expected_rbis.select do |name, value|
+        existing_rbis[name] != value
+      end.keys.sort
+    end
+
+    sig { params(filename: Pathname).void }
+    def add(filename)
+      say("++ Adding: #{filename}")
+    end
+
+    sig { params(filename: Pathname).void }
+    def remove(filename)
+      say("-- Removing: #{filename}")
+      filename.unlink
+    end
+
+    sig { params(old_filename: Pathname, new_filename: Pathname).void }
+    def move(old_filename, new_filename)
+      say("-> Moving: #{old_filename} to #{new_filename}")
+      old_filename.rename(new_filename.to_s)
+    end
+
+    sig { void }
+    def perform_removals
+      say("Removing RBI files of gems that have been removed:", [:blue, :bold])
+      puts
+
+      anything_done = T.let(false, T::Boolean)
+
+      gems = removed_rbis
+
+      indent do
+        if gems.empty?
+          say("Nothing to do.")
+        else
+          gems.each do |removed|
+            filename = existing_rbi(removed)
+            remove(filename)
+          end
+
+          anything_done = true
+        end
+      end
+
+      puts
+
+      anything_done
+    end
+
+    sig { void }
+    def perform_additions
+      say("Generating RBI files of gems that are added or updated:", [:blue, :bold])
+      puts
+
+      anything_done = T.let(false, T::Boolean)
+
+      gems = added_rbis
+
+      indent do
+        if gems.empty?
+          say("Nothing to do.")
+        else
+          require_gem_file
+
+          gems.each do |gem_name|
+            filename = expected_rbi(gem_name)
+
+            if rbi_exists?(gem_name)
+              old_filename = existing_rbi(gem_name)
+              move(old_filename, filename) unless old_filename == filename
+            end
+
+            gem = T.must(bundle.gem(gem_name))
+            compile_rbi(gem)
+            add(filename)
+
+            puts
+          end
+        end
+
+        anything_done = true
+      end
+
+      puts
+
+      anything_done
+    end
+
+    sig do
+      params(gem_names: T::Array[String])
+        .returns(T::Array[Gemfile::Gem])
+    end
+    def gems_to_generate(gem_names)
+      return bundle.dependencies if gem_names.empty?
+
+      gem_names.map do |gem_name|
+        gem = bundle.gem(gem_name)
+        if gem.nil?
+          say("Error: Cannot find gem '#{gem_name}'", :red)
+          exit(1)
+        end
+        gem
+      end
+    end
+
+    sig { params(command: String, typed_sigil: String).returns(String) }
+    def rbi_header(command, typed_sigil)
+      <<~HEAD
+        # This file is autogenerated. Do not edit it by hand. Regenerate it with:
+        #   #{command}
+
+        # typed: #{typed_sigil}
+
+      HEAD
+    end
+
+    sig { params(gem: Gemfile::Gem).void }
+    def compile_rbi(gem)
+      compiler = Compilers::SymbolTableCompiler.new
+      gem_name = set_color(gem.name, :yellow, :bold)
+      say("Compiling #{gem_name}, this may take a few seconds... ")
+
+      typed_sigil = typed_overrides.fetch(gem.name, "true")
+
+      content = compiler.compile(gem)
+      content.prepend(rbi_header(command, typed_sigil))
+
+      FileUtils.mkdir_p(outdir)
+      filename = outdir / gem.rbi_file_name
+      File.write(filename.to_s, content)
+
+      say("Done", :green)
+
+      outdir.glob("#{gem.name}@*.rbi") do |file|
+        remove(file) unless file.basename.to_s == gem.rbi_file_name
+      end
+    end
+  end
+end