tapioca 0.4.17 → 0.4.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9293078ee1614e88f45586904e3d90cc556cab3218340699325902e224d94aed
-  data.tar.gz: d14050953a3de23bfc4830b6b27282331dcac745090695cd2552a5e7a1ee6296
+  metadata.gz: 8e3ea6e1fb437f52cfb699c43b4c3d46115592ac09a69aec5a8d0701906f42cd
+  data.tar.gz: 9fba45117a3f1f72ab8d3278838fb7d4a860eaa7cadc03535d99be618e8994c9
 SHA512:
-  metadata.gz: bd3bbcbc3a7d5448e7ace8472258e96c654d8854f1c4ec3ffe498a5b06e136f46df526f5a83d4b7814bf1ed57eec24cb3694c8fce686dd2df02a6d6af6de8414
-  data.tar.gz: 641e472a327784295d117481c9676b7fc92c320a764d06449ed9c5d65e1f5cc76cb63b0446e4269d85fd606df8ec19e519ce42cfe503403a1cf2197c042ad494
+  metadata.gz: 6519978a03ff03499f223d810a9f0d2bfd74e406017efb300a72fff0d95e1e08b64d2165ae1b54bad48f8767c5f831fe5f4398185282a5643224499355d7badc
+  data.tar.gz: 28ace672d799beb84aa802fe0773e574d3a827c53e15564d643dbe04e6330d6abb11d640a06b064641781258600ce73f3b5695915caaf9ce0813679dede867b2

data/Gemfile

@@ -4,18 +4,18 @@ source("https://rubygems.org")
 
 gemspec
 
-gem 'rubocop-shopify', require: false
-
-group(:deployment, :development) do
-  gem("rake")
-end
-
-gem("yard", "~> 0.9.25")
-gem("pry-byebug")
 gem("minitest")
 gem("minitest-hooks")
 gem("minitest-reporters")
+gem("pry-byebug")
+gem("rubocop-shopify", require: false)
+gem("rubocop-sorbet", ">= 0.4.1")
 gem("sorbet")
+gem("yard", "~> 0.9.25")
+
+group(:deployment, :development) do
+  gem("rake")
+end
 
 group(:development, :test) do
   gem("smart_properties", ">= 1.15.0", require: false)
