cask/artifact: enable Sorbet typed: strict

Enable strict typing for the abstract base classes in `Cask::Artifact`:
- `AbstractArtifact`
- `AbstractFlightBlock`
- `AbstractUninstall`
- `Relocated`

This adds proper type signatures to all methods and updates the typing
level from `typed: true` to `typed: strict`.

Also marks `english_name` and `dirmethod` as `overridable` in
`AbstractArtifact` and adds `override` to subclasses that override them.

Advances #17297

Author: dduugg

Library/Homebrew/bundle.rb

@@ -101,7 +101,7 @@ def which_formula?(name)
         which(name).present?
       end
 
-      sig { params(block: T.proc.returns(T.anything)).returns(T.untyped) }
+      sig { type_parameters(:U).params(block: T.proc.returns(T.type_parameter(:U))).returns(T.type_parameter(:U)) }
       def exchange_uid_if_needed!(&block)
         euid = Process.euid
         uid = Process.uid

Library/Homebrew/cache_store.rb

@@ -22,9 +22,9 @@ class CacheStoreDatabase
       .returns(T.type_parameter(:U))
   }
   def self.use(type, &_blk)
-    @db_type_reference_hash ||= T.let({}, T.nilable(T::Hash[T.untyped, T.untyped]))
-    @db_type_reference_hash[type] ||= {}
-    type_ref = @db_type_reference_hash[type]
+    @db_type_reference_hash ||= T.let({}, T.nilable(T::Hash[Symbol, { count: Integer, db: CacheStoreDatabase }]))
+    @db_type_reference_hash[type] ||= { count: 0, db: CacheStoreDatabase.new(type) }
+    type_ref = @db_type_reference_hash.fetch(type)
 
     type_ref[:count] ||= 0
     type_ref[:count]  += 1

Library/Homebrew/cask/artifact/app.rb

