tapioca 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4eea2d365ede4ba5398d65a2042c7dc86270ec7309cb0bc9747357f44ea1c675
-  data.tar.gz: 7f7252a0619b138664fe5d30acf0858fb09eb9403d513a06266cc58c464dd3b2
+  metadata.gz: ef378ec3f3035d85d6aebfa4624896d216bcccd7d9332cbdc9d64be469b79b48
+  data.tar.gz: 2f34d64fadd075ed1653ec26d27c73a02bfff949440fc6d1fd8bf80116161b48
 SHA512:
-  metadata.gz: 1ac4530bd50af56e2acee0a630571dbc7452cf10e55ec89088ddb5ed8f9a350fae0b4031602fa13b5b319390172e55bdebe6a3d3b6a722e88fe7902aceb5bb61
-  data.tar.gz: 26a6365606966861c36ffcea2b247a7dfc5395925d04a9d89f35273ce6ae9c3f29ee3d94002c3dd49c46f05acda9e202025a79cf9e4dd0fbebe49ff542d575ae
+  metadata.gz: 78b6ce07ee08391457763a8e9069b0ff0efaa1be26cdeec7f334d2b45afa6ec12fd152d24c42d4c2b6834db25af77f74d6401bf577fd749ed446ef122dc01161
+  data.tar.gz: 0b1998a9a72153d24747838606ff636cf8718efc67aa98e0c9d3ff01849d677840cd73f0adb8f289cc8c6f7e07b20bd37594bbcd1aea1b91761132fd07a1a9db

data/Gemfile

@@ -10,6 +10,7 @@ gem("minitest-reporters")
 gem("pry-byebug")
 gem("rubocop-shopify", require: false)
 gem("rubocop-sorbet", ">= 0.4.1")
+gem("rubocop-rspec", require: false)
 gem("sorbet")
 
 group(:deployment, :development) do
