mirror of
https://github.com/Homebrew/brew.git
synced 2025-07-14 16:09:03 +08:00
45978435e7
- Previously I thought that comments were fine to discourage people from wasting their time trying to bump things that used `undef` that Sorbet didn't support. But RuboCop is better at this since it'll complain if the comments are unnecessary. - Suggested in https://github.com/Homebrew/brew/pull/18018#issuecomment-2283369501. - I've gone for a mixture of `rubocop:disable` for the files that can't be `typed: strict` (use of undef, required before everything else, etc) and `rubocop:todo` for everything else that should be tried to make strictly typed. There's no functional difference between the two as `rubocop:todo` is `rubocop:disable` with a different name. - And I entirely disabled the cop for the docs/ directory since `typed: strict` isn't going to gain us anything for some Markdown linting config files. - This means that now it's easier to track what needs to be done rather than relying on checklists of files in our big Sorbet issue: ```shell $ git grep 'typed: true # rubocop:todo Sorbet/StrictSigil' | wc -l 268 ``` - And this is confirmed working for new files: ```shell $ git status On branch use-rubocop-for-sorbet-strict-sigils Untracked files: (use "git add <file>..." to include in what will be committed) Library/Homebrew/bad.rb Library/Homebrew/good.rb nothing added to commit but untracked files present (use "git add" to track) $ brew style Offenses: bad.rb:1:1: C: Sorbet/StrictSigil: Sorbet sigil should be at least strict got true. ^^^^^^^^^^^^^ 1340 files inspected, 1 offense detected ```
103 lines
2.9 KiB
Ruby
103 lines
2.9 KiB
Ruby
# typed: true # rubocop:todo Sorbet/StrictSigil
|
|
# frozen_string_literal: true
|
|
|
|
require "cask/artifact/abstract_artifact"
|
|
require "extend/hash/keys"
|
|
|
|
module Cask
|
|
module Artifact
|
|
# Artifact corresponding to the `installer` stanza.
|
|
class Installer < AbstractArtifact
|
|
VALID_KEYS = Set.new([
|
|
:manual,
|
|
:script,
|
|
]).freeze
|
|
|
|
# Extension module for manual installers.
|
|
module ManualInstaller
|
|
def install_phase(**)
|
|
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}'"
|
|
|
|
executable_path = staged_path_join_executable(path)
|
|
|
|
command.run!(
|
|
executable_path,
|
|
**args,
|
|
env: { "PATH" => PATH.new(
|
|
HOMEBREW_PREFIX/"bin", HOMEBREW_PREFIX/"sbin", ENV.fetch("PATH")
|
|
) },
|
|
reset_uid: true,
|
|
)
|
|
end
|
|
end
|
|
|
|
def self.from_args(cask, **args)
|
|
raise CaskInvalidError.new(cask, "'installer' stanza requires an argument.") if args.empty?
|
|
|
|
if args.key?(:script) && !args[:script].respond_to?(:key?)
|
|
if args.key?(:executable)
|
|
raise CaskInvalidError.new(cask, "'installer' stanza gave arguments for both :script and :executable.")
|
|
end
|
|
|
|
args[:executable] = args[:script]
|
|
args.delete(:script)
|
|
args = { script: args }
|
|
end
|
|
|
|
if args.keys.count != 1
|
|
raise CaskInvalidError.new(
|
|
cask,
|
|
"invalid 'installer' stanza: Only one of #{VALID_KEYS.inspect} is permitted.",
|
|
)
|
|
end
|
|
|
|
args.assert_valid_keys(*VALID_KEYS)
|
|
new(cask, **args)
|
|
end
|
|
|
|
attr_reader :path, :args
|
|
|
|
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?
|
|
|
|
@path = Pathname(path)
|
|
extend(ScriptInstaller)
|
|
end
|
|
|
|
def summarize
|
|
path.to_s
|
|
end
|
|
|
|
def to_h
|
|
{ path: }.tap do |h|
|
|
h[:args] = args unless is_a?(ManualInstaller)
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|