Class: Tab Private

Inherits:
Object show all
Extended by:
Cachable
Defined in:
tab.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.

Rather than calling new directly, use one of the class methods like Tab.create.

Constant Summary collapse

FILENAME =

This constant is part of a private API. This constant may only be used in the Homebrew/brew repository. Third parties should avoid using this constant if possible, as it may be removed or changed without warning. 

"INSTALL_RECEIPT.json"

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Cachable

cache, clear_cache

Constructor Details

#initialize(attributes = {}) ⇒ Tab

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



262
263
264
 
# File 'tab.rb', line 262

def initialize(attributes = {})
  attributes.each { |key, value| instance_variable_set(:"@#{key}", value) }
end

Instance Attribute Details

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



31
32
33
 
# File 'tab.rb', line 31

def aliases
  @aliases
end

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



31
32
33
 
# File 'tab.rb', line 31

def arch
  @arch
end

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



31
32
33
 
# File 'tab.rb', line 31

def built_as_bottle
  @built_as_bottle
end

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



31
32
33
 
# File 'tab.rb', line 31

def built_on
  @built_on
end

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



31
32
33
 
# File 'tab.rb', line 31

def changed_files
  @changed_files
end

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



306
307
308
 
# File 'tab.rb', line 306

def compiler
  @compiler || DevelopmentTools.default_compiler
end

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



31
32
33
 
# File 'tab.rb', line 31

def homebrew_version
  @homebrew_version
end

#installed_as_dependency ⇒ Object

This method is part of an internal API. This method may only be used internally in repositories owned by Homebrew, except in casks or formulae. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Check whether the formula was installed as a dependency.



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

def installed_as_dependency
  @installed_as_dependency
end

#installed_on_request ⇒ Object

This method is part of an internal API. This method may only be used internally in repositories owned by Homebrew, except in casks or formulae. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Check whether the formula was installed on request.



24
25
26
 
# File 'tab.rb', line 24

def installed_on_request
  @installed_on_request
end

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



31
32
33
 
# File 'tab.rb', line 31

def loaded_from_api
  @loaded_from_api
end

#poured_from_bottle ⇒ Object

This method is part of an internal API. This method may only be used internally in repositories owned by Homebrew, except in casks or formulae. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Check whether the formula was poured from a bottle.



29
30
31
 
# File 'tab.rb', line 29

def poured_from_bottle
  @poured_from_bottle
end

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



316
317
318
319
320
 
# File 'tab.rb', line 316

def runtime_dependencies
  # Homebrew versions prior to 1.1.6 generated incorrect runtime dependency
  # lists.
  @runtime_dependencies if parsed_homebrew_version >= "1.1.6"
end

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



31
32
33
 
# File 'tab.rb', line 31

def source
  @source
end

#source_modified_time ⇒ Time

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:



368
369
370
 
# File 'tab.rb', line 368

def source_modified_time
  Time.at(@source_modified_time || 0)
end

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



31
32
33
 
# File 'tab.rb', line 31

def stdlib
  @stdlib
end

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



31
32
33
 
# File 'tab.rb', line 31

def tabfile
  @tabfile
end

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



31
32
33
 
# File 'tab.rb', line 31

def time
  @time
end

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



302
303
304
 
# File 'tab.rb', line 302

def unused_options
  Options.create(@unused_options)
end

#used_options ⇒ Options

This method is part of an internal API. This method may only be used internally in repositories owned by Homebrew, except in casks or formulae. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

The options used to install the formula.

Returns:



298
299
300
 
# File 'tab.rb', line 298

def used_options
  Options.create(@used_options)
end

Class Method Details

.create(formula, compiler, stdlib) ⇒ 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.

Instantiates a Tab for a new installation of a formula.



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'tab.rb', line 42

