Class: Homebrew::Cleanup Private

Inherits:

Object

Object
Homebrew::Cleanup

show all

Extended by:: Utils::Output::Mixin

Includes:: OS::Linux::Cleanup, OS::Mac::Cleanup, Utils::Output::Mixin

Defined in:: cleanup.rb

Overview

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.

Helper class for cleaning up the Homebrew cache.

Constant Summary collapse

PERIODIC_CLEAN_FILE =

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.

T.let((HOMEBREW_CACHE/".cleaned").freeze, Pathname)

Instance Attribute Summary collapse

#args ⇒ Array<String> readonly private
#cache ⇒ Pathname readonly private
#days ⇒ Integer readonly private
#disk_cleanup_size ⇒ Integer readonly private

Class Method Summary collapse

.autoremove(dry_run: false) ⇒ void private
.dry_run_output(*args, formulae: []) ⇒ String private
.go_cache_directory?(pathname) ⇒ Boolean private
.incomplete?(pathname) ⇒ Boolean private
.install_cleanup_formulae(formulae) ⇒ Array<Formula> private
.install_formula_clean!(formula) ⇒ void private
.nested_cache?(pathname) ⇒ Boolean private
.periodic_clean!(dry_run: false) ⇒ void private
.periodic_clean_due? ⇒ Boolean private
.printed_dry_run_output?(output, ohai: false) ⇒ Boolean private
.prune?(pathname, days) ⇒ Boolean private
.puts_no_install_cleanup_disable_message ⇒ void private
.puts_no_install_cleanup_disable_message_if_not_already! ⇒ void private
.skip_clean_formula?(formula) ⇒ Boolean private
.stale?(entry, scrub: false) ⇒ Boolean private

Instance Method Summary collapse

#cache_files ⇒ Array<Hash> private
#clean!(quiet: false, periodic: false) ⇒ void private
#cleanup_bootsnap ⇒ void private
#cleanup_cache(entries = nil) ⇒ void private
#cleanup_cache_db(rack = nil) ⇒ void private
#cleanup_cask(cask, ds_store: true) ⇒ void private
#cleanup_empty_api_source_directories(directory = cache/"api-source") ⇒ void private
#cleanup_formula(formula, quiet: false, ds_store: true, cache_db: true) ⇒ void private
#cleanup_keg(keg) ⇒ void private
#cleanup_lockfiles(*lockfiles) ⇒ void private
#cleanup_logs ⇒ void private
#cleanup_path(path, &_block) ⇒ void private
#cleanup_portable_ruby ⇒ void private
#cleanup_python_site_packages ⇒ void private
#cleanup_temp_cellar ⇒ void private
#cleanup_unreferenced_downloads ⇒ void private
#dry_run? ⇒ Boolean private
#initialize(*args, dry_run: false, scrub: false, days: nil, cache: HOMEBREW_CACHE) ⇒ void constructor private
#prune? ⇒ Boolean private
#prune_prefix_symlinks_and_directories ⇒ void private
#rm_ds_store(dirs = nil) ⇒ void private
#scrub? ⇒ Boolean private
#unremovable_kegs ⇒ Array<Keg> private
#use_system_ruby? ⇒ Boolean private

Methods included from Utils::Output::Mixin

issue_reporting_message, odebug, odeprecated, odie, odisabled, ofail, oh1, oh1_title, ohai, ohai_title, onoe, opoo, opoo_outside_github_actions, opoo_without_github_actions_annotation, pretty_deprecated, pretty_disabled, pretty_duration, pretty_install_status, pretty_installed, pretty_outdated, pretty_uninstalled, pretty_upgradable

Constructor Details

#initialize(*args, dry_run: false, scrub: false, days: nil, cache: HOMEBREW_CACHE) ⇒ `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:

args (String)
dry_run (Boolean) (defaults to: false)
scrub (Boolean) (defaults to: false)
days (Integer, nil) (defaults to: nil)
cache (Pathname) (defaults to: HOMEBREW_CACHE)

# File 'cleanup.rb', line 256

def initialize(*args, dry_run: false, scrub: false, days: nil, cache: HOMEBREW_CACHE)
  @disk_cleanup_size = T.let(0, Integer)
  @args = args
  @dry_run = dry_run
  @scrub = scrub
  @prune = T.let(days.present?, T::Boolean)
  @days = T.let(days || Homebrew::EnvConfig.cleanup_max_age_days.to_i, Integer)
  @cache = cache
  @cleaned_up_paths = T.let(Set.new, T::Set[Pathname])
end

Instance Attribute Details

#args ⇒ `Array<String>` (readonly)

