Class: AbstractDownloadStrategy Abstract Private

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

Defined Under Namespace

Modules: Pourable

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Context

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

Constructor Details

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

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 a new instance of AbstractDownloadStrategy.



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

def initialize(url, name, version, **meta)
  @url = url
  @name = name
  @version = version
  @cache = meta.fetch(:cache, HOMEBREW_CACHE)
  @meta = meta
  @quiet = false
  extend Pourable if meta[:bottle]
end

Instance Attribute Details

#cache ⇒ Object (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. 



53
54
55
 
# File 'download_strategy.rb', line 53

def cache
  @cache
end

#cached_location ⇒ Pathname (readonly)

Location of the cached download.

Returns:



51
52
53
 
# File 'download_strategy.rb', line 51

def cached_location
  @cached_location
end

#source_modified_time ⇒ Time (readonly)

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

Returns:

  • (Time) 


127
128
129
 
# File 'download_strategy.rb', line 127

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

#url ⇒ String (readonly)

The download URL.

Returns:



45
46
47
 
# File 'download_strategy.rb', line 45

def url
  @url
end

Instance Method Details

#basename ⇒ Object

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. 



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

def basename
  cached_location.basename
end

#clear_cache ⇒ Object

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



135
136
137
 
# File 'download_strategy.rb', line 135

def clear_cache
  rm_rf(cached_location)
end

#fetch(timeout: nil) ⇒ Object

Download and cache the resource at #cached_location.



70
 
# File 'download_strategy.rb', line 70

def fetch(timeout: nil); 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) 


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

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

#shutup! ⇒ Object

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.

Disable any output during downloading.



78
79
80
 
# File 'download_strategy.rb', line 78

def shutup!
  @quiet = true
end

#stage(&block) ⇒ Object

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.



95
96
97
98
99
100
101
102
103
 
# File 'download_strategy.rb', line 95

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