Class: Tab Private

Inherits:
AbstractTab show all
Defined in:
tab/tab.rb

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.

Constant Summary collapse

Cache =

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. 

type_template { { fixed: T::Hash[T.any(Pathname, String), T.untyped] } }

Constants inherited from AbstractTab

AbstractTab::FILENAME, AbstractTab::RuntimeDependencies

Instance Attribute Summary collapse

Attributes inherited from AbstractTab

#arch, #built_on, #homebrew_version, #installed_on_request, #loaded_from_api, #loaded_from_internal_api, #source, #tabfile, #time

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from AbstractTab

from_file, #installed_on_request_present?, #parsed_homebrew_version, #tap, #tap=

Methods included from Cachable

#cache, #clear_cache

Constructor Details

#initialize(attributes = {}) ⇒ 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:



44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'tab/tab.rb', line 44

def initialize(attributes = {})
  @poured_from_bottle = T.let(nil, T.nilable(T::Boolean))
  @built_as_bottle = T.let(nil, T.nilable(T::Boolean))
  @changed_files = T.let(nil, T.nilable(T::Array[Pathname]))
  @stdlib = T.let(nil, T.nilable(T.any(String, Symbol)))
  @aliases = T.let(nil, T.nilable(T::Array[String]))
  @used_options = T.let(nil, T.nilable(T::Array[String]))
  @unused_options = T.let(nil, T.nilable(T::Array[String]))
  @compiler = T.let(nil, T.nilable(T.any(String, Symbol)))
  @source_modified_time = T.let(nil, T.nilable(Integer))
  @tapped_from = T.let(nil, T.nilable(String))

  super
end

Instance Attribute Details

#aliases ⇒ Array<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:



23
24
25
 
# File 'tab/tab.rb', line 23

def aliases
  @aliases
end

#built_as_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, nil) 


17
18
19
 
# File 'tab/tab.rb', line 17

def built_as_bottle
  @built_as_bottle
end

#changed_files ⇒ Array<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.

Returns:



41
42
43
 
# File 'tab/tab.rb', line 41

def changed_files
  @changed_files
end

#compiler ⇒ String, Symbol

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:



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

def compiler
  @compiler || DevelopmentTools.default_compiler
end

#poured_from_bottle ⇒ Boolean?

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.

Returns:

  • (Boolean, nil) 


14
15
16
 
# File 'tab/tab.rb', line 14

def poured_from_bottle
  @poured_from_bottle
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:



352
353
354
 
# File 'tab/tab.rb', line 352

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

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



20
21
22
 
# File 'tab/tab.rb', line 20

def stdlib
  @stdlib
end

#tapped_from ⇒ String? (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.

Returns:



38
39
40
 
# File 'tab/tab.rb', line 38

def tapped_from
  @tapped_from
end

#unused_options ⇒ Options

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:



293
294
295
 
# File 'tab/tab.rb', line 293

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:



288
289
290
 
# File 'tab/tab.rb', line 288

def used_options
  Options.create(@used_options)
end

Class Method Details

.create(formula_or_cask, compiler = DevelopmentTools.default_compiler, stdlib = nil) ⇒ T.attached_class

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.

Parameters:

Returns:

  • (T.attached_class) 


64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'tab/tab.rb', line 64

def self.create(formula_or_cask, compiler = DevelopmentTools.default_compiler, stdlib = nil)
  formula = T.cast(formula_or_cask, Formula)

  tab = super(formula)
  build = formula.build
  runtime_deps = formula.runtime_dependencies(undeclared: false)

  tab.used_options = build.used_options.as_flags
  tab.unused_options = build.unused_options.as_flags
  tab.tabfile = formula.prefix/FILENAME
  tab.built_as_bottle = build.bottle?
  tab.poured_from_bottle = false
  tab.source_modified_time = formula.source_modified_time.to_i
  tab.compiler = compiler
  tab.stdlib = stdlib
  tab.aliases = formula.aliases
  tab.runtime_dependencies = Tab.runtime_deps_hash(formula, runtime_deps)
  active_spec = if formula.active_spec_sym == :head
    T.must(formula.head)
  else
    T.must(formula.stable)
  end

  tab.source["spec"] = formula.active_spec_sym.to_s
  tab.source["path"] = formula.specified_path.to_s
  if (downloader = active_spec.downloader).cached_location.exist? &&
     (scm_revision = downloader.source_revision).present?
    tab.source["scm_revision"] = scm_revision
  end
  tab.source["versions"] = {
    "stable"                => formula.stable&.version&.to_s,
    "head"                  => formula.head&.version&.to_s,
    "version_scheme"        => formula.version_scheme,
    "compatibility_version" => formula.compatibility_version,
  }

  tab