@@ -25,8 +26,12 @@ group(:development, :test) do
   gem("activerecord-typedstore", require: false)
   gem("sqlite3")
   gem("identity_cache", 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("activeresource", require: false)
   gem("google-protobuf", require: false)
   gem("shopify-money", require: false)
@@ -36,4 +41,10 @@ group(:development, :test) do
   gem("aasm", require: false)
   gem("bcrypt", require: false)
   gem("xpath", require: false)
+  gem("rubocop-lsp", require: false)
+
+  # net-smtp was removed from default gems in Ruby 3.1, but is used by the `mail` gem.
+  # So we need to add it as a dependency until `mail` is fixed:
+  # https://github.com/rails/rails/blob/0919aa97260ab8240150278d3b07a1547489e3fd/Gemfile#L178-L191
+  gem("net-smtp", "0.3.1", require: false)
 end

data/README.md

@@ -80,8 +80,8 @@ Command: `tapioca init`
 
 This will create the `sorbet/config` and `sorbet/tapioca/require.rb` files for you, if they don't exist. If any of the files already exist, they will not be changed.
 
+<!-- START_HELP_COMMAND_INIT -->
 ```shell
-$ bundle exec tapioca help init
 Usage:
   tapioca init
 
@@ -92,6 +92,7 @@ Options:
 
 initializes folder structure
 ```
+<!-- END_HELP_COMMAND_INIT -->
 
 ### Generate RBI files for gems
 
@@ -99,13 +100,13 @@ Command: `tapioca gem [gems...]`
 
 This will generate RBIs for the specified gems and place them in the RBI directory.
 
+<!-- START_HELP_COMMAND_GEM -->
 ```shell
-$ bundle exec tapioca help gem
 Usage:
   tapioca gem [gem...]
 
 Options:
-  --out, -o, [--outdir=directory]                             # The output directory for generated RBI files
+  --out, -o, [--outdir=directory]                             # The output directory for generated gem RBI files
                                                               # Default: sorbet/rbi/gems
           [--file-header], [--no-file-header]                 # Add a "This file is generated" header on top of each generated RBI file
                                                               # Default: true
@@ -113,21 +114,28 @@ 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
                                                               # Default: sorbet/tapioca/require.rb
-  -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
+  -x, [--exclude=gem [gem ...]]                               # Exclude the given gem(s) from RBI generation
+  --typed, -t, [--typed-overrides=gem:level [gem:level ...]]  # Override for typed sigils for generated gem RBIs
                                                               # Default: {"activesupport"=>"false"}
-          [--verify], [--no-verify]                           # Verifies RBIs are up-to-date
+          [--verify], [--no-verify]                           # Verify RBIs are up-to-date
           [--doc], [--no-doc]                                 # Include YARD documentation from sources when generating RBIs. Warning: this might be slow
           [--exported-gem-rbis], [--no-exported-gem-rbis]     # Include RBIs found in the `rbi/` directory of the gem
                                                               # Default: true
   -w, [--workers=N]                                           # EXPERIMENTAL: Number of parallel workers to use when generating RBIs
                                                               # Default: 1
+          [--auto-strictness], [--no-auto-strictness]         # Autocorrect strictness in gem RBIs in case of conflict with the DSL RBIs
+                                                              # Default: true
+  --dsl-dir, [--dsl-dir=directory]                            # The DSL directory used to correct gems strictnesses
+                                                              # Default: sorbet/rbi/dsl
+          [--rbi-max-line-length=N]                           # Set the max line length of generated RBIs. Signatures longer than the max line length will be wrapped
+                                                              # Default: 120
   -c, [--config=<config file path>]                           # Path to the Tapioca configuration file
                                                               # Default: sorbet/tapioca/config.yml
   -V, [--verbose], [--no-verbose]                             # Verbose output for debugging purposes
 
 generate RBIs from gems
 ```
+<!-- END_HELP_COMMAND_GEM -->
 
 ### Generate the list of all unresolved constants
 
@@ -135,13 +143,13 @@ Command: `tapioca todo`
 
 This will generate the file `sorbet/rbi/todo.rbi` defining all unresolved constants as empty modules.
 
+<!-- START_HELP_COMMAND_TODO -->
 ```shell
-$ bundle exec tapioca help todo
 Usage:
   tapioca todo
 
 Options:
-      [--todo-file=TODO_FILE]
+      [--todo-file=TODO_FILE]              # Path to the generated todo RBI file
                                            # Default: sorbet/rbi/todo.rbi
       [--file-header], [--no-file-header]  # Add a "This file is generated" header on top of each generated RBI file
                                            # Default: true
@@ -151,35 +159,40 @@ Options:
 
 generate the list of unresolved constants
 ```
+<!-- END_HELP_COMMAND_TODO -->
 
 ### Generate DSL RBI files
 
 Command: `tapioca dsl [constant...]`
 
-This will generate DSL RBIs for specified constants (or for all handled constants, if a constant name is not supplied). You can read about DSL RBI generators supplied by `tapioca` in [the manual](manual/generators.md).
+This will generate DSL RBIs for specified constants (or for all handled constants, if a constant name is not supplied). You can read about DSL RBI compilers supplied by `tapioca` in [the manual](manual/compilers.md).
 
+<!-- START_HELP_COMMAND_DSL -->
 ```shell
-$ bundle exec tapioca help dsl
 Usage:
   tapioca dsl [constant...]
 
 Options:
-  --out, -o, [--outdir=directory]                # The output directory for generated RBI files
-                                                 # Default: sorbet/rbi/dsl
-          [--file-header], [--no-file-header]    # Add a "This file is generated" header on top of each generated RBI file
-                                                 # Default: true
-          [--only=generator [generator ...]]     # Only run supplied DSL generators
-          [--exclude=generator [generator ...]]  # Exclude supplied DSL generators
-          [--verify], [--no-verify]              # Verifies RBIs are up-to-date
-  -q, [--quiet], [--no-quiet]                    # Supresses file creation output
-  -w, [--workers=N]                              # EXPERIMENTAL: Number of parallel workers to use when generating RBIs
-                                                 # Default: 1
-  -c, [--config=<config file path>]              # Path to the Tapioca configuration file
-                                                 # Default: sorbet/tapioca/config.yml
-  -V, [--verbose], [--no-verbose]                # Verbose output for debugging purposes
+  --out, -o, [--outdir=directory]              # The output directory for generated DSL RBI files
+                                               # Default: sorbet/rbi/dsl
+          [--file-header], [--no-file-header]  # Add a "This file is generated" header on top of each generated RBI file
+                                               # Default: true
+          [--only=compiler [compiler ...]]     # Only run supplied DSL compiler(s)
+          [--exclude=compiler [compiler ...]]  # Exclude supplied DSL compiler(s)
+          [--verify], [--no-verify]            # Verifies RBIs are up-to-date
+  -q, [--quiet], [--no-quiet]                  # Supresses file creation output
+  -w, [--workers=N]                            # EXPERIMENTAL: Number of parallel workers to use when generating RBIs
+                                               # Default: 1
+          [--rbi-max-line-length=N]            # Set the max line length of generated RBIs. Signatures longer than the max line length will be wrapped
+                                               # Default: 120
+  -c, [--config=<config file path>]            # Path to the Tapioca configuration file
+                                               # Default: sorbet/tapioca/config.yml
+  -V, [--verbose], [--no-verbose]              # Verbose output for debugging purposes
 
 generate RBIs for dynamic methods
 ```
+<!-- END_HELP_COMMAND_DSL -->
+
 ## Configuration
 
 Tapioca supports loading command defaults from a configuration file. The default configuration
@@ -192,20 +205,61 @@ For example, if you always want to generate gem RBIs with inline documentation,
 
 ```yaml
 gem:
-  docs: true
+  doc: true
 ```
 
 Additionally, if you always want to exclude the `AASM` and `ActiveRecordFixtures` DSL compilers in your DSL RBI generation runs, your config file would then look like this:
 
 ```yaml
 gem:
-  docs: true
+  doc: true
 dsl:
   exclude:
   - UrlHelpers
   - ActiveRecordFixtures
 ```
 
+The full configuration file, with each option and its default value, would look something like this:
+<!-- START_CONFIG_TEMPLATE -->
+```yaml
+---
+require:
+  postrequire: sorbet/tapioca/require.rb
+todo:
+  todo_file: sorbet/rbi/todo.rbi
+  file_header: true
+dsl:
+  outdir: sorbet/rbi/dsl
+  file_header: true
+  only: []
+  exclude: []
+  verify: false
+  quiet: false
+  workers: 1
+  rbi_max_line_length: 120
+gem:
+  outdir: sorbet/rbi/gems
+  file_header: true
+  all: false
+  prerequire: ''
+  postrequire: sorbet/tapioca/require.rb
+  exclude: []
+  typed_overrides:
+    activesupport: 'false'
+  verify: false
+  doc: false
+  exported_gem_rbis: true
+  workers: 1
+  auto_strictness: true
+  dsl_dir: sorbet/rbi/dsl
+  rbi_max_line_length: 120
+check_shims:
+  gem_rbi_dir: sorbet/rbi/gems
+  dsl_rbi_dir: sorbet/rbi/dsl
+  shim_rbi_dir: sorbet/rbi/shims
+```
+<!-- END_CONFIG_TEMPLATE -->
+
 ## 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/main/CODE_OF_CONDUCT.md) code of conduct.

data/Rakefile

@@ -1,22 +1,18 @@
 # frozen_string_literal: true
 
 require "bundler/gem_tasks"
-require "rake/testtask"
 Dir["tasks/**/*.rake"].each { |t| load t }
 
-Rake.application.options.trace = false
+require "rubocop/rake_task"
+RuboCop::RakeTask.new
 
-Rake::TestTask.new do |t|
-  t.libs << "lib"
-  t.libs << "spec"
-  t.warning = false
-  t.test_files = FileList["spec/**/*_spec.rb"]
+desc "Run tests"
+task :test do
+  require "shellwords"
+  test = Array(ENV.fetch("TEST", []))
+  test_opts = Shellwords.split(ENV.fetch("TESTOPTS", ""))
+  success = system("bin/test", *test, *test_opts)
+  success || exit(false)
 end
 
-task(:spec) do
-  Rake::Task[:test].execute
-rescue RuntimeError
-  exit(1)
-end
-
-task(default: :spec)
+task(default: :test)

data/lib/tapioca/cli.rb

@@ -5,6 +5,7 @@ module Tapioca
   class Cli < Thor
     include CliHelper
     include ConfigHelper
+    include ShimsHelper
 
     FILE_HEADER_OPTION_DESC = "Add a \"This file is generated\" header on top of each generated RBI file"
 
@@ -22,44 +23,42 @@ module Tapioca
 
     desc "init", "initializes folder structure"
     def init
-      generator = Generators::Init.new(
+      command = Commands::Init.new(
         sorbet_config: SORBET_CONFIG_FILE,
         tapioca_config: TAPIOCA_CONFIG_FILE,
-        default_postrequire: DEFAULT_POSTREQUIRE_FILE,
-        default_command: DEFAULT_COMMAND
+        default_postrequire: DEFAULT_POSTREQUIRE_FILE
       )
-      generator.generate
+      command.execute
     end
 
     desc "require", "generate the list of files to be required by tapioca"
     option :postrequire, type: :string, default: DEFAULT_POSTREQUIRE_FILE
     def require
-      generator = Generators::Require.new(
+      command = Commands::Require.new(
         requires_path: options[:postrequire],
-        sorbet_config_path: SORBET_CONFIG_FILE,
-        default_command: DEFAULT_COMMAND
+        sorbet_config_path: SORBET_CONFIG_FILE
       )
       Tapioca.silence_warnings do
-        generator.generate
+        command.execute
       end
     end
 
     desc "todo", "generate the list of unresolved constants"
     option :todo_file,
       type: :string,
+      desc: "Path to the generated todo RBI file",
       default: DEFAULT_TODO_FILE
     option :file_header,
       type: :boolean,
       desc: FILE_HEADER_OPTION_DESC,
       default: true
     def todo
-      generator = Generators::Todo.new(
+      command = Commands::Todo.new(
         todo_file: options[:todo_file],
-        file_header: options[:file_header],
-        default_command: DEFAULT_COMMAND
+        file_header: options[:file_header]
       )
       Tapioca.silence_warnings do
-        generator.generate
+        command.execute
       end
     end
 
@@ -75,13 +74,13 @@ module Tapioca
       default: true
     option :only,
       type: :array,
-      banner: "generator [generator ...]",
-      desc: "Only run supplied DSL generator(s)",
+      banner: "compiler [compiler ...]",
+      desc: "Only run supplied DSL compiler(s)",
       default: []
     option :exclude,
       type: :array,
-      banner: "generator [generator ...]",
-      desc: "Exclude supplied DSL generator(s)",
+      banner: "compiler [compiler ...]",
+      desc: "Exclude supplied DSL compiler(s)",
       default: []
     option :verify,
       type: :boolean,
@@ -97,20 +96,24 @@ module Tapioca
       type: :numeric,
       desc: "EXPERIMENTAL: Number of parallel workers to use when generating RBIs",
       default: 1
+    option :rbi_max_line_length,
+      type: :numeric,
+      desc: "Set the max line length of generated RBIs. Signatures longer than the max line length will be wrapped",
+      default: 120
     def dsl(*constants)
-      generator = Generators::Dsl.new(
+      command = Commands::Dsl.new(
         requested_constants: constants,
         outpath: Pathname.new(options[:outdir]),
         only: options[:only],
         exclude: options[:exclude],
         file_header: options[:file_header],
-        compiler_path: Tapioca::Compilers::Dsl::DSL_COMPILERS_DIR,
+        compiler_path: Tapioca::Dsl::Compilers::DIRECTORY,
         tapioca_path: TAPIOCA_DIR,
-        default_command: DEFAULT_COMMAND,
         should_verify: options[:verify],
         quiet: options[:quiet],
         verbose: options[:verbose],
-        number_of_workers: options[:workers]
+        number_of_workers: options[:workers],
+        rbi_formatter: rbi_formatter(options)
       )
 
       if options[:workers] != 1
@@ -121,7 +124,7 @@ module Tapioca
       end
 
       Tapioca.silence_warnings do
-        generator.generate
+        command.execute
       end
     end
 
@@ -178,23 +181,38 @@ module Tapioca
       type: :numeric,
       desc: "EXPERIMENTAL: Number of parallel workers to use when generating RBIs",
       default: 1
+    option :auto_strictness,
+      type: :boolean,
+      desc: "Autocorrect strictness in gem RBIs in case of conflict with the DSL RBIs",
+      default: true
+    option :dsl_dir,
+      aliases: ["--dsl-dir"],
+      banner: "directory",
+      desc: "The DSL directory used to correct gems strictnesses",
+      default: DEFAULT_DSL_DIR
+    option :rbi_max_line_length,
+      type: :numeric,
+      desc: "Set the max line length of generated RBIs. Signatures longer than the max line length will be wrapped",
+      default: 120
     def gem(*gems)
       Tapioca.silence_warnings do
         all = options[:all]
         verify = options[:verify]
 
-        generator = Generators::Gem.new(
+        command = Commands::Gem.new(
           gem_names: all ? [] : gems,
           exclude: options[:exclude],
           prerequire: options[:prerequire],
           postrequire: options[:postrequire],
           typed_overrides: options[:typed_overrides],
-          default_command: DEFAULT_COMMAND,
           outpath: Pathname.new(options[:outdir]),
           file_header: options[:file_header],
           doc: options[:doc],
           include_exported_rbis: options[:exported_gem_rbis],
-          number_of_workers: options[:workers]
+          number_of_workers: options[:workers],
+          auto_strictness: options[:auto_strictness],
+          dsl_dir: options[:dsl_dir],
+          rbi_formatter: rbi_formatter(options)
         )
 
         raise MalformattedArgumentError, "Options '--all' and '--verify' are mutually exclusive" if all && verify
@@ -212,80 +230,48 @@ module Tapioca
         end
 
         if gems.empty? && !all
-          generator.sync(should_verify: verify)
+          command.sync(should_verify: verify)
         else
-          generator.generate
+          command.execute
         end
       end
     end
+    map "gems" => :gem
 
-    desc "clean-shims", "clean duplicated definitions in shim RBIs"
+    desc "check-shims", "check duplicated definitions in shim RBIs"
     option :gem_rbi_dir, type: :string, desc: "Path to gem RBIs", default: DEFAULT_GEM_DIR
     option :dsl_rbi_dir, type: :string, desc: "Path to DSL RBIs", default: DEFAULT_DSL_DIR
     option :shim_rbi_dir, type: :string, desc: "Path to shim RBIs", default: DEFAULT_SHIM_DIR
-    def clean_shims(*files_to_clean)
+    def check_shims
       index = RBI::Index.new
 
-      # Index gem RBIs
-      gem_rbi_dir = options[:gem_rbi_dir]
-      say("Loading gem RBIs from #{gem_rbi_dir}... ")
-      gem_rbis_files = Dir.glob("#{gem_rbi_dir}/**/*.rbi").sort
-      gem_rbis_trees = RBI::Parser.parse_files(gem_rbis_files)
-      index.visit_all(gem_rbis_trees)
-      say(" Done", :green)
-
-      # Index dsl RBIs
-      dsl_rbi_dir = options[:dsl_rbi_dir]
-      say("Loading dsl RBIs from #{dsl_rbi_dir}... ")
-      dsl_rbis_files = Dir.glob("#{dsl_rbi_dir}/**/*.rbi").sort
-      dsl_rbis_trees = RBI::Parser.parse_files(dsl_rbis_files)
-      index.visit_all(dsl_rbis_trees)
-      say(" Done", :green)
-
-      # Clean shim RBIs
-      if files_to_clean.empty?
-        shim_rbi_dir = options[:shim_rbi_dir]
-        print("Cleaning shim RBIs from #{shim_rbi_dir}...")
-        files_to_clean = Dir.glob("#{shim_rbi_dir}/*.rbi")
-      else
-        print("Cleaning shim RBIs...")
+      shim_rbi_dir = options[:shim_rbi_dir]
+      if !Dir.exist?(shim_rbi_dir) || Dir.empty?(shim_rbi_dir)
+        say("No shim RBIs to check", :green)
+        exit(0)
       end
 
-      done_something = T.let(false, T::Boolean)
-      files_to_clean.sort.each do |path|
-        original = RBI::Parser.parse_file(path)
-        cleaned, operations = RBI::Rewriters::RemoveKnownDefinitions.remove(original, index)
+      index_rbis(index, "shim", shim_rbi_dir)
+      index_rbis(index, "gem", options[:gem_rbi_dir])
+      index_rbis(index, "dsl", options[:dsl_rbi_dir])
 
-        next if operations.empty?
-        done_something = true
-
-        operations.each do |operation|
-          print("\n  #{operation}")
-        end
-
-        if cleaned.empty?
-          print("\n  Deleted empty file #{path}")
-          FileUtils.rm(path)
-        else
-          File.write(path, cleaned.string)
+      duplicates = duplicated_nodes_from_index(index, shim_rbi_dir)
+      unless duplicates.empty?
+        duplicates.each do |key, nodes|
+          say_error("\nDuplicated RBI for #{key}:", :red)
+          nodes.each do |node|
+            say_error(" * #{node.loc}", :red)
+          end
         end
+        say_error("\nPlease remove the duplicated definitions from the #{shim_rbi_dir} directory.", :red)
+        exit(1)
       end
 
-      if done_something
-        say("\nDone", :green)
-      else
-        say(" Done ", :green)
-        say("(nothing to do)", :yellow)
-      end
-    rescue Errno::ENOENT => e
-      say_error("\nCan't read RBI: #{e}")
-      exit(1)
-    rescue RBI::ParseError => e
-      say_error("\nCan't parse RBI: #{e} (#{e.location})")
-      exit(1)
+      say("\nNo duplicates found in shim RBIs", :green)
+      exit(0)
     end
 
-    map T.unsafe(["--version", "-v"] => :__print_version)
+    map ["--version", "-v"] => :__print_version
 
     desc "--version, -v", "show version"
     def __print_version

data/lib/tapioca/{generators/base.rb → commands/command.rb}

@@ -2,8 +2,8 @@
 # frozen_string_literal: true
 
 module Tapioca
-  module Generators
-    class Base
+  module Commands
+    class Command
       extend T::Sig
       extend T::Helpers
 
@@ -11,22 +11,29 @@ module Tapioca
         include Thor::Actions
       end
 
-      include CliHelper
       include Thor::Base
+      include CliHelper
 
       abstract!
 
-      sig { params(default_command: String, file_writer: Thor::Actions).void }
-      def initialize(default_command:, file_writer: FileWriter.new)
-        @file_writer = file_writer
-        @default_command = default_command
+      sig { void }
+      def initialize
+        @file_writer = T.let(FileWriter.new, Thor::Actions)
       end
 
       sig { abstract.void }
-      def generate; end
+      def execute; end
 
       private
 
+      sig { params(command: Symbol, args: String).returns(String) }
+      def default_command(command, *args)
+        [Tapioca::BINARY_FILE, command.to_s, *args].join(" ")
+      end
+
+      sig { returns(Thor::Actions) }
+      attr_reader :file_writer
+
       sig do
         params(
           path: T.any(String, Pathname),
@@ -37,7 +44,7 @@ module Tapioca
         ).void
       end
       def create_file(path, content, force: true, skip: false, verbose: true)
-        @file_writer.create_file(path, force: force, skip: skip, verbose: verbose) { content }
+        file_writer.create_file(path, force: force, skip: skip, verbose: verbose) { content }
       end
 
       sig do
@@ -47,7 +54,7 @@ module Tapioca
         ).void
       end
       def remove_file(path, verbose: true)
-        @file_writer.remove_file(path, verbose: verbose)
+        file_writer.remove_file(path, verbose: verbose)
       end
     end
   end