Class: AbstractDownloadStrategy Abstract Private

Inherits:
Object
  • Object
show all
Extended by:
T::Helpers
Includes:
Context, FileUtils, SystemCommand::Mixin, Utils::Output::Mixin
Defined in:
download_strategy/abstract_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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Utils::Output::Mixin

#issue_reporting_message, #odebug, #odeprecated, #odie, #odisabled, #ofail, #oh1, #oh1_title, #ohai_title, #onoe, #opoo, #opoo_outside_github_actions, #pretty_deprecated, #pretty_disabled, #pretty_duration, #pretty_install_status, #pretty_installed, #pretty_outdated, #pretty_uninstalled, #pretty_upgradable

Methods included from SystemCommand::Mixin

#system_command, #system_command!

Methods included from Context

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

Constructor Details

#initialize(url, name, version, **meta) ⇒ void

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.

Parameters:



35
36
37
38
39
40
41
42
43
44
45
 
# File 'download_strategy/abstract_download_strategy.rb', line 35

def initialize(url, name, version, **meta)
  @cached_location = T.let(nil, T.nilable(Pathname))
  @ref_type = T.let(nil, T.nilable(Symbol))
  @ref = T.let(nil, T.untyped)
  @url = url
  @name = name
  @version = version
  @cache = T.let(meta.fetch(:cache, HOMEBREW_CACHE), Pathname)
  @meta = T.let(meta, T::Hash[Symbol, T.untyped])
  @quiet = T.let(false, T.nilable(T::Boolean))
end

Instance Attribute Details

#cache ⇒ Pathname (readonly)

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:



21
22
23
 
# File 'download_strategy/abstract_download_strategy.rb', line 21

def cache
  @cache
end

#url ⇒ String (readonly)

The download URL.

Returns:



18
19
20
 
# File 'download_strategy/abstract_download_strategy.rb', line 18

def url
  @url
end

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:



144
145
146
 
# File 'download_strategy/abstract_download_strategy.rb', line 144

def basename
  cached_location.basename
end

#cached_location ⇒ Pathname

This method is abstract.

Location of the cached download.

Returns:



65
 
# File 'download_strategy/abstract_download_strategy.rb', line 65

def cached_location; end

#clear_cache ⇒ void

This method returns an undefined value.

Remove #cached_location and any other files associated with the resource from the cache.



139
140
141
 
# File 'download_strategy/abstract_download_strategy.rb', line 139

def clear_cache
  rm_rf(cached_location)
end

#fetch(timeout: nil) ⇒ void

This method returns an undefined value.

Download and cache the resource at #cached_location.

Parameters:

  • timeout (Float, Integer, nil) (defaults to: nil) 


51
 
# File 'download_strategy/abstract_download_strategy.rb', line 51

def fetch(timeout: nil); end

#fetched_size ⇒ Integer?

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.

Total bytes downloaded if available.

Returns:



55
 
# File 'download_strategy/abstract_download_strategy.rb', line 55

def fetched_size; end

#ohai(title, *sput) ⇒ void

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.

This method returns an undefined value.

Parameters:

  • title (String, Exception)
  • sput (T.anything) 


149
150
151
 
# File 'download_strategy/abstract_download_strategy.rb', line 149

def ohai(title, *sput)
  super unless quiet?
end

#quiet! ⇒ void

This method returns an undefined value.

Disable any output during downloading.



71
72
73
 
# File 'download_strategy/abstract_download_strategy.rb', line 71

def quiet!
  @quiet = T.let(true, T.nilable(T::Boolean))
end

#quiet? ⇒ Boolean

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:

  • (Boolean) 


76
77
78
 
# File 'download_strategy/abstract_download_strategy.rb', line 76

def quiet?
  Context.current.quiet? || @quiet || false
end

#source_modified_time ⇒ Time

Returns the most recent modified time for all files in the current working directory after stage.

Returns:



124
125
126
 
# File 'download_strategy/abstract_download_strategy.rb', line 124

def source_modified_time
  Pathname.pwd.to_enum(:find).select(&:file?).map(&:mtime).max
end

#source_revision ⇒ String?

Return the checked out source revision for version control downloads.

Returns:



132
 
# File 'download_strategy/abstract_download_strategy.rb', line 132

def source_revision; end

#stage(&block) ⇒ void

This method returns an undefined value.

Unpack #cached_location into the current working directory.

Additionally, if a block is given, the working directory was previously empty and a single directory is extracted from the archive, the block will be called with the working directory changed to that directory. Otherwise this method will return, or the block will be called, without changing the current working directory.

Parameters:

  • block (T.proc.void, nil) 


90
91
92
93
94
95
96
97
98
 
# File 'download_strategy/abstract_download_strategy.rb', line 90

def stage(&block)
  UnpackStrategy.detect(cached_location,
                        prioritize_extension: true,
                        ref_type: @ref_type, ref: @ref)
                .extract_nestedly(basename:,
                                  prioritize_extension: true,
                                  verbose:              verbose? && !quiet?)
  chdir(&block) if block
end

#total_size ⇒ Integer?

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.

Total download size if available.

Returns:



59
 
# File 'download_strategy/abstract_download_strategy.rb', line 59

def total_size; end