tapioca 0.2.8 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3bd7a0a3f7cb0bbb9ed158cd446ae76a2d89f5872c620f1dce5ecc41e898d330
-  data.tar.gz: e66cc1b09f4c7b47bf493a9a1966c9cc6dd05c2f12f4d29e6a1900949554c3b0
+  metadata.gz: fbb47e890388bfea9f9413a20cc6768d16175f9b962291d04d35eaaf3e94e109
+  data.tar.gz: eb041465b3237e6f87872c1aeaf172fb0c28ebb445f1855f837dd1759888362f
 SHA512:
-  metadata.gz: 8e12cfbd5404421a8ab57a0c85c8ee503bc0f87cfc569edac3e97da1f86d420aa137a91c79dae3d86220cdd5ea817476387613068e05fd7986fa8284e2b5da97
-  data.tar.gz: 85603c8f06e73f214dac2c31b389ea1e4ac63c513e209da649a657e33951e7d2d0c7f9208a5c4eee597ba953937397bc3d630a4a0a01a29c092ed60d7aa935c5
+  metadata.gz: 703f76a6df75973603aebc4e2589a81d124b98196372dccc170da3e720dd02676749a6439e9538862a327945b182f71f826beecd1b9b99d032c4e6067b9afb66
+  data.tar.gz: 7a86ffe6ef50693f8f22fdc9bd4c853b0d7d5d4296d85f6ba7e0207471f6a1654d561f9a97a148e48e8bec80559c0c68c9afd95374e1b5a40ec2785172e7e43c

data/lib/tapioca.rb

@@ -28,12 +28,14 @@ rescue
   nil
 end
 
-require_relative "tapioca/loader"
-require_relative "tapioca/constant_locator"
-require_relative "tapioca/generator"
-require_relative "tapioca/cli"
-require_relative "tapioca/gemfile"
-require_relative "tapioca/compilers/symbol_table_compiler"
-require_relative "tapioca/compilers/symbol_table/symbol_generator"
-require_relative "tapioca/compilers/symbol_table/symbol_loader"
-require_relative "tapioca/version"
+require "tapioca/loader"
+require "tapioca/constant_locator"
+require "tapioca/config"
+require "tapioca/config_builder"
+require "tapioca/generator"
+require "tapioca/cli"
+require "tapioca/gemfile"
+require "tapioca/compilers/symbol_table_compiler"
+require "tapioca/compilers/symbol_table/symbol_generator"
+require "tapioca/compilers/symbol_table/symbol_loader"
+require "tapioca/version"

data/lib/tapioca/cli.rb

@@ -13,34 +13,36 @@ module Tapioca
                   desc: "A file to be required before Bundler.require is called"
     class_option :postrequire,
                   aliases: ["--post", "-a"],
-                  default: Generator::DEFAULT_POSTREQUIRE,
                   banner: "file",
                   desc: "A file to be required after Bundler.require is called"
     class_option :outdir,
                   aliases: ["--out", "-o"],
-                  default: Generator::DEFAULT_OUTDIR,
                   banner: "directory",
                   desc: "The output directory for generated RBI files"
     class_option :generate_command,
                   aliases: ["--cmd", "-c"],
                   banner: "command",
                   desc: "The command to run to regenerate RBI files"
+    class_option :exclude,
+                  aliases: ["-x"],
+                  type: :array,
+                  banner: "gem [gem ...]",
+                  desc: "Excludes the given gem(s) from RBI generation"
     class_option :typed_overrides,
                   aliases: ["--typed", "-t"],
                   type: :hash,
-                  default: {},
-                  banner: "gem:level",
+                  banner: "gem:level [gem:level ...]",
                   desc: "Overrides for typed sigils for generated gem RBIs"
 
     desc "init", "initializes folder structure"
     def init
-      create_file(Generator::SORBET_CONFIG, skip: true) do
+      create_file(Config::SORBET_CONFIG, skip: true) do
         <<~CONTENT
           --dir
           .
         CONTENT
       end
