tapioca 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 91a976cddc1429c3b08568b39d8fae5fe8d4d54a8b8b2b04deebb75f475987e8
-  data.tar.gz: 45074066696bd5c838ab09523980fd9c148faeb1b9f6ee800e8752e636edbd1a
+  metadata.gz: 46bdcc628673ddc597495e267b471e3a6f4c705b8f8d8d32dffba17c69470c21
+  data.tar.gz: 4a2e597d03ea9354835e73f52034d088b1c15ac65f445d0f6963bbbca09c2b23
 SHA512:
-  metadata.gz: 1646cf3ec4957442bf0895a636bfc684e00f0d88e2252502d119fd3f4b4073e41b773ce0cbe8f725766d0c82bae7f67b92381a32a123b6fa2067ddd6a9e2c8d2
-  data.tar.gz: 33f8dae8437b44c2bb2e7d4a1bb483adc11c0ae58322b62fa97a879698ba3d9abab4f198d38b7a8433e57f32f64df5b39ce1b5d8a13ebe37b011dae2d179d926
+  metadata.gz: 51c134a7948c262721672f61105e08e1e31146b70d982fac0944b0d42be91d5e2210a110775596d11704e60eac68d6b2e27c016587777c658fab2b64131f7a1e
+  data.tar.gz: 1f048066d59bc2cc08a62fb93de96afdb7146d8e1c987c2a98677edd4920b08896096f9beaa658466ebd54be729c2bf6947ef1c409ab7329dac5ac27f7847dbc

data/README.md

@@ -8,6 +8,8 @@ As yet, no gem exports type information in a consumable format and it would be a
 
 When you run `tapioca sync` in a project, `tapioca` loads all the gems that are in your dependency list from the Gemfile into memory. It then performs runtime introspection on the loaded types to understand their structure and generates an appropriate RBI file for each gem with a versioned filename.
 
+## Manual gem requires
+
 For gems that have a normal default `require` and load all of their constants through such a require, everything works seamlessly. However, for gems that are marked as `require: false` in the Gemfile, or for gems that export optionally loaded types via different requires, where a single require does not load the whole gem code into memory, `tapioca` will not be able to load some of the types into memory and, thus, won't be able to generate complete RBIs for them. For this reason, we need to keep a small external file named `sorbet/tapioca/require.rb` that is executed after all the gems in the Gemfile have been required and before generation of gem RBIs have started. This file is responsible for adding the requires for additional files from gems, which are not covered by the default require.
 
 For example, suppose you are using the class `BetterHtml::Parser` exported from the `better_html` gem. Just doing a `require "better_html"` (which is the default require) does not load that type:

data/lib/tapioca/compilers/dsl/active_record_columns.rb

@@ -349,9 +349,9 @@ module Tapioca
               !(constant.singleton_class < Object.const_get(:StrongTypeGeneration))
         end
 
-        sig { params(column_type: Module).returns(String) }
+        sig { params(column_type: Object).returns(String) }
         def handle_unknown_type(column_type)
-          return "T.untyped" unless column_type < ActiveModel::Type::Value
+          return "T.untyped" unless ActiveModel::Type::Value === column_type
 
           lookup_return_type_of_method(column_type, :deserialize) ||
             lookup_return_type_of_method(column_type, :cast) ||
@@ -359,19 +359,27 @@ module Tapioca
             "T.untyped"
         end
 
-        sig { params(column_type: Module, method: Symbol).returns(T.nilable(String)) }
+        sig { params(column_type: ActiveModel::Type::Value, method: Symbol).returns(T.nilable(String)) }
         def lookup_return_type_of_method(column_type, method)
-          signature = T::Private::Methods.signature_for_method(column_type.instance_method(method))
+          signature = T::Private::Methods.signature_for_method(column_type.method(method))
           return unless signature
 
-          return_type = signature.return_type.to_s
-          return_type if return_type != "<VOID>" && return_type != "<NOT-TYPED>"
+          return_type = signature.return_type
+          return if T::Types::Simple === return_type && T::Generic === return_type.raw_type
+          return if return_type == T::Private::Types::Void || return_type == T::Private::Types::NotTyped
+
+          return_type.to_s
         end
 
-        sig { params(column_type: Module, method: Symbol).returns(T.nilable(String)) }
+        sig { params(column_type: ActiveModel::Type::Value, method: Symbol).returns(T.nilable(String)) }
         def lookup_arg_type_of_method(column_type, method)
-          signature = T::Private::Methods.signature_for_method(column_type.instance_method(method))
-          signature.arg_types.first.last.to_s if signature
+          signature = T::Private::Methods.signature_for_method(column_type.method(method))
+          return unless signature
+
+          arg_type = signature.arg_types.first.last
+          return if T::Types::Simple === arg_type && T::Generic === arg_type.raw_type
+
+          arg_type.to_s
         end
       end
     end