@@ -8,7 +8,7 @@ module Artifact
     # Artifact corresponding to the `app` stanza.
     class App < Moved
       sig {
-        params(
+        override.params(
           adopt:        T::Boolean,
           auto_updates: T.nilable(T::Boolean),
           force:        T::Boolean,

Library/Homebrew/cask/artifact/artifact.rb

@@ -12,20 +12,21 @@ def self.english_name
         "Generic Artifact"
       end
 
-      sig { params(cask: Cask, args: T.untyped).returns(T.attached_class) }
-      def self.from_args(cask, *args)
-        source, options = args
-
+      sig { params(cask: Cask, source: T.nilable(String), target_hash: T.anything).returns(Relocated) }
+      def self.from_args(cask, source = nil, **target_hash)
         raise CaskInvalidError.new(cask.token, "No source provided for #{english_name}.") if source.blank?
 
-        unless options&.key?(:target)
+        unless target_hash.key?(:target)
           raise CaskInvalidError.new(cask.token, "#{english_name} '#{source}' requires a target.")
         end
 
-        new(cask, source, **options)
+        new(cask, source, **target_hash)
       end
 
-      sig { params(target: T.any(String, Pathname)).returns(Pathname) }
+      # FIXME: This is a pre-existing violation
+      # rubocop:disable Sorbet/AllowIncompatibleOverride
+      sig { override(allow_incompatible: true).params(target: T.any(String, Pathname)).returns(Pathname) }
+      # rubocop:enable Sorbet/AllowIncompatibleOverride
       def resolve_target(target)
         super(target, base_dir: nil)
       end

Library/Homebrew/cask/artifact/bashcompletion.rb

@@ -7,7 +7,10 @@ module Cask
   module Artifact
     # Artifact corresponding to the `bash_completion` stanza.
     class BashCompletion < ShellCompletion
-      sig { params(target: T.any(String, Pathname)).returns(Pathname) }
+      # FIXME: This is a pre-existing violation
+      # rubocop:disable Sorbet/AllowIncompatibleOverride
+      sig { override(allow_incompatible: true).params(target: T.any(String, Pathname)).returns(Pathname) }
+      # rubocop:enable Sorbet/AllowIncompatibleOverride
       def resolve_target(target)
         name = if File.extname(target).nil?
           target

Library/Homebrew/cask/artifact/binary.rb

@@ -1,4 +1,4 @@
-# typed: true # rubocop:todo Sorbet/StrictSigil
+# typed: strict
 # frozen_string_literal: true
 
 require "cask/artifact/symlinked"
@@ -7,7 +7,8 @@ module Cask
   module Artifact
     # Artifact corresponding to the `binary` stanza.
     class Binary < Symlinked
-      def link(command: nil, **options)
+      sig { override.params(command: T.class_of(SystemCommand), force: T::Boolean, adopt: T::Boolean, _options: T.anything).void }
+      def link(command:, force: false, adopt: false, **_options)
         super
         return if source.executable?
 

Library/Homebrew/cask/artifact/fishcompletion.rb

@@ -7,7 +7,10 @@ module Cask
   module Artifact
     # Artifact corresponding to the `fish_completion` stanza.
     class FishCompletion < ShellCompletion
-      sig { params(target: T.any(String, Pathname)).returns(Pathname) }
+      # FIXME: This is a pre-existing violation
+      # rubocop:disable Sorbet/AllowIncompatibleOverride
+      sig { override(allow_incompatible: true).params(target: T.any(String, Pathname)).returns(Pathname) }
+      # rubocop:enable Sorbet/AllowIncompatibleOverride
       def resolve_target(target)
         name = if target.to_s.end_with? ".fish"
           target

Library/Homebrew/cask/artifact/installer.rb

@@ -1,4 +1,4 @@
-# typed: true # rubocop:todo Sorbet/StrictSigil
+# typed: strict
 # frozen_string_literal: true
 
 require "cask/artifact/abstract_artifact"
@@ -8,12 +8,13 @@ module Cask
   module Artifact
     # Artifact corresponding to the `installer` stanza.
     class Installer < AbstractArtifact
-      VALID_KEYS = Set.new([
-        :manual,
-        :script,
-      ]).freeze
+      VALID_KEYS = T.let(
+        Set.new([:manual, :script]).freeze,
+        T::Set[Symbol],
+      )
 
-      def install_phase(command: nil, **_)
+      sig { params(command: T.class_of(SystemCommand), _options: T.anything).void }
+      def install_phase(command:, **_options)
         if manual_install
           puts <<~EOS
             Cask #{cask} only provides a manual installer. To run it and complete the installation:
@@ -35,6 +36,7 @@ def install_phase(command: nil, **_)
         end
       end
 
+      sig { params(cask: Cask, args: DirectivesType).returns(Installer) }
       def self.from_args(cask, **args)
         raise CaskInvalidError.new(cask, "'installer' stanza requires an argument.") if args.empty?
 
@@ -59,18 +61,23 @@ def self.from_args(cask, **args)
         new(cask, **args)
       end
 
-      attr_reader :path, :args
+      sig { returns(Pathname) }
+      attr_reader :path
+
+      sig { returns(T::Hash[Symbol, DirectivesType]) }
+      attr_reader :args
 
       sig { returns(T::Boolean) }
       attr_reader :manual_install
 
+      sig { params(cask: Cask, args: DirectivesType).void }
       def initialize(cask, **args)
         super
 
-        if args.key?(:manual)
-          @path = Pathname(args[:manual])
-          @args = []
-          @manual_install = true
+        if (manual = T.cast(args[:manual], T.nilable(String)))
+          @path = T.let(Pathname(manual), Pathname)
+          @args = T.let({}, T::Hash[Symbol, DirectivesType])
+          @manual_install = T.let(true, T::Boolean)
         else
           path, @args = self.class.read_script_arguments(
             args[:script], self.class.dsl_key.to_s, { must_succeed: true, sudo: false }, print_stdout: true
@@ -85,10 +92,9 @@ def initialize(cask, **args)
       sig { override.returns(String) }
       def summarize = path.to_s
 
+      sig { returns(T::Hash[Symbol, T.anything]) }
       def to_h
-        { path: }.tap do |h|
-          h[:args] = args unless manual_install
-        end
+        manual_install ? { path: } : { path:, args: }
       end
     end
   end

Library/Homebrew/cask/artifact/keyboard_layout.rb

@@ -1,4 +1,4 @@
-# typed: true # rubocop:todo Sorbet/StrictSigil
+# typed: strict
 # frozen_string_literal: true
 
 require "cask/artifact/moved"
@@ -7,19 +7,22 @@ module Cask
   module Artifact
     # Artifact corresponding to the `keyboard_layout` stanza.
     class KeyboardLayout < Moved
-      def install_phase(**options)
+      sig { override.params(command: T.class_of(SystemCommand), options: T.anything).void }
+      def install_phase(command:, **options)
         super
         delete_keyboard_layout_cache(**options)
       end
 
-      def uninstall_phase(**options)
+      sig { override.params(command: T.class_of(SystemCommand), options: T.anything).void }
+      def uninstall_phase(command:, **options)
         super
         delete_keyboard_layout_cache(**options)
       end
 
       private
 
-      def delete_keyboard_layout_cache(command: nil, **_)
+      sig { params(command: T.class_of(SystemCommand), _options: T.anything).void }
+      def delete_keyboard_layout_cache(command:, **_options)
         command.run!(
           "/bin/rm",
           args:         ["-f", "--", "/System/Library/Caches/com.apple.IntlDataCache.le*"],

Library/Homebrew/cask/artifact/manpage.rb

@@ -1,4 +1,4 @@
-# typed: true # rubocop:todo Sorbet/StrictSigil
+# typed: strict
 # frozen_string_literal: true
 
 require "cask/artifact/symlinked"
@@ -7,22 +7,29 @@ module Cask
   module Artifact
     # Artifact corresponding to the `manpage` stanza.
     class Manpage < Symlinked
+      sig { returns(String) }
       attr_reader :section
 
-      def self.from_args(cask, source)
+      sig { params(cask: Cask, source: String, _target_hash: T.anything).returns(Manpage) }
+      def self.from_args(cask, source, **_target_hash)
         section = source.to_s[/\.([1-8]|n|l)(?:\.gz)?$/, 1]
 
         raise CaskInvalidError, "'#{source}' is not a valid man page name" unless section
 
-        new(cask, source, section)
+        new(cask, T.must(source), section)
       end
 
+      sig { params(cask: Cask, source: String, section: String).void }
       def initialize(cask, source, section)
         @section = section
 
         super(cask, source)
       end
 
+      # FIXME: This is a pre-existing violation
+      # rubocop:disable Sorbet/AllowIncompatibleOverride
+      sig { override(allow_incompatible: true).params(target: T.any(String, Pathname)).returns(Pathname) }
+      # rubocop:enable Sorbet/AllowIncompatibleOverride
       def resolve_target(target)
         config.manpagedir.join("man#{section}", target)
       end