Class: Resource Private

Inherits:
Object
  • Object
show all
Extended by:
T::Sig
Includes:
Context, FileUtils, OnOS
Defined in:
Library/Homebrew/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 OnOS

#on_linux, #on_macos

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.


30
31
32
33
34
35
36
37
38
39
40
# File 'Library/Homebrew/resource.rb', line 30

def initialize(name = nil, &block)
  @name = name
  @url = nil
  @version = nil
  @mirrors = []
  @specs = {}
  @checksum = nil
  @using = nil
  @patches = []
  instance_eval(&block) if block
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.


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

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.


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

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.


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

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.


28
29
30
# File 'Library/Homebrew/resource.rb', line 28

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.


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

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.


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

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.


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

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.


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

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.


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

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.


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

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.


104
105
106
107
108
109
# File 'Library/Homebrew/resource.rb', line 104

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.


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

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.


74
75
76
# File 'Library/Homebrew/resource.rb', line 74

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.


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

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)

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

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.


47
48
49
50
# File 'Library/Homebrew/resource.rb', line 47

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.


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

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.


136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
# File 'Library/Homebrew/resource.rb', line 136

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.


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

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.


132
133
134
# File 'Library/Homebrew/resource.rb', line 132

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.


186
187
188
# File 'Library/Homebrew/resource.rb', line 186

def mirror(val)
  mirrors << val
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.


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

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.


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

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

#sha256(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.


166
167
168
# File 'Library/Homebrew/resource.rb', line 166

def sha256(val)
  @checksum = Checksum.new(val)
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)

84
85
86
87
88
89
90
91
92
# File 'Library/Homebrew/resource.rb', line 84

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.


115
116
117
118
119
120
121
122
123
124
125
126
127
128
# File 'Library/Homebrew/resource.rb', line 115

def unpack(target = nil)
  mktemp(download_name) do |staging|
    downloader.stage do
      @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
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.


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

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.


152
153
154
155
156
157
158
159
160
161
162
163
164
# File 'Library/Homebrew/resource.rb', line 152

def verify_download_integrity(fn)
  if fn.file?
    ohai "Verifying checksum for '#{fn.basename}'" if verbose?
    fn.verify_checksum(checksum)
  end
rescue ChecksumMissingError
  opoo <<~EOS
    Cannot verify integrity of '#{fn.basename}'.
    No checksum was provided for this resource.
    For your reference, the checksum is:
      sha256 "#{fn.sha256}"
  EOS
end