Class: Resource

Inherits:
Object
  • Object
show all
Includes:
FileUtils
Defined in:
brew/Library/Homebrew/resource.rb

Overview

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

Constructor Details

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

Returns a new instance of Resource



22
23
24
25
26
27
28
29
30
31
32
 
# File 'brew/Library/Homebrew/resource.rb', line 22

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

#checksum ⇒ Object

Returns the value of attribute checksum



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

def checksum
  @checksum
end

#download_strategy ⇒ Object

Returns the value of attribute download_strategy



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

def download_strategy
  @download_strategy
end

#mirrors ⇒ Object (readonly)

Returns the value of attribute mirrors



14
15
16
 
# File 'brew/Library/Homebrew/resource.rb', line 14

def mirrors
  @mirrors
end

#name ⇒ Object

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



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

def name
  @name
end

#owner ⇒ Object

Returns the value of attribute owner



14
15
16
 
# File 'brew/Library/Homebrew/resource.rb', line 14

def owner
  @owner
end

#patches ⇒ Object (readonly)

Returns the value of attribute patches



14
15
16
 
# File 'brew/Library/Homebrew/resource.rb', line 14

def patches
  @patches
end

#source_modified_time ⇒ Object (readonly)

Returns the value of attribute source_modified_time



14
15
16
 
# File 'brew/Library/Homebrew/resource.rb', line 14

def source_modified_time
  @source_modified_time
end

#specs ⇒ Object (readonly)

Returns the value of attribute specs



14
15
16
 
# File 'brew/Library/Homebrew/resource.rb', line 14

def specs
  @specs
end

#using ⇒ Object (readonly)

Returns the value of attribute using



14
15
16
 
# File 'brew/Library/Homebrew/resource.rb', line 14

def using
  @using
end

#version(val = nil) ⇒ Object 



153
154
155
156
157
158
 
# File 'brew/Library/Homebrew/resource.rb', line 153

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

Instance Method Details

#apply_patches ⇒ Object 



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

def apply_patches
  return if patches.empty?

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

#cached_download ⇒ Object 



58
59
60
 
# File 'brew/Library/Homebrew/resource.rb', line 58

def cached_download
  downloader.cached_location
end

#clear_cache ⇒ Object 



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

def clear_cache
  downloader.clear_cache
end

#download_name ⇒ Object 



51
52
53
54
55
56
 
# File 'brew/Library/Homebrew/resource.rb', line 51

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

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

#downloader ⇒ Object 



39
40
41
42
 
# File 'brew/Library/Homebrew/resource.rb', line 39

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

#escaped_name ⇒ Object

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



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

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

#fetch ⇒ Object 



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

def fetch
  HOMEBREW_CACHE.mkpath

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

  cached_download
end

#files(*files) ⇒ Object 



113
114
115
 
# File 'brew/Library/Homebrew/resource.rb', line 113

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

#mirror(val) ⇒ Object 



160
161
162
 
# File 'brew/Library/Homebrew/resource.rb', line 160

def mirror(val)
  mirrors << val
end

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



164
165
166
167
 
# File 'brew/Library/Homebrew/resource.rb', line 164

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

#prepare_patches ⇒ Object 



78
79
80
81
82
83
84
 
# File 'brew/Library/Homebrew/resource.rb', line 78

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

  patches.each do |patch|
    patch.verify_download_integrity(patch.fetch) if patch.external?
  end
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) 


70
71
72
73
74
75
76
 
# File 'brew/Library/Homebrew/resource.rb', line 70

def stage(target = nil, &block)
  raise ArgumentError, "target directory or block is required" unless target || block

  verify_download_integrity(fetch)
  prepare_patches
  unpack(target, &block)
end

#unpack(target = nil) ⇒ Object

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.



97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'brew/Library/Homebrew/resource.rb', line 97

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 



144
145
146
147
148
149
150
151
 
# File 'brew/Library/Homebrew/resource.rb', line 144

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 



129
130
131
132
133
134
135
136
137
138
 
# File 'brew/Library/Homebrew/resource.rb', line 129

def verify_download_integrity(fn)
  if fn.file?
    ohai "Verifying #{fn.basename} checksum" if ARGV.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