end

.empty ⇒ T.attached_class

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:

  • (T.attached_class) 


215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'tab/tab.rb', line 215

def self.empty
  tab = super

  tab.used_options = []
  tab.unused_options = []
  tab.built_as_bottle = false
  tab.poured_from_bottle = false
  tab.source_modified_time = 0
  tab.stdlib = nil
  tab.compiler = DevelopmentTools.default_compiler
  tab.aliases = []
  tab.source["spec"] = "stable"
  tab.source["versions"] = empty_source_versions

  tab
end

.for_formula(formula) ⇒ T.attached_class

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.

Parameters:

Returns:

  • (T.attached_class) 


175
176
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
 
# File 'tab/tab.rb', line 175

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,
      "tap_git_head" => formula.tap_git_head,
      "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) 


135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'tab/tab.rb', line 135

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) ⇒ T.attached_class

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.

Parameters:

Returns:

  • (T.attached_class) 


151
152
153
154
155
156
157
158
 
# File 'tab/tab.rb', line 151

def self.for_name(name)
  rack = HOMEBREW_CELLAR/name
  if (keg = Keg.from_rack(rack))
    for_keg(keg)
  else
    for_formula(Formulary.from_rack(rack, keg:))
  end
end

.from_file_content(content, path) ⇒ T.attached_class

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 AbstractTab.from_file, but bypass the cache.

Parameters:

Returns:

  • (T.attached_class) 


105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'tab/tab.rb', line 105

def self.from_file_content(content, path)
  tab = super

  tab.tap = tab.tapped_from if !tab.tapped_from.nil? && tab.tapped_from != "path or URL"
  tab.tap = "homebrew/core" if ["mxcl/master", "Homebrew/homebrew"].include?(tab.tap)

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

  tab.source["versions"] ||= empty_source_versions

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

  tab
end

.remap_deprecated_options(deprecated_options, options) ⇒ Options

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:



161
162
163
164
165
166
167
168
169
170
 
# File 'tab/tab.rb', line 161

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) ⇒ Array<Hash{String => T.untyped}>

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:



244
245
246
247
248
 
# File 'tab/tab.rb', line 244

def self.runtime_deps_hash(formula, deps)
  deps.map do |dep|
    formula_to_dep_hash(dep.to_formula, formula.deps.map(&:name))
  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) 


251
252
253
 
# File 'tab/tab.rb', line 251

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) 


322
323
324
 
# File 'tab/tab.rb', line 322

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) 


317
318
319
 
# File 'tab/tab.rb', line 317

def built_bottle?
  !!built_as_bottle && !poured_from_bottle
end

#cxxstdlib ⇒ CxxStdlib

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:



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

def cxxstdlib
  # Older tabs won't have these values, so provide sensible defaults
  lib = stdlib&.to_sym
  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) 


275
276
277
 
# File 'tab/tab.rb', line 275

def head?
  spec == :head
end

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

Returns:



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

def head_version
  versions["head"]&.then { Version.new(it) }
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.

Parameters:

Returns:

  • (Boolean) 


270
271
272
 
# File 'tab/tab.rb', line 270

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

#runtime_dependencies ⇒ RuntimeDependencies

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:



303
304
305
306
307
 
# File 'tab/tab.rb', line 303

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

#spec ⇒ Symbol

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:



327
328
329
 
# File 'tab/tab.rb', line 327

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) 


280
281
282
 
# File 'tab/tab.rb', line 280

def stable?
  spec == :stable
end

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

Returns:



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

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

#to_bottle_hash ⇒ Hash{String => T.untyped}

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.

Returns:



385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
 
# File 'tab/tab.rb', line 385

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,
    "source"               => source.slice("scm_revision").compact.presence,
    "arch"                 => arch,
    "built_on"             => built_on,
  }
  attributes.delete("stdlib") if attributes["stdlib"].blank?
  attributes.delete("source") if attributes["source"].blank?
  attributes
end

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

  • options (Hash{String => T.untyped}, nil) (defaults to: nil)

Returns:



357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
 
# File 'tab/tab.rb', line 357

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,
    "loaded_from_internal_api" => loaded_from_internal_api,
    "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 ⇒ Integer

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:



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

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

#versions ⇒ Hash{String => T.untyped}

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:



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

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.

Parameters:

Returns:

  • (Boolean) 


256
257
258
259
260
261
262
 
# File 'tab/tab.rb', line 256

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

  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.

Parameters:

Returns:

  • (Boolean) 


265
266
267
 
# File 'tab/tab.rb', line 265

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

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



403
404
405
406
407
408
409
 
# File 'tab/tab.rb', line 403

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

  super
end