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 ```
115 lines
2.7 KiB
Ruby
115 lines
2.7 KiB
Ruby
# typed: true # rubocop:todo Sorbet/StrictSigil
|
|
# frozen_string_literal: true
|
|
|
|
require "downloadable"
|
|
require "fileutils"
|
|
require "cask/cache"
|
|
require "cask/quarantine"
|
|
|
|
module Cask
|
|
# A download corresponding to a {Cask}.
|
|
class Download < ::Downloadable
|
|
include Context
|
|
|
|
attr_reader :cask
|
|
|
|
def initialize(cask, quarantine: nil)
|
|
super()
|
|
|
|
@cask = cask
|
|
@quarantine = quarantine
|
|
end
|
|
|
|
sig { override.returns(T.nilable(::URL)) }
|
|
def url
|
|
return if cask.url.nil?
|
|
|
|
@url ||= ::URL.new(cask.url.to_s, cask.url.specs)
|
|
end
|
|
|
|
sig { override.returns(T.nilable(::Checksum)) }
|
|
def checksum
|
|
@checksum ||= cask.sha256 if cask.sha256 != :no_check
|
|
end
|
|
|
|
sig { override.returns(T.nilable(Version)) }
|
|
def version
|
|
return if cask.version.nil?
|
|
|
|
@version ||= Version.new(cask.version)
|
|
end
|
|
|
|
sig {
|
|
override
|
|
.params(quiet: T.nilable(T::Boolean),
|
|
verify_download_integrity: T::Boolean,
|
|
timeout: T.nilable(T.any(Integer, Float)))
|
|
.returns(Pathname)
|
|
}
|
|
def fetch(quiet: nil, verify_download_integrity: true, timeout: nil)
|
|
downloader.quiet! if quiet
|
|
|
|
begin
|
|
super(verify_download_integrity: false, timeout:)
|
|
rescue DownloadError => e
|
|
error = CaskError.new("Download failed on Cask '#{cask}' with message: #{e.cause}")
|
|
error.set_backtrace e.backtrace
|
|
raise error
|
|
end
|
|
|
|
downloaded_path = cached_download
|
|
quarantine(downloaded_path)
|
|
self.verify_download_integrity(downloaded_path) if verify_download_integrity
|
|
downloaded_path
|
|
end
|
|
|
|
def time_file_size(timeout: nil)
|
|
raise ArgumentError, "not supported for this download strategy" unless downloader.is_a?(CurlDownloadStrategy)
|
|
|
|
T.cast(downloader, CurlDownloadStrategy).resolved_time_file_size(timeout:)
|
|
end
|
|
|
|
def basename
|
|
downloader.basename
|
|
end
|
|
|
|
sig { override.params(filename: Pathname).void }
|
|
def verify_download_integrity(filename)
|
|
if @cask.sha256 == :no_check
|
|
opoo "No checksum defined for cask '#{@cask}', skipping verification."
|
|
return
|
|
end
|
|
|
|
super
|
|
end
|
|
|
|
sig { override.returns(String) }
|
|
def download_name
|
|
cask.token
|
|
end
|
|
|
|
private
|
|
|
|
def quarantine(path)
|
|
return if @quarantine.nil?
|
|
return unless Quarantine.available?
|
|
|
|
if @quarantine
|
|
Quarantine.cask!(cask: @cask, download_path: path)
|
|
else
|
|
Quarantine.release!(download_path: path)
|
|
end
|
|
end
|
|
|
|
sig { override.returns(T.nilable(::URL)) }
|
|
def determine_url
|
|
url
|
|
end
|
|
|
|
sig { override.returns(Pathname) }
|
|
def cache
|
|
Cache.path
|
|
end
|
|
end
|
|
end
|