tapioca 0.16.9 → 0.17.7

data/lib/tapioca/commands/check_shims.rb

@@ -8,17 +8,7 @@ module Tapioca
       include SorbetHelper
       include RBIFilesHelper
 
-      sig do
-        params(
-          gem_rbi_dir: String,
-          dsl_rbi_dir: String,
-          annotations_rbi_dir: String,
-          shim_rbi_dir: String,
-          todo_rbi_file: String,
-          payload: T::Boolean,
-          number_of_workers: T.nilable(Integer),
-        ).void
-      end
+      #: (gem_rbi_dir: String, dsl_rbi_dir: String, annotations_rbi_dir: String, shim_rbi_dir: String, todo_rbi_file: String, payload: bool, number_of_workers: Integer?) -> void
       def initialize(
         gem_rbi_dir:,
         dsl_rbi_dir:,
@@ -40,7 +30,8 @@ module Tapioca
 
       private
 
-      sig { override.void }
+      # @override
+      #: -> void
       def execute
         index = RBI::Index.new
 
@@ -50,7 +41,7 @@ module Tapioca
           return
         end
 
-        payload_path = T.let(nil, T.nilable(String))
+        payload_path = nil #: String?
 
         if @payload
           Dir.mktmpdir do |dir|
@@ -58,7 +49,7 @@ module Tapioca
             result = sorbet("--no-config --print=payload-sources:#{payload_path}")
 
             unless result.status
-              raise Thor::Error, <<~ERROR
+              raise Tapioca::Error, <<~ERROR
                 "Sorbet failed to dump payload"
                 #{result.err}
               ERROR
@@ -96,7 +87,7 @@ module Tapioca
             "\nPlease remove the duplicated definitions from #{@shim_rbi_dir} and #{@todo_rbi_file}", :red
           )
 
-          raise Thor::Error, messages.join("\n")
+          raise Tapioca::Error, messages.join("\n")
         end
 
         say("\nNo duplicates found in shim RBIs", :green)

data/lib/tapioca/commands/command.rb

@@ -3,10 +3,9 @@
 
 module Tapioca
   module Commands
+    # @abstract
     class Command
       extend T::Sig
-      extend T::Helpers
-
       class FileWriter < Thor
         include Thor::Actions
       end
@@ -14,14 +13,13 @@ module Tapioca
       include Thor::Base
       include CliHelper
 
-      abstract!
-
-      sig { void }
+      #: -> void
       def initialize
-        @file_writer = T.let(FileWriter.new, Thor::Actions)
+        @file_writer = FileWriter.new #: Thor::Actions
       end
 
-      sig(:final) { void }
+      # @final
+      #: -> void
       def run
         Tapioca.silence_warnings do
           execute
@@ -30,36 +28,24 @@ module Tapioca
 
       private
 
-      sig { abstract.void }
-      def execute; end
+      # @abstract
+      #: -> void
+      def execute = raise NotImplementedError, "Abstract method called"
 
-      sig { params(command: Symbol, args: String).returns(String) }
+      #: (Symbol command, *String args) -> String
       def default_command(command, *args)
         [Tapioca::BINARY_FILE, command.to_s, *args].join(" ")
       end
 
-      sig { returns(Thor::Actions) }
+      #: Thor::Actions
       attr_reader :file_writer
 
-      sig do
-        params(
-          path: T.any(String, Pathname),
-          content: String,
-          force: T::Boolean,
-          skip: T::Boolean,
-          verbose: T::Boolean,
-        ).void
-      end
+      #: ((String | Pathname) path, String content, ?force: bool, ?skip: bool, ?verbose: bool) -> void
       def create_file(path, content, force: true, skip: false, verbose: true)
         file_writer.create_file(path, force: force, skip: skip, verbose: verbose) { content }
       end
 
-      sig do
-        params(
-          path: T.any(String, Pathname),
-          verbose: T::Boolean,
-        ).void
-      end
+      #: ((String | Pathname) path, ?verbose: bool) -> void
       def remove_file(path, verbose: true)
         file_writer.remove_file(path, verbose: verbose)
       end

