tapioca 0.4.5 → 0.4.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a6ca30be86eac3958354ca4204904993088bfeeef36c72d63b428ccc5ff3eff3
-  data.tar.gz: e218a8ed57c6eb6c46b00f423771fa1a4874a8f0a945d8f5683e849fe5ca9e91
+  metadata.gz: db90e001ad45dbd8edd11b2288405dd406588e1bb46120c7cd5f0cb560647ea6
+  data.tar.gz: 1eab20c32a1785046f814ca2fc54866bbc0c9d083bf682a8b1ea15bf92c9cc1e
 SHA512:
-  metadata.gz: 39b2b67d35896d998f0f11dcdeda386e6e8312e124b12d8e5e252650417ba3c8a452aedfe014059064ca69e465d97089bfad55f1801d6667612902a4edc24903
-  data.tar.gz: 0fa4fe00a45d1f0e870f6d2cf985291ee1ed3f78d339c1f27be5653cff99490de31c6907abc462f1c1c7c197d7eb3eba63c2a90764c56a89fd607fd950c4a493
+  metadata.gz: 77d4598557fc72b8a76dea56b626d05a3f91dd88d53cb0e96156ed92419534a32beeed17cd0f4791e37c972f2da86c07bb6a386a0dbb5813a5b4f998438e3127
+  data.tar.gz: 102c5591a319f1846506d0e1e439f52613bc9f5d6110eab98ee857d7a943921584e12b56733ec7b4f6e95824396ea1052ffc691eed0505bf2b00a7438ceabbe0

data/Gemfile

@@ -34,3 +34,5 @@ group(:development, :test) do
   gem("activeresource", "~> 5.1", require: false)
   gem("google-protobuf", "~>3.12.0", require: false)
 end
+
+gem "rubocop-sorbet", ">= 0.4.1"

data/README.md

@@ -1,6 +1,6 @@
 # Tapioca
 
