mirror of
https://github.com/Homebrew/brew.git
synced 2025-07-14 16:09:03 +08:00

- 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 ```
105 lines
3.2 KiB
Ruby
105 lines
3.2 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
|
|
# Superclass for all artifacts which have a source and a target location.
|
|
class Relocated < AbstractArtifact
|
|
def self.from_args(cask, *args)
|
|
source_string, target_hash = args
|
|
|
|
if target_hash
|
|
raise CaskInvalidError, cask unless target_hash.respond_to?(:keys)
|
|
|
|
target_hash.assert_valid_keys(:target)
|
|
end
|
|
|
|
target_hash ||= {}
|
|
|
|
new(cask, source_string, **target_hash)
|
|
end
|
|
|
|
def resolve_target(target, base_dir: config.public_send(self.class.dirmethod))
|
|
target = Pathname(target)
|
|
|
|
if target.relative?
|
|
return target.expand_path if target.descend.first.to_s == "~"
|
|
return base_dir/target if base_dir
|
|
end
|
|
|
|
target
|
|
end
|
|
|
|
sig {
|
|
params(cask: Cask, source: T.nilable(T.any(String, Pathname)), target_hash: T.any(String, Pathname))
|
|
.void
|
|
}
|
|
def initialize(cask, source, **target_hash)
|
|
super
|
|
|
|
target = target_hash[:target]
|
|
@source_string = source.to_s
|
|
@target_string = target.to_s
|
|
end
|
|
|
|
def source
|
|
@source ||= begin
|
|
base_path = cask.staged_path
|
|
base_path = base_path.join(cask.url.only_path) if cask.url&.only_path.present?
|
|
base_path.join(@source_string)
|
|
end
|
|
end
|
|
|
|
def target
|
|
@target ||= resolve_target(@target_string.presence || source.basename)
|
|
end
|
|
|
|
def to_a
|
|
[@source_string].tap do |ary|
|
|
ary << { target: @target_string } unless @target_string.empty?
|
|
end
|
|
end
|
|
|
|
sig { override.returns(String) }
|
|
def summarize
|
|
target_string = @target_string.empty? ? "" : " -> #{@target_string}"
|
|
"#{@source_string}#{target_string}"
|
|
end
|
|
|
|
private
|
|
|
|
ALT_NAME_ATTRIBUTE = "com.apple.metadata:kMDItemAlternateNames"
|
|
|
|
# Try to make the asset searchable under the target name. Spotlight
|
|
# respects this attribute for many filetypes, but ignores it for App
|
|
# bundles. Alfred 2.2 respects it even for App bundles.
|
|
def add_altname_metadata(file, altname, command: nil)
|
|
return if altname.to_s.casecmp(file.basename.to_s).zero?
|
|
|
|
odebug "Adding #{ALT_NAME_ATTRIBUTE} metadata"
|
|
altnames = command.run("/usr/bin/xattr",
|
|
args: ["-p", ALT_NAME_ATTRIBUTE, file],
|
|
print_stderr: false).stdout.sub(/\A\((.*)\)\Z/, '\1')
|
|
odebug "Existing metadata is: #{altnames}"
|
|
altnames.concat(", ") unless altnames.empty?
|
|
altnames.concat(%Q("#{altname}"))
|
|
altnames = "(#{altnames})"
|
|
|
|
# Some packages are shipped as u=rx (e.g. Bitcoin Core)
|
|
command.run!("/bin/chmod", args: ["--", "u+rw", file, file.realpath])
|
|
|
|
command.run!("/usr/bin/xattr",
|
|
args: ["-w", ALT_NAME_ATTRIBUTE, altnames, file],
|
|
print_stderr: false)
|
|
end
|
|
|
|
def printable_target
|
|
target.to_s.sub(/^#{Dir.home}(#{File::SEPARATOR}|$)/, "~/")
|
|
end
|
|
end
|
|
end
|
|
end
|