data/lib/tapioca/commands/command_without_tracker.rb

@@ -3,12 +3,9 @@
 
 module Tapioca
   module Commands
+    # @abstract
     class CommandWithoutTracker < Command
-      extend T::Helpers
-
-      abstract!
-
-      sig { void }
+      #: -> void
       def initialize
         Tapioca::Runtime::Trackers.disable_all!
         super

data/lib/tapioca/commands/configure.rb

@@ -4,13 +4,7 @@
 module Tapioca
   module Commands
     class Configure < CommandWithoutTracker
-      sig do
-        params(
-          sorbet_config: String,
-          tapioca_config: String,
-          default_postrequire: String,
-        ).void
-      end
+      #: (sorbet_config: String, tapioca_config: String, default_postrequire: String) -> void
       def initialize(
         sorbet_config:,
         tapioca_config:,
@@ -22,13 +16,14 @@ module Tapioca
 
         super()
 
-        @installer = T.let(nil, T.nilable(Bundler::Installer))
-        @spec = T.let(nil, T.nilable(Bundler::StubSpecification))
+        @installer = nil #: Bundler::Installer?
+        @spec = nil #: Bundler::StubSpecification?
       end
 
       private
 
-      sig { override.void }
+      # @override
+      #: -> void
       def execute
         create_sorbet_config
         create_tapioca_config
@@ -36,7 +31,7 @@ module Tapioca
         create_binstub
       end
 
-      sig { void }
+      #: -> void
       def create_sorbet_config
         create_file(@sorbet_config, <<~CONTENT, skip: true, force: false)
           --dir
@@ -46,7 +41,7 @@ module Tapioca
         CONTENT
       end
 
-      sig { void }
+      #: -> void
       def create_tapioca_config
         create_file(@tapioca_config, <<~YAML, skip: true, force: false)
           gem:
@@ -65,7 +60,7 @@ module Tapioca
         YAML
       end
 
-      sig { void }
+      #: -> void
       def create_post_require
         create_file(@default_postrequire, <<~CONTENT, skip: true, force: false)
           # typed: true
@@ -75,7 +70,7 @@ module Tapioca
         CONTENT
       end
 
-      sig { void }
+      #: -> void
       def create_binstub
         force = File.exist?(Tapioca::BINARY_FILE)
 
@@ -88,12 +83,12 @@ module Tapioca
         )
       end
 
-      sig { returns(Bundler::Installer) }
+      #: -> Bundler::Installer
       def installer
         @installer ||= Bundler::Installer.new(Bundler.root, Bundler.definition)
       end
 
-      sig { returns(T.any(Bundler::StubSpecification, ::Gem::Specification)) }
+      #: -> (Bundler::StubSpecification | ::Gem::Specification)
       def spec
         @spec ||= Bundler.definition.specs.find { |s| s.name == "tapioca" }
       end

data/lib/tapioca/commands/dsl_compiler_list.rb

@@ -6,7 +6,8 @@ module Tapioca
     class DslCompilerList < AbstractDsl
       private
 
-      sig { override.void }
+      # @override
+      #: -> void
       def execute
         load_application
 

data/lib/tapioca/commands/dsl_generate.rb

@@ -6,7 +6,8 @@ module Tapioca
     class DslGenerate < AbstractDsl
       private
 
-      sig { override.void }
+      # @override
+      #: -> void
       def execute
         load_application
 

data/lib/tapioca/commands/dsl_verify.rb

@@ -6,7 +6,8 @@ module Tapioca
     class DslVerify < AbstractDsl
       private
 
-      sig { override.void }
+      # @override
+      #: -> void
       def execute
         load_application
 

data/lib/tapioca/commands/gem_generate.rb

@@ -6,7 +6,8 @@ module Tapioca
     class GemGenerate < AbstractGem
       private
 