Returns:

(Array<String>)



242
243
244

# File 'cleanup.rb', line 242

def args
  @args
end

#cache ⇒ `Pathname` (readonly)

Returns:

(Pathname)



248
249
250

# File 'cleanup.rb', line 248

def cache
  @cache
end

#days ⇒ `Integer` (readonly)

Returns:

(Integer)



245
246
247

# File 'cleanup.rb', line 245

def days
  @days
end

#disk_cleanup_size ⇒ `Integer` (readonly)

Returns:

(Integer)



251
252
253

# File 'cleanup.rb', line 251

def disk_cleanup_size
  @disk_cleanup_size
end

Class Method Details

.autoremove(dry_run: false) ⇒ `void`

This method returns an undefined value.

Parameters:

dry_run (Boolean) (defaults to: false)

# File 'cleanup.rb', line 820

def self.autoremove(dry_run: false)
  require "utils/autoremove"
  require "cask/caskroom"

  # If this runs after install, uninstall, reinstall or upgrade,
  # the cache of installed formulae may no longer be valid.
  Formula.clear_cache unless dry_run

  formulae = Formula.installed
  # Remove formulae listed in HOMEBREW_NO_CLEANUP_FORMULAE and their dependencies.
  if Homebrew::EnvConfig.no_cleanup_formulae.present?
    formulae -= formulae.select { skip_clean_formula?(it) }
                        .flat_map { |f| [f, *f.installed_runtime_formula_dependencies] }
  end
  casks = Cask::Caskroom.casks

  removable_formulae = Utils::Autoremove.removable_formulae(formulae, casks)
  if (candidate_kegs = removable_formulae.filter_map(&:any_installed_keg).presence) &&
     (required_kegs, = InstalledDependents.find_some_installed_dependents(candidate_kegs)) &&
     (required_names = Set.new(required_kegs.map(&:name)).presence)
    removable_formulae.reject! { |formula| required_names.include?(formula.name) }
  end

  return if removable_formulae.blank?

  formulae_names = removable_formulae.map(&:full_name).sort

  verb = dry_run ? "Would autoremove" : "Autoremoving"
  oh1 "#{verb} #{formulae_names.count} unneeded #{Utils.pluralize("formula", formulae_names.count)}:"
  puts formulae_names.join("\n")
  return if dry_run

  require "uninstall"

  kegs_by_rack = removable_formulae.filter_map(&:any_installed_keg).group_by(&:rack)
  Uninstall.uninstall_kegs(kegs_by_rack)

  # The installed formula cache will be invalid after uninstalling.
  Formula.clear_cache
end

.dry_run_output(*args, formulae: []) ⇒ `String`

Parameters:

args (String)
formulae (Array<Formula>) (defaults to: [])

Returns:

(String)

# File 'cleanup.rb', line 291

def self.dry_run_output(*args, formulae: [])
  output = StringIO.new
  old_stdout = $stdout
  begin
    $stdout = output
    cleanup = Cleanup.new(*args, dry_run: true)
    if formulae.empty?
      cleanup.clean!
    else
      formulae.each { |formula| cleanup.cleanup_formula(formula) }
    end
  ensure
    $stdout = old_stdout
  end
  output.string
end

.go_cache_directory?(pathname) ⇒ `Boolean`

Parameters:

pathname (Pathname)

Returns:

(Boolean)

# File 'cleanup.rb', line 43

def go_cache_directory?(pathname)
  # Go makes its cache contents read-only to ensure cache integrity,
  # which makes sense but is something we need to undo for cleanup.
  pathname.directory? && %w[go_cache go_mod_cache].include?(pathname.basename.to_s)
end

.incomplete?(pathname) ⇒ `Boolean`

Parameters:

pathname (Pathname)

Returns:

(Boolean)



24
25
26

# File 'cleanup.rb', line 24

def incomplete?(pathname)
  pathname.extname.end_with?(".incomplete")
end

.install_cleanup_formulae(formulae) ⇒ `Array<Formula>`

Parameters:

formulae (Array<Formula>)

Returns:

(Array<Formula>)

# File 'cleanup.rb', line 309

def self.install_cleanup_formulae(formulae)
  return [] if Homebrew::EnvConfig.no_install_cleanup?

  formulae.select do |formula|
    formula.latest_version_installed? && !skip_clean_formula?(formula)
  end
end

.install_formula_clean!(formula) ⇒ `void`

This method returns an undefined value.

Parameters:

formula (Formula)

# File 'cleanup.rb', line 318

