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 ```
86 lines
2.5 KiB
Ruby
86 lines
2.5 KiB
Ruby
# typed: true # rubocop:todo Sorbet/StrictSigil
|
|
# frozen_string_literal: true
|
|
|
|
require "cask/artifact/relocated"
|
|
|
|
module Cask
|
|
module Artifact
|
|
# Superclass for all artifacts which are installed by symlinking them to the target location.
|
|
class Symlinked < Relocated
|
|
sig { returns(String) }
|
|
def self.link_type_english_name
|
|
"Symlink"
|
|
end
|
|
|
|
sig { returns(String) }
|
|
def self.english_description
|
|
"#{english_name} #{link_type_english_name}s"
|
|
end
|
|
|
|
def install_phase(**options)
|
|
link(**options)
|
|
end
|
|
|
|
def uninstall_phase(**options)
|
|
unlink(**options)
|
|
end
|
|
|
|
def summarize_installed
|
|
if target.symlink? && target.exist? && target.readlink.exist?
|
|
"#{printable_target} -> #{target.readlink} (#{target.readlink.abv})"
|
|
else
|
|
string = if target.symlink?
|
|
"#{printable_target} -> #{target.readlink}"
|
|
else
|
|
printable_target
|
|
end
|
|
|
|
Formatter.error(string, label: "Broken Link")
|
|
end
|
|
end
|
|
|
|
private
|
|
|
|
def link(force: false, adopt: false, command: nil, **_options)
|
|
unless source.exist?
|
|
raise CaskError,
|
|
"It seems the #{self.class.link_type_english_name.downcase} " \
|
|
"source '#{source}' is not there."
|
|
end
|
|
|
|
if target.exist?
|
|
message = "It seems there is already #{self.class.english_article} " \
|
|
"#{self.class.english_name} at '#{target}'"
|
|
|
|
if (force || adopt) && target.symlink? &&
|
|
(target.realpath == source.realpath || target.realpath.to_s.start_with?("#{cask.caskroom_path}/"))
|
|
opoo "#{message}; overwriting."
|
|
Utils.gain_permissions_remove(target, command:)
|
|
else
|
|
raise CaskError, "#{message}."
|
|
end
|
|
end
|
|
|
|
ohai "Linking #{self.class.english_name} '#{source.basename}' to '#{target}'"
|
|
create_filesystem_link(command:)
|
|
end
|
|
|
|
def unlink(command: nil, **)
|
|
return unless target.symlink?
|
|
|
|
ohai "Unlinking #{self.class.english_name} '#{target}'"
|
|
Utils.gain_permissions_remove(target, command:)
|
|
end
|
|
|
|
def create_filesystem_link(command: nil)
|
|
Utils.gain_permissions_mkpath(target.dirname, command:)
|
|
|
|
command.run! "/bin/ln", args: ["-h", "-f", "-s", "--", source, target],
|
|
sudo: !target.dirname.writable?
|
|
|
|
add_altname_metadata(source, target.basename, command:)
|
|
end
|
|
end
|
|
end
|
|
end
|