data/lib/tapioca/compilers/dsl/base.rb

@@ -1,6 +1,8 @@
 # typed: strict
 # frozen_string_literal: true
 
+require "parlour"
+
 module Tapioca
   module Compilers
     module Dsl

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

@@ -29,7 +29,7 @@ module Tapioca
         def generate
           symbols
             .sort
-            .map(&method(:generate_from_symbol))
+            .map { |symbol| generate_from_symbol(symbol) }
             .compact
             .join("\n\n")
             .concat("\n")

data/lib/tapioca/gemfile.rb

@@ -28,7 +28,7 @@ module Tapioca
     sig { returns(T::Array[Gem]) }
     def dependencies
       @dependencies ||= begin
-        specs = definition.specs.to_a
+        specs = definition.locked_gems.specs.to_a
 
         definition
           .resolve
@@ -79,17 +79,18 @@ module Tapioca
       extend(T::Sig)
 
       IGNORED_GEMS = T.let(%w{
-        sorbet sorbet-static sorbet-runtime tapioca
+        sorbet sorbet-static sorbet-runtime
       }.freeze, T::Array[String])
 
       sig { returns(String) }
-      attr_reader :full_gem_path
+      attr_reader :full_gem_path, :version
 
       sig { params(spec: Spec).void }
       def initialize(spec)
         @spec = T.let(spec, Tapioca::Gemfile::Spec)
         real_gem_path = to_realpath(@spec.full_gem_path)
         @full_gem_path = T.let(real_gem_path, String)
+        @version = T.let(version_string, String)
       end
 
       sig { params(gemfile_dir: String).returns(T::Boolean) }
@@ -109,11 +110,6 @@ module Tapioca
         @spec.name
       end
 
-      sig { returns(::Gem::Version) }
-      def version
-        @spec.version
-      end
-
       sig { returns(String) }
       def rbi_file_name
         "#{name}@#{version}.rbi"
@@ -121,11 +117,38 @@ module Tapioca
 
       sig { params(path: String).returns(T::Boolean) }
       def contains_path?(path)
-        to_realpath(path).start_with?(full_gem_path)
+        to_realpath(path).start_with?(full_gem_path) || has_parent_gemspec?(path)
       end
 
       private
 
+      sig { returns(String) }
+      def version_string
+        version = @spec.version.to_s
+        version += "-#{@spec.source.revision}" if Bundler::Source::Git === @spec.source
+        version
+      end
+
+      sig { params(path: String).returns(T::Boolean) }
+      def has_parent_gemspec?(path)
+        # For some Git installed gems the location of the loaded file can
+        # be different from the gem path as indicated by the spec file
+        #
+        # To compensate for these cases, we walk up the directory hierarchy
+        # from the given file and try to match a <gem-name.gemspec> file in
+        # one of those folders to see if the path really belongs in the given gem
+        # or not.
+        return false unless Bundler::Source::Git === @spec.source
+        parent = Pathname.new(path)
+
+        until parent.root?
+          parent = parent.parent.expand_path
+          return true if parent.join("#{name}.gemspec").file?
+        end
+
+        false
+      end
+
       sig { params(path: T.any(String, Pathname)).returns(String) }
       def to_realpath(path)
         path_string = path.to_s

data/lib/tapioca/generator.rb

@@ -162,6 +162,11 @@ module Tapioca
 
     private
 
+    EMPTY_RBI_COMMENT = <<~CONTENT
+      # THIS IS AN EMPTY RBI FILE.
+      # see https://github.com/Shopify/tapioca/blob/master/README.md#manual-gem-requires
+    CONTENT
+
     sig { returns(Gemfile) }
     def bundle
       @bundle ||= Gemfile.new
@@ -422,20 +427,25 @@ module Tapioca
       say("Compiling #{gem_name}, this may take a few seconds... ")
 
       strictness = config.typed_overrides[gem.name] || "true"
-
+      rbi_body_content = compiler.compile(gem)
       content = String.new
       content << rbi_header(
         config.generate_command,
         reason: "types exported from the `#{gem.name}` gem",
         strictness: strictness
       )
-      content << compiler.compile(gem)
 
       FileUtils.mkdir_p(config.outdir)
       filename = config.outpath / gem.rbi_file_name
-      File.write(filename.to_s, content)
 
-      say("Done", :green)
+      if rbi_body_content.strip.empty?
+        content << EMPTY_RBI_COMMENT
+        say("Done (empty output)", :yellow)
+      else
+        content << rbi_body_content
+        say("Done", :green)
+      end
+      File.write(filename.to_s, content)
 
       Pathname.glob((config.outpath / "#{gem.name}@*.rbi").to_s) do |file|
         remove(file) unless file.basename.to_s == gem.rbi_file_name

data/lib/tapioca/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tapioca
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - Ufuk Kayserilioglu
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-27 00:00:00.000000000 Z
+date: 2020-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry