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(poured_from_bottle: nil, built_as_bottle: nil, changed_files: nil, stdlib: nil, aliases: nil, used_options: nil, unused_options: nil, compiler: nil, source_modified_time: nil, tapped_from: nil, **rest) ⇒ 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:

  • poured_from_bottle (Boolean, nil) (defaults to: nil)
  • built_as_bottle (Boolean, nil) (defaults to: nil)
  • changed_files (Array<Pathname, String>, nil) (defaults to: nil)
  • stdlib (String, Symbol, nil) (defaults to: nil)
  • aliases (Array<String>, nil) (defaults to: nil)
  • used_options (Array<String>, nil) (defaults to: nil)
  • unused_options (Array<String>, nil) (defaults to: nil)
  • compiler (String, Symbol, nil) (defaults to: nil)
  • source_modified_time (Integer, nil) (defaults to: nil)
  • tapped_from (String, nil) (defaults to: nil)
  • rest (T.untyped) 


53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'tab/tab.rb', line 53

def initialize(poured_from_bottle: nil, built_as_bottle: nil, changed_files: nil, stdlib: nil, aliases: nil,
               used_options: nil, unused_options: nil, compiler: nil, source_modified_time: nil,
               tapped_from: nil, **rest)
  @poured_from_bottle = poured_from_bottle
  @built_as_bottle = built_as_bottle
  @changed_files = T.let(changed_files&.map { |f| Pathname(f) }, T.nilable(T::Array[Pathname]))
  @stdlib = stdlib
  @aliases = aliases
  @used_options = used_options
  @unused_options = unused_options
  @compiler = compiler
  @source_modified_time = source_modified_time
  @tapped_from = tapped_from

  super(**rest)
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:



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

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) 


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

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:



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

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:



309
310
311
 
# File 'tab/tab.rb', line 309

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) 


11
12
13
 
# File 'tab/tab.rb', line 11

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:



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

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:



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

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:



35
36
37
 
# File 'tab/tab.rb', line 35

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:



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

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:



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

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) 


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
102
103
104
105
106
107
108
109
110
111
112
 
# File 'tab/tab.rb', line 75

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) 


226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'tab/tab.rb', line 226

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) 


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
214
215
216
217
218
219
220
221
222
223
 
# File 'tab/tab.rb', line 186

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) 


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

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) 


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

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) 


116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'tab/tab.rb', line 116

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:



172
173
174
175
176
177
178
179
180
181
 
# File 'tab/tab.rb', line 172

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:



255
256
257
258
259
 
# File 'tab/tab.rb', line 255

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) 


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

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) 


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

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/tab.rb', line 328

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:



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

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) 


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

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:



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

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) 


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

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:



314
315
316
317
318
 
# File 'tab/tab.rb', line 314

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:



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

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) 


291
292
293
 
# File 'tab/tab.rb', line 291

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:



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

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:



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

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:



368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
 
# File 'tab/tab.rb', line 368

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:



358
359
360
 
# File 'tab/tab.rb', line 358

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:



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

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) 


267
268
269
270
271
272
273
 
# File 'tab/tab.rb', line 267

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) 


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

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.



414
415
416
417
418
419
420
 
# File 'tab/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?

  super
end