Document Tab.for_keg and use Keg#tab where possible.

Homebrew · Apr 28, 2024 · 90c9a9c · 90c9a9c
1 parent 5e027bf
commit 90c9a9c
Show file tree

Hide file tree

Showing 20 changed files with 38 additions and 31 deletions.
diff --git a/Library/Homebrew/cli/named_args.rb b/Library/Homebrew/cli/named_args.rb
@@ -371,11 +371,11 @@ def resolve_latest_keg(name)
         # Return keg if it is the only installed keg
         return kegs if kegs.length == 1
 
-        stable_kegs = kegs.reject { |k| k.version.head? }
+        stable_kegs = kegs.reject { |keg| keg.version.head? }
 
         if stable_kegs.blank?
           return kegs.max_by do |keg|
-            [Tab.for_keg(keg).source_modified_time, keg.version.revision]
+            [keg.tab.source_modified_time, keg.version.revision]
           end
         end
 

diff --git a/Library/Homebrew/cmd/info.rb b/Library/Homebrew/cmd/info.rb
@@ -293,9 +293,9 @@ def info_formula(formula)
         end
 
         kegs = formula.installed_kegs
-        heads, versioned = kegs.partition { |k| k.version.head? }
+        heads, versioned = kegs.partition { |keg| keg.version.head? }
         kegs = [
-          *heads.sort_by { |k| -Tab.for_keg(k).time.to_i },
+          *heads.sort_by { |keg| -keg.tab.time.to_i },
           *versioned.sort_by(&:scheme_and_version),
         ]
         if kegs.empty?
@@ -304,7 +304,7 @@ def info_formula(formula)
           puts "Installed"
           kegs.each do |keg|
             puts "#{keg} (#{keg.abv})#{" *" if keg.linked?}"
-            tab = Tab.for_keg(keg).to_s
+            tab = keg.tab.to_s
             puts "  #{tab}" unless tab.empty?
           end
         end

diff --git a/Library/Homebrew/cmd/leaves.rb b/Library/Homebrew/cmd/leaves.rb
@@ -40,11 +40,11 @@ def run
       private
 
       def installed_on_request?(formula)
-        Tab.for_keg(formula.any_installed_keg).installed_on_request
+        formula.any_installed_keg.tab.installed_on_request
       end
 
       def installed_as_dependency?(formula)
-        Tab.for_keg(formula.any_installed_keg).installed_as_dependency
+        formula.any_installed_keg.installed_as_dependency
       end
     end
   end

diff --git a/Library/Homebrew/cmd/update-report.rb b/Library/Homebrew/cmd/update-report.rb
@@ -162,7 +162,7 @@ def output_update_report
               next unless formula.any_version_installed?
 
               keg = formula.installed_kegs.last
-              tab = Tab.for_keg(keg)
+              tab = keg.tab
               # force a `brew upgrade` from the linuxbrew-core version to the homebrew-core version (even if lower)
               tab.source["versions"]["version_scheme"] = -1
               tab.write
@@ -631,7 +631,7 @@ def migrate_tap_migration
 
       next unless (dir = HOMEBREW_CELLAR/name).exist? # skip if formula is not installed.
 
-      tabs = dir.subdirs.map { |d| Tab.for_keg(Keg.new(d)) }
+      tabs = dir.subdirs.map { |d| Keg.new(d).tab }
       next if tabs.first.tap != tap # skip if installed formula is not from this tap.
 
       new_tap = Tap.fetch(new_tap_name)

diff --git a/Library/Homebrew/dev-cmd/bottle.rb b/Library/Homebrew/dev-cmd/bottle.rb
@@ -491,7 +491,7 @@ def bottle_formula(formula)
             Tab.clear_cache
             Dependency.clear_cache
             Requirement.clear_cache
-            tab = Tab.for_keg(keg)
+            tab = keg.tab
             original_tab = tab.dup
             tab.poured_from_bottle = false
             tab.time = nil

diff --git a/Library/Homebrew/diagnostic.rb b/Library/Homebrew/diagnostic.rb
@@ -832,7 +832,7 @@ def check_deleted_formula
         kegs = Keg.all
 
         deleted_formulae = kegs.filter_map do |keg|