-      sig { override.void }
+      # @override
+      #: -> void
       def execute
         Loaders::Gem.load_application(
           bundle: @bundle,
@@ -47,7 +48,7 @@ module Tapioca
         GitAttributes.create_generated_attribute_file(@outpath)
       end
 
-      sig { params(gem_names: T::Array[String]).returns(T::Array[Gemfile::GemSpec]) }
+      #: (Array[String] gem_names) -> Array[Gemfile::GemSpec]
       def gems_to_generate(gem_names)
         return @bundle.dependencies if gem_names.empty?
 
@@ -57,7 +58,7 @@ module Tapioca
           if gem.nil?
             next if @lsp_addon
 
-            raise Thor::Error, set_color("Error: Cannot find gem '#{gem_name}'", :red)
+            raise Tapioca::Error, set_color("Error: Cannot find gem '#{gem_name}'", :red)
           end
 
           gems.concat(gem_dependencies(gem)) if @include_dependencies
@@ -65,12 +66,7 @@ module Tapioca
         end
       end
 
-      sig do
-        params(
-          gem: Gemfile::GemSpec,
-          dependencies: T::Array[Gemfile::GemSpec],
-        ).returns(T::Array[Gemfile::GemSpec])
-      end
+      #: (Gemfile::GemSpec gem, ?Array[Gemfile::GemSpec] dependencies) -> Array[Gemfile::GemSpec]
       def gem_dependencies(gem, dependencies = [])
         direct_dependencies = gem.dependencies.filter_map { |dependency| @bundle.gem(dependency.name) }
         gems = dependencies | direct_dependencies

data/lib/tapioca/commands/gem_sync.rb

@@ -6,7 +6,8 @@ module Tapioca
     class GemSync < AbstractGem
       private
 
-      sig { override.void }
+      # @override
+      #: -> void
       def execute
         anything_done = [
           perform_removals,

data/lib/tapioca/commands/gem_verify.rb

@@ -6,14 +6,15 @@ module Tapioca
     class GemVerify < AbstractGem
       private
 
-      sig { override.void }
+      # @override
+      #: -> void
       def execute
         say("Checking for out-of-date RBIs...")
         say("")
         perform_sync_verification
       end
 
-      sig { void }
+      #: -> void
       def perform_sync_verification
         diff = {}
 

data/lib/tapioca/commands/require.rb

@@ -4,12 +4,7 @@
 module Tapioca
   module Commands
     class Require < CommandWithoutTracker
-      sig do
-        params(
-          requires_path: String,
-          sorbet_config_path: String,
-        ).void
-      end
+      #: (requires_path: String, sorbet_config_path: String) -> void
       def initialize(requires_path:, sorbet_config_path:)
         @requires_path = requires_path
         @sorbet_config_path = sorbet_config_path
@@ -19,7 +14,8 @@ module Tapioca
 
       private
 
-      sig { override.void }
+      # @override
+      #: -> void
       def execute
         compiler = Static::RequiresCompiler.new(@sorbet_config_path)
         name = set_color(@requires_path, :yellow, :bold)

data/lib/tapioca/commands/todo.rb

@@ -17,12 +17,7 @@ module Tapioca
         4. Manually create an RBI shim defining the missing constants
       DEPRECATION
 
-      sig do
-        params(
-          todo_file: String,
-          file_header: T::Boolean,
-        ).void
-      end
+      #: (todo_file: String, file_header: bool) -> void
       def initialize(todo_file:, file_header:)
         @todo_file = todo_file
         @file_header = file_header
@@ -30,7 +25,7 @@ module Tapioca
         super()
       end
 
-      sig { void }
+      #: -> void
       def run_with_deprecation
         say(DEPRECATION_MESSAGE, :red)
         say("")
@@ -40,7 +35,8 @@ module Tapioca
 
       private
 
-      sig { override.void }
+      # @override
+      #: -> void
       def execute
         say("Finding all unresolved constants, this may take a few seconds... ")
 
@@ -64,7 +60,7 @@ module Tapioca
         say("Please review changes and commit them.", [:green, :bold])
       end
 
-      sig { params(constants: T::Array[String], command: String).returns(RBI::File) }
+      #: (Array[String] constants, command: String) -> RBI::File
       def rbi(constants, command:)
         file = RBI::File.new
 
@@ -84,7 +80,7 @@ module Tapioca
         file
       end
 
-      sig { returns(T::Array[String]) }
+      #: -> Array[String]
       def unresolved_constants
         # Taken from https://github.com/sorbet/sorbet/blob/master/gems/sorbet/lib/todo-rbi.rb
         sorbet("--print=missing-constants", "--quiet", "--stdout-hup-hack", "--no-error-count")

data/lib/tapioca/dsl/compiler.rb

@@ -3,55 +3,49 @@
 
 module Tapioca
   module Dsl
+    # @abstract
+    #: [ConstantType < Module]
     class Compiler
       extend T::Sig
-      extend T::Helpers
-      extend T::Generic
 
       include RBIHelper
       include Runtime::Reflection
       extend Runtime::Reflection
 
-      ConstantType = type_member { { upper: Module } }
-
-      abstract!
-
-      sig { returns(ConstantType) }
+      #: ConstantType
       attr_reader :constant
 
-      sig { returns(RBI::Tree) }
+      #: RBI::Tree
       attr_reader :root
 
-      sig { returns(T::Hash[String, T.untyped]) }
+      #: Hash[String, untyped]
       attr_reader :options
 
-      @@requested_constants = T.let([], T::Array[Module]) # rubocop:disable Style/ClassVars
+      @@requested_constants = [] #: Array[Module] # rubocop:disable Style/ClassVars
 
       class << self
         extend T::Sig
 
-        sig { params(constant: Module).returns(T::Boolean) }
+        #: (Module constant) -> bool
         def handles?(constant)
           processable_constants.include?(constant)
         end
 
-        sig { abstract.returns(T::Enumerable[Module]) }
-        def gather_constants; end
+        # @abstract
+        #: -> T::Enumerable[Module]
+        def gather_constants = raise NotImplementedError, "Abstract method called"
 
-        sig { returns(T::Set[Module]) }
+        #: -> Set[Module]
         def processable_constants
-          @processable_constants ||= T.let(
-            T::Set[Module].new.compare_by_identity.merge(gather_constants),
-            T.nilable(T::Set[Module]),
-          )
+          @processable_constants ||= T::Set[Module].new.compare_by_identity.merge(gather_constants) #: Set[Module]?
         end
 
-        sig { params(constants: T::Array[Module]).void }
+        #: (Array[Module] constants) -> void
         def requested_constants=(constants)
           @@requested_constants = constants # rubocop:disable Style/ClassVars
         end
 
-        sig { void }
+        #: -> void
         def reset_state
           @processable_constants = nil
           @all_classes = nil
@@ -60,11 +54,7 @@ module Tapioca
 
         private
 
-        sig do
-          type_parameters(:U)
-            .params(klass: T.all(T::Class[T.anything], T.type_parameter(:U)))
-            .returns(T::Array[T.type_parameter(:U)])
-        end
+        #: [U] ((Class[top] & U) klass) -> Array[U]
         def descendants_of(klass)
           if @@requested_constants.any?
             T.cast(
@@ -78,53 +68,41 @@ module Tapioca
           end
         end
 
-        sig { returns(T::Enumerable[T::Class[T.anything]]) }
+        #: -> T::Enumerable[Class[top]]
         def all_classes
-          @all_classes ||= T.let(
-            all_modules.grep(Class).freeze,
-            T.nilable(T::Enumerable[T::Class[T.anything]]),
-          )
+          @all_classes ||= all_modules.grep(Class).freeze #: T::Enumerable[Class[top]]?
         end
 
-        sig { returns(T::Enumerable[Module]) }
+        #: -> T::Enumerable[Module]
         def all_modules
-          @all_modules ||= T.let(
-            if @@requested_constants.any?
-              @@requested_constants.grep(Module)
-            else
-              ObjectSpace.each_object(Module).to_a
-            end.freeze,
-            T.nilable(T::Enumerable[Module]),
-          )
+          @all_modules ||= if @@requested_constants.any?
+            @@requested_constants.grep(Module)
+          else
+            ObjectSpace.each_object(Module).to_a
+          end.freeze #: T::Enumerable[Module]?
         end
       end
 
-      sig do
-        params(
-          pipeline: Tapioca::Dsl::Pipeline,
-          root: RBI::Tree,
-          constant: ConstantType,
-          options: T::Hash[String, T.untyped],
-        ).void
-      end
+      #: (Tapioca::Dsl::Pipeline pipeline, RBI::Tree root, ConstantType constant, ?Hash[String, untyped] options) -> void
       def initialize(pipeline, root, constant, options = {})
         @pipeline = pipeline
         @root = root
         @constant = constant
         @options = options
-        @errors = T.let([], T::Array[String])
+        @errors = [] #: Array[String]
       end
 
-      sig { params(compiler_name: String).returns(T::Boolean) }
+      #: (String compiler_name) -> bool
       def compiler_enabled?(compiler_name)
         @pipeline.compiler_enabled?(compiler_name)
       end
 
-      sig { abstract.void }
-      def decorate; end
+      # @abstract
+      #: -> void
+      def decorate = raise NotImplementedError, "Abstract method called"
 
       # NOTE: This should eventually accept an `Error` object or `Exception` rather than simply a `String`.
-      sig { params(error: String).void }
+      #: (String error) -> void
       def add_error(error)
         @pipeline.add_error(error)
       end
@@ -132,14 +110,9 @@ module Tapioca
       private
 
       # Get the types of each parameter from a method signature
-      sig do
-        params(
-          method_def: T.any(Method, UnboundMethod),
-          signature: T.untyped, # as `T::Private::Methods::Signature` is private
-        ).returns(T::Array[String])
-      end
+      #: ((Method | UnboundMethod) method_def, untyped signature) -> Array[String]
       def parameters_types_from_signature(method_def, signature)
-        params = T.let([], T::Array[String])
+        params = [] #: Array[String]
 
         return method_def.parameters.map { "T.untyped" } unless signature
 
@@ -163,7 +136,7 @@ module Tapioca
         params
       end
 
-      sig { params(scope: RBI::Scope, method_def: T.any(Method, UnboundMethod), class_method: T::Boolean).void }
+      #: (RBI::Scope scope, (Method | UnboundMethod) method_def, ?class_method: bool) -> void
       def create_method_from_def(scope, method_def, class_method: false)
         scope.create_method(
           method_def.name.to_s,
@@ -173,13 +146,13 @@ module Tapioca
         )
       end
 
-      sig { params(method_def: T.any(Method, UnboundMethod)).returns(T::Array[RBI::TypedParam]) }
+      #: ((Method | UnboundMethod) method_def) -> Array[RBI::TypedParam]
       def compile_method_parameters_to_rbi(method_def)
         signature = signature_of(method_def)
         method_def = signature.nil? ? method_def : signature.method
         method_types = parameters_types_from_signature(method_def, signature)
 
-        parameters = T.let(method_def.parameters, T::Array[[Symbol, T.nilable(Symbol)]])
+        parameters = method_def.parameters #: Array[[Symbol, Symbol?]]
 
         parameters.each_with_index.map do |(type, name), index|
           fallback_arg_name = "_arg#{index}"
@@ -209,7 +182,7 @@ module Tapioca
         end
       end
 
-      sig { params(method_def: T.any(Method, UnboundMethod)).returns(String) }
+      #: ((Method | UnboundMethod) method_def) -> String
       def compile_method_return_type_to_rbi(method_def)
         signature = signature_of(method_def)
         return_type = signature.nil? ? "T.untyped" : name_of_type(signature.return_type)