Class: Resource Private

Inherits:
Object
  • Object
show all
Includes:
Context, FileUtils
Defined in:
Library/Homebrew/resource.rb,
Library/Homebrew/extend/os/mac/resource.rb,
Library/Homebrew/extend/os/linux/resource.rb

Overview

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

Resource is the fundamental representation of an external resource. The primary formula download, along with other declared resources, are instances of this class.

Direct Known Subclasses

Go, PatchResource

Defined Under Namespace

Classes: Go, Partial, PatchResource

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Context

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

Constructor Details

#initialize(name = nil, &block) ⇒ Resource

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Resource.


25
26
27
28
29
30
31
32
33
34
35
# File 'Library/Homebrew/resource.rb', line 25

def initialize(name = nil, &block)
  @name = name
  @url = nil
  @version = nil
  @mirrors = []
  @specs = {}
  @checksum = nil
  @using = nil
  @patches = []
  instance_eval(&block) if block_given?
end

Instance Attribute Details

#checksumObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.


19
20
21
# File 'Library/Homebrew/resource.rb', line 19

def checksum
  @checksum
end

#download_strategyObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.


19
20
21
# File 'Library/Homebrew/resource.rb', line 19

def download_strategy
  @download_strategy
end

#mirrorsObject (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.


17
18
19
# File 'Library/Homebrew/resource.rb', line 17

def mirrors
  @mirrors
end

#nameObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Formula name must be set after the DSL, as we have no access to the formula name before initialization of the formula


23
24
25
# File 'Library/Homebrew/resource.rb', line 23

def name
  @name
end

#ownerObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.


17
18
19
# File 'Library/Homebrew/resource.rb', line 17

def owner
  @owner
end

#patchesObject (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.


17
18
19
# File 'Library/Homebrew/resource.rb', line 17

def patches
  @patches
end

#source_modified_timeObject (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.


17
18
19
# File 'Library/Homebrew/resource.rb', line 17

def source_modified_time
  @source_modified_time
end

#specsObject (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.


17
18
19
# File 'Library/Homebrew/resource.rb', line 17

def specs
  @specs
end

#usingObject (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.


17
18
19
# File 'Library/Homebrew/resource.rb', line 17

def using
  @using
end

#version(val = nil) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.


170
171
172
173
174
175
# File 'Library/Homebrew/resource.rb', line 170

def version(val = nil)
  @version ||= begin
    version = detect_version(val)
    version.null? ? nil : version
  end
end

Instance Method Details

#apply_patchesObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.


99
100
101
102
103
104
# File 'Library/Homebrew/resource.rb', line 99

def apply_patches
  return if patches.empty?

  ohai "Patching #{name}"
  patches.each(&:apply)
end

#cached_downloadObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.


65
66
67
# File 'Library/Homebrew/resource.rb', line 65

def cached_download
  downloader.cached_location
end

#clear_cacheObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.


69
70
71
# File 'Library/Homebrew/resource.rb', line 69

def clear_cache
  downloader.clear_cache
end

#download_nameObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.


54
55
56
57
58
59
# File 'Library/Homebrew/resource.rb', line 54

def download_name
  return owner.name if name.nil?
  return escaped_name if owner.nil?

  "#{owner.name}--#{escaped_name}"
end

#downloaded?Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

  • (Boolean)

61
62
63
# File 'Library/Homebrew/resource.rb', line 61

def downloaded?
  cached_download.exist?
end

#downloaderObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.


42
43
44
45
# File 'Library/Homebrew/resource.rb', line 42

def downloader
  @downloader ||= download_strategy.new(url, download_name, version,
                                        mirrors: mirrors.dup, **specs)
end

#escaped_nameObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Removes /s from resource names; this allows go package names to be used as resource names without confusing software that interacts with download_name, e.g. github.com/foo/bar


50
51
52
# File 'Library/Homebrew/resource.rb', line 50

def escaped_name
  name.tr("/", "-")
end

#fetch(verify_download_integrity: true) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.


130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
# File 'Library/Homebrew/resource.rb', line 130

