Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make Cask::Artifact::Installer typesafe #18020

Merged
merged 1 commit into from
Aug 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 19 additions & 26 deletions Library/Homebrew/cask/artifact/installer.rb
Original file line number Diff line number Diff line change
Expand Up @@ -13,22 +13,14 @@ class Installer < AbstractArtifact
:script,
]).freeze

# Extension module for manual installers.
module ManualInstaller
def install_phase(**)
def install_phase(command: nil, **_)
if manual_install
puts <<~EOS
Cask #{cask} only provides a manual installer. To run it and complete the installation:
open #{cask.staged_path.join(path).to_s.shellescape}
EOS
end
end

# Extension module for script installers.
module ScriptInstaller
def install_phase(command: nil, **_)
# TODO: The `T.unsafe` is a false positive that is unnecessary in newer releasese of Sorbet
# (confirmend with sorbet v0.5.10672)
ohai "Running #{T.unsafe(self.class).dsl_key} script '#{path}'"
else
ohai "Running #{self.class.dsl_key} script '#{path}'"

executable_path = staged_path_join_executable(path)

Expand Down Expand Up @@ -69,32 +61,33 @@ def self.from_args(cask, **args)

attr_reader :path, :args

sig { returns(T::Boolean) }
attr_reader :manual_install

def initialize(cask, **args)
super

if args.key?(:manual)
@path = Pathname(args[:manual])
@args = []
extend(ManualInstaller)
return
end

path, @args = self.class.read_script_arguments(
args[:script], self.class.dsl_key.to_s, { must_succeed: true, sudo: false }, print_stdout: true
)
raise CaskInvalidError.new(cask, "#{self.class.dsl_key} missing executable") if path.nil?
@manual_install = true
else
path, @args = self.class.read_script_arguments(
args[:script], self.class.dsl_key.to_s, { must_succeed: true, sudo: false }, print_stdout: true
)
raise CaskInvalidError.new(cask, "#{self.class.dsl_key} missing executable") if path.nil?

@path = Pathname(path)
extend(ScriptInstaller)
@path = Pathname(path)
@manual_install = false
end
end

def summarize
path.to_s
end
sig { override.returns(String) }
def summarize = path.to_s

def to_h
{ path: }.tap do |h|
h[:args] = args unless is_a?(ManualInstaller)
h[:args] = args unless manual_install
end
end
end
Expand Down
11 changes: 0 additions & 11 deletions Library/Homebrew/cask/artifact/installer.rbi

This file was deleted.

4 changes: 3 additions & 1 deletion Library/Homebrew/cask/upgrade.rb
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,9 @@ def self.upgrade_casks(
end

manual_installer_casks = outdated_casks.select do |cask|
cask.artifacts.any?(Artifact::Installer::ManualInstaller)
cask.artifacts.any? do |artifact|
artifact.is_a?(Artifact::Installer) && artifact.manual_install
end
end

if manual_installer_casks.present?
Expand Down
2 changes: 1 addition & 1 deletion Library/Homebrew/test/cask/dsl_spec.rb
Original file line number Diff line number Diff line change
Expand Up @@ -501,7 +501,7 @@ def caveats

it "allows installer manual to be specified" do
installer = cask.artifacts.first
expect(installer).to be_a(Cask::Artifact::Installer::ManualInstaller)
expect(installer.instance_variable_get(:@manual_install)).to be true
expect(installer.path).to eq(Pathname("Caffeine.app"))
end
end
Expand Down