Class: Tab
- Inherits:
-
AbstractTab
- Object
- AbstractTab
- Tab
- Defined in:
- tab.rb
Constant Summary
Constants inherited from AbstractTab
Instance Attribute Summary collapse
-
#aliases ⇒ Object
private
Returns the value of attribute aliases.
-
#built_as_bottle ⇒ Object
private
Returns the value of attribute built_as_bottle.
- #changed_files ⇒ Array<Pathname>? private
- #compiler ⇒ String, Symbol private
-
#poured_from_bottle ⇒ Object
internal
Check whether the formula was poured from a bottle.
- #source_modified_time ⇒ Time private
-
#stdlib ⇒ Object
private
Returns the value of attribute stdlib.
-
#tapped_from ⇒ Object
readonly
private
Returns the value of attribute tapped_from.
- #unused_options ⇒ Options private
-
#used_options ⇒ Options
internal
The options used to install the formula.
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
-
.create(formula_or_cask, compiler = DevelopmentTools.default_compiler, stdlib = nil) ⇒ T.attached_class
private
Instantiates a Tab for a new installation of a formula.
- .empty ⇒ T.attached_class private
-
.for_formula(formula) ⇒ T.attached_class
private
Returns a Tab for an already installed formula, or a fake one if the formula is not installed.
- .for_keg(keg) ⇒ T.attached_class internal
-
.for_name(name) ⇒ T.attached_class
private
Returns a Tab for the named formula's installation, or a fake one if the formula is not installed.
-
.from_file_content(content, path) ⇒ T.attached_class
private
Like AbstractTab.from_file, but bypass the cache.
- .remap_deprecated_options(deprecated_options, options) ⇒ Object
- .runtime_deps_hash(formula, deps) ⇒ Object
Instance Method Summary collapse
- #any_args_or_options? ⇒ Boolean private
- #bottle? ⇒ Boolean private
- #built_bottle? ⇒ Boolean private
- #cxxstdlib ⇒ CxxStdlib private
- #head? ⇒ Boolean private
- #head_version ⇒ Version? private
- #include?(opt) ⇒ Boolean private
- #initialize(attributes = {}) ⇒ void constructor private
- #runtime_dependencies ⇒ Object
- #spec ⇒ Symbol private
- #stable? ⇒ Boolean private
- #stable_version ⇒ Version? private
-
#to_bottle_hash ⇒ Hash{String => T.untyped}
private
A subset of to_json that we care about for bottles.
- #to_json(options = nil) ⇒ String private
- #version_scheme ⇒ Integer private
- #versions ⇒ Hash{String => T.untyped} private
- #with?(val) ⇒ Boolean
- #without?(val) ⇒ Boolean
- #write ⇒ void private
Methods inherited from AbstractTab
from_file, #parsed_homebrew_version, #tap, #tap=
Methods included from Cachable
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.
185 186 187 188 189 190 191 192 193 194 195 196 197 198 |
# File 'tab.rb', line 185 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.
177 178 179 |
# File 'tab.rb', line 177 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.
177 178 179 |
# File 'tab.rb', line 177 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.
182 183 184 |
# File 'tab.rb', line 182 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.
420 421 422 |
# File 'tab.rb', line 420 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.
175 176 177 |
# File 'tab.rb', line 175 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.
473 474 475 |
# File 'tab.rb', line 473 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.
177 178 179 |
# File 'tab.rb', line 177 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.
179 180 181 |
# File 'tab.rb', line 179 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.
415 416 417 |
# File 'tab.rb', line 415 def 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.
410 411 412 |
# File 'tab.rb', line 410 def 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.
205 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 |
# File 'tab.rb', line 205 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. = build..as_flags tab. = build..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, } 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.
341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 |
# File 'tab.rb', line 341 def self.empty tab = super tab. = [] tab. = [] 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.
301 302 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 |
# File 'tab.rb', line 301 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) = (formula., tab.) tab. = .as_flags else # Formula is not installed. Return a fake tab. tab = empty tab. = formula..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.
267 268 269 270 271 272 273 274 275 276 277 278 |
# File 'tab.rb', line 267 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.
283 284 285 |
# File 'tab.rb', line 283 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.
235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 |
# File 'tab.rb', line 235 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
287 288 289 290 291 292 293 294 295 296 |
# File 'tab.rb', line 287 def self.(, ) .each do |deprecated_option| option = .find { |o| o.name == deprecated_option.old } next unless option -= [option] << Option.new(deprecated_option.current, option.description) end end |
.runtime_deps_hash(formula, deps) ⇒ Object
368 369 370 371 372 |
# File 'tab.rb', line 368 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.
375 376 377 |
# File 'tab.rb', line 375 def !.empty? || !.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.
443 444 445 |
# File 'tab.rb', line 443 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.
438 439 440 |
# File 'tab.rb', line 438 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.
431 432 433 434 435 |
# File 'tab.rb', line 431 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.
397 398 399 |
# File 'tab.rb', line 397 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.
463 464 465 |
# File 'tab.rb', line 463 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.
392 393 394 |
# File 'tab.rb', line 392 def include?(opt) .include? opt end |
#runtime_dependencies ⇒ Object
424 425 426 427 428 |
# File 'tab.rb', line 424 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.
448 449 450 |
# File 'tab.rb', line 448 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.
402 403 404 |
# File 'tab.rb', line 402 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.
458 459 460 |
# File 'tab.rb', line 458 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.
506 507 508 509 510 511 512 513 514 515 516 517 518 519 |
# File 'tab.rb', line 506 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.
478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 |
# File 'tab.rb', line 478 def to_json( = nil) attributes = { "homebrew_version" => homebrew_version, "used_options" => .as_flags, "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, ) 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.
468 469 470 |
# File 'tab.rb', line 468 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.
453 454 455 |
# File 'tab.rb', line 453 def versions source["versions"] end |
#with?(val) ⇒ Boolean
379 380 381 382 383 384 385 |
# File 'tab.rb', line 379 def with?(val) option_names = val.respond_to?(:option_names) ? val.option_names : [val] option_names.any? do |name| include?("with-#{name}") || .include?("without-#{name}") end end |
#without?(val) ⇒ Boolean
387 388 389 |
# File 'tab.rb', line 387 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.
522 523 524 525 526 527 528 |
# File 'tab.rb', line 522 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 |