Class: Resource Private

Inherits:
Object show all
Includes:
Downloadable, FileUtils, OnSystem::MacOSAndLinux, Utils::Output::Mixin
Defined in:
resource.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.

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

BottleManifest, Formula, Go, Local, Patch

Defined Under Namespace

Classes: BottleManifest, Formula, Go, Local, Partial, Patch

Instance Attribute Summary collapse

Attributes included from Downloadable

#checksum, #mirrors

Instance Method Summary collapse

Methods included from Utils::Output::Mixin

#odebug, #odeprecated, #odie, #odisabled, #ofail, #oh1, #oh1_title, #ohai, #ohai_title, #onoe, #opoo, #opoo_outside_github_actions, #pretty_duration, #pretty_installed, #pretty_outdated, #pretty_uninstalled

Methods included from OnSystem::MacOSAndLinux

included, #on_arch_conditional, #on_macos, #on_system_conditional

Methods included from Downloadable

#cached_download, #clear_cache, #download_queue_name, #downloaded?, #downloader, #verify_download_integrity

Methods included from Context

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

Constructor Details

#initialize(name = nil, &block) ⇒ 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:

  • name (String, nil) (defaults to: nil)
  • block (T.proc.bind(Resource).void, nil) 


28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'resource.rb', line 28

def initialize(name = nil, &block)
  super()
  # Generally ensure this is synced with `initialize_dup` and `freeze`
  # (excluding simple objects like integers & booleans, weak refs like `owner` or permafrozen objects)
  @name = name
  @source_modified_time = nil
  @patches = []
  @owner = nil
  @livecheck = Livecheck.new(self)
  @livecheck_defined = false
  @insecure = false
  instance_eval(&block) if block
end

Instance Attribute Details

#checksum=(value) ⇒ Object (writeonly)

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. 



20
21
22
 
# File 'resource.rb', line 20

def checksum=(value)
  @checksum = value
end

#download_strategy ⇒ 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. 



21
22
23
 
# File 'resource.rb', line 21

def download_strategy
  @download_strategy
end

#name ⇒ 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.

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



25
26
27
 
# File 'resource.rb', line 25

def name
  @name
end

#owner ⇒ 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. 



19
20
21
 
# File 'resource.rb', line 19

def owner
  @owner
end

#patches ⇒ 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. 



19
20
21
 
# File 'resource.rb', line 19

def patches
  @patches
end

#source_modified_time ⇒ 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. 



19
20
21
 
# File 'resource.rb', line 19

def source_modified_time
  @source_modified_time
end

Instance Method Details

#apply_patches ⇒ 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. 



91
92
93
94
95
96
 
# File 'resource.rb', line 91

def apply_patches
  return if patches.empty?

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

#download_queue_type ⇒ String

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:



63
 
# File 'resource.rb', line 63

def download_queue_type = "Resource"

#fetch(verify_download_integrity: true, timeout: nil, quiet: false, skip_patches: false) ⇒ 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.

Parameters:

  • verify_download_integrity (Boolean) (defaults to: true)
  • timeout (Integer, Float, nil) (defaults to: nil)
  • quiet (Boolean) (defaults to: false)
  • skip_patches (Boolean) (defaults to: false)

Returns:



134
135
136
137
138
 
# File 'resource.rb', line 134

def fetch(verify_download_integrity: true, timeout: nil, quiet: false, skip_patches: false)
  fetch_patches unless skip_patches

  super(verify_download_integrity:, timeout:, quiet:)
end

#fetch_patches(skip_downloaded: false) ⇒ 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. 



85
86
87
88
89
 
# File 'resource.rb', line 85

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. 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. 



121
122
123
 
# File 'resource.rb', line 121

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

#freeze ⇒ 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. 



50
51
52
53
54
55
 
# File 'resource.rb', line 50

def freeze
  @name.freeze
  @patches.freeze
  @livecheck.freeze
  super
end

#initialize_dup(other) ⇒ 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.

This method returns an undefined value.

Parameters:



43
44
45
46
47
48
 
# File 'resource.rb', line 43

