Class: Tab

Inherits:
AbstractTab show all
Defined in:
tab.rb

Constant Summary

Constants inherited from AbstractTab

AbstractTab::FILENAME

Instance Attribute Summary collapse

Attributes inherited from AbstractTab

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

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from AbstractTab

from_file, #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:



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

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 = nil
  @stdlib = T.let(nil, T.nilable(String))
  @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(String))
  @source_modified_time = T.let(nil, T.nilable(Integer))
  @tapped_from = T.let(nil, T.nilable(String))

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

Returns the value of attribute aliases.



178
179
180
 
# File 'tab.rb', line 178

def aliases
  @aliases
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.

Returns the value of attribute built_as_bottle.



178
179
180
 
# File 'tab.rb', line 178

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:



183
184
185
 
# File 'tab.rb', line 183

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:



423
424
425
 
# File 'tab.rb', line 423

def compiler
  @compiler || DevelopmentTools.default_compiler
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.



176
177
178
 
# File 'tab.rb', line 176

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:



476
477
478
 
# File 'tab.rb', line 476

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.

Returns the value of attribute stdlib.



178
179
180
 
# File 'tab.rb', line 178

def stdlib
  @stdlib
end

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

Returns the value of attribute tapped_from.



180
181
182
 
# File 'tab.rb', line 180

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:



418
419
420
 
# File 'tab.rb', line 418

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:



413
414
415
 
# File 'tab.rb', line 413

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) 


206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'tab.rb', line 206

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)
  tab.source["spec"] = formula.active_spec_sym.to_s
  tab.source["path"] = formula.specified_path.to_s
  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) 


343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
 
# File 'tab.rb', line 343

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) 


303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'tab.rb', line 303

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) 


269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'tab.rb', line 269

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) 


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

def self.for_name(name)
  for_formula(Formulary.factory(name))
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) 


237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'tab.rb', line 237

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

  tab.source ||= {}

  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) ⇒ Object 



289
290
291
292
293
294
295
296
297
298
 
# File 'tab.rb', line 289

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 



371
372
373
374
375
 
# File 'tab.rb', line 371

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) 


378
379
380
 
# File 'tab.rb', line 378

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) 


446
447
448
 
# File 'tab.rb', line 446

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) 


441
442
443
 
# File 'tab.rb', line 441

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:



434
435
436
437
438
 
# File 'tab.rb', line 434

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) 


400
401
402
 
# File 'tab.rb', line 400

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:



466
467
468
 
# File 'tab.rb', line 466

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.

Parameters:

Returns:

  • (Boolean) 


395
396
397
 
# File 'tab.rb', line 395

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

#runtime_dependencies ⇒ Object 



427
428
429
430
431
 
# File 'tab.rb', line 427

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:



451
452
453
 
# File 'tab.rb', line 451

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) 


405
406
407
 
# File 'tab.rb', line 405

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:



461
462
463
 
# File 'tab.rb', line 461

def stable_version
  versions["stable"]&.then { Version.new(_1) }
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:



509
510
511
512
513
514
515
516
517
518
519
520
521
522
 
# File 'tab.rb', line 509

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) ⇒ 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:



481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
 
# File 'tab.rb', line 481

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

  • (Integer) 


471
472
473
 
# File 'tab.rb', line 471

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:



456
457
458
 
# File 'tab.rb', line 456

def versions
  source["versions"]
end

#with?(val) ⇒ Boolean

Returns:

  • (Boolean) 


382
383
384
385
386
387
388
 
# File 'tab.rb', line 382

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

Returns:

  • (Boolean) 


390
391
392
 
# File 'tab.rb', line 390

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.



525
526
527
528
529
530
531
 
# File 'tab.rb', line 525

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