-[![Build Status](https://travis-ci.org/Shopify/tapioca.svg?branch=master)](https://travis-ci.org/Shopify/tapioca)
+![Build Status](https://github.com/Shopify/tapioca/workflows/CI/badge.svg)
 
 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.
 
@@ -55,6 +55,8 @@ and do not forget to execute `tapioca` using `bundler`:
 ```shell
 $ bundle exec tapioca
 Commands:
+  tapioca --version, -v      # show version
+  tapioca dsl [constant...]  # generate RBIs for dynamic methods
   tapioca generate [gem...]  # generate RBIs from gems
   tapioca help [COMMAND]     # Describe available commands or one specific command
   tapioca init               # initializes folder structure
@@ -63,12 +65,12 @@ Commands:
   tapioca todo               # generate the list of unresolved constants
 
 Options:
-  --pre, -b, [--prerequire=file]              # A file to be required before Bundler.require is called
-  --post, -a, [--postrequire=file]            # A file to be required after Bundler.require is called
-  --out, -o, [--outdir=directory]             # The output directory for generated RBI files
-                                              # Default: sorbet/rbi/gems
-  --cmd, -c, [--generate-command=command]     # The command to run to regenerate RBI files
-  --typed, -t, [--typed-overrides=gem:level]  # Overrides for typed sigils for generated gem RBIs
+  --pre, -b, [--prerequire=file]                              # A file to be required before Bundler.require is called
+  --post, -a, [--postrequire=file]                            # A file to be required after Bundler.require is called
+  --out, -o, [--outdir=directory]                             # The output directory for generated RBI files
+  --cmd, -c, [--generate-command=command]                     # The command to run to regenerate RBI files
+  -x, [--exclude=gem [gem ...]]                               # Excludes the given gem(s) from RBI generation
+  --typed, -t, [--typed-overrides=gem:level [gem:level ...]]  # Overrides for typed sigils for generated gem RBIs
 ```
 
 ## Usage

data/lib/tapioca/cli.rb

@@ -1,5 +1,5 @@
-# frozen_string_literal: true
 # typed: true
+# frozen_string_literal: true
 
 require 'thor'
 
@@ -34,6 +34,8 @@ module Tapioca
                   banner: "gem:level [gem:level ...]",
                   desc: "Overrides for typed sigils for generated gem RBIs"
 
+    map T.unsafe(%w[--version -v] => :__print_version)
+
     desc "init", "initializes folder structure"
     def init
       create_file(Config::SORBET_CONFIG, skip: true) do
@@ -92,6 +94,11 @@ module Tapioca
       end
     end
 
+    desc "--version, -v", "show version"
+    def __print_version
+      puts "Tapioca v#{Tapioca::VERSION}"
+    end
+
     no_commands do
       def self.exit_on_failure?
         true

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

@@ -45,10 +45,10 @@ module Tapioca
       #   sig { params(value: T.nilable(::User)).void }
       #   def author=(value); end
       #
-      #   sig { params(args: T.untyped, blk: T.untyped).returns(T.nilable(::User)) }
+      #   sig { params(args: T.untyped, blk: T.untyped).returns(::User) }
       #   def build_author(*args, &blk); end
       #
-      #   sig { params(args: T.untyped, blk: T.untyped).returns(T.nilable(::Category)) }
+      #   sig { params(args: T.untyped, blk: T.untyped).returns(::Category) }
       #   def build_category(*args, &blk); end
       #
       #   sig { returns(T.nilable(::Category)) }
@@ -69,16 +69,16 @@ module Tapioca
       #   sig { params(value: T::Enumerable[::Comment]).void }
       #   def comments=(value); end
       #
-      #   sig { params(args: T.untyped, blk: T.untyped).returns(T.nilable(::User)) }
+      #   sig { params(args: T.untyped, blk: T.untyped).returns(::User) }
       #   def create_author(*args, &blk); end
       #
-      #   sig { params(args: T.untyped, blk: T.untyped).returns(T.nilable(::User)) }
+      #   sig { params(args: T.untyped, blk: T.untyped).returns(::User) }
       #   def create_author!(*args, &blk); end
       #
-      #   sig { params(args: T.untyped, blk: T.untyped).returns(T.nilable(::Category)) }
+      #   sig { params(args: T.untyped, blk: T.untyped).returns(::Category) }
       #   def create_category(*args, &blk); end
       #
-      #   sig { params(args: T.untyped, blk: T.untyped).returns(T.nilable(::Category)) }
+      #   sig { params(args: T.untyped, blk: T.untyped).returns(::Category) }
       #   def create_category!(*args, &blk); end
       #
       #   sig { returns(T.nilable(::User)) }
@@ -152,7 +152,7 @@ module Tapioca
             "reload_#{association_name}",
             return_type: association_type,
           )
-          if reflection.constructable?
+          unless reflection.polymorphic?
             create_method(
               klass,
               "build_#{association_name}",
@@ -160,7 +160,7 @@ module Tapioca
                 Parlour::RbiGenerator::Parameter.new("*args", type: "T.untyped"),
                 Parlour::RbiGenerator::Parameter.new("&blk", type: "T.untyped"),
               ],
-              return_type: association_type
+              return_type: association_class
             )
             create_method(
               klass,
@@ -169,7 +169,7 @@ module Tapioca
                 Parlour::RbiGenerator::Parameter.new("*args", type: "T.untyped"),
                 Parlour::RbiGenerator::Parameter.new("&blk", type: "T.untyped"),
               ],
-              return_type: association_type
+              return_type: association_class
             )
             create_method(
               klass,
@@ -178,7 +178,7 @@ module Tapioca
                 Parlour::RbiGenerator::Parameter.new("*args", type: "T.untyped"),
                 Parlour::RbiGenerator::Parameter.new("&blk", type: "T.untyped"),
               ],