def self.install_formula_clean!(formula)
  return if install_cleanup_formulae([formula]).blank?

  ohai "Running `brew cleanup #{formula}`..."
  puts_no_install_cleanup_disable_message_if_not_already!
  Cleanup.new.cleanup_formula(formula)
end

.nested_cache?(pathname) ⇒ `Boolean`

Parameters:

pathname (Pathname)

Returns:

(Boolean)

# File 'cleanup.rb', line 29

def nested_cache?(pathname)
  pathname.directory? && %w[
    cargo_cache
    go_cache
    go_mod_cache
    glide_home
    java_cache
    npm_cache
    pip_cache
    gclient_cache
  ].include?(pathname.basename.to_s)
end

.periodic_clean!(dry_run: false) ⇒ `void`

This method returns an undefined value.

Parameters:

dry_run (Boolean) (defaults to: false)

# File 'cleanup.rb', line 366

def self.periodic_clean!(dry_run: false)
  return if Homebrew::EnvConfig.no_install_cleanup?
  return unless periodic_clean_due?

  if dry_run
    oh1 "Would run `brew cleanup` which has not been run in the last #{CLEANUP_DEFAULT_DAYS} days"
  else
    oh1 "`brew cleanup` has not been run in the last #{CLEANUP_DEFAULT_DAYS} days, running now..."
  end

  puts_no_install_cleanup_disable_message
  return if dry_run

  Cleanup.new.clean!(quiet: true, periodic: true)
end

.periodic_clean_due? ⇒ `Boolean`

Returns:

(Boolean)

# File 'cleanup.rb', line 353

def self.periodic_clean_due?
  return false if Homebrew::EnvConfig.no_install_cleanup?

  unless PERIODIC_CLEAN_FILE.exist?
    HOMEBREW_CACHE.mkpath
    FileUtils.touch PERIODIC_CLEAN_FILE
    return false
  end

  PERIODIC_CLEAN_FILE.mtime < (DateTime.now - CLEANUP_DEFAULT_DAYS).to_time
end

.printed_dry_run_output?(output, ohai: false) ⇒ `Boolean`

Parameters:

output (String)
ohai (Boolean) (defaults to: false)

Returns:

(Boolean)

# File 'cleanup.rb', line 277

def self.printed_dry_run_output?(output, ohai: false)
  return false if output.blank?

  if ohai
    ohai "Would `brew cleanup`"
  else
    puts "Would `brew cleanup`:"
  end
  print output
  puts unless output.end_with?("\n")
  true
end

.prune?(pathname, days) ⇒ `Boolean`

Parameters:

pathname (Pathname)
days (Integer, nil)

Returns:

(Boolean)

# File 'cleanup.rb', line 50

def prune?(pathname, days)
  return false unless days
  return true if days.zero?
  return true if pathname.symlink? && !pathname.exist?

  days_ago = (DateTime.now - days).to_time
  pathname.mtime < days_ago && pathname.ctime < days_ago
end

.puts_no_install_cleanup_disable_message ⇒ `void`

This method returns an undefined value.

# File 'cleanup.rb', line 327

def self.puts_no_install_cleanup_disable_message
  return if Homebrew::EnvConfig.no_env_hints?
  return if Homebrew::EnvConfig.no_install_cleanup?

  puts "Disable this behaviour by setting `HOMEBREW_NO_INSTALL_CLEANUP=1`."
  puts "Hide these hints with `HOMEBREW_NO_ENV_HINTS=1` (see `man brew`)."
end

.puts_no_install_cleanup_disable_message_if_not_already! ⇒ `void`

This method returns an undefined value.

# File 'cleanup.rb', line 336

def self.puts_no_install_cleanup_disable_message_if_not_already!
  return if @puts_no_install_cleanup_disable_message_if_not_already

  puts_no_install_cleanup_disable_message
  @puts_no_install_cleanup_disable_message_if_not_already = T.let(true, T.nilable(TrueClass))
end

.skip_clean_formula?(formula) ⇒ `Boolean`

Parameters:

formula (Formula)

Returns:

(Boolean)

# File 'cleanup.rb', line 344

def self.skip_clean_formula?(formula)
  no_cleanup_formula = Homebrew::EnvConfig.no_cleanup_formulae
  return false if no_cleanup_formula.blank?

  @skip_clean_formulae ||= T.let(no_cleanup_formula.split(","), T.nilable(T::Array[String]))
  @skip_clean_formulae.include?(formula.name) || @skip_clean_formulae.intersect?(formula.aliases)
end

.stale?(entry, scrub: false) ⇒ `Boolean`

Parameters:

entry (Hash)
scrub (Boolean) (defaults to: false)

Returns:

(Boolean)

