Class: AbstractDownloadStrategy Abstract Private

Inherits:
Object
  • Object
show all
Extended by:
T::Helpers
Includes:
Context, FileUtils, SystemCommand::Mixin
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.

Instance Attribute Summary collapse

Instance Method Summary collapse

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:



54
55
56
57
58
59
60
61
62
63
64
 
# File 'download_strategy.rb', line 54

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:



40
41
42
 
# File 'download_strategy.rb', line 40

def cache
  @cache
end

#url ⇒ String (readonly)

The download URL.

Returns:



37
38
39
 
# File 'download_strategy.rb', line 37

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:



147
148
149
 
# File 'download_strategy.rb', line 147

def basename
  cached_location.basename
end

#cached_location ⇒ Pathname

This method is abstract.

Location of the cached download.

Returns:



76
 
# File 'download_strategy.rb', line 76

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.



142
143
144
 
# File 'download_strategy.rb', line 142

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) 


70
 
# File 'download_strategy.rb', line 70

def fetch(timeout: nil); end

#quiet! ⇒ void

This method returns an undefined value.

Disable any output during downloading.



82
83
84
 
# File 'download_strategy.rb', line 82

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) 


87
88
89
 
# File 'download_strategy.rb', line 87

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:



133
134
135
 
# File 'download_strategy.rb', line 133

def source_modified_time
  Pathname.pwd.to_enum(:find).select(&:file?).map(&:mtime).max
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.untyped) 


101
102
103
104
105
106
107
108
109
 
# File 'download_strategy.rb', line 101

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