tapioca 0.10.1 → 0.10.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 555978fd8996f91539408f4e1c251bf30933d800deab606a63974088f59d8525
-  data.tar.gz: 249a48a0c8a9cc73d56334b2a83b26b356a920747b7ba4b83e1c92575ba1d158
+  metadata.gz: 3c5b81fee880c497fca1e34c644d6da53e4f155e45f564c95eb886f0f6c30d69
+  data.tar.gz: d0973ab750b577064e5891c0fbd9dd71ddeb82b54d7d8dfcabad4841052e8d6d
 SHA512:
-  metadata.gz: 819cb6fc4c0fb0adbbf79ad4250147c6753b87f257a9c9d869419ca4db68ad869aea78fbbb995a71e1cee31b06a237df34f680bc1c97e3f3b7ea62c4c67b6b16
-  data.tar.gz: e28b2f755e4ff5aab74cacc4f7141e5c93ee2b0ca8e1818c068b0c4ef5ba6e76e06cfbc5775f8e03babc50309df8d85c20c30708e9656bb714f506cb7ed8434d
+  metadata.gz: 105ab9194d3e62657fedff6d0fd78b187980b5084af80be294690c00a86ac1544b29bd9d86951f50072c895516ce1541251ac2ff05cbb3a2acbbee5d0e103b51
+  data.tar.gz: 612f856fd4b36301dbfee4cdd80615ee4a684447ea077037c5a72e1c7c216be7c465aae13a5b4462a8db9889929765703293d2935036d7ac1e94b8d21d4ee5fb

data/README.md

@@ -198,7 +198,7 @@ generate RBIs from gems
 ```
 <!-- END_HELP_COMMAND_GEM -->
 
-By default, running `tapioca gem` will only generate the RBI files for gems that have been added to or removed from the project's `Gemfile` this means that Tapioca will not regenerate the RBI files for untouched gems. However, when changing Tapioca configuration or bumping its version, it may be useful to force the regeneration of the RBI files previsouly generated. This can be done with the `--all` option:
+By default, running `tapioca gem` will only generate the RBI files for gems that have been added to or removed from the project's `Gemfile` this means that Tapioca will not regenerate the RBI files for untouched gems. However, when changing Tapioca configuration or bumping its version, it may be useful to force the regeneration of the RBI files previously generated. This can be done with the `--all` option:
 
 ```shell
 bin/tapioca gems --all
@@ -466,12 +466,15 @@ Options:
           [--exclude=compiler [compiler ...]]    # Exclude supplied DSL compiler(s)
           [--verify], [--no-verify]              # Verifies RBIs are up-to-date
   -q, [--quiet], [--no-quiet]                    # Suppresses file creation output