# File 'cleanup.rb', line 60

def stale?(entry, scrub: false)
  pathname = entry[:path]
  return false unless pathname.resolved_path.file?

  case entry[:type]
  when :api_source
    stale_api_source?(pathname, scrub)
  when :cask
    stale_cask?(pathname, scrub)
  when :gh_actions_artifact
    stale_gh_actions_artifact?(pathname, scrub)
  else
    stale_formula?(pathname, scrub)
  end
end

Instance Method Details

#cache_files ⇒ `Array<Hash>`

Returns:

(Array<Hash>)

# File 'cleanup.rb', line 497

def cache_files
  files = cache.directory? ? cache.children : []
  cask_files = (cache/"Cask").directory? ? (cache/"Cask").children : []
  api_source_files = (cache/"api-source").glob("*/*/*/**/*").select { |path| path.file? || path.symlink? }
  gh_actions_artifacts = (cache/"gh-actions-artifact").directory? ? (cache/"gh-actions-artifact").children : []

  files.map { |path| { path:, type: nil } } +
    cask_files.map { |path| { path:, type: :cask } } +
    api_source_files.map { |path| { path:, type: :api_source } } +
    gh_actions_artifacts.map { |path| { path:, type: :gh_actions_artifact } }
end

#clean!(quiet: false, periodic: false) ⇒ `void`

This method returns an undefined value.

Parameters:

quiet (Boolean) (defaults to: false)
periodic (Boolean) (defaults to: false)

# File 'cleanup.rb', line 383

def clean!(quiet: false, periodic: false)
  if args.empty?
    Formula.installed
           .sort_by(&:name)
           .reject { |f| Cleanup.skip_clean_formula?(f) }
           .each do |formula|
      cleanup_formula(formula, quiet:, ds_store: false, cache_db: false)
    end

    if ENV["HOMEBREW_AUTOREMOVE"].present?
      opoo "`$HOMEBREW_AUTOREMOVE` is now a no-op as it is the default behaviour. " \
           "Set `HOMEBREW_NO_AUTOREMOVE=1` to disable it."
    end
    Cleanup.autoremove(dry_run: dry_run?) unless Homebrew::EnvConfig.no_autoremove?

    cleanup_cache
    cleanup_empty_api_source_directories
    cleanup_bootsnap
    cleanup_logs
    cleanup_temp_cellar
    cleanup_lockfiles
    cleanup_python_site_packages
    prune_prefix_symlinks_and_directories

    unless dry_run?
      cleanup_cache_db
      rm_ds_store
      HOMEBREW_CACHE.mkpath
      FileUtils.touch PERIODIC_CLEAN_FILE
    end

    # Cleaning up Ruby needs to be done last to avoid requiring additional
    # files afterwards. Additionally, don't allow it on periodic cleans to
    # avoid having to try to do a `brew install` when we've just deleted
    # the running Ruby process...
    return if periodic

    cleanup_portable_ruby
  else
    args.each do |arg|
      formula = begin
        Formulary.resolve(arg)
      rescue FormulaUnavailableError, TapFormulaAmbiguityError
        nil
      end

      cask = begin
        Cask::CaskLoader.load(arg)
      rescue Cask::CaskError
        nil
      end

      if formula && Cleanup.skip_clean_formula?(formula)
        onoe "Refusing to clean #{formula} because it is listed in " \
             "#{Tty.bold}HOMEBREW_NO_CLEANUP_FORMULAE#{Tty.reset}!"
      elsif formula
        cleanup_formula(formula)
      end
      cleanup_cask(cask) if cask
    end
  end
end

#cleanup_bootsnap ⇒ `void`

This method returns an undefined value.

# File 'cleanup.rb', line 658

def cleanup_bootsnap
  bootsnap = cache/"bootsnap"
  return unless bootsnap.directory?

  bootsnap.each_child do |subdir|
    cleanup_path(subdir) { FileUtils.rm_r(subdir) } if subdir.basename.to_s != Homebrew::Bootsnap.key
  end
end

#cleanup_cache(entries = nil) ⇒ `void`

This method returns an undefined value.

Parameters:

entries (Array<Hash>, nil) (defaults to: nil)

# File 'cleanup.rb', line 550

