Class: AbstractFileDownloadStrategy Abstract Private

Inherits:
AbstractDownloadStrategy show all
Defined in:
download_strategy.rb

Overview

This class is part of a private API. This class may only be used in the Homebrew/brew repository. Third parties should avoid using this class if possible, as it may be removed or changed without warning.

This class is abstract.

Abstract superclass for all download strategies downloading a single file.

Instance Attribute Summary

Attributes inherited from AbstractDownloadStrategy

#cache, #url

Instance Method Summary collapse

Methods inherited from AbstractDownloadStrategy

#clear_cache, #fetch, #initialize, #ohai, #quiet!, #quiet?, #source_modified_time, #stage

Methods included from Utils::Output::Mixin

#odebug, #odeprecated, #odie, #odisabled, #ofail, #oh1, #oh1_title, #ohai, #ohai_title, #onoe, #opoo, #opoo_outside_github_actions, #pretty_duration, #pretty_installed, #pretty_outdated, #pretty_uninstalled

Methods included from SystemCommand::Mixin

#system_command, #system_command!

Methods included from Context

current, current=, #debug?, #quiet?, #verbose?, #with_context

Constructor Details

This class inherits a constructor from AbstractDownloadStrategy

Instance Method Details

#basename ⇒ Pathname

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Returns:



342
343
344
 
# File 'download_strategy.rb', line 342

def basename
  cached_location.basename.sub(/^[\da-f]{64}--/, "")
end

#cached_location ⇒ Pathname

Path for storing the completed download.

Returns:



324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
 
# File 'download_strategy.rb', line 324

def cached_location
  return @cached_location if @cached_location

  url_sha256 = Digest::SHA256.hexdigest(url)
  downloads = Pathname.glob(HOMEBREW_CACHE/"downloads/#{url_sha256}--*")
                      .reject { |path| path.extname.end_with?(".incomplete") }

  @cached_location = T.let(
    if downloads.one?
      downloads.fetch(0)
    else
      HOMEBREW_CACHE/"downloads/#{url_sha256}--#{Utils.safe_filename(resolved_basename)}"
    end, T.nilable(Pathname)
  )
  T.must(@cached_location)
end

#symlink_location ⇒ Pathname

Path of the symlink (whose name includes the resource name, version and extension) pointing to #cached_location.

Returns:



312
313
314
315
316
317
318
 
# File 'download_strategy.rb', line 312

def symlink_location
  return T.must(@symlink_location) if defined?(@symlink_location)

  ext = Pathname(parse_basename(url)).extname
  @symlink_location = T.let(@cache/Utils.safe_filename("#{name}--#{version}#{ext}"), T.nilable(Pathname))
  T.must(@symlink_location)
end

#temporary_path ⇒ Pathname

Path for storing an incomplete download while the download is still in progress.

Returns:



303
304
305
 
# File 'download_strategy.rb', line 303

def temporary_path
  @temporary_path ||= T.let(Pathname.new("#{cached_location}.incomplete"), T.nilable(Pathname))
end