@@ -26,14 +26,13 @@ group(:development, :test) do
   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("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)
+  gem("google-protobuf", "~> 3.12.0", require: false)
   # Fix version to 0.14.1 since it is the last version to support Ruby 2.4
   gem("shopify-money", "= 0.14.1", require: false)
-  gem("sidekiq", "~>5.0", require: false) # Version 6 dropped support for Ruby 2.4
+  gem("sidekiq", "~> 5.0", require: false) # Version 6 dropped support for Ruby 2.4
+  gem("nokogiri", "1.10.10", require: false) # Lock to last supported for Ruby 2.4
 end
-
-gem "rubocop-sorbet", ">= 0.4.1"

data/README.md

@@ -1,3 +1,5 @@
+> :warning: **Note**: This software is currently under active development. The API and interface should be considered unstable until a v1.0.0 release.
+
 # Tapioca
 
 ![Build Status](https://github.com/Shopify/tapioca/workflows/CI/badge.svg)
@@ -14,7 +16,7 @@ For gems that have a normal default `require` and load all of their constants th
 
 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:
 
-```ruby
+```shell
 $ bundle exec pry
 [1] pry(main)> require 'better_html'
 => true
@@ -110,7 +112,7 @@ This will generate DSL RBIs for specified constants (or for all handled constant
 - `--prerequire [file]`: A file to be required before `Bundler.require` is called.
 - `--postrequire [file]`: A file to be required after `Bundler.require` is called.
 - `--out [directory]`: The output directory for generated RBI files, default to `sorbet/rbi/gems`.
-- `--generate-command [command]`: The command to run to regenerate RBI files (used in header comment of the RBI files), defaults to the current command.
+- `--generate-command [command]`: **[DEPRECATED]** 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).
 
 ## Contributing

data/exe/tapioca

@@ -1,6 +1,21 @@
 #! /usr/bin/env ruby
 # frozen_string_literal: true
 
-require_relative "../lib/tapioca"
+require 'sorbet-runtime'
 
-Tapioca::Cli.start(ARGV)
+begin
+  T::Configuration.default_checked_level = :never
+  # Suppresses errors caused by T.cast, T.let, T.must, etc.
+  T::Configuration.inline_type_error_handler = ->(*) {}
+  # Suppresses errors caused by incorrect parameter ordering
+  T::Configuration.sig_validation_error_handler = ->(*) {}
+rescue
+  # Need this rescue so that if another gem has
+  # already set the checked level by the time we
+  # get to it, we don't fail outright.
+  nil
+end
+
+require_relative "../lib/tapioca/internal"
+
+Tapioca::Cli::Main.start(ARGV)

data/lib/tapioca.rb

@@ -17,31 +17,5 @@ module Tapioca
   class Error < StandardError; end
 end
 
-begin
-  T::Configuration.default_checked_level = :never
-  # Suppresses errors caused by T.cast, T.let, T.must, etc.
-  T::Configuration.inline_type_error_handler = ->(*) {}
-  # Suppresses errors caused by incorrect parameter ordering
-  T::Configuration.sig_validation_error_handler = ->(*) {}
-rescue
-  # Need this rescue so that if another gem has
-  # already set the checked level by the time we
-  # get to it, we don't fail outright.
-  nil
-end
-
-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/compilers/dsl/base"
 require "tapioca/version"

data/lib/tapioca/cli.rb

@@ -4,112 +4,5 @@
 require 'thor'
 
 module Tapioca
-  class Cli < Thor
-    include(Thor::Actions)
-
-    class_option :prerequire,
-                  aliases: ["--pre", "-b"],
-                  banner: "file",
-                  desc: "A file to be required before Bundler.require is called"
-    class_option :postrequire,
-                  aliases: ["--post", "-a"],
-                  banner: "file",
-                  desc: "A file to be required after Bundler.require is called"
-    class_option :outdir,
-                  aliases: ["--out", "-o"],
-                  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,
-                  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
-        <<~CONTENT
-          --dir
-          .
-        CONTENT
-      end
-      create_file(Config::DEFAULT_POSTREQUIRE, skip: true) do
-        <<~CONTENT
-          # typed: false
-          # frozen_string_literal: true
-
-          # Add your extra requires here
-        CONTENT
-      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
-        generator.build_gem_rbis(gems)
-      end
-    end
-
-    desc "sync", "sync RBIs to Gemfile"
-    def sync
-      Tapioca.silence_warnings do
-        generator.sync_rbis_with_gemfile
-      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
-      end
-
-      def generator
-        current_command = T.must(current_command_chain.first)
-        @generator ||= Generator.new(
-          ConfigBuilder.from_options(current_command, options)
-        )
-      end
-    end
-  end
+  module Cli; end
 end

data/lib/tapioca/cli/main.rb

@@ -0,0 +1,146 @@
+# typed: true
+# frozen_string_literal: true
+
+module Tapioca
+  module Cli
+    class Main < Thor
+      include(Thor::Actions)
+
+      class_option :prerequire,
+                    aliases: ["--pre", "-b"],
+                    banner: "file",
+                    desc: "A file to be required before Bundler.require is called"
+      class_option :postrequire,
+                    aliases: ["--post", "-a"],
+                    banner: "file",
+                    desc: "A file to be required after Bundler.require is called"
+      class_option :outdir,
+                    aliases: ["--out", "-o"],
+                    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,
+                    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_config
+        create_post_require
+        generate_binstub
+      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"
+      option :verify,
+        type: :boolean,
+        default: false,
+        desc: "Verifies RBIs are up-to-date"
+      option :quiet,
+        aliases: ["-q"],
+        type: :boolean,
+        desc: "Supresses file creation output"
+      def dsl(*constants)
+        Tapioca.silence_warnings do
+          generator.build_dsl(constants, should_verify: options[:verify], quiet: options[:quiet])
+        end
+      end
+
+      desc "generate [gem...]", "generate RBIs from gems"
+      def generate(*gems)
+        Tapioca.silence_warnings do
+          generator.build_gem_rbis(gems)
+        end
+      end
+
+      desc "sync", "sync RBIs to Gemfile"
+      def sync
+        Tapioca.silence_warnings do
+          generator.sync_rbis_with_gemfile
+        end
+      end
+
+      desc "--version, -v", "show version"
+      def __print_version
+        puts "Tapioca v#{Tapioca::VERSION}"
+      end
+
+      private
+
+      def create_config
+        create_file(Config::SORBET_CONFIG, skip: true) do
+          <<~CONTENT
+            --dir
+            .
+          CONTENT
+        end
+      end
+
+      def create_post_require
+        create_file(Config::DEFAULT_POSTREQUIRE, skip: true) do
+          <<~CONTENT
+            # typed: false
+            # frozen_string_literal: true
+
+            # Add your extra requires here
+          CONTENT
+        end
+      end
+
+      def generate_binstub
+        bin_stub_exists = File.exist?("bin/tapioca")
+        installer = Bundler::Installer.new(Bundler.root, Bundler.definition)
+        spec = Bundler.definition.specs.find { |s| s.name == "tapioca" }
+        installer.generate_bundler_executable_stubs(spec, { force: true })
+        if bin_stub_exists
+          shell.say_status(:force, "bin/tapioca", :yellow)
+        else
+          shell.say_status(:create, "bin/tapioca", :green)
+        end
+      end
+
+      no_commands do
+        def self.exit_on_failure?
+          true
+        end
+
+        def generator
+          current_command = T.must(current_command_chain.first)
+          @generator ||= Generator.new(
+            ConfigBuilder.from_options(current_command, options)
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,71 @@
+# typed: strict
+# frozen_string_literal: true
+
+require "parlour"
+
+begin
+  require "active_job"
+rescue LoadError
+  return
+end
+
+module Tapioca
+  module Compilers
+    module Dsl
+      # `Tapioca::Compilers::Dsl::ActiveJob` generates RBI files for subclasses of
+      # [`ActiveJob::Base`](https://api.rubyonrails.org/classes/ActiveJob/Base.html).
+      #
+      # For example, with the following `ActiveJob` subclass:
+      #
+      # ~~~rb
+      # class NotifyUserJob < ActiveJob::Base
+      #   def perform(user)
+      #     # ...
+      #   end
+      # end
+      # ~~~
+      #
+      # this generator will produce the RBI file `notify_user_job.rbi` with the following content:
+      #
+      # ~~~rbi
+      # # notify_user_job.rbi
+      # # typed: true
+      # class NotifyUserJob
+      #   sig { params(user: T.untyped).returns(NotifyUserJob) }
+      #   def self.perform_later(user); end
+      #
+      #   sig { params(user: T.untyped).returns(NotifyUserJob) }
+      #   def self.perform_now(user); end
+      # end
+      # ~~~
+      class ActiveJob < Base
+        extend T::Sig
+
+        sig { override.params(root: Parlour::RbiGenerator::Namespace, constant: T.class_of(::ActiveJob::Base)).void }
+        def decorate(root, constant)
+          root.path(constant) do |job|
+            next unless constant.instance_methods(false).include?(:perform)
+
+            method = constant.instance_method(:perform)
+            parameters = compile_method_parameters_to_parlour(method)
+
+            %w[perform_later perform_now].each do |name|
+              create_method(
+                job,
+                name,
+                parameters: parameters,
+                return_type: constant.name,
+                class_method: true
+              )
+            end
+          end
+        end
+
+        sig { override.returns(T::Enumerable[Module]) }
+        def gather_constants
+          ::ActiveJob::Base.descendants
+        end
+      end
+    end
+  end
+end