def cleanup_cache(entries = nil)
  entries ||= cache_files

  entries.each do |entry|
    path = entry[:path]
    next if path == PERIODIC_CLEAN_FILE

    FileUtils.chmod_R 0755, path if self.class.go_cache_directory?(path) && !dry_run?
    next cleanup_path(path) { path.unlink } if self.class.incomplete?(path)
    next cleanup_path(path) { FileUtils.rm_rf path } if self.class.nested_cache?(path)

    if self.class.prune?(path, days)
      if path.file? || path.symlink?
        cleanup_path(path) { path.unlink }
      elsif path.directory? && path.to_s.include?("--")
        cleanup_path(path) { FileUtils.rm_rf path }
      end
      next
    end

    # If we've specified --prune don't do the (expensive) .stale? check.
    cleanup_path(path) { path.unlink } if !prune? && self.class.stale?(entry, scrub: scrub?)
  end

  cleanup_unreferenced_downloads
end

#cleanup_cache_db(rack = nil) ⇒ `void`

This method returns an undefined value.

Parameters:

rack (Pathname, nil) (defaults to: nil)

# File 'cleanup.rb', line 668

def cleanup_cache_db(rack = nil)
  FileUtils.rm_rf [
    cache/"desc_cache.json",
    cache/"linkage.db",
    cache/"linkage.db.db",
  ]

  CacheStoreDatabase.use(:linkage) do |db|
    break unless db.created?

    db.each_key do |keg|
      keg = T.cast(keg, String)
      next if rack.present? && !keg.start_with?("#{rack}/")
      next if File.directory?(keg)

      LinkageCacheStore.new(
        keg,
        T.cast(db, CacheStoreDatabase[String, T::Hash[T.any(String, Symbol), T.anything]]),
      ).delete!
    end
  end
end

#cleanup_cask(cask, ds_store: true) ⇒ `void`

This method returns an undefined value.

Parameters:

cask (Cask::Cask)
ds_store (Boolean) (defaults to: true)

# File 'cleanup.rb', line 462

def cleanup_cask(cask, ds_store: true)
  cleanup_cache(Pathname.glob(cache/"Cask/#{cask.token}--*").map { |path| { path:, type: :cask } })
  rm_ds_store([cask.caskroom_path]) if ds_store
  cleanup_lockfiles(CaskLock.new(cask.token).path)
end

#cleanup_empty_api_source_directories(directory = cache/"api-source") ⇒ `void`

This method returns an undefined value.

Parameters:

directory (Pathname) (defaults to: cache/"api-source")

# File 'cleanup.rb', line 510

def cleanup_empty_api_source_directories(directory = cache/"api-source")
  return if dry_run?
  return unless directory.directory?

  directory.each_child do |child|
    next unless child.directory?

    cleanup_empty_api_source_directories(child)
    child.rmdir if child.empty?
  end
end

#cleanup_formula(formula, quiet: false, ds_store: true, cache_db: true) ⇒ `void`

This method returns an undefined value.

Parameters:

formula (Formula)
quiet (Boolean) (defaults to: false)
ds_store (Boolean) (defaults to: true)
cache_db (Boolean) (defaults to: true)

# File 'cleanup.rb', line 452

def cleanup_formula(formula, quiet: false, ds_store: true, cache_db: true)
  formula.eligible_kegs_for_cleanup(quiet:)
         .each { |keg| cleanup_keg(keg) }
  cleanup_cache(Pathname.glob(cache/"#{formula.name}{_bottle_manifest,}--*").map { |path| { path:, type: nil } })
  rm_ds_store([formula.rack]) if ds_store
  cleanup_cache_db(formula.rack) if cache_db
  cleanup_lockfiles(FormulaLock.new(formula.name).path)
end

#cleanup_keg(keg) ⇒ `void`

This method returns an undefined value.

Parameters:

keg (Keg)

# File 'cleanup.rb', line 469

def cleanup_keg(keg)
  cleanup_path(Pathname.new(keg)) { keg.uninstall(raise_failures: true) }
rescue Errno::EACCES, Errno::ENOTEMPTY => e
  opoo e.message
  unremovable_kegs << keg
end

#cleanup_lockfiles(*lockfiles) ⇒ `void`

This method returns an undefined value.

Parameters:

lockfiles (Pathname)

# File 'cleanup.rb', line 593

def cleanup_lockfiles(*lockfiles)
  return if dry_run?

  lockfiles = HOMEBREW_LOCKS.children.select(&:file?) if lockfiles.empty? && HOMEBREW_LOCKS.directory?

  lockfiles.each do |file|
    next unless file.readable?

    file.open(File::RDWR) do |lockfile|
      next unless lockfile.flock(File::LOCK_EX | File::LOCK_NB)

      begin
        file.unlink
      ensure
        lockfile.flock(File::LOCK_UN) if file.exist?
      end
    end
  end
end

#cleanup_logs ⇒ `void`

This method returns an undefined value.

# File 'cleanup.rb', line 477

