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 ```
68 lines
2.2 KiB
Ruby
68 lines
2.2 KiB
Ruby
# typed: true # rubocop:todo Sorbet/StrictSigil
|
|
# frozen_string_literal: true
|
|
|
|
module Cask
|
|
# Helper module for reading and writing cask metadata.
|
|
module Metadata
|
|
METADATA_SUBDIR = ".metadata"
|
|
TIMESTAMP_FORMAT = "%Y%m%d%H%M%S.%L"
|
|
|
|
def metadata_main_container_path(caskroom_path: self.caskroom_path)
|
|
caskroom_path.join(METADATA_SUBDIR)
|
|
end
|
|
|
|
def metadata_versioned_path(version: self.version, caskroom_path: self.caskroom_path)
|
|
cask_version = (version || :unknown).to_s
|
|
|
|
raise CaskError, "Cannot create metadata path with empty version." if cask_version.empty?
|
|
|
|
metadata_main_container_path(caskroom_path:).join(cask_version)
|
|
end
|
|
|
|
def metadata_timestamped_path(version: self.version, timestamp: :latest, create: false,
|
|
caskroom_path: self.caskroom_path)
|
|
raise CaskError, "Cannot create metadata path when timestamp is :latest." if create && timestamp == :latest
|
|
|
|
path = if timestamp == :latest
|
|
Pathname.glob(metadata_versioned_path(version:, caskroom_path:).join("*")).max
|
|
else
|
|
timestamp = new_timestamp if timestamp == :now
|
|
metadata_versioned_path(version:, caskroom_path:).join(timestamp)
|
|
end
|
|
|
|
if create && !path.directory?
|
|
odebug "Creating metadata directory: #{path}"
|
|
path.mkpath
|
|
end
|
|
|
|
path
|
|
end
|
|
|
|
def metadata_subdir(leaf, version: self.version, timestamp: :latest, create: false,
|
|
caskroom_path: self.caskroom_path)
|
|
raise CaskError, "Cannot create metadata subdir when timestamp is :latest." if create && timestamp == :latest
|
|
raise CaskError, "Cannot create metadata subdir for empty leaf." if !leaf.respond_to?(:empty?) || leaf.empty?
|
|
|
|
parent = metadata_timestamped_path(version:, timestamp:, create:,
|
|
caskroom_path:)
|
|
|
|
return if parent.nil?
|
|
|
|
subdir = parent.join(leaf)
|
|
|
|
if create && !subdir.directory?
|
|
odebug "Creating metadata subdirectory: #{subdir}"
|
|
subdir.mkpath
|
|
end
|
|
|
|
subdir
|
|
end
|
|
|
|
private
|
|
|
|
def new_timestamp(time = Time.now)
|
|
time.utc.strftime(TIMESTAMP_FORMAT)
|
|
end
|
|
end
|
|
end
|