-          tap = Tab.for_keg(keg).tap
+          tap = keg.tab.tap
           tap_keg_name = tap ? "#{tap}/#{keg.name}" : keg.name
 
           loadable = [

diff --git a/Library/Homebrew/extend/os/linux/cmd/update-report.rb b/Library/Homebrew/extend/os/linux/cmd/update-report.rb
@@ -23,7 +23,7 @@ def migrate_gcc_dependents_if_needed
       next unless recursive_runtime_dependencies.map(&:name).include? "gcc"
 
       keg = formula.installed_kegs.last
-      tab = Tab.for_keg(keg)
+      tab = keg.tab
       # Force reinstallation upon `brew upgrade` to fix the bottle RPATH.
       tab.source["versions"]["version_scheme"] = -1
       tab.write

diff --git a/Library/Homebrew/extend/os/mac/formula_cellar_checks.rb b/Library/Homebrew/extend/os/mac/formula_cellar_checks.rb
@@ -80,7 +80,7 @@ def check_linkage
           #{checker.display_test_output}
       EOS
 
-      tab = Tab.for_keg(keg)
+      tab = keg.tab
       if tab.poured_from_bottle
         output += <<~EOS
           Rebuild this from source with:

diff --git a/Library/Homebrew/formula.rb b/Library/Homebrew/formula.rb
@@ -751,6 +751,7 @@ def installed_prefixes
   end
 
   # All currently installed kegs.
+  sig { returns(T::Array[Keg]) }
   def installed_kegs
     installed_prefixes.map { |dir| Keg.new(dir) }
   end
@@ -1408,7 +1409,7 @@ def link_overwrite?(path)
     rescue NotAKegError, Errno::ENOENT
       # file doesn't belong to any keg.
     else
-      tab_tap = Tab.for_keg(keg).tap
+      tab_tap = keg.tab.tap
       # this keg doesn't below to any core/tap formula, most likely coming from a DIY install.
       return false if tab_tap.nil?
 
@@ -2147,6 +2148,7 @@ def recursive_requirements(&block)
 
   # Returns a Keg for the opt_prefix or installed_prefix if they exist.
   # If not, return `nil`.
+  sig { returns(Keg) }
   def any_installed_keg
     Formula.cache[:any_installed_keg] ||= {}
     Formula.cache[:any_installed_keg][full_name] ||= if (installed_prefix = any_installed_prefix)
@@ -2328,7 +2330,7 @@ def to_hash
     hsh.merge!(dependencies_hash)
 
     hsh["installed"] = installed_kegs.sort_by(&:scheme_and_version).map do |keg|
-      tab = Tab.for_keg keg
+      tab = keg.tab
       {
         "version"                 => keg.version.to_s,
         "used_options"            => tab.used_options.as_flags,
@@ -2887,7 +2889,7 @@ def eligible_kegs_for_cleanup(quiet: false)
         head - [Keg.new(head_prefix)] + stable.sort_by(&:scheme_and_version).slice(0...-1)
       else
         installed_kegs.select do |keg|
-          tab = Tab.for_keg(keg)
+          tab = keg.tab
           if version_scheme > tab.version_scheme
             true
           elsif version_scheme == tab.version_scheme

diff --git a/Library/Homebrew/formula_installer.rb b/Library/Homebrew/formula_installer.rb
@@ -471,7 +471,7 @@ def install
       Pathname(brew_prefix/"#{formula.name}.rb").atomic_write(s)
 
       keg = Keg.new(formula.prefix)
-      tab = Tab.for_keg(keg)
+      tab = keg.tab
       tab.installed_as_dependency = installed_as_dependency?
       tab.installed_on_request = installed_on_request?
       tab.write
@@ -707,15 +707,15 @@ def install_dependency(dep, inherited_options)
 
     if df.linked_keg.directory?
       linked_keg = Keg.new(df.linked_keg.resolved_path)
-      tab = Tab.for_keg(linked_keg)
+      tab = linked_keg.tab
       keg_had_linked_keg = true
       keg_was_linked = linked_keg.linked?
       linked_keg.unlink
     end
 
     if df.latest_version_installed?
       installed_keg = Keg.new(df.prefix)
-      tab ||= Tab.for_keg(installed_keg)
+      tab ||= installed_keg.tab
       tmp_keg = Pathname.new("#{installed_keg}.tmp")
       installed_keg.rename(tmp_keg)
     end
@@ -822,7 +822,7 @@ def finish
     end
 
     # Update tab with actual runtime dependencies
-    tab = Tab.for_keg(keg)
+    tab = keg.tab
     Tab.clear_cache
     f_runtime_deps = formula.runtime_dependencies(read_from_tab: false)
     tab.runtime_dependencies = Tab.runtime_deps_hash(formula, f_runtime_deps)

diff --git a/Library/Homebrew/formulary.rb b/Library/Homebrew/formulary.rb
@@ -1038,7 +1038,7 @@ def self.from_keg(
     force_bottle: T.unsafe(nil),
     flags: T.unsafe(nil)
   )
-    tab = Tab.for_keg(keg)
+    tab = keg.tab
     tap = tab.tap
     spec ||= tab.spec
 

diff --git a/Library/Homebrew/install.rb b/Library/Homebrew/install.rb
@@ -211,7 +211,7 @@ def install_formula?(
         return false unless formula.opt_prefix.directory?
 
         keg = Keg.new(formula.opt_prefix.resolved_path)
-        tab = Tab.for_keg(keg)
+        tab = keg.tab
         unless tab.installed_on_request
           tab.installed_on_request = true
           tab.write

diff --git a/Library/Homebrew/keg.rb b/Library/Homebrew/keg.rb
@@ -158,6 +158,7 @@ def self.all
                  :to_path, :hash, :abv, :disk_usage, :file_count, :directory?, :exist?, :/,
                  :join, :rename, :find
 
+  sig { params(path: Pathname).void }
   def initialize(path)
     path = path.resolved_path if path.to_s.start_with?("#{HOMEBREW_PREFIX}/opt/")
     raise "#{path} is not a valid keg" if path.parent.parent.realpath != HOMEBREW_CELLAR.realpath

diff --git a/Library/Homebrew/linkage_checker.rb b/Library/Homebrew/linkage_checker.rb
@@ -143,7 +143,7 @@ def check_dylibs(rebuild_cache:)
         end
 
         begin
-          owner = Keg.for Pathname.new(dylib)
+          owner = Keg.for(Pathname(dylib))
         rescue NotAKegError
           @system_dylibs << dylib
         rescue Errno::ENOENT
@@ -159,7 +159,7 @@ def check_dylibs(rebuild_cache:)
             @broken_dylibs << dylib
           end
         else
-          tap = Tab.for_keg(owner).tap
+          tap = owner.tab.tap
           f = if tap.nil? || tap.core_tap?
             owner.name
           else

diff --git a/Library/Homebrew/migrator.rb b/Library/Homebrew/migrator.rb
@@ -128,7 +128,7 @@ def initialize(formula, oldname, force: false)
     @old_cellar = HOMEBREW_CELLAR/oldname
     raise MigratorNoOldpathError, oldname unless old_cellar.exist?
 
-    @old_tabs = old_cellar.subdirs.map { |d| Tab.for_keg(Keg.new(d)) }
+    @old_tabs = old_cellar.subdirs.map { |d| Keg.new(d).tab }
     @old_tap = old_tabs.first.tap
 
     raise MigratorDifferentTapsError.new(formula, oldname, old_tap) if !force && !from_same_tap_user?
@@ -373,7 +373,7 @@ def link_oldname_opt
   # After migration every `INSTALL_RECEIPT.json` has the wrong path to the formula
   # so we must update `INSTALL_RECEIPT`s.
   def update_tabs
-    new_tabs = new_cellar.subdirs.map { |d| Tab.for_keg(Keg.new(d)) }
+    new_tabs = new_cellar.subdirs.map { |d| Keg.new(d).tab }
     new_tabs.each do |tab|
       tab.source["path"] = formula.path.to_s if tab.source["path"]
       tab.write

diff --git a/Library/Homebrew/reinstall.rb b/Library/Homebrew/reinstall.rb
@@ -25,7 +25,7 @@ def reinstall_formula(
   )
     if formula.opt_prefix.directory?
       keg = Keg.new(formula.opt_prefix.resolved_path)
-      tab = Tab.for_keg(keg)
+      tab = keg.tab
       keg_had_linked_opt = true
       keg_was_linked = keg.linked?
       backup keg

diff --git a/Library/Homebrew/tab.rb b/Library/Homebrew/tab.rb
@@ -128,7 +128,11 @@ def self.from_file_content(content, path)
     new(attributes)
   end
 
+  # Get the {Tab} for the given {Keg},
+  # or a fake one if the formula is not installed.
+  #
   # @api internal
+  sig { params(keg: T.any(Keg, Pathname)).returns(T.attached_class) }
   def self.for_keg(keg)
     path = keg/FILENAME
 

diff --git a/Library/Homebrew/test/formula_installer_spec.rb b/Library/Homebrew/test/formula_installer_spec.rb
@@ -30,7 +30,7 @@ def temporary_install(formula, **options)
 
     begin
       Tab.clear_cache
-      expect(Tab.for_keg(keg)).not_to be_poured_from_bottle
+      expect(keg.tab).not_to be_poured_from_bottle
 
       yield formula if block_given?
     ensure

diff --git a/Library/Homebrew/upgrade.rb b/Library/Homebrew/upgrade.rb
@@ -161,7 +161,7 @@ def create_formula_installer(
 
       if formula.opt_prefix.directory?
         keg = Keg.new(formula.opt_prefix.resolved_path)
-        tab = Tab.for_keg(keg)
+        tab = keg.tab
       end
 
       build_options = BuildOptions.new(Options.create(flags), formula.options)

diff --git a/Library/Homebrew/utils/autoremove.rb b/Library/Homebrew/utils/autoremove.rb
@@ -40,7 +40,7 @@ def formulae_with_no_formula_dependents(formulae)
           dependents += formula.runtime_formula_dependencies
 
           # Ignore build dependencies when the formula is a bottle
-          next if Tab.for_keg(formula.any_installed_keg).poured_from_bottle
+          next if formula.any_installed_keg.tab.poured_from_bottle
 
           formula.deps.select(&:build?).each do |dep|
             dependents << dep.to_formula
@@ -57,7 +57,7 @@ def formulae_with_no_formula_dependents(formulae)
       sig { params(formulae: T::Array[Formula]).returns(T::Array[Formula]) }
       def unused_formulae_with_no_formula_dependents(formulae)
         unused_formulae = formulae_with_no_formula_dependents(formulae).reject do |f|
-          Tab.for_keg(f.any_installed_keg).installed_on_request
+          f.any_installed_keg.tab.installed_on_request
         end
 
         unless unused_formulae.empty?