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 ```
84 lines
2.8 KiB
Ruby
84 lines
2.8 KiB
Ruby
# typed: true # rubocop:todo Sorbet/StrictSigil
|
|
# frozen_string_literal: true
|
|
|
|
require "cask/cask_loader"
|
|
require "utils/inreplace"
|
|
|
|
module Cask
|
|
class Migrator
|
|
attr_reader :old_cask, :new_cask
|
|
|
|
sig { params(old_cask: Cask, new_cask: Cask).void }
|
|
def initialize(old_cask, new_cask)
|
|
raise CaskNotInstalledError, new_cask unless new_cask.installed?
|
|
|
|
@old_cask = old_cask
|
|
@new_cask = new_cask
|
|
end
|
|
|
|
sig { params(new_cask: Cask, dry_run: T::Boolean).void }
|
|
def self.migrate_if_needed(new_cask, dry_run: false)
|
|
old_tokens = new_cask.old_tokens
|
|
return if old_tokens.empty?
|
|
|
|
return unless (installed_caskfile = new_cask.installed_caskfile)
|
|
|
|
old_cask = CaskLoader.load(installed_caskfile)
|
|
return if new_cask.token == old_cask.token
|
|
|
|
migrator = new(old_cask, new_cask)
|
|
migrator.migrate(dry_run:)
|
|
end
|
|
|
|
sig { params(dry_run: T::Boolean).void }
|
|
def migrate(dry_run: false)
|
|
old_token = old_cask.token
|
|
new_token = new_cask.token
|
|
|
|
old_caskroom_path = old_cask.caskroom_path
|
|
new_caskroom_path = new_cask.caskroom_path
|
|
|
|
old_installed_caskfile = old_cask.installed_caskfile.relative_path_from(old_caskroom_path)
|
|
new_installed_caskfile = old_installed_caskfile.dirname/old_installed_caskfile.basename.sub(
|
|
old_token,
|
|
new_token,
|
|
)
|
|
|
|
if dry_run
|
|
oh1 "Would migrate cask #{Formatter.identifier(old_token)} to #{Formatter.identifier(new_token)}"
|
|
|
|
puts "cp -r #{old_caskroom_path} #{new_caskroom_path}"
|
|
puts "mv #{new_caskroom_path}/#{old_installed_caskfile} #{new_caskroom_path}/#{new_installed_caskfile}"
|
|
puts "rm -r #{old_caskroom_path}"
|
|
puts "ln -s #{new_caskroom_path.basename} #{old_caskroom_path}"
|
|
else
|
|
oh1 "Migrating cask #{Formatter.identifier(old_token)} to #{Formatter.identifier(new_token)}"
|
|
|
|
begin
|
|
FileUtils.cp_r old_caskroom_path, new_caskroom_path
|
|
FileUtils.mv new_caskroom_path/old_installed_caskfile, new_caskroom_path/new_installed_caskfile
|
|
self.class.replace_caskfile_token(new_caskroom_path/new_installed_caskfile, old_token, new_token)
|
|
rescue => e
|
|
FileUtils.rm_rf new_caskroom_path
|
|
raise e
|
|
end
|
|
|
|
FileUtils.rm_r old_caskroom_path
|
|
FileUtils.ln_s new_caskroom_path.basename, old_caskroom_path
|
|
end
|
|
end
|
|
|
|
sig { params(path: Pathname, old_token: String, new_token: String).void }
|
|
def self.replace_caskfile_token(path, old_token, new_token)
|
|
case path.extname
|
|
when ".rb"
|
|
::Utils::Inreplace.inreplace path, /\A\s*cask\s+"#{Regexp.escape(old_token)}"/, "cask #{new_token.inspect}"
|
|
when ".json"
|
|
json = JSON.parse(path.read)
|
|
json["token"] = new_token
|
|
path.atomic_write json.to_json
|
|
end
|
|
end
|
|
end
|
|
end
|