-  -w, [--workers=N]                              # Number of parallel workers to use when generating RBIs (default: auto)
+  -w, [--workers=N]                              # Number of parallel workers to use when generating RBIs (default: 2)
+                                                 # Default: 2
           [--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
   -e, [--environment=ENVIRONMENT]                # The Rack/Rails environment to use when generating RBIs
                                                  # Default: development
   -l, [--list-compilers], [--no-list-compilers]  # List all loaded compilers
+          [--app-root=APP_ROOT]                  # The path to the Rails application
+                                                 # Default: .
   -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
@@ -634,6 +637,8 @@ There are two main parts to the DSL compiler API: `gather_constants` and `decora
 * The `gather_constants` class method collects all classes (or modules) that should be processed by this specific DSL compiler.
 * The `decorate` method defines how to generate the necessary RBI definitions for the gathered constants.
 
+Every compiler must declare the type member `ConstantType` in order for Sorbet to understand what the return type of the `constant` attribute reader is. It needs to be assigned the correct type variable matching the type of constants that `gather_constants` returns. This generic variable allows Sorbet to type-check method calls on the `constant` reader in your `decorate` method. See the Sorbet documentation on [generics](https://sorbet.org/docs/generics) for more information.
+
 You can now run the new RBI compiler through the normal DSL generation process (your custom compiler will be loaded automatically by Tapioca):
 
 ```shell
@@ -817,10 +822,11 @@ dsl:
   exclude: []
   verify: false
   quiet: false
-  workers: 1
+  workers: 2
   rbi_max_line_length: 120
   environment: development
   list_compilers: false
+  app_root: "."
 gem:
   outdir: sorbet/rbi/gems
   file_header: true

data/lib/tapioca/cli.rb

@@ -9,6 +9,8 @@ module Tapioca
 
     FILE_HEADER_OPTION_DESC = "Add a \"This file is generated\" header on top of each generated RBI file"
 
+    check_unknown_options!
+
     class_option :config,
       aliases: ["-c"],
       banner: "<config file path>",
@@ -37,7 +39,7 @@ module Tapioca
       command = Commands::Configure.new(
         sorbet_config: SORBET_CONFIG_FILE,
         tapioca_config: options[:config],
-        default_postrequire: options[:postrequire]
+        default_postrequire: options[:postrequire],
       )
       command.execute
     end
@@ -47,7 +49,7 @@ module Tapioca
     def require
       command = Commands::Require.new(
         requires_path: options[:postrequire],
-        sorbet_config_path: SORBET_CONFIG_FILE
+        sorbet_config_path: SORBET_CONFIG_FILE,
       )
       Tapioca.silence_warnings do
         command.execute
@@ -66,7 +68,7 @@ module Tapioca
     def todo
       command = Commands::Todo.new(
         todo_file: options[:todo_file],
-        file_header: options[:file_header]
+        file_header: options[:file_header],
       )
       Tapioca.silence_warnings do
         command.execute
@@ -105,7 +107,8 @@ module Tapioca
     option :workers,
       aliases: ["-w"],
       type: :numeric,
-      desc: "Number of parallel workers to use when generating RBIs (default: auto)"
+      desc: "Number of parallel workers to use when generating RBIs (default: 2)",
+      default: 2
     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",
@@ -120,6 +123,10 @@ module Tapioca
       type: :boolean,
       desc: "List all loaded compilers",
       default: false
+    option :app_root,
+      type: :string,
+      desc: "The path to the Rails application",
+      default: "."
     def dsl(*constants)
       set_environment(options)
 
@@ -134,7 +141,8 @@ module Tapioca
         quiet: options[:quiet],
         verbose: options[:verbose],
         number_of_workers: options[:workers],
-        rbi_formatter: rbi_formatter(options)
+        rbi_formatter: rbi_formatter(options),
+        app_root: options[:app_root],
       )
 
       Tapioca.silence_warnings do
@@ -241,7 +249,7 @@ module Tapioca
           number_of_workers: options[:workers],
           auto_strictness: options[:auto_strictness],
           dsl_dir: options[:dsl_dir],
-          rbi_formatter: rbi_formatter(options)
+          rbi_formatter: rbi_formatter(options),
         )
 
         raise MalformattedArgumentError, "Options '--all' and '--verify' are mutually exclusive" if all && verify
@@ -269,8 +277,6 @@ module Tapioca
     option :payload, type: :boolean, desc: "Check shims against Sorbet's payload", default: true
     option :workers, aliases: ["-w"], type: :numeric, desc: "Number of parallel workers (default: auto)"
     def check_shims
-      Tapioca.disable_traces
-
       command = Commands::CheckShims.new(
         gem_rbi_dir: options[:gem_rbi_dir],
         dsl_rbi_dir: options[:dsl_rbi_dir],
@@ -278,9 +284,12 @@ module Tapioca
         annotations_rbi_dir: options[:annotations_rbi_dir],
         todo_rbi_file: options[:todo_rbi_file],
         payload: options[:payload],
-        number_of_workers: options[:workers]
+        number_of_workers: options[:workers],
       )
-      command.execute
+
+      Tapioca.silence_warnings do
+        command.execute
+      end
     end
 
     desc "annotations", "Pull gem RBI annotations from remote sources"
@@ -304,9 +313,12 @@ module Tapioca
         central_repo_root_uris: options[:sources],
         auth: options[:auth],
         netrc_file: netrc_file(options),
-        typed_overrides: options[:typed_overrides]
+        typed_overrides: options[:typed_overrides],
       )
-      command.execute
+
+      Tapioca.silence_warnings do
+        command.execute
+      end
     end
 
     map ["--version", "-v"] => :__print_version

data/lib/tapioca/commands/annotations.rb

@@ -3,7 +3,7 @@
 
 module Tapioca
   module Commands
-    class Annotations < Command
+    class Annotations < CommandWithoutTracker
       extend T::Sig
 
       sig do
@@ -12,7 +12,7 @@ module Tapioca
           auth: T.nilable(String),
           netrc_file: T.nilable(String),
           central_repo_index_path: String,