def cleanup_logs
  return unless HOMEBREW_LOGS.directory?

  logs_days = [days, CLEANUP_DEFAULT_DAYS].min

  HOMEBREW_LOGS.subdirs.each do |dir|
    cleanup_path(dir) { FileUtils.rm_r(dir) } if self.class.prune?(dir, logs_days)
  end
end

#cleanup_path(path, &_block) ⇒ `void`

This method returns an undefined value.

Parameters:

path (Pathname)
_block (T.proc.void)

# File 'cleanup.rb', line 578

def cleanup_path(path, &_block)
  return unless path.exist?
  return unless @cleaned_up_paths.add?(path)

  @disk_cleanup_size += path.disk_usage

  if dry_run?
    puts "Would remove: #{path} (#{path.abv})"
  else
    puts "Removing: #{path}... (#{path.abv})"
    yield
  end
end

#cleanup_portable_ruby ⇒ `void`

This method returns an undefined value.

# File 'cleanup.rb', line 614

def cleanup_portable_ruby
  vendor_dir = HOMEBREW_LIBRARY/"Homebrew/vendor"
  portable_ruby_latest_version = (vendor_dir/"portable-ruby-version").read.chomp

  portable_rubies_to_remove = []
  Pathname.glob(vendor_dir/"portable-ruby/*.*").select(&:directory?).each do |path|
    next if !use_system_ruby? && portable_ruby_latest_version == path.basename.to_s

    portable_rubies_to_remove << path
  end

  return if portable_rubies_to_remove.empty?

  bundler_paths = (vendor_dir/"bundle/ruby").children.select do |child|
    basename = child.basename.to_s

    next false if basename == ".homebrew_gem_groups"
    next true unless child.directory?

    [
      "#{Version.new(portable_ruby_latest_version).major_minor}.0",
      RbConfig::CONFIG["ruby_version"],
    ].uniq.exclude?(basename)
  end

  bundler_paths.each do |bundler_path|
    if dry_run?
      puts Utils.popen_read("git", "-C", HOMEBREW_REPOSITORY, "clean", "-nx", bundler_path).chomp
    else
      puts Utils.popen_read("git", "-C", HOMEBREW_REPOSITORY, "clean", "-ffqx", bundler_path).chomp
    end
  end

  portable_rubies_to_remove.each do |portable_ruby|
    cleanup_path(portable_ruby) { FileUtils.rm_r(portable_ruby) }
  end
end

#cleanup_python_site_packages ⇒ `void`

This method returns an undefined value.

# File 'cleanup.rb', line 707

def cleanup_python_site_packages
  pyc_files = Hash.new { |h, k| h[k] = [] }
  seen_non_pyc_file = Hash.new { |h, k| h[k] = false }
  unused_pyc_files = []

  HOMEBREW_PREFIX.glob("lib/python*/site-packages").each do |site_packages|
    site_packages.each_child do |child|
      next unless child.directory?
      # TODO: Work out a sensible way to clean up `pip`'s, `setuptools`' and `wheel`'s
      #       `{dist,site}-info` directories. Alternatively, consider always removing
      #       all `-info` directories, because we may not be making use of them.
      next if child.basename.to_s.end_with?("-info")

      # Clean up old *.pyc files in the top-level __pycache__.
      if child.basename.to_s == "__pycache__"
        child.find do |path|
          next if path.extname != ".pyc"
          next unless self.class.prune?(path, days)

          unused_pyc_files << path
        end

        next
      end

      # Look for directories that contain only *.pyc files.
      child.find do |path|
        next if path.directory?

        if path.extname == ".pyc"
          pyc_files[child] << path
        else
          seen_non_pyc_file[child] = true
          break
        end
      end
    end
  end

  unused_pyc_files += pyc_files.reject { |k,| seen_non_pyc_file[k] }
                               .values
                               .flatten
  return if unused_pyc_files.blank?

  unused_pyc_files.each do |pyc|
    cleanup_path(pyc) { pyc.unlink }
  end
end

#cleanup_temp_cellar ⇒ `void`

This method returns an undefined value.

# File 'cleanup.rb', line 488

def cleanup_temp_cellar
  return unless HOMEBREW_TEMP_CELLAR.directory?

  HOMEBREW_TEMP_CELLAR.each_child do |child|
    cleanup_path(child) { FileUtils.rm_r(child) }
  end
end

#cleanup_unreferenced_downloads ⇒ `void`

This method returns an undefined value.

# File 'cleanup.rb', line 523

