Class: ReporterHub

Inherits:

Object

• Object
• ReporterHub

Defined in:

cmd/update-report.rb

Instance Attribute Summary

• #reporters ⇒ Object readonly private

  Returns the value of attribute reporters.

Instance Method Summary

• #add(reporter, auto_update: false) ⇒ Object
• #dump(auto_update: false) ⇒ Object
• #empty? ⇒ Boolean
• #initialize ⇒ void constructor private
• #select_formula_or_cask(key) ⇒ Object

Constructor Details

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

# File 'cmd/update-report.rb', line 737

def initialize
  @hash = {}
  @reporters = []
end

Instance Attribute Details

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

# File 'cmd/update-report.rb', line 734

def reporters
  @reporters
end

Instance Method Details

#add(reporter, auto_update: false) ⇒ Object

# File 'cmd/update-report.rb', line 746

def add(reporter, auto_update: false)
  @reporters << reporter
  report = reporter.report(auto_update:).delete_if { |_k, v| v.empty? }
  @hash.update(report) { |_key, oldval, newval| oldval.concat(newval) }
end

#dump(auto_update: false) ⇒ Object

# File 'cmd/update-report.rb', line 756

def dump(auto_update: false)
  report_all = ENV["HOMEBREW_UPDATE_REPORT_ALL_FORMULAE"].present?
  if report_all && !Homebrew::EnvConfig.no_install_from_api?
    odisabled "`HOMEBREW_UPDATE_REPORT_ALL_FORMULAE`"
    opoo "This will not report all formulae because Homebrew cannot get this data from the API."
    report_all = false
  end

  unless Homebrew::EnvConfig.no_update_report_new?
    dump_new_formula_report
    dump_new_cask_report
  end

  if report_all
    dump_renamed_formula_report
    dump_renamed_cask_report
  end

  dump_deleted_formula_report(report_all)
  dump_deleted_cask_report(report_all)

  outdated_formulae = []
  outdated_casks = []

  if report_all
    if auto_update
      if (changed_formulae = select_formula_or_cask(:M).count) && changed_formulae.positive?
        ohai "Modified Formulae",
             "Modified #{Utils.pluralize("formula", changed_formulae, plural: "e", include_count: true)}."
      end

      if (changed_casks = select_formula_or_cask(:MC).count) && changed_casks.positive?
        ohai "Modified Casks", "Modified #{Utils.pluralize("cask", changed_casks, include_count: true)}."
      end
    else
      dump_modified_formula_report
      dump_modified_cask_report
    end
  else
    outdated_formulae = Formula.installed.select(&:outdated?).map(&:name)
    outdated_casks = Cask::Caskroom.casks.select(&:outdated?).map(&:token)
    unless auto_update
      output_dump_formula_or_cask_report "Outdated Formulae", outdated_formulae
      output_dump_formula_or_cask_report "Outdated Casks", outdated_casks
    end
  end

  return if outdated_formulae.blank? && outdated_casks.blank?

  outdated_formulae = outdated_formulae.count
  outdated_casks = outdated_casks.count

  update_pronoun = if (outdated_formulae + outdated_casks) == 1
    "it"
  else
    "them"
  end

  msg = ""

  if outdated_formulae.positive?
    noun = Utils.pluralize("formula", outdated_formulae, plural: "e")
    msg += "#{Tty.bold}#{outdated_formulae}#{Tty.reset} outdated #{noun}"
  end

  if outdated_casks.positive?
    msg += " and " if msg.present?
    msg += "#{Tty.bold}#{outdated_casks}#{Tty.reset} outdated #{Utils.pluralize("cask", outdated_casks)}"
  end

  return if msg.blank?

  puts
  puts "You have #{msg} installed."
  # If we're auto-updating, don't need to suggest commands that we're perhaps
  # already running.
  return if auto_update

  puts <<~EOS
    You can upgrade #{update_pronoun} with #{Tty.bold}brew upgrade#{Tty.reset}
    or list #{update_pronoun} with #{Tty.bold}brew outdated#{Tty.reset}.
  EOS
end

#empty? ⇒ Boolean

Returns:

• (Boolean)

# File 'cmd/update-report.rb', line 752

def empty?
  @hash.empty?
end

#select_formula_or_cask(key) ⇒ Object

# File 'cmd/update-report.rb', line 742

def select_formula_or_cask(key)
  @hash.fetch(key, [])
end