def self.create(formula, compiler, stdlib)
  build = formula.build
  runtime_deps = formula.runtime_dependencies(undeclared: false)
  attributes = {
    "homebrew_version"        => HOMEBREW_VERSION,
    "used_options"            => build.used_options.as_flags,
    "unused_options"          => build.unused_options.as_flags,
    "tabfile"                 => formula.prefix/FILENAME,
    "built_as_bottle"         => build.bottle?,
    "installed_as_dependency" => false,
    "installed_on_request"    => false,
    "poured_from_bottle"      => false,
    "loaded_from_api"         => false,
    "time"                    => Time.now.to_i,
    "source_modified_time"    => formula.source_modified_time.to_i,
    "compiler"                => compiler,
    "stdlib"                  => stdlib,
    "aliases"                 => formula.aliases,
    "runtime_dependencies"    => Tab.runtime_deps_hash(formula, runtime_deps),
    "arch"                    => Hardware::CPU.arch,
    "source"                  => {
      "path"         => formula.specified_path.to_s,
      "tap"          => formula.tap&.name,
      "tap_git_head" => nil, # Filled in later if possible
      "spec"         => formula.active_spec_sym.to_s,
      "versions"     => {
        "stable"         => formula.stable&.version&.to_s,
        "head"           => formula.head&.version&.to_s,
        "version_scheme" => formula.version_scheme,
      },
    },
    "built_on"                => DevelopmentTools.build_system_info,
  }

  # We can only get `tap_git_head` if the tap is installed locally
  attributes["source"]["tap_git_head"] = formula.tap.git_head if formula.tap&.installed?

  new(attributes)
end

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



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'tab.rb', line 215

def self.empty
  attributes = {
    "homebrew_version"        => HOMEBREW_VERSION,
    "used_options"            => [],
    "unused_options"          => [],
    "built_as_bottle"         => false,
    "installed_as_dependency" => false,
    "installed_on_request"    => false,
    "poured_from_bottle"      => false,
    "loaded_from_api"         => false,
    "time"                    => nil,
    "source_modified_time"    => 0,
    "stdlib"                  => nil,
    "compiler"                => DevelopmentTools.default_compiler,
    "aliases"                 => [],
    "runtime_dependencies"    => nil,
    "arch"                    => nil,
    "source"                  => {
      "path"         => nil,
      "tap"          => nil,
      "tap_git_head" => nil,
      "spec"         => "stable",
      "versions"     => {
        "stable"         => nil,
        "head"           => nil,
        "version_scheme" => 0,
      },
    },
    "built_on"                => DevelopmentTools.generic_build_system_info,
  }

  new(attributes)
end

.for_formula(formula) ⇒ 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.

Returns a Tab for an already installed formula, or a fake one if the formula is not installed.



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'tab.rb', line 177

def self.for_formula(formula)
  paths = []

  paths << formula.opt_prefix.resolved_path if formula.opt_prefix.symlink? && formula.opt_prefix.directory?

  paths << formula.linked_keg.resolved_path if formula.linked_keg.symlink? && formula.linked_keg.directory?

  if (dirs = formula.installed_prefixes).length == 1
    paths << dirs.first
  end

  paths << formula.latest_installed_prefix

  path = paths.map { |pathname| pathname/FILENAME }.find(&:file?)

  if path
    tab = from_file(path)
    used_options = remap_deprecated_options(formula.deprecated_options, tab.used_options)
    tab.used_options = used_options.as_flags
  else
    # Formula is not installed. Return a fake tab.
    tab = empty
    tab.unused_options = formula.options.as_flags
    tab.source = {
      "path"     => formula.specified_path.to_s,
      "tap"      => formula.tap&.name,
      "spec"     => formula.active_spec_sym.to_s,
      "versions" => {
        "stable"         => formula.stable&.version&.to_s,
        "head"           => formula.head&.version&.to_s,
        "version_scheme" => formula.version_scheme,
      },
    }
  end

  tab
end

.for_keg(keg) ⇒ T.attached_class

This method is part of an internal API. This method may only be used internally in repositories owned by Homebrew, except in casks or formulae. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Get the Tab for the given Keg, or a fake one if the formula is not installed.

Parameters:

Returns:

  • (T.attached_class) 


145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'tab.rb', line 145

