tapioca 0.16.10 → 0.17.0

data/lib/tapioca/commands/abstract_gem.rb

@@ -9,27 +9,7 @@ module Tapioca
 
       abstract!
 
-      sig do
-        params(
-          gem_names: T::Array[String],
-          exclude: T::Array[String],
-          include_dependencies: T::Boolean,
-          prerequire: T.nilable(String),
-          postrequire: String,
-          typed_overrides: T::Hash[String, String],
-          outpath: Pathname,
-          file_header: T::Boolean,
-          include_doc: T::Boolean,
-          include_loc: T::Boolean,
-          include_exported_rbis: T::Boolean,
-          number_of_workers: T.nilable(Integer),
-          auto_strictness: T::Boolean,
-          dsl_dir: String,
-          rbi_formatter: RBIFormatter,
-          halt_upon_load_error: T::Boolean,
-          lsp_addon: T.nilable(T::Boolean),
-        ).void
-      end
+      #: (gem_names: Array[String], exclude: Array[String], include_dependencies: bool, prerequire: String?, postrequire: String, typed_overrides: Hash[String, String], outpath: Pathname, file_header: bool, include_doc: bool, include_loc: bool, include_exported_rbis: bool, ?number_of_workers: Integer?, ?auto_strictness: bool, ?dsl_dir: String, ?rbi_formatter: RBIFormatter, ?halt_upon_load_error: bool, ?lsp_addon: bool?) -> void
       def initialize(
         gem_names:,
         exclude:,
@@ -65,18 +45,18 @@ module Tapioca
 
         super()
 
-        @bundle = T.let(Gemfile.new(exclude), Gemfile)
-        @existing_rbis = T.let(nil, T.nilable(T::Hash[String, String]))
-        @expected_rbis = T.let(nil, T.nilable(T::Hash[String, String]))
-        @include_doc = T.let(include_doc, T::Boolean)
-        @include_loc = T.let(include_loc, T::Boolean)
+        @bundle = Gemfile.new(exclude) #: Gemfile
+        @existing_rbis = nil #: Hash[String, String]?
+        @expected_rbis = nil #: Hash[String, String]?
+        @include_doc = include_doc #: bool
+        @include_loc = include_loc #: bool
         @include_exported_rbis = include_exported_rbis
         @halt_upon_load_error = halt_upon_load_error
       end
 
       private
 
-      sig { params(gem: Gemfile::GemSpec).void }
+      #: (Gemfile::GemSpec gem) -> void
       def compile_gem_rbi(gem)
         gem_name = set_color(gem.name, :yellow, :bold)
 
@@ -116,12 +96,12 @@ module Tapioca
         end
       end
 
-      sig { void }
+      #: -> void
       def perform_removals
         say("Removing RBI files of gems that have been removed:", [:blue, :bold])
         puts
 
-        anything_done = T.let(false, T::Boolean)
+        anything_done = false #: bool
 
         gems = removed_rbis
 
@@ -143,12 +123,12 @@ module Tapioca
         anything_done
       end
 
-      sig { void }
+      #: -> void
       def perform_additions
         say("Generating RBI files of gems that are added or updated:", [:blue, :bold])
         puts
 
-        anything_done = T.let(false, T::Boolean)
+        anything_done = false #: bool
 
         gems = added_rbis
 
@@ -186,34 +166,34 @@ module Tapioca
         anything_done
       end
 
-      sig { returns(T::Array[String]) }
+      #: -> Array[String]
       def removed_rbis
         (existing_rbis.keys - expected_rbis.keys).sort
       end
 
-      sig { params(gem_name: String).returns(Pathname) }
+      #: (String gem_name) -> Pathname
       def existing_rbi(gem_name)
         gem_rbi_filename(gem_name, T.must(existing_rbis[gem_name]))
       end
 
-      sig { returns(T::Array[String]) }
+      #: -> Array[String]
       def added_rbis
         expected_rbis.select do |name, value|
           existing_rbis[name] != value
         end.keys.sort
       end
 
-      sig { params(gem_name: String).returns(Pathname) }
+      #: (String gem_name) -> Pathname
       def expected_rbi(gem_name)
         gem_rbi_filename(gem_name, T.must(expected_rbis[gem_name]))
       end
 
-      sig { params(gem_name: String).returns(T::Boolean) }
+      #: (String gem_name) -> bool
       def gem_rbi_exists?(gem_name)
         existing_rbis.key?(gem_name)
       end
 
-      sig { params(diff: T::Hash[String, Symbol], command: Symbol).void }
+      #: (Hash[String, Symbol] diff, Symbol command) -> void
       def report_diff_and_exit_if_out_of_date(diff, command)
         if diff.empty?
           say("Nothing to do, all RBIs are up-to-date.")
@@ -233,36 +213,36 @@ module Tapioca
         end
       end
 
-      sig { params(old_filename: Pathname, new_filename: Pathname).void }
+      #: (Pathname old_filename, Pathname new_filename) -> void
       def move(old_filename, new_filename)
         say("-> Moving: #{old_filename} to #{new_filename}")
         old_filename.rename(new_filename.to_s)
       end
 
-      sig { returns(T::Hash[String, String]) }
+      #: -> Hash[String, String]
       def existing_rbis
         @existing_rbis ||= Pathname.glob((@outpath / "*@*.rbi").to_s)
           .to_h { |f| T.cast(f.basename(".*").to_s.split("@", 2), [String, String]) }
       end
 
-      sig { returns(T::Hash[String, String]) }
+      #: -> Hash[String, String]
       def expected_rbis
         @expected_rbis ||= @bundle.dependencies
           .reject { |gem| @exclude.include?(gem.name) }
           .to_h { |gem| [gem.name, gem.version.to_s] }
       end
 
-      sig { params(gem_name: String, version: String).returns(Pathname) }
+      #: (String gem_name, String version) -> Pathname
       def gem_rbi_filename(gem_name, version)
         @outpath / "#{gem_name}@#{version}.rbi"
       end
 
-      sig { params(cause: Symbol, files: T::Array[String]).returns(String) }
+      #: (Symbol cause, Array[String] files) -> String
       def build_error_for_files(cause, files)
         "  File(s) #{cause}:\n  - #{files.join("\n  - ")}"
       end
 
-      sig { params(gem: Gemfile::GemSpec, file: RBI::File).void }
+      #: (Gemfile::GemSpec gem, RBI::File file) -> void
       def merge_with_exported_rbi(gem, file)
         return file unless gem.export_rbi_files?
 

data/lib/tapioca/commands/annotations.rb

@@ -6,15 +6,7 @@ module Tapioca
     class Annotations < CommandWithoutTracker
       extend T::Sig
 
-      sig do
-        params(
-          central_repo_root_uris: T::Array[String],
-          auth: T.nilable(String),
-          netrc_file: T.nilable(String),
-          central_repo_index_path: String,
-          typed_overrides: T::Hash[String, String],
-        ).void
-      end
+      #: (central_repo_root_uris: Array[String], ?auth: String?, ?netrc_file: String?, ?central_repo_index_path: String, ?typed_overrides: Hash[String, String]) -> void
       def initialize(
         central_repo_root_uris:,
         auth: nil,
@@ -23,19 +15,20 @@ module Tapioca
         typed_overrides: {}
       )
         super()
-        @outpath = T.let(Pathname.new(DEFAULT_ANNOTATIONS_DIR), Pathname)
+        @outpath = Pathname.new(DEFAULT_ANNOTATIONS_DIR) #: Pathname
         @central_repo_root_uris = central_repo_root_uris
         @auth = auth
         @netrc_file = netrc_file
-        @netrc_info = T.let(nil, T.nilable(Netrc))
-        @tokens = T.let(repo_tokens, T::Hash[String, T.nilable(String)])
-        @indexes = T.let({}, T::Hash[String, RepoIndex])
+        @netrc_info = nil #: Netrc?
+        @tokens = repo_tokens #: Hash[String, String?]
+        @indexes = {} #: Hash[String, RepoIndex]
         @typed_overrides = typed_overrides
       end
 
       private
 
-      sig { override.void }
+      # @override
+      #: -> void
       def execute
         @indexes = fetch_indexes
         project_gems = list_gemfile_gems
@@ -46,7 +39,7 @@ module Tapioca
         GitAttributes.create_vendored_attribute_file(@outpath)
       end
 
-      sig { returns(T::Array[GemInfo]) }
+      #: -> Array[GemInfo]
       def list_gemfile_gems
         say("Listing gems from Gemfile.lock... ", [:blue, :bold])
         gemfile = Bundler.read_file("Gemfile.lock")
@@ -56,7 +49,7 @@ module Tapioca
         gem_info
       end
 
-      sig { params(project_gems: T::Array[GemInfo]).void }
+      #: (Array[GemInfo] project_gems) -> void
       def remove_expired_annotations(project_gems)
         say("Removing annotations for gems that have been removed... ", [:blue, :bold])
 
@@ -77,11 +70,11 @@ module Tapioca
         say("\nDone\n\n", :green)
       end
 
-      sig { returns(T::Hash[String, RepoIndex]) }
+      #: -> Hash[String, RepoIndex]
       def fetch_indexes
         multiple_repos = @central_repo_root_uris.size > 1
         repo_number = 1
-        indexes = T.let({}, T::Hash[String, RepoIndex])
+        indexes = {} #: Hash[String, RepoIndex]
 
         @central_repo_root_uris.each do |uri|
           index = fetch_index(uri, repo_number: multiple_repos ? repo_number : nil)
@@ -98,7 +91,7 @@ module Tapioca
         indexes
       end
 
-      sig { params(repo_uri: String, repo_number: T.nilable(Integer)).returns(T.nilable(RepoIndex)) }
+      #: (String repo_uri, repo_number: Integer?) -> RepoIndex?
       def fetch_index(repo_uri, repo_number:)
         say("Retrieving index from central repository#{repo_number ? " ##{repo_number}" : ""}... ", [:blue, :bold])
         content = fetch_file(repo_uri, CENTRAL_REPO_INDEX_PATH)
@@ -109,10 +102,10 @@ module Tapioca
         index
       end
 
-      sig { params(project_gems: T::Array[GemInfo]).returns(T::Array[String]) }
+      #: (Array[GemInfo] project_gems) -> Array[String]
       def fetch_annotations(project_gems)
         say("Fetching gem annotations from central repository... ", [:blue, :bold])
-        fetchable_gems = T.let(Hash.new { |h, k| h[k] = [] }, T::Hash[GemInfo, T::Array[String]])
+        fetchable_gems = Hash.new { |h, k| h[k] = [] } #: Hash[GemInfo, Array[String]]
 
         project_gems.each_with_object(fetchable_gems) do |gem_info, hash|
           @indexes.each do |uri, index|
@@ -132,7 +125,7 @@ module Tapioca
         fetched_gems.keys.map(&:name).sort
       end
 
-      sig { params(repo_uris: T::Array[String], gem_info: GemInfo).void }
+      sig { params(repo_uris: T::Array[String], gem_info: GemInfo).returns(T::Boolean) }
       def fetch_annotation(repo_uris, gem_info)
         gem_name = gem_info.name
         gem_version = gem_info.version
@@ -142,7 +135,7 @@ module Tapioca
         end
 
         content = merge_files(gem_name, contents.compact)
-        return unless content
+        return false unless content
 
         content = apply_typed_override(gem_name, content)
         content = filter_versions(gem_version, content)
@@ -150,9 +143,10 @@ module Tapioca
 
         say("\n  Fetched #{set_color(gem_name, :yellow, :bold)}", :green)
         create_file(@outpath.join("#{gem_name}.rbi"), content)
+        true
       end
 
-      sig { params(repo_uri: String, path: String).returns(T.nilable(String)) }
+      #: (String repo_uri, String path) -> String?
       def fetch_file(repo_uri, path)
         if repo_uri.start_with?(%r{https?://})
           fetch_http_file(repo_uri, path)
@@ -161,7 +155,7 @@ module Tapioca
         end
       end
 
-      sig { params(repo_uri: String, path: String).returns(T.nilable(String)) }
+      #: (String repo_uri, String path) -> String?
       def fetch_local_file(repo_uri, path)
         File.read("#{repo_uri}/#{path}")
       rescue => e
@@ -169,7 +163,7 @@ module Tapioca
         nil
       end
 
-      sig { params(repo_uri: String, path: String).returns(T.nilable(String)) }
+      #: (String repo_uri, String path) -> String?
       def fetch_http_file(repo_uri, path)
         auth = @tokens[repo_uri]
         uri = URI("#{repo_uri}/#{path}")
@@ -193,7 +187,7 @@ module Tapioca
         nil
       end
 
-      sig { params(name: String, content: String).returns(String) }
+      #: (String name, String content) -> String
       def add_header(name, content)
         # WARNING: Changing this header could impact how GitHub determines if the file should be hidden:
         # https://github.com/github/linguist/pull/6143
@@ -213,7 +207,7 @@ module Tapioca
         end
       end
 
-      sig { params(name: String, content: String).returns(String) }
+      #: (String name, String content) -> String
       def apply_typed_override(name, content)
         strictness = @typed_overrides[name]
         return content unless strictness
@@ -225,7 +219,7 @@ module Tapioca
         Spoom::Sorbet::Sigils.update_sigil(content, strictness)
       end
 
-      sig { params(gem_version: ::Gem::Version, content: String).returns(String) }
+      #: (::Gem::Version gem_version, String content) -> String
       def filter_versions(gem_version, content)
         rbi = RBI::Parser.parse_string(content)
         rbi.filter_versions!(gem_version)
@@ -233,7 +227,7 @@ module Tapioca
         rbi.string
       end
 
-      sig { params(gem_name: String, contents: T::Array[String]).returns(T.nilable(String)) }
+      #: (String gem_name, Array[String] contents) -> String?
       def merge_files(gem_name, contents)
         return if contents.empty?
 
@@ -260,7 +254,7 @@ module Tapioca
         nil
       end
 
-      sig { returns(T::Hash[String, T.nilable(String)]) }
+      #: -> Hash[String, String?]
       def repo_tokens
         @netrc_info = Netrc.read(@netrc_file) if @netrc_file
         @central_repo_root_uris.filter_map do |uri|
@@ -272,7 +266,7 @@ module Tapioca
         end.to_h
       end
 
-      sig { params(repo_uri: String).returns(T.nilable(String)) }
+      #: (String repo_uri) -> String?
       def token_for(repo_uri)
         return unless @netrc_info
 
@@ -288,7 +282,7 @@ module Tapioca
         "token #{token}"
       end
 
-      sig { params(path: String, repo_uri: String, message: String).void }
+      #: (String path, String repo_uri, message: String) -> void
       def say_http_error(path, repo_uri, message:)
         say_error("\nCan't fetch file `#{path}` from #{repo_uri} (#{message})\n\n", :bold, :red)
         say_error(<<~ERROR)

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|

data/lib/tapioca/commands/command.rb

@@ -16,12 +16,13 @@ module Tapioca
 
       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
@@ -33,33 +34,20 @@ module Tapioca
       sig { abstract.void }
       def execute; end
 
-      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

@@ -8,7 +8,7 @@ module Tapioca
 
       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?
 
@@ -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)