def fetch(verify_download_integrity: true)
  HOMEBREW_CACHE.mkpath

  fetch_patches

  begin
    downloader.fetch
  rescue ErrorDuringExecution, CurlDownloadStrategyError => e
    raise DownloadError.new(self, e)
  end

  download = cached_download
  verify_download_integrity(download) if verify_download_integrity
  download
end

#fetch_patches(skip_downloaded: false) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.


93
94
95
96
97
# File 'Library/Homebrew/resource.rb', line 93

def fetch_patches(skip_downloaded: false)
  external_patches = patches.select(&:external?)
  external_patches.reject!(&:downloaded?) if skip_downloaded
  external_patches.each(&:fetch)
end

#files(*files) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.


126
127
128
# File 'Library/Homebrew/resource.rb', line 126

def files(*files)
  Partial.new(self, files)
end

#mirror(val) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.


177
178
179
# File 'Library/Homebrew/resource.rb', line 177

def mirror(val)
  mirrors << val
end

#on_linux(&_block) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Block only executed on Linux. No-op on macOS.

on_linux do
  url "linux_only_url"
end

196
# File 'Library/Homebrew/resource.rb', line 196

def on_linux(&_block); end

#on_macos(&_block) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Block only executed on macOS. No-op on Linux.

on_macos do
  url "mac_only_url"
end

190
# File 'Library/Homebrew/resource.rb', line 190

def on_macos(&_block); end

#patch(strip = :p1, src = nil, &block) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.


181
182
183
184
# File 'Library/Homebrew/resource.rb', line 181

def patch(strip = :p1, src = nil, &block)
  p = Patch.create(strip, src, &block)
  patches << p
end

#prepare_patchesObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.


89
90
91
# File 'Library/Homebrew/resource.rb', line 89

def prepare_patches
  patches.grep(DATAPatch) { |p| p.path = owner.owner.path }
end

#stage(target = nil, &block) ⇒ Object

Verifies download and unpacks it. The block may call |resource, staging| staging.retain! to retain the staging directory. Subclasses that override stage should implement the tmp dir using Mktemp so that works with all subtypes.

Raises:

  • (ArgumentError)

79
80
81
82
83
84
85
86
87
# File 'Library/Homebrew/resource.rb', line 79

def stage(target = nil, &block)
  raise ArgumentError, "target directory or block is required" if !target && block.blank?

  prepare_patches
  fetch_patches(skip_downloaded: true)
  fetch unless downloaded?

  unpack(target, &block)
end

#unpack(target = nil) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

If a target is given, unpack there; else unpack to a temp folder. If block is given, yield to that block with |stage|, where stage is a ResourceStageContext. A target or a block must be given, but not both.


110
111
112
113
114
115
116
117
118
119
120
121
122
# File 'Library/Homebrew/resource.rb', line 110

def unpack(target = nil)
  mktemp(download_name) do |staging|
    downloader.stage
    @source_modified_time = downloader.source_modified_time
    apply_patches
    if block_given?
      yield ResourceStageContext.new(self, staging)
    elsif target
      target = Pathname(target)
      target.install Pathname.pwd.children
    end
  end
end

#url(val = nil, **specs) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.


161
162
163
164
165
166
167
168
# File 'Library/Homebrew/resource.rb', line 161

def url(val = nil, **specs)
  return @url if val.nil?

  @url = val
  @specs.merge!(specs)
  @using = @specs.delete(:using)
  @download_strategy = DownloadStrategyDetector.detect(url, using)
end

#verify_download_integrity(fn) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.


146
147
148
149
150
151
152
153
154
155
# File 'Library/Homebrew/resource.rb', line 146

def verify_download_integrity(fn)
  if fn.file?
    ohai "Verifying #{fn.basename} checksum" if verbose?
    fn.verify_checksum(checksum)
  end
rescue ChecksumMissingError
  opoo "Cannot verify integrity of #{fn.basename}"
  puts "A checksum was not provided for this resource."
  puts "For your reference the SHA-256 is: #{fn.sha256}"
end