def initialize_dup(other)
  super
  @name = @name.dup
  @patches = @patches.dup
  @livecheck = @livecheck.dup
end

#livecheck(&block) ⇒ 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.

Livecheck can be used to check for newer versions of the software. This method evaluates the DSL specified in the livecheck block of the Resource (if it exists) and sets the instance variables of a Livecheck object accordingly. This is used by brew livecheck to check for newer versions of the software.

Example

livecheck do
  url "https://example.com/foo/releases"
  regex /foo-(\d+(?:\.\d+)+)\.tar/
end



154
155
156
157
158
159
 
# File 'resource.rb', line 154

def livecheck(&block)
  return @livecheck unless block

  @livecheck_defined = true
  @livecheck.instance_eval(&block)
end

#livecheck_defined? ⇒ 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.

Whether a livecheck specification is defined or not.

It returns true when a livecheck block is present in the Resource and false otherwise.

Returns:

  • (Boolean) 


166
167
168
 
# File 'resource.rb', line 166

def livecheck_defined?
  @livecheck_defined == true
end

#livecheckable? ⇒ 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.

Deprecated.

Calling #livecheckable? is disabled, use #livecheck_defined? instead.

Whether a livecheck specification is defined or not. This is a legacy alias for #livecheck_defined?.

It returns true when a livecheck block is present in the Resource and false otherwise.

Returns:

  • (Boolean) 


176
177
178
179
 
# File 'resource.rb', line 176

def livecheckable?
  odisabled "`livecheckable?`", "`livecheck_defined?`"
  @livecheck_defined == true
end

#mirror(val) ⇒ 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. 



213
214
215
 
# File 'resource.rb', line 213

def mirror(val)
  mirrors << val
end

#patch(strip = :p1, src = nil, &block) ⇒ 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. 



217
218
219
220
 
# File 'resource.rb', line 217

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

#prepare_patches ⇒ 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. 



81
82
83
 
# File 'resource.rb', line 81

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

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



181
182
183
 
# File 'resource.rb', line 181

def sha256(val)
  @checksum = Checksum.new(val)
end

#specs ⇒ 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. 



226
227
228
 
# File 'resource.rb', line 226

def specs
  @url&.specs || {}.freeze
end

#stage(target = nil, debug_symbols: false, &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) 


71
72
73
74
75
76
77
78
79
 
# File 'resource.rb', line 71

def stage(target = nil, debug_symbols: false, &block)
  raise ArgumentError, "Target directory or block is required" if !target && !block_given?

  prepare_patches
  fetch_patches(skip_downloaded: true)
  fetch unless downloaded?

  unpack(target, debug_symbols:, &block)
end

#unpack(target = nil, debug_symbols: false) ⇒ 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.

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.



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'resource.rb', line 102

def unpack(target = nil, debug_symbols: false)
  current_working_directory = Pathname.pwd
  stage_resource(download_name, debug_symbols:) do |staging|
    downloader.stage do
      @source_modified_time = downloader.source_modified_time.freeze
      apply_patches
      if block_given?
        yield ResourceStageContext.new(self, staging)
      elsif target
        target = Pathname(target)
        target = current_working_directory/target if target.relative?
        target.install Pathname.pwd.children
      end
    end
  end
end

#url(val = nil, **specs) ⇒ String?

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:

  • val (String, nil) (defaults to: nil)
  • specs (T.anything)

Returns:



186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'resource.rb', line 186

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

  specs = specs.dup
  # Don't allow this to be set.
  specs.delete(:insecure)

  specs[:insecure] = true if @insecure

  @url = URL.new(val, specs)
  @downloader = nil
  @download_strategy = @url.download_strategy
  @url.to_s
end

#using ⇒ 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. 



222
223
224
 
# File 'resource.rb', line 222

def using
  @url&.using
end

#version(val = nil) ⇒ Version?

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:

Returns:



202
203
204
205
206
207
208
209
210
211
 
# File 'resource.rb', line 202

def version(val = nil)
  return super() if val.nil?

  @version = case val
  when String
    val.blank? ? Version::NULL : Version.new(val)
  when Version
    val
  end
end