-          typed_overrides: T::Hash[String, String]
+          typed_overrides: T::Hash[String, String],
         ).void
       end
       def initialize(

data/lib/tapioca/commands/check_shims.rb

@@ -3,7 +3,7 @@
 
 module Tapioca
   module Commands
-    class CheckShims < Command
+    class CheckShims < CommandWithoutTracker
       extend T::Sig
       include SorbetHelper
       include RBIFilesHelper
@@ -16,7 +16,7 @@ module Tapioca
           shim_rbi_dir: String,
           todo_rbi_file: String,
           payload: T::Boolean,
-          number_of_workers: T.nilable(Integer)
+          number_of_workers: T.nilable(Integer),
         ).void
       end
       def initialize(
@@ -51,26 +51,18 @@ module Tapioca
         payload_path = T.let(nil, T.nilable(String))
 
         if @payload
-          if sorbet_supports?(:print_payload_sources)
-            Dir.mktmpdir do |dir|
-              payload_path = dir
-              result = sorbet("--no-config --print=payload-sources:#{payload_path}")
-
-              unless result.status
-                raise Thor::Error, <<~ERROR
-                  "Sorbet failed to dump payload"
-                  #{result.err}
-                ERROR
-              end
-
-              index_rbis(index, "payload", payload_path, number_of_workers: @number_of_workers)
+          Dir.mktmpdir do |dir|
+            payload_path = dir
+            result = sorbet("--no-config --print=payload-sources:#{payload_path}")
+
+            unless result.status
+              raise Thor::Error, <<~ERROR
+                "Sorbet failed to dump payload"
+                #{result.err}
+              ERROR
             end
-          else
-            raise Thor::Error, <<~ERROR
-              The version of Sorbet used in your Gemfile.lock does not support `--print=payload-sources`
-              Current: v#{SORBET_GEM_SPEC.version}
-              Required: #{FEATURE_REQUIREMENTS[:print_payload_sources]}
-            ERROR
+
+            index_rbis(index, "payload", payload_path, number_of_workers: @number_of_workers)
           end
         end
 

data/lib/tapioca/commands/command.rb

@@ -40,7 +40,7 @@ module Tapioca
           content: String,
           force: T::Boolean,
           skip: T::Boolean,
-          verbose: T::Boolean
+          verbose: T::Boolean,
         ).void
       end
       def create_file(path, content, force: true, skip: false, verbose: true)
@@ -50,7 +50,7 @@ module Tapioca
       sig do
         params(
           path: T.any(String, Pathname),
-          verbose: T::Boolean
+          verbose: T::Boolean,
         ).void
       end
       def remove_file(path, verbose: true)

data/lib/tapioca/commands/command_without_tracker.rb

@@ -0,0 +1,18 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Tapioca
+  module Commands
+    class CommandWithoutTracker < Command
+      extend T::Helpers
+
+      abstract!
+
+      sig { void }
+      def initialize
+        Tapioca::Runtime::Trackers.disable_all!
+        super
+      end
+    end
+  end
+end

data/lib/tapioca/commands/configure.rb

@@ -3,12 +3,12 @@
 
 module Tapioca
   module Commands
-    class Configure < Command
+    class Configure < CommandWithoutTracker
       sig do
         params(
           sorbet_config: String,
           tapioca_config: String,
-          default_postrequire: String
+          default_postrequire: String,
         ).void
       end
       def initialize(
@@ -83,7 +83,7 @@ module Tapioca
         say_status(
           force ? :force : :create,
           Tapioca::BINARY_FILE,
-          force ? :yellow : :green
+          force ? :yellow : :green,
         )
       end
 

data/lib/tapioca/commands/dsl.rb

@@ -3,7 +3,7 @@
 
 module Tapioca
   module Commands
-    class Dsl < Command
+    class Dsl < CommandWithoutTracker
       include SorbetHelper
       include RBIFilesHelper
 
@@ -21,7 +21,8 @@ module Tapioca
           number_of_workers: T.nilable(Integer),
           auto_strictness: T::Boolean,
           gem_dir: String,
-          rbi_formatter: RBIFormatter
+          rbi_formatter: RBIFormatter,
+          app_root: String,
         ).void
       end
       def initialize(
@@ -37,7 +38,8 @@ module Tapioca
         number_of_workers: nil,
         auto_strictness: true,
         gem_dir: DEFAULT_GEM_DIR,
-        rbi_formatter: DEFAULT_RBI_FORMATTER
+        rbi_formatter: DEFAULT_RBI_FORMATTER,
+        app_root: "."
       )
         @requested_constants = requested_constants
         @outpath = outpath
@@ -52,6 +54,7 @@ module Tapioca
         @auto_strictness = auto_strictness
         @gem_dir = gem_dir
         @rbi_formatter = rbi_formatter
+        @app_root = app_root
 
         super()
       end
