tapioca 0.2.7 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a3d27cc18a2cc1afcfd1f9c9cb1e833078ea06b1c4a4900e76614b2b54478b7
-  data.tar.gz: 9b8e0b109fbdc3a7d6393a67df9f53031c8e29aa1479eb0a1fb644783998bc36
+  metadata.gz: 91a976cddc1429c3b08568b39d8fae5fe8d4d54a8b8b2b04deebb75f475987e8
+  data.tar.gz: 45074066696bd5c838ab09523980fd9c148faeb1b9f6ee800e8752e636edbd1a
 SHA512:
-  metadata.gz: 5601255b31b7cec6eb03ec8553f03450148de320ef48ab3370f278797d7189c020d1a7a2c04b6ab5b2e509321df4df0fbb022dd9e0ae9477aceaca4a195b620a
-  data.tar.gz: 1b3fcf4e9c997f60199e60e9206d2113e3d1292334d38db0d670ba0e3d5f4f0e8f348c88e74b8c1f8df0524bc9f40c59c1f214273b76259db5d88246610ccc55
+  metadata.gz: 1646cf3ec4957442bf0895a636bfc684e00f0d88e2252502d119fd3f4b4073e41b773ce0cbe8f725766d0c82bae7f67b92381a32a123b6fa2067ddd6a9e2c8d2
+  data.tar.gz: 33f8dae8437b44c2bb2e7d4a1bb483adc11c0ae58322b62fa97a879698ba3d9abab4f198d38b7a8433e57f32f64df5b39ce1b5d8a13ebe37b011dae2d179d926

data/Gemfile

@@ -4,6 +4,32 @@ source("https://rubygems.org")
 
 gemspec
 
+gem 'rubocop-shopify', require: false
+
 group(:deployment, :development) do
-  gem("rake", "~> 12.3")
+  gem("rake")
+end
+
+gem("bundler", "~> 1.17")
+gem("pry-byebug")
+gem("minitest")
+gem("minitest-hooks")
+gem("minitest-fork_executor")
+gem("minitest-reporters")
+gem("sorbet")
+
+group(:development, :test) do
+  gem("smart_properties", ">= 1.15.0", require: false)
+  gem("frozen_record", ">= 0.17", require: false)
+  gem("sprockets", "~> 3.7", require: false)
+  gem("rails", "~> 5.2", require: false)
+  gem("state_machines", "~> 0.5.0", require: false)
+  gem("activerecord-typedstore", "~> 1.3", require: false)
+  gem("sqlite3")
+  gem("identity_cache", "~> 1.0", require: false)
+  gem('cityhash', git: 'https://github.com/csfrancis/cityhash.git',
+                  ref: '3cfc7d01f333c01811d5e834f1495eaa29f87c36', require: false)
+  gem("activemodel-serializers-xml", "~> 1.0", require: false)
+  gem("activeresource", "~> 5.1", require: false)
+  gem("google-protobuf", "~>3.12.0", require: false)
 end

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,10 +27,17 @@ 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.
 