-      create_file(Generator::DEFAULT_POSTREQUIRE, skip: true) do
+      create_file(Config::DEFAULT_POSTREQUIRE, skip: true) do
         <<~CONTENT
           # frozen_string_literal: true
           # typed: false
@@ -65,14 +67,12 @@ module Tapioca
     end
 
     no_commands do
+      def self.exit_on_failure?
+        true
+      end
+
       def generator
-        @generator ||= Generator.new(
-          outdir: options[:outdir],
-          prerequire: options[:prerequire],
-          postrequire: options[:postrequire],
-          command: options[:generate_command],
-          typed_overrides: options[:typed_overrides]
-        )
+        @generator ||= Generator.new(ConfigBuilder.from_options(options))
       end
     end
   end

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

@@ -137,14 +137,11 @@ module Tapioca
         end
         def compile_object(name, value)
           return if symbol_ignored?(name)
-          indented("#{name} = T.let(T.unsafe(nil), #{type_name_of(value)})")
-        end
-
-        sig { params(value: BasicObject).returns(String).checked(:never) }
-        def type_name_of(value)
           klass = class_of(value)
+          return if name_of(klass)&.start_with?("T::Types::", "T::Private::")
 
-          public_module?(klass) && name_of(klass) || "T.untyped"
+          type_name = public_module?(klass) && name_of(klass) || "T.untyped"
+          indented("#{name} = T.let(T.unsafe(nil), #{type_name})")
         end
 
         sig { params(name: String, constant: Module).returns(T.nilable(String)) }
@@ -289,7 +286,7 @@ module Tapioca
             end
 
           prepends = prepend
-            .select(&method(:name_of))
+            .select { |mod| (name = name_of(mod)) && !name.start_with?("T::") }
             .select(&method(:public_module?))
             .map do |mod|
               # TODO: Sorbet currently does not handle prepend
@@ -299,14 +296,14 @@ module Tapioca
             end
 
           includes = include
-            .select(&method(:name_of))
+            .select { |mod| (name = name_of(mod)) && !name.start_with?("T::") }
             .select(&method(:public_module?))
             .map do |mod|
               indented("include(#{qualified_name_of(mod)})")
             end
 
           extends = extend
-            .select(&method(:name_of))
+            .select { |mod| (name = name_of(mod)) && !name.start_with?("T::") }
             .select(&method(:public_module?))
             .map do |mod|
               indented("extend(#{qualified_name_of(mod)})")
@@ -424,11 +421,6 @@ module Tapioca
           SymbolLoader.ignore_symbol?(symbol_name)
         end
 