def cleanup_unreferenced_downloads
  return if dry_run?
  return unless (cache/"downloads").directory?

  downloads = (cache/"downloads").children

  referenced_downloads = cache_files.map { |file| file[:path] }.select(&:symlink?).map(&:resolved_path)

  (downloads - referenced_downloads).each do |download|
    if self.class.incomplete?(download)
      begin
        DownloadLock.new(download).with_lock do
          download.unlink
        end
      rescue OperationInProgressError
        # Skip incomplete downloads which are still in progress.
        next
      end
    elsif download.directory?
      FileUtils.rm_rf download
    else
      download.unlink
    end
  end
end

#dry_run? ⇒ `Boolean`

Returns:

(Boolean)

268	# File 'cleanup.rb', line 268 def dry_run? = @dry_run

#prune? ⇒ `Boolean`

Returns:

(Boolean)

271	# File 'cleanup.rb', line 271 def prune? = @prune

#prune_prefix_symlinks_and_directories ⇒ `void`

This method returns an undefined value.

# File 'cleanup.rb', line 757

def prune_prefix_symlinks_and_directories
  ObserverPathnameExtension.reset_counts!

  dirs = []
  children_count = {}

  Keg.must_exist_subdirectories.each do |dir|
    next unless dir.directory?

    dir.find do |path|
      path.extend(ObserverPathnameExtension)
      if path.symlink?
        unless path.resolved_path_exists?
          path.uninstall_info if path.to_s.match?(Keg::INFOFILE_RX) && !dry_run?

          if dry_run?
            puts "Would remove (broken link): #{path}"
            children_count[path.dirname] -= 1 if children_count.key?(path.dirname)
          else
            path.unlink
          end
        end
      elsif path.directory? && Keg.must_exist_subdirectories.exclude?(path)
        dirs << path
        children_count[path] = path.children.length if dry_run?
      end
    end
  end

  dirs.reverse_each do |d|
    if !dry_run?
      d.rmdir_if_possible
    elsif children_count[d].zero?
      puts "Would remove (empty directory): #{d}"
      children_count[d.dirname] -= 1 if children_count.key?(d.dirname)
    end
  end

  require "cask/caskroom"
  if Cask::Caskroom.path.directory?
    Cask::Caskroom.path.each_child do |path|
      path.extend(ObserverPathnameExtension)
      next if !path.symlink? || path.resolved_path_exists?

      if dry_run?
        puts "Would remove (broken link): #{path}"
      else
        path.unlink
      end
    end
  end

  return if dry_run?

  return if ObserverPathnameExtension.total.zero?

  n, d = ObserverPathnameExtension.counts
  print "Pruned #{n} symbolic links "
  print "and #{d} directories " if d.positive?
  puts "from #{HOMEBREW_PREFIX}"
end

#rm_ds_store(dirs = nil) ⇒ `void`

This method returns an undefined value.

Parameters:

dirs (Array<Pathname>, nil) (defaults to: nil)

# File 'cleanup.rb', line 692

def rm_ds_store(dirs = nil)
  dirs ||= Keg.must_exist_directories + [
    HOMEBREW_PREFIX/"Caskroom",
  ]
  dirs.select(&:directory?)
      .flat_map { |d| Pathname.glob("#{d}/**/.DS_Store") }
      .each do |dir|
        dir.unlink
      rescue Errno::EACCES
        # don't care if we can't delete a .DS_Store
        nil
      end
end

#scrub? ⇒ `Boolean`

Returns:

(Boolean)

274	# File 'cleanup.rb', line 274 def scrub? = @scrub

#unremovable_kegs ⇒ `Array<Keg>`

Returns:

(Array<Keg>)



447
448
449

# File 'cleanup.rb', line 447

def unremovable_kegs
  @unremovable_kegs ||= T.let([], T.nilable(T::Array[Keg]))
end

#use_system_ruby? ⇒ `Boolean`

Returns:

(Boolean)



653
654
655

# File 'cleanup.rb', line 653

def use_system_ruby?
  false
end

Class: Homebrew::Cleanup Private

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Utils::Output::Mixin

Constructor Details

#initialize(*args, dry_run: false, scrub: false, days: nil, cache: HOMEBREW_CACHE) ⇒ void

Instance Attribute Details

#args ⇒ Array<String> (readonly)

#cache ⇒ Pathname (readonly)

#days ⇒ Integer (readonly)

#disk_cleanup_size ⇒ Integer (readonly)

Class Method Details

.autoremove(dry_run: false) ⇒ void

.dry_run_output(*args, formulae: []) ⇒ String

.go_cache_directory?(pathname) ⇒ Boolean

.incomplete?(pathname) ⇒ Boolean