def self.for_keg(keg)
  path = keg/FILENAME

  tab = if path.exist?
    from_file(path)
  else
    empty
  end

  tab.tabfile = path
  tab
end

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

Returns a Tab for the named formula's installation, or a fake one if the formula is not installed.



160
161
162
 
# File 'tab.rb', line 160

def self.for_name(name)
  for_formula(Formulary.factory(name))
end

.from_file(path) ⇒ 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.

Note:

Results are cached.

Returns the Tab for an install receipt at path.



85
86
87
88
89
90
91
92
 
# File 'tab.rb', line 85

def self.from_file(path)
  cache.fetch(path) do |p|
    content = File.read(p)
    return empty if content.blank?

    cache[p] = from_file_content(content, p)
  end
end

.from_file_content(content, path) ⇒ 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.

Like from_file, but bypass the cache.



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'tab.rb', line 95

def self.from_file_content(content, path)
  attributes = begin
    JSON.parse(content)
  rescue JSON::ParserError => e
    raise e, "Cannot parse #{path}: #{e}", e.backtrace
  end
  attributes["tabfile"] = path
  attributes["source_modified_time"] ||= 0
  attributes["source"] ||= {}

  tapped_from = attributes["tapped_from"]
  if !tapped_from.nil? && tapped_from != "path or URL"
    attributes["source"]["tap"] = attributes.delete("tapped_from")
  end

  if attributes["source"]["tap"] == "mxcl/master" ||
     attributes["source"]["tap"] == "Homebrew/homebrew"
    attributes["source"]["tap"] = "homebrew/core"
  end

  if attributes["source"]["spec"].nil?
    version = PkgVersion.parse(File.basename(File.dirname(path)))
    attributes["source"]["spec"] = if version.head?
      "head"
    else
      "stable"
    end
  end

  if attributes["source"]["versions"].nil?
    attributes["source"]["versions"] = {
      "stable"         => nil,
      "head"           => nil,
      "version_scheme" => 0,
    }
  end

  # Tabs created with Homebrew 1.5.13 through 4.0.17 inclusive created empty string versions in some cases.
  ["stable", "head"].each do |spec|
    attributes["source"]["versions"][spec] = attributes["source"]["versions"][spec].presence
  end

  new(attributes)
end

.remap_deprecated_options(deprecated_options, options) ⇒ 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. 



164
165
166
167
168
169
170
171
172
173
 
# File 'tab.rb', line 164

def self.remap_deprecated_options(deprecated_options, options)
  deprecated_options.each do |deprecated_option|
    option = options.find { |o| o.name == deprecated_option.old }
    next unless option

    options -= [option]
    options << Option.new(deprecated_option.current, option.description)
  end
  options
end

.runtime_deps_hash(formula, deps) ⇒ 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. 



249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'tab.rb', line 249

def self.runtime_deps_hash(formula, deps)
  deps.map do |dep|
    f = dep.to_formula
    {
      "full_name"         => f.full_name,
      "version"           => f.version.to_s,
      "revision"          => f.revision,
      "pkg_version"       => f.pkg_version.to_s,
      "declared_directly" => formula.deps.include?(dep),
    }
  end
end

Instance Method Details

#any_args_or_options? ⇒ 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) 


266
267
268
 
# File 'tab.rb', line 266

def any_args_or_options?
  !used_options.empty? || !unused_options.empty?
end

#bottle? ⇒ 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) 


332
333
334
 
# File 'tab.rb', line 332

def bottle?
  built_as_bottle
end

#built_bottle? ⇒ 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) 


328
329
330
 
# File 'tab.rb', line 328

def built_bottle?
  built_as_bottle && !poured_from_bottle
end

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



322
323
324
325
326
 
# File 'tab.rb', line 322

def cxxstdlib
  # Older tabs won't have these values, so provide sensible defaults
  lib = stdlib.to_sym if stdlib
  CxxStdlib.create(lib, compiler.to_sym)
end

#head? ⇒ 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) 


286
287
288
 
# File 'tab.rb', line 286

def head?
  spec == :head
end

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



359
360
361
 