+You can use the command `tapioca require` to auto-populate the `sorbet/tapioca/require.rb` file with all the requires found
+in your application. Once the file generated, you should review it, remove all unnecessary requires and commit it.
+
+## How does tapioca compare to "srb rbi gems" ?
+
+[Please see the detailed answer on our wiki](https://github.com/Shopify/tapioca/wiki/How-does-tapioca-compare-to-%22srb-rbi-gems%22-%3F)
+
 ## Installation
 
 Add this line to your application's `Gemfile`:
@@ -49,7 +56,9 @@ Commands:
   tapioca generate [gem...]  # generate RBIs from gems
   tapioca help [COMMAND]     # Describe available commands or one specific command
   tapioca init               # initializes folder structure
+  tapioca require            # generate the list of files to be required by tapioca
   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 +89,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.
@@ -88,6 +103,10 @@ This will sync the RBIs with the gems in the Gemfile and will add, update, and r
 - `--generate-command [command]`: The command to run to regenerate RBI files (used in header comment of the RBI files), defaults to the current command.
 - `--typed-overrides [gem:level]`: Overrides typed sigils for generated gem RBIs for gem `gem` to level `level` (`level` can be one of `ignore`, `false`, `true`, `strict`, or `strong`, see [the Sorbet docs](https://sorbet.org/docs/static#file-level-granularity-strictness-levels) for more details).
 
+### Strong typing option for ActiveRecord column methods
+
+`tapioca` gives you the option to generate stricter type signatures for your ActiveRecord column types. By default, methods generated for columns that are defined in the schema have signatures of T.untyped. However, if the object extends a module with name StrongTypeGeneration, tapioca will generate stricter signatures that follow closely with the types defined in the schema. Expectation is the StrongTypeGeneration module you define in your application won't allow objects to be initialized with "bad state". It will check all the attributes that are not nillable to ensure they are not nil.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/Shopify/tapioca. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](https://github.com/Shopify/tapioca/blob/master/CODE_OF_CONDUCT.md) code of conduct.

data/Rakefile

@@ -3,10 +3,21 @@
 require "bundler/gem_tasks"
 require "rake/testtask"
 
-begin
-  require 'rspec/core/rake_task'
-  RSpec::Core::RakeTask.new(:spec)
-rescue LoadError # rubocop:disable Lint/SuppressedException
+Rake.application.options.trace = false
+
+Rake::TestTask.new do |t|
+  t.libs << "lib"
+  t.libs << "spec"
+  t.warning = false
+  t.test_files = FileList['spec/**/*_spec.rb']
+end
+
+task(:spec) do
+  begin
+    Rake::Task[:test].execute
+  rescue RuntimeError
+    exit(1)
+  end
 end
 
 task(default: :spec)

data/lib/tapioca.rb

@@ -28,12 +28,18 @@ 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/sorbet"
+require "tapioca/compilers/requires_compiler"
+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/compilers/dsl_compiler"
+require "tapioca/version"

data/lib/tapioca/cli.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-# typed: false
+# typed: true
 
 require 'thor'
 
@@ -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
@@ -50,6 +52,32 @@ module Tapioca
       end
     end
 
+    desc "require", "generate the list of files to be required by tapioca"
+    def require
+      Tapioca.silence_warnings do
+        generator.build_requires
+      end
+    end
+
+    desc "todo", "generate the list of unresolved constants"
+    def todo
+      Tapioca.silence_warnings do
+        generator.build_todos
+      end
+    end
+
+    desc "dsl [constant...]", "generate RBIs for dynamic methods"
+    option :generators,
+      type: :array,
+      aliases: ["--gen", "-g"],
+      banner: "generator [generator ...]",
+      desc: "Only run supplied DSL generators"
+    def dsl(*constants)
+      Tapioca.silence_warnings do
+        generator.build_dsl(constants)
+      end
+    end
+
     desc "generate [gem...]", "generate RBIs from gems"
     def generate(*gems)
       Tapioca.silence_warnings do
@@ -65,13 +93,14 @@ module Tapioca
     end
 
     no_commands do
+      def self.exit_on_failure?
+        true
+      end
+
       def generator
+        current_command = T.must(current_command_chain.first)
         @generator ||= Generator.new(
-          outdir: options[:outdir],
-          prerequire: options[:prerequire],
-          postrequire: options[:postrequire],
-          command: options[:generate_command],
-          typed_overrides: options[:typed_overrides]
+          ConfigBuilder.from_options(current_command, options)
         )
       end
     end

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

@@ -0,0 +1,129 @@
+# typed: strict
+# frozen_string_literal: true
+
+require "parlour"
+
+begin
+  require "action_controller"
+rescue LoadError
+  return
+end
+
+module Tapioca
+  module Compilers
+    module Dsl
+      # `Tapioca::Compilers::Dsl::ActionControllerHelpers` decorates RBI files for all
+      # subclasses of `::ActionController::Base`
+      # to add helper methods (see https://api.rubyonrails.org/classes/ActionController/Helpers.html).
+      #
+      # For example, with the following `MyHelper` module:
+      #
+      # ~~~rb
+      # module MyHelper
+      #   def greet(user)
+      #     # ...
+      #   end
+      #
+      #  def localized_time
+      #     # ...
+      #   end
+      # end
+      # ~~~
+      #
+      # and the following controller:
+      #
+      # ~~~rb
+      # class UserController < ActionController::Base
+      #   helper MyHelper
+      #   helper { def age(user) "99" end }
+      #   helper_method :current_user_name
+      #
+      #   def current_user_name
+      #     # ...
+      #   end
+      # end
+      #
+      # this generator will produce an RBI file `user_controller.rbi` with the following content:
+      #
+      # ~~~rbi
+      # # user_controller.rbi
+      # # typed: strong
+      # class UserController
+      #   sig { returns(UserController::HelperProxy) }
+      #   def helpers; end
+      # end
+      #
+      # module UserController::HelperMethods
+      #    include MyHelper
+      #
+      #    sig { params(user: T.untyped).returns(T.untyped) }
+      #    def age(user); end
+      #
+      #    sig { returns(T.untyped) }
+      #    def current_user_name; end
+      #  end
+      #
+      # class UserController::HelperProxy < ::ActionView::Base
+      #   include UserController::HelperMethods
+      # end
+      # ~~~
+      class ActionControllerHelpers < Base
+        extend T::Sig
+
+        sig do
+          override
+            .params(root: Parlour::RbiGenerator::Namespace, constant: T.class_of(::ActionController::Base))
+            .void
+        end
+        def decorate(root, constant)
+          helper_proxy_name = "#{constant}::HelperProxy"
+          helper_methods_name = "#{constant}::HelperMethods"
+          proxied_helper_methods = constant._helper_methods.map(&:to_s).map(&:to_sym)
+
+          # Create helper method module
+          root.create_module(helper_methods_name) do |helper_methods|
+            helpers_module = constant._helpers
+
+            gather_includes(helpers_module).each do |ancestor|
+              helper_methods.create_include(ancestor)
+            end
+
+            helpers_module.instance_methods(false).each do |method_name|
+              method = if proxied_helper_methods.include?(method_name)
+                constant.instance_method(method_name)
+              else
+                helpers_module.instance_method(method_name)
+              end
+              create_method_from_def(helper_methods, method)
+            end
+          end
+
+          # Create helper proxy class
+          root.create_class(helper_proxy_name, superclass: "::ActionView::Base") do |proxy|
+            proxy.create_include(helper_methods_name)
+          end
+
+          # Define the helpers method
+          root.path(constant) do |controller|
+            create_method(controller, 'helpers', return_type: helper_proxy_name)
+          end
+        end
+
+        sig { override.returns(T::Enumerable[Module]) }
+        def gather_constants
+          ::ActionController::Base.descendants.reject(&:abstract?)
+        end
+
+        private
+
+        sig { params(mod: Module).returns(T::Array[String]) }
+        def gather_includes(mod)
+          mod.ancestors
+            .reject { |ancestor| ancestor.is_a?(Class) || ancestor == mod || ancestor.name.nil? }
+            .map { |ancestor| T.must(ancestor.name) }
+            .reverse
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,65 @@
+# typed: strict
+# frozen_string_literal: true
+
+require "parlour"
+
+begin
+  require "action_mailer"
+rescue LoadError
+  return
+end
+
+module Tapioca
+  module Compilers
+    module Dsl
+      # `Tapioca::Compilers::Dsl::ActionMailer` generates RBI files for subclasses of `ActionMailer::Base`
+      # (see https://api.rubyonrails.org/classes/ActionMailer/Base.html).
+      #
+      # For example, with the following `ActionMailer` subclass:
+      #
+      # ~~~rb
+      # class NotifierMailer < ActionMailer::Base
+      #   def notify_customer(customer_id)
+      #     # ...
+      #   end
+      # end
+      # ~~~
+      #
+      # this generator will produce the RBI file `notifier_mailer.rbi` with the following content:
+      #
+      # ~~~rbi
+      # # notifier_mailer.rbi
+      # # typed: true
+      # class NotifierMailer
+      #   sig { params(customer_id: T.untyped).returns(::ActionMailer::MessageDelivery) }
+      #   def self.notify_customer(customer_id); end
+      # end
+      # ~~~
+      class ActionMailer < Base
+        extend T::Sig
+
+        sig { override.params(root: Parlour::RbiGenerator::Namespace, constant: T.class_of(::ActionMailer::Base)).void }
+        def decorate(root, constant)
+          root.path(constant) do |k|
+            constant.action_methods.to_a.each do |mailer_method|
+              method_def = constant.instance_method(mailer_method)
+              parameters = compile_method_parameters_to_parlour(method_def)
+              create_method(
+                k,
+                mailer_method,
+                parameters: parameters,
+                return_type: '::ActionMailer::MessageDelivery',
+                class_method: true
+              )
+            end
+          end
+        end
+
+        sig { override.returns(T::Enumerable[Module]) }
+        def gather_constants
+          ::ActionMailer::Base.descendants.reject(&:abstract?)
+        end
+      end
+    end
+  end
+end