-        sig { params(path: String).returns(T::Boolean) }
-        def path_in_gem?(path)
-          File.realpath(path).start_with?(gem.full_gem_path)
-        end
-
         SPECIAL_METHOD_NAMES = %w[! ~ +@ ** -@ * / % + - << >> & | ^ < <= => > >= == === != =~ !~ <=> [] []= `]
 
         sig { params(name: String).returns(T::Boolean) }
@@ -462,7 +454,7 @@ module Tapioca
           source_location = method.source_location&.first
           return false if source_location.nil?
 
-          path_in_gem?(source_location)
+          gem.contains_path?(source_location)
         end
 
         sig { params(constant: Module, strict: T::Boolean).returns(T::Boolean) }
@@ -473,7 +465,7 @@ module Tapioca
           return !strict if files.empty?
 
           files.any? do |file|
-            path_in_gem?(file)
+            gem.contains_path?(file)
           end
         end
 

data/lib/tapioca/config.rb

@@ -0,0 +1,34 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Tapioca
+  class Config < T::Struct
+    extend(T::Sig)
+
+    const(:outdir, String)
+    const(:prerequire, T.nilable(String))
+    const(:postrequire, String)
+    const(:generate_command, String)
+    const(:exclude, T::Array[String])
+    const(:typed_overrides, T::Hash[String, String])
+
+    sig { returns(Pathname) }
+    def outpath
+      @outpath ||= T.let(Pathname.new(outdir), T.nilable(Pathname))
+      T.must(@outpath)
+    end
+
+    private_class_method :new
+
+    CONFIG_FILE_PATH = "sorbet/tapioca/config.yml"
+    SORBET_CONFIG = "sorbet/config"
+
+    DEFAULT_POSTREQUIRE = "sorbet/tapioca/require.rb"
+    DEFAULT_OUTDIR = "sorbet/rbi/gems"
+    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])
+  end
+end

data/lib/tapioca/config_builder.rb

@@ -0,0 +1,62 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Tapioca
+  class ConfigBuilder
+    class << self
+      extend(T::Sig)
+
+      sig { params(options: T::Hash[String, T.untyped]).returns(Config) }
+      def from_options(options)
+        Config.from_hash(
+          merge_options(default_options, config_options, options)
+        )
+      end
+
+      private
+
+      sig { returns(T::Hash[String, T.untyped]) }
+      def config_options
+        if File.exist?(Config::CONFIG_FILE_PATH)
+          YAML.load_file(Config::CONFIG_FILE_PATH, fallback: {})
+        else
+          {}
+        end
+      end
+
+      sig { returns(T::Hash[String, T.untyped]) }
+      def default_options
+        DEFAULT_OPTIONS
+      end
+
+      sig { returns(String) }
+      def default_command
+        command = File.basename($PROGRAM_NAME)
+        args = ARGV.join(" ")
+
+        "#{command} #{args}".strip
+      end
+
+      sig { params(options: T::Hash[String, T.untyped]).returns(T::Hash[String, T.untyped]) }
+      def merge_options(*options)
+        options.each_with_object({}) do |option, result|
+          result.merge!(option) do |_, this_val, other_val|
+            if this_val.is_a?(Hash) && other_val.is_a?(Hash)
+              this_val.merge(other_val)
+            else
+              other_val
+            end
+          end
+        end
+      end
+    end
+
+    DEFAULT_OPTIONS = T.let({
+      "postrequire" => Config::DEFAULT_POSTREQUIRE,
+      "outdir" => Config::DEFAULT_OUTDIR,
+      "generate_command" => default_command,
+      "exclude" => [],
+      "typed_overrides" => Config::DEFAULT_OVERRIDES,
+    }.freeze, T::Hash[String, T.untyped])
+  end
+end

data/lib/tapioca/gemfile.rb

@@ -88,7 +88,7 @@ module Tapioca
       sig { params(spec: Spec).void }
       def initialize(spec)
         @spec = T.let(spec, Tapioca::Gemfile::Spec)
-        real_gem_path = File.realpath(@spec.full_gem_path.to_s)
+        real_gem_path = to_realpath(@spec.full_gem_path)
         @full_gem_path = T.let(real_gem_path, String)
       end
 
@@ -119,8 +119,20 @@ module Tapioca
         "#{name}@#{version}.rbi"
       end
 
+      sig { params(path: String).returns(T::Boolean) }
+      def contains_path?(path)
+        to_realpath(path).start_with?(full_gem_path)
+      end
+
       private
 
+      sig { params(path: T.any(String, Pathname)).returns(String) }
+      def to_realpath(path)
+        path_string = path.to_s
+        path_string = File.realpath(path_string) if File.exist?(path_string)
+        path_string
+      end
+
       sig { returns(T::Boolean) }
       def gem_ignored?
         IGNORED_GEMS.include?(name)

data/lib/tapioca/generator.rb

@@ -8,41 +8,16 @@ module Tapioca
   class Generator < ::Thor::Shell::Color
     extend(T::Sig)
 
-    SORBET_CONFIG = "sorbet/config"
-    DEFAULT_POSTREQUIRE = "sorbet/tapioca/require.rb"
-    DEFAULT_OUTDIR = "sorbet/rbi/gems"
-    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])
-
-    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 { returns(Config) }
+    attr_reader :config
 
     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])
+        config: Config
       ).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 || DEFAULT_POSTREQUIRE, T.nilable(String))
-      @command = T.let(command || default_command, String)
-      @typed_overrides = T.let(typed_overrides || {}, T::Hash[String, String])
+    def initialize(config)
+      @config = config
       @bundle = T.let(nil, T.nilable(Gemfile))
       @loader = T.let(nil, T.nilable(Loader))
       @compiler = T.let(nil, T.nilable(Compilers::SymbolTableCompiler))
@@ -55,13 +30,15 @@ module Tapioca
     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
+      gems_to_generate(gem_names)
+        .reject { |gem| config.exclude.include?(gem.name) }
+        .each do |gem|
+          say("Processing '#{gem.name}' gem:", :green)
+          indent do
+            compile_rbi(gem)
+            puts
+          end
         end
-      end
 
       say("All operations performed in working directory.", [:green, :bold])
       say("Please review changes and commit them.", [:green, :bold])
@@ -86,14 +63,6 @@ module Tapioca
 
     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
@@ -112,14 +81,14 @@ module Tapioca
     sig { void }
     def require_gem_file
       say("Requiring all gems to prepare for compiling... ")
-      loader.load_bundle(prerequire, postrequire)
+      loader.load_bundle(config.prerequire, config.postrequire)
       say(" Done", :green)
       puts
     end
 
     sig { returns(T::Hash[String, String]) }
     def existing_rbis
-      @existing_rbis ||= Pathname.glob((Pathname.new(outdir) / "*@*.rbi").to_s)
+      @existing_rbis ||= Pathname.glob((config.outpath / "*@*.rbi").to_s)
         .map { |f| f.basename(".*").to_s.split('@') }
         .to_h
     end
@@ -127,13 +96,14 @@ module Tapioca
     sig { returns(T::Hash[String, String]) }
     def expected_rbis
       @expected_rbis ||= bundle.dependencies
+        .reject { |gem| config.exclude.include?(gem.name) }
         .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"
+      config.outpath / "#{gem_name}@#{version}.rbi"
     end
 
     sig { params(gem_name: String).returns(Pathname) }
@@ -280,18 +250,18 @@ module Tapioca
       gem_name = set_color(gem.name, :yellow, :bold)
       say("Compiling #{gem_name}, this may take a few seconds... ")
 
-      typed_sigil = typed_overrides[gem.name] || DEFAULT_OVERRIDES[gem.name] || "true"
+      typed_sigil = config.typed_overrides[gem.name] || "true"
 
       content = compiler.compile(gem)
-      content.prepend(rbi_header(command, typed_sigil))
+      content.prepend(rbi_header(config.generate_command, typed_sigil))
 
-      FileUtils.mkdir_p(outdir)
-      filename = outdir / gem.rbi_file_name
+      FileUtils.mkdir_p(config.outdir)
+      filename = config.outpath / gem.rbi_file_name
       File.write(filename.to_s, content)
 
       say("Done", :green)
 
-      Pathname.glob((outdir / "#{gem.name}@*.rbi").to_s) do |file|
+      Pathname.glob((config.outpath / "#{gem.name}@*.rbi").to_s) do |file|
         remove(file) unless file.basename.to_s == gem.rbi_file_name
       end
     end

data/lib/tapioca/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tapioca
 version: !ruby/object:Gem::Version
-  version: 0.2.8
+  version: 0.3.0
 platform: ruby
 authors:
 - Ufuk Kayserilioglu
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-24 00:00:00.000000000 Z
+date: 2020-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -142,6 +142,8 @@ files:
 - 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/config.rb
+- lib/tapioca/config_builder.rb
 - lib/tapioca/constant_locator.rb
 - lib/tapioca/gemfile.rb
 - lib/tapioca/generator.rb