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 ```
139 lines
4.1 KiB
Ruby
139 lines
4.1 KiB
Ruby
# typed: true # rubocop:todo Sorbet/StrictSigil
|
|
# frozen_string_literal: true
|
|
|
|
require "utils/user"
|
|
require "open3"
|
|
|
|
BUG_REPORTS_URL = "https://github.com/Homebrew/homebrew-cask#reporting-bugs"
|
|
|
|
module Cask
|
|
# Helper functions for various cask operations.
|
|
module Utils
|
|
def self.gain_permissions_mkpath(path, command: SystemCommand)
|
|
dir = path.ascend.find(&:directory?)
|
|
return if path == dir
|
|
|
|
if dir.writable?
|
|
path.mkpath
|
|
else
|
|
command.run!("/bin/mkdir", args: ["-p", "--", path], sudo: true, print_stderr: false)
|
|
end
|
|
end
|
|
|
|
def self.gain_permissions_rmdir(path, command: SystemCommand)
|
|
gain_permissions(path, [], command) do |p|
|
|
if p.parent.writable?
|
|
FileUtils.rmdir p
|
|
else
|
|
command.run!("/bin/rmdir", args: ["--", p], sudo: true, print_stderr: false)
|
|
end
|
|
end
|
|
end
|
|
|
|
def self.gain_permissions_remove(path, command: SystemCommand)
|
|
directory = false
|
|
permission_flags = if path.symlink?
|
|
["-h"]
|
|
elsif path.directory?
|
|
directory = true
|
|
["-R"]
|
|
elsif path.exist?
|
|
[]
|
|
else
|
|
# Nothing to remove.
|
|
return
|
|
end
|
|
|
|
gain_permissions(path, permission_flags, command) do |p|
|
|
if p.parent.writable?
|
|
if directory
|
|
p.rmtree
|
|
else
|
|
FileUtils.rm_f p
|
|
end
|
|
else
|
|
recursive_flag = directory ? ["-R"] : []
|
|
command.run!("/bin/rm", args: recursive_flag + ["-f", "--", p], sudo: true, print_stderr: false)
|
|
end
|
|
end
|
|
end
|
|
|
|
def self.gain_permissions(path, command_args, command)
|
|
tried_permissions = false
|
|
tried_ownership = false
|
|
begin
|
|
yield path
|
|
rescue
|
|
# in case of permissions problems
|
|
unless tried_permissions
|
|
print_stderr = Context.current.debug? || Context.current.verbose?
|
|
# TODO: Better handling for the case where path is a symlink.
|
|
# The `-h` and `-R` flags cannot be combined and behavior is
|
|
# dependent on whether the file argument has a trailing
|
|
# slash. This should do the right thing, but is fragile.
|
|
command.run("/usr/bin/chflags",
|
|
print_stderr:,
|
|
args: command_args + ["--", "000", path])
|
|
command.run("/bin/chmod",
|
|
print_stderr:,
|
|
args: command_args + ["--", "u+rwx", path])
|
|
command.run("/bin/chmod",
|
|
print_stderr:,
|
|
args: command_args + ["-N", path])
|
|
tried_permissions = true
|
|
retry # rmtree
|
|
end
|
|
|
|
unless tried_ownership
|
|
# in case of ownership problems
|
|
# TODO: Further examine files to see if ownership is the problem
|
|
# before using `sudo` and `chown`.
|
|
ohai "Using sudo to gain ownership of path '#{path}'"
|
|
command.run("/usr/sbin/chown",
|
|
args: command_args + ["--", User.current, path],
|
|
sudo: true)
|
|
tried_ownership = true
|
|
# retry chflags/chmod after chown
|
|
tried_permissions = false
|
|
retry # rmtree
|
|
end
|
|
|
|
raise
|
|
end
|
|
end
|
|
|
|
sig { params(path: Pathname).returns(T::Boolean) }
|
|
def self.path_occupied?(path)
|
|
path.exist? || path.symlink?
|
|
end
|
|
|
|
sig { params(name: String).returns(String) }
|
|
def self.token_from(name)
|
|
name.downcase
|
|
.gsub("+", "-plus-")
|
|
.gsub("@", "-at-")
|
|
.gsub(/[ _·•]/, "-")
|
|
.gsub(/[^\w-]/, "")
|
|
.gsub(/--+/, "-")
|
|
.delete_prefix("-")
|
|
.delete_suffix("-")
|
|
end
|
|
|
|
sig { returns(String) }
|
|
def self.error_message_with_suggestions
|
|
<<~EOS
|
|
Follow the instructions here:
|
|
#{Formatter.url(BUG_REPORTS_URL)}
|
|
EOS
|
|
end
|
|
|
|
def self.method_missing_message(method, token, section = nil)
|
|
message = +"Unexpected method '#{method}' called "
|
|
message << "during #{section} " if section
|
|
message << "on Cask #{token}."
|
|
|
|
ofail "#{message}\n#{error_message_with_suggestions}"
|
|
end
|
|
end
|
|
end
|