.install_cleanup_formulae(formulae) ⇒ Array<Formula>

.install_formula_clean!(formula) ⇒ void

.nested_cache?(pathname) ⇒ Boolean

.periodic_clean!(dry_run: false) ⇒ void

.periodic_clean_due? ⇒ Boolean

.printed_dry_run_output?(output, ohai: false) ⇒ Boolean

.prune?(pathname, days) ⇒ Boolean

.puts_no_install_cleanup_disable_message ⇒ void

.puts_no_install_cleanup_disable_message_if_not_already! ⇒ void

.skip_clean_formula?(formula) ⇒ Boolean

.stale?(entry, scrub: false) ⇒ Boolean

Instance Method Details

#cache_files ⇒ Array<Hash>

#clean!(quiet: false, periodic: false) ⇒ void

#cleanup_bootsnap ⇒ void

#cleanup_cache(entries = nil) ⇒ void

#cleanup_cache_db(rack = nil) ⇒ void

#cleanup_cask(cask, ds_store: true) ⇒ void

#cleanup_empty_api_source_directories(directory = cache/"api-source") ⇒ void

#cleanup_formula(formula, quiet: false, ds_store: true, cache_db: true) ⇒ void

#cleanup_keg(keg) ⇒ void

#cleanup_lockfiles(*lockfiles) ⇒ void

#cleanup_logs ⇒ void

#cleanup_path(path, &_block) ⇒ void

#cleanup_portable_ruby ⇒ void

#cleanup_python_site_packages ⇒ void

#cleanup_temp_cellar ⇒ void

#cleanup_unreferenced_downloads ⇒ void

#dry_run? ⇒ Boolean

#prune? ⇒ Boolean

#prune_prefix_symlinks_and_directories ⇒ void

#rm_ds_store(dirs = nil) ⇒ void

#scrub? ⇒ Boolean

#unremovable_kegs ⇒ Array<Keg>

#use_system_ruby? ⇒ Boolean

#initialize(*args, dry_run: false, scrub: false, days: nil, cache: HOMEBREW_CACHE) ⇒ `void`

#args ⇒ `Array<String>` (readonly)

#cache ⇒ `Pathname` (readonly)

#days ⇒ `Integer` (readonly)

#disk_cleanup_size ⇒ `Integer` (readonly)

.autoremove(dry_run: false) ⇒ `void`

.dry_run_output(*args, formulae: []) ⇒ `String`

.go_cache_directory?(pathname) ⇒ `Boolean`

.incomplete?(pathname) ⇒ `Boolean`

.install_cleanup_formulae(formulae) ⇒ `Array<Formula>`

.install_formula_clean!(formula) ⇒ `void`

.nested_cache?(pathname) ⇒ `Boolean`

.periodic_clean!(dry_run: false) ⇒ `void`

.periodic_clean_due? ⇒ `Boolean`

.printed_dry_run_output?(output, ohai: false) ⇒ `Boolean`

.prune?(pathname, days) ⇒ `Boolean`

.puts_no_install_cleanup_disable_message ⇒ `void`

.puts_no_install_cleanup_disable_message_if_not_already! ⇒ `void`

.skip_clean_formula?(formula) ⇒ `Boolean`

.stale?(entry, scrub: false) ⇒ `Boolean`

#cache_files ⇒ `Array<Hash>`

#clean!(quiet: false, periodic: false) ⇒ `void`

#cleanup_bootsnap ⇒ `void`

#cleanup_cache(entries = nil) ⇒ `void`

#cleanup_cache_db(rack = nil) ⇒ `void`

#cleanup_cask(cask, ds_store: true) ⇒ `void`

#cleanup_empty_api_source_directories(directory = cache/"api-source") ⇒ `void`

#cleanup_formula(formula, quiet: false, ds_store: true, cache_db: true) ⇒ `void`

#cleanup_keg(keg) ⇒ `void`

#cleanup_lockfiles(*lockfiles) ⇒ `void`

#cleanup_logs ⇒ `void`

#cleanup_path(path, &_block) ⇒ `void`

#cleanup_portable_ruby ⇒ `void`

#cleanup_python_site_packages ⇒ `void`

#cleanup_temp_cellar ⇒ `void`

#cleanup_unreferenced_downloads ⇒ `void`

#dry_run? ⇒ `Boolean`

#prune? ⇒ `Boolean`

#prune_prefix_symlinks_and_directories ⇒ `void`

#rm_ds_store(dirs = nil) ⇒ `void`

#scrub? ⇒ `Boolean`

#unremovable_kegs ⇒ `Array<Keg>`

#use_system_ruby? ⇒ `Boolean`