@@ -60,7 +63,8 @@ module Tapioca
       def list_compilers
         Loaders::Dsl.load_application(
           tapioca_path: @tapioca_path,
-          eager_load: @requested_constants.empty?
+          eager_load: @requested_constants.empty?,
+          app_root: @app_root,
         )
 
         pipeline = create_pipeline
@@ -86,7 +90,8 @@ module Tapioca
       def execute
         Loaders::Dsl.load_application(
           tapioca_path: @tapioca_path,
-          eager_load: @requested_constants.empty?
+          eager_load: @requested_constants.empty?,
+          app_root: @app_root,
         )
 
         if @should_verify
@@ -112,7 +117,7 @@ module Tapioca
             constant_name,
             contents,
             outpath: outpath,
-            quiet: @should_verify || (@quiet && !@verbose)
+            quiet: @should_verify || (@quiet && !@verbose),
           )
         end
 
@@ -133,7 +138,7 @@ module Tapioca
               gem_dir: @gem_dir,
               dsl_dir: @outpath.to_s,
               auto_strictness: @auto_strictness,
-              compilers: pipeline.active_compilers
+              compilers: pipeline.active_compilers,
             )
           end
 
@@ -153,7 +158,7 @@ module Tapioca
           error_handler: ->(error) {
             say_error(error, :bold, :red)
           },
-          number_of_workers: @number_of_workers
+          number_of_workers: @number_of_workers,
         )
       end
 
@@ -230,7 +235,7 @@ module Tapioca
           constant_name: String,
           rbi: RBI::File,
           outpath: Pathname,
-          quiet: T::Boolean
+          quiet: T::Boolean,
         ).returns(T.nilable(Pathname))
       end
       def compile_dsl_rbi(constant_name, rbi, outpath: @outpath, quiet: false)
@@ -241,7 +246,7 @@ module Tapioca
         @rbi_formatter.write_header!(
           rbi,
           generate_command_for(constant_name),
-          reason: "dynamic methods in `#{constant_name}`"
+          reason: "dynamic methods in `#{constant_name}`",
         ) if @file_header
 
         rbi_string = @rbi_formatter.print_file(rbi)
@@ -328,7 +333,7 @@ module Tapioca
 
           raise Thor::Error, <<~ERROR
             #{set_color("RBI files are out-of-date. In your development environment, please run:", :green)}
-              #{set_color("`#{default_command(command)}`", [:green, :bold])}
+              #{set_color("`#{default_command(command)}`", :green, :bold)}
             #{set_color("Once it is complete, be sure to commit and push any changes", :green)}
 
             #{set_color("Reason:", :red)}

data/lib/tapioca/commands/gem.rb

@@ -22,7 +22,7 @@ module Tapioca
           number_of_workers: T.nilable(Integer),
           auto_strictness: T::Boolean,
           dsl_dir: String,
-          rbi_formatter: RBIFormatter
+          rbi_formatter: RBIFormatter,
         ).void
       end
       def initialize(
@@ -91,7 +91,7 @@ module Tapioca
             gem_dir: @outpath.to_s,
             dsl_dir: @dsl_dir,
             auto_strictness: @auto_strictness,
-            gems: @bundle.dependencies
+            gems: @bundle.dependencies,
           )
 
           say("All operations performed in working directory.", [:green, :bold])
@@ -121,7 +121,7 @@ module Tapioca
             gem_dir: @outpath.to_s,
             dsl_dir: @dsl_dir,
             auto_strictness: @auto_strictness,
-            gems: @bundle.dependencies
+            gems: @bundle.dependencies,
           )
 
           say("All operations performed in working directory.", [:green, :bold])
@@ -158,7 +158,7 @@ module Tapioca
 
         @rbi_formatter.write_header!(rbi,
           default_command(:gem, gem.name),
-          reason: "types exported from the `#{gem.name}` gem",) if @file_header
+          reason: "types exported from the `#{gem.name}` gem") if @file_header
 
         rbi.root = Tapioca::Gem::Pipeline.new(gem, include_doc: @include_doc, include_loc: @include_loc).compile
 
@@ -305,7 +305,7 @@ module Tapioca
 
           raise Thor::Error, <<~ERROR
             #{set_color("RBI files are out-of-date. In your development environment, please run:", :green)}
-              #{set_color("`#{default_command(command)}`", [:green, :bold])}
+              #{set_color("`#{default_command(command)}`", :green, :bold)}
             #{set_color("Once it is complete, be sure to commit and push any changes", :green)}
 
             #{set_color("Reason:", :red)}

data/lib/tapioca/commands/require.rb

@@ -3,11 +3,11 @@
 
 module Tapioca
   module Commands