-              return_type: association_type
+              return_type: association_class
             )
           end
         end

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

@@ -108,7 +108,7 @@ module Tapioca
         sig { override.returns(T::Enumerable[Module]) }
         def gather_constants
           ::ActiveRecord::Base.descendants.select do |klass|
-            klass < IdentityCache
+            klass < IdentityCache::WithoutPrimaryIndex
           end
         end
 
@@ -126,7 +126,7 @@ module Tapioca
           if returns_collection
             COLLECTION_TYPE.call(cache_type)
           else
-            "::#{cache_type}"
+            "T.nilable(::#{cache_type})"
           end
         rescue ArgumentError
           "T.untyped"

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

@@ -92,24 +92,28 @@ module Tapioca
           method_def = signature.nil? ? method_def : signature.method
           method_types = parameters_types_from_signature(method_def, signature)
 
-          method_def.parameters.each_with_index.map do |(type, name), i|
-            name ||= :_
-            name = name.to_s.gsub(/&|\*/, '_') # avoid incorrect names from `delegate`
+          method_def.parameters.each_with_index.map do |(type, name), index|
+            fallback_arg_name = "_arg#{index}"
+
+            name ||= fallback_arg_name
+            name = name.to_s.gsub(/&|\*/, fallback_arg_name) # avoid incorrect names from `delegate`
+            method_type = method_types[index]
+
             case type
             when :req
-              ::Parlour::RbiGenerator::Parameter.new(name, type: method_types[i])
+              ::Parlour::RbiGenerator::Parameter.new(name, type: method_type)
             when :opt
-              ::Parlour::RbiGenerator::Parameter.new(name, type: method_types[i], default: 'T.unsafe(nil)')
+              ::Parlour::RbiGenerator::Parameter.new(name, type: method_type, default: 'T.unsafe(nil)')
             when :rest
-              ::Parlour::RbiGenerator::Parameter.new("*#{name}", type: method_types[i])
+              ::Parlour::RbiGenerator::Parameter.new("*#{name}", type: method_type)
             when :keyreq
-              ::Parlour::RbiGenerator::Parameter.new("#{name}:", type: method_types[i])
+              ::Parlour::RbiGenerator::Parameter.new("#{name}:", type: method_type)
             when :key
-              ::Parlour::RbiGenerator::Parameter.new("#{name}:", type: method_types[i], default: 'T.unsafe(nil)')
+              ::Parlour::RbiGenerator::Parameter.new("#{name}:", type: method_type, default: 'T.unsafe(nil)')
             when :keyrest
-              ::Parlour::RbiGenerator::Parameter.new("**#{name}", type: method_types[i])
+              ::Parlour::RbiGenerator::Parameter.new("**#{name}", type: method_type)
             when :block
-              ::Parlour::RbiGenerator::Parameter.new("&#{name}", type: method_types[i])
+              ::Parlour::RbiGenerator::Parameter.new("&#{name}", type: method_type)
             else
               raise "Unknown type `#{type}`."
             end

data/lib/tapioca/compilers/dsl_compiler.rb

@@ -1,5 +1,5 @@
+# typed: strict
 # frozen_string_literal: true
-# typed: true
 
 require "tapioca/compilers/dsl/base"
 
@@ -30,7 +30,7 @@ module Tapioca
           T::Enumerable[Dsl::Base]
         )
         @requested_constants = requested_constants
-        @error_handler = error_handler || $stderr.method(:puts)
+        @error_handler = T.let(error_handler || $stderr.method(:puts), T.proc.params(error: String).void)
       end
 
       sig { params(blk: T.proc.params(constant: Module, rbi: String).void).void }
@@ -54,9 +54,9 @@ module Tapioca
 
       private
 
-      sig { params(requested_generators: T::Array[String]).returns(Proc) }
+      sig { params(requested_generators: T::Array[String]).returns(T.proc.params(klass: Class).returns(T::Boolean)) }
       def generator_filter(requested_generators)