# File 'tab.rb', line 359

def head_version
  versions["head"]&.then { Version.new(_1) }
end

#include?(opt) ⇒ 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) 


282
283
284
 
# File 'tab.rb', line 282

def include?(opt)
  used_options.include? opt
end

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



310
311
312
313
314
 
# File 'tab.rb', line 310

def parsed_homebrew_version
  return Version::NULL if homebrew_version.nil?

  Version.new(homebrew_version)
end

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



347
348
349
 
# File 'tab.rb', line 347

def spec
  source["spec"].to_sym
end

#stable? ⇒ 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) 


290
291
292
 
# File 'tab.rb', line 290

def stable?
  spec == :stable
end

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



355
356
357
 
# File 'tab.rb', line 355

def stable_version
  versions["stable"]&.then { Version.new(_1) }
end

#tap ⇒ Tap?

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:



337
338
339
340
 
# File 'tab.rb', line 337

def tap
  tap_name = source["tap"]
  Tap.fetch(tap_name) if tap_name
end

#tap=(tap) ⇒ 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. 



342
343
344
345
 
# File 'tab.rb', line 342

def tap=(tap)
  tap_name = tap.respond_to?(:name) ? tap.name : tap
  source["tap"] = tap_name
end

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

A subset of to_json that we care about for bottles.



399
400
401
402
403
404
405
406
407
408
409
410
411
412
 
# File 'tab.rb', line 399

def to_bottle_hash
  attributes = {
    "homebrew_version"     => homebrew_version,
    "changed_files"        => changed_files&.map(&:to_s),
    "source_modified_time" => source_modified_time.to_i,
    "stdlib"               => stdlib&.to_s,
    "compiler"             => compiler&.to_s,
    "runtime_dependencies" => runtime_dependencies,
    "arch"                 => arch,
    "built_on"             => built_on,
  }
  attributes.delete("stdlib") if attributes["stdlib"].blank?
  attributes
end

#to_json(options = nil) ⇒ 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. 



372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
 
# File 'tab.rb', line 372

def to_json(options = nil)
  attributes = {
    "homebrew_version"        => homebrew_version,
    "used_options"            => used_options.as_flags,
    "unused_options"          => unused_options.as_flags,
    "built_as_bottle"         => built_as_bottle,
    "poured_from_bottle"      => poured_from_bottle,
    "loaded_from_api"         => loaded_from_api,
    "installed_as_dependency" => installed_as_dependency,
    "installed_on_request"    => installed_on_request,
    "changed_files"           => changed_files&.map(&:to_s),
    "time"                    => time,
    "source_modified_time"    => source_modified_time.to_i,
    "stdlib"                  => stdlib&.to_s,
    "compiler"                => compiler&.to_s,
    "aliases"                 => aliases,
    "runtime_dependencies"    => runtime_dependencies,
    "source"                  => source,
    "arch"                    => arch,
    "built_on"                => built_on,
  }
  attributes.delete("stdlib") if attributes["stdlib"].blank?

  JSON.pretty_generate(attributes, options)
end

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



363
364
365
 
# File 'tab.rb', line 363

def version_scheme
  versions["version_scheme"] || 0
end

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



351
352
353
 
# File 'tab.rb', line 351

def versions
  source["versions"]
end

#with?(val) ⇒ 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) 


270
271
272
273
274
275
276
 
# File 'tab.rb', line 270

def with?(val)
  option_names = val.respond_to?(:option_names) ? val.option_names : [val]

  option_names.any? do |name|
    include?("with-#{name}") || unused_options.include?("without-#{name}")
  end
end

#without?(val) ⇒ 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) 


278
279
280
 
# File 'tab.rb', line 278

def without?(val)
  !with?(val)
end

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



414
415
416
417
418
419
420
421
 
# File 'tab.rb', line 414

def write
  # If this is a new installation, the cache of installed formulae
  # will no longer be valid.
  Formula.clear_cache unless tabfile.exist?

  self.class.cache[tabfile] = self
  tabfile.atomic_write(to_json)
end