-    class Require < Command
+    class Require < CommandWithoutTracker
       sig do
         params(
           requires_path: String,
-          sorbet_config_path: String
+          sorbet_config_path: String,
         ).void
       end
       def initialize(requires_path:, sorbet_config_path:)

data/lib/tapioca/commands/todo.rb

@@ -3,13 +3,13 @@
 
 module Tapioca
   module Commands
-    class Todo < Command
+    class Todo < CommandWithoutTracker
       include SorbetHelper
 
       sig do
         params(
           todo_file: String,
-          file_header: T::Boolean
+          file_header: T::Boolean,
         ).void
       end
       def initialize(todo_file:, file_header:)

data/lib/tapioca/commands.rb

@@ -4,6 +4,7 @@
 module Tapioca
   module Commands
     autoload :Command, "tapioca/commands/command"
+    autoload :CommandWithoutTracker, "tapioca/commands/command_without_tracker"
     autoload :Annotations, "tapioca/commands/annotations"
     autoload :CheckShims, "tapioca/commands/check_shims"
     autoload :Dsl, "tapioca/commands/dsl"

data/lib/tapioca/dsl/compiler.rb

@@ -37,7 +37,7 @@ module Tapioca
         def processable_constants
           @processable_constants ||= T.let(
             T::Set[Module].new(gather_constants).compare_by_identity,
-            T.nilable(T::Set[Module])
+            T.nilable(T::Set[Module]),
           )
         end
 
@@ -84,7 +84,7 @@ module Tapioca
       sig do
         params(
           method_def: T.any(Method, UnboundMethod),
-          signature: T.untyped # as `T::Private::Methods::Signature` is private
+          signature: T.untyped, # as `T::Private::Methods::Signature` is private
         ).returns(T::Array[String])
       end
       def parameters_types_from_signature(method_def, signature)
@@ -115,7 +115,7 @@ module Tapioca
           method_def.name.to_s,
           parameters: compile_method_parameters_to_rbi(method_def),
           return_type: compile_method_return_type_to_rbi(method_def),
-          class_method: class_method
+          class_method: class_method,
         )
       end
 

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

@@ -46,7 +46,7 @@ module Tapioca
           T.let(
             ["after", "after_commit", "after_transaction", "before", "before_transaction", "ensure", "error",
              "before_success", "success",].freeze,
-            T::Array[String]
+            T::Array[String],
           )
 
         ConstantType = type_member { { fixed: T.all(::AASM::ClassMethods, Class) } }
@@ -81,7 +81,7 @@ module Tapioca
                 create_block_param("block", type: "T.nilable(T.proc.bind(PrivateAASMMachine).void)"),
               ],
               return_type: "PrivateAASMMachine",
-              class_method: true
+              class_method: true,
             )
 
             # Create a private machine class that we can pass around for the
@@ -94,7 +94,7 @@ module Tapioca
                   create_param("name", type: "T.untyped"),
                   create_opt_param("options", default: "nil", type: "T.untyped"),
                   create_block_param("block", type: "T.proc.bind(PrivateAASMEvent).void"),
-                ]
+                ],
               )
 
               # Create a private event class that we can pass around for the
@@ -107,7 +107,7 @@ module Tapioca
                     parameters: [
                       create_opt_param("symbol", type: "T.nilable(Symbol)", default: "nil"),
                       create_block_param("block", type: "T.nilable(T.proc.bind(#{name_of(constant)}).void)"),
-                    ]
+                    ],
                   )
                 end
               end

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

@@ -149,7 +149,7 @@ module Tapioca
               create_kw_rest_param("kwargs", type: "T.untyped"),
               create_block_param("blk", type: "T.untyped"),
             ],
-            return_type: "T.untyped"
+            return_type: "T.untyped",
           )
         end
 

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

@@ -48,7 +48,7 @@ module Tapioca
                 mailer_method,
                 parameters: parameters,
                 return_type: "::ActionMailer::MessageDelivery",
-                class_method: true
+                class_method: true,
               )
             end
           end

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

@@ -55,14 +55,14 @@ module Tapioca
               "perform_later",
               parameters: parameters,
               return_type: "T.any(#{name_of(constant)}, FalseClass)",
-              class_method: true
+              class_method: true,
             )
 
             job.create_method(
               "perform_now",
               parameters: parameters,
               return_type: return_type,
-              class_method: true
+              class_method: true,
             )
           end
         end

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

@@ -131,7 +131,7 @@ module Tapioca
             klass.create_method(
               method,
               parameters: [parameter],
-              return_type: type
+              return_type: type,
             )
           else
             klass.create_method(method, return_type: type)