-        return proc { true } if requested_generators.empty?
+        return ->(_klass) { true } if requested_generators.empty?
 
         generators = requested_generators.map(&:downcase)
 
@@ -70,7 +70,7 @@ module Tapioca
       def gather_generators(requested_generators)
         generator_filter = generator_filter(requested_generators)
 
-        Dsl::Base.descendants.select(&generator_filter).map(&:new)
+        T.cast(Dsl::Base.descendants.select(&generator_filter).map(&:new), T::Enumerable[Dsl::Base])
       end
 
       sig { params(requested_constants: T::Array[Module]).returns(T::Set[Module]) }

data/lib/tapioca/compilers/requires_compiler.rb

@@ -1,5 +1,5 @@
-# frozen_string_literal: true
 # typed: strict
+# frozen_string_literal: true
 
 require 'spoom'
 
@@ -34,7 +34,8 @@ module Tapioca
           path = (Pathname.new(@sorbet_path) / "../.." / path).cleanpath
           if path.directory?
             Dir.glob("#{path}/**/*.rb", File::FNM_EXTGLOB).reject do |file|
-              file_ignored_by_sorbet?(config, file)
+              relative_file_path = Pathname.new(file).relative_path_from(path)
+              file_ignored_by_sorbet?(config, relative_file_path)
             end
           else
             [path.to_s]
@@ -49,13 +50,40 @@ module Tapioca
         end.compact
       end
 
-      sig { params(config: Spoom::Sorbet::Config, file: String).returns(T::Boolean) }
-      def file_ignored_by_sorbet?(config, file)
-        config.ignore.any? do |path|
-          Regexp.new(Regexp.escape(path)) =~ file
+      sig { params(config: Spoom::Sorbet::Config, file_path: Pathname).returns(T::Boolean) }
+      def file_ignored_by_sorbet?(config, file_path)
+        file_path_parts = path_parts(file_path)
+
+        config.ignore.any? do |ignore|
+          # Sorbet --ignore matching method:
+          # ---
+          # Ignores input files that contain the given
+          # string in their paths (relative to the input
+          # path passed to Sorbet).
+          #
+          # Strings beginning with / match against the
+          # prefix of these relative paths; others are
+          # substring matchs.
+
+          # Matches must be against whole folder and file
+          # names, so `foo` matches `/foo/bar.rb` and
+          # `/bar/foo/baz.rb` but not `/foo.rb` or
+          # `/foo2/bar.rb`.
+          ignore_parts = path_parts(Pathname.new(ignore))
+          file_path_part_sequences = file_path_parts.each_cons(ignore_parts.size)
+          # if ignore string begins with /, we only want the first sequence to match
+          file_path_part_sequences = [file_path_part_sequences.first].to_enum if ignore.start_with?("/")
+
+          # we need to match whole segments
+          file_path_part_sequences.include?(ignore_parts)
         end
       end
 
+      sig { params(path: Pathname).returns(T::Array[String]) }
+      def path_parts(path)
+        T.unsafe(path).descend.map { |part| part.basename.to_s }
+      end
+
       sig { params(files: T::Enumerable[String], name: String).returns(T::Boolean) }
       def name_in_project?(files, name)
         files.any? do |file|

data/lib/tapioca/compilers/sorbet.rb

@@ -1,5 +1,5 @@
-# frozen_string_literal: true
 # typed: true
+# frozen_string_literal: true
 
 require 'pathname'
 require 'shellwords'

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

@@ -1,5 +1,5 @@
-# frozen_string_literal: true
 # typed: true
+# frozen_string_literal: true
 
 require 'pathname'
 
@@ -209,7 +209,11 @@ module Tapioca
             method = "const" if prop.fetch(:immutable, false)
             type = prop.fetch(:type_object, "T.untyped")
 
-            indented("#{method} :#{name}, #{type}")
+            if prop.key?(:default)
+              indented("#{method} :#{name}, #{type}, default: T.unsafe(nil)")
+            else
+              indented("#{method} :#{name}, #{type}")
+            end
           end.join("\n")
         end
 
@@ -513,7 +517,9 @@ module Tapioca
 
           parameters = T.let(method.parameters, T::Array[[Symbol, T.nilable(Symbol)]])
 
-          sanitized_parameters = parameters.map do |type, name|
+          sanitized_parameters = parameters.each_with_index.map do |(type, name), index|
+            fallback_arg_name = "_arg#{index}"
+
             unless name
               # For attr_writer methods, Sorbet signatures have the name
               # of the method (without the trailing = sign) as the name of
@@ -533,12 +539,12 @@ module Tapioca
               name = if writer_method_with_sig
                 T.must(method_name[0...-1]).to_sym
               else
-                :_
+                fallback_arg_name
               end
             end
 
             # Sanitize param names
-            name = name.to_s.gsub(/[^a-zA-Z0-9_]/, '_')
+            name = name.to_s.gsub(/[^a-zA-Z0-9_]/, fallback_arg_name)
 
             [type, name]
           end
@@ -612,6 +618,7 @@ module Tapioca
           signature_body = signature_body
             .gsub(".returns(<VOID>)", ".void")
             .gsub("<NOT-TYPED>", "T.untyped")
+            .gsub(".params()", "")
             .gsub(TYPE_PARAMETER_MATCHER, "T.type_parameter(:\\1)")[1..-1]
 
           "sig { #{signature_body} }"

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

@@ -1,5 +1,5 @@
-# frozen_string_literal: true
 # typed: true
+# frozen_string_literal: true
 
 require 'json'
 require 'tempfile'

data/lib/tapioca/compilers/symbol_table_compiler.rb

@@ -1,5 +1,5 @@
-# frozen_string_literal: true
 # typed: strong
+# frozen_string_literal: true
 
 module Tapioca
   module Compilers

data/lib/tapioca/compilers/todos_compiler.rb

@@ -1,5 +1,5 @@
-# frozen_string_literal: true
 # typed: strong
+# frozen_string_literal: true
 
 module Tapioca
   module Compilers

data/lib/tapioca/core_ext/class.rb

@@ -1,7 +1,9 @@
-# typed: false
+# typed: strict
 # frozen_string_literal: true
 
 class Class
+  extend T::Sig
+
   # Returns an array with all classes that are < than its receiver.
   #
   #   class C; end
@@ -15,9 +17,12 @@ class Class
   #
   #   class D < C; end
   #   C.descendants # => [B, A, D]
+  sig { returns(T::Array[Class]) }
   def descendants
-    ObjectSpace.each_object(singleton_class).reject do |k|
-      k.singleton_class? || k == self
+    result = ObjectSpace.each_object(singleton_class).reject do |k|
+      T.cast(k, Module).singleton_class? || k == self
     end
+
+    T.cast(result, T::Array[Class])
   end
 end

data/lib/tapioca/gemfile.rb

@@ -1,5 +1,5 @@
-# frozen_string_literal: true
 # typed: strict
+# frozen_string_literal: true
 
 require "bundler"
 

data/lib/tapioca/generator.rb

@@ -1,5 +1,5 @@
-# frozen_string_literal: true
 # typed: strict
+# frozen_string_literal: true
 
 require 'pathname'
 require 'thor'

data/lib/tapioca/loader.rb

@@ -1,5 +1,5 @@
-# frozen_string_literal: true
 # typed: strict
+# frozen_string_literal: true
 
 module Tapioca
   class Loader

data/lib/tapioca/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tapioca
 version: !ruby/object:Gem::Version
-  version: 0.4.5
+  version: 0.4.10
 platform: ruby
 authors:
 - Ufuk Kayserilioglu
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-09-10 00:00:00.000000000 Z
+date: 2020-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry