brew/Library/Homebrew/deprecate_disable.rb

# typed: strict
# frozen_string_literal: true

# Helper module for handling `disable!` and `deprecate!`.
# @api internal
module DeprecateDisable
  module_function

  FORMULA_DEPRECATE_DISABLE_REASONS = T.let({
    does_not_build:      "does not build",
    no_license:          "has no license",
    repo_archived:       "has an archived upstream repository",
    repo_removed:        "has a removed upstream repository",
    unmaintained:        "is not maintained upstream",
    unsupported:         "is not supported upstream",
    deprecated_upstream: "is deprecated upstream",
    versioned_formula:   "is a versioned formula",
    checksum_mismatch:   "was built with an initially released source file that had " \
                         "a different checksum than the current one. " \
                         "Upstream's repository might have been compromised. " \
                         "We can re-package this once upstream has confirmed that they retagged their release",
  }.freeze, T::Hash[Symbol, String])

  CASK_DEPRECATE_DISABLE_REASONS = T.let({
    discontinued:             "is discontinued upstream",
    moved_to_mas:             "is now exclusively distributed on the Mac App Store",
    no_longer_available:      "is no longer available upstream",
    no_longer_meets_criteria: "no longer meets the criteria for acceptable casks",
    unmaintained:             "is not maintained upstream",
    fails_gatekeeper_check:   "does not pass the macOS Gatekeeper check",
    # odeprecate: remove the unsigned reason in a future release
    unsigned:                 "is unsigned or does not meet signature requirements",
  }.freeze, T::Hash[Symbol, String])

  # One year when << or >> to Date.today.
  REMOVE_DISABLED_TIME_WINDOW = 12
  REMOVE_DISABLED_BEFORE = T.let((Date.today << REMOVE_DISABLED_TIME_WINDOW).freeze, Date)

  sig { params(formula_or_cask: T.any(Formula, Cask::Cask)).returns(T.nilable(Symbol)) }
  def type(formula_or_cask)
    return :deprecated if formula_or_cask.deprecated?

    :disabled if formula_or_cask.disabled?
  end

  sig {
    params(
      formula: T.nilable(String),
      cask:    T.nilable(String),
    ).returns(T.nilable(String))
  }
  def replacement_with_type(formula, cask)
    if formula && formula == cask
      formula
    elsif formula
      "--formula #{formula}"
    elsif cask
      "--cask #{cask}"
    end
  end

  sig { params(formula_or_cask: T.any(Formula, Cask::Cask)).returns(T.nilable(String)) }
  def message(formula_or_cask)
    return if type(formula_or_cask).blank?

    reason = if formula_or_cask.deprecated?
      formula_or_cask.deprecation_reason
    elsif formula_or_cask.disabled?
      formula_or_cask.disable_reason
    end

    # odeprecate: remove this remapping in a future release
    reason = :fails_gatekeeper_check if reason == :unsigned

    reason = if formula_or_cask.is_a?(Formula) && FORMULA_DEPRECATE_DISABLE_REASONS.key?(reason)
      FORMULA_DEPRECATE_DISABLE_REASONS[reason]
    elsif formula_or_cask.is_a?(Cask::Cask) && CASK_DEPRECATE_DISABLE_REASONS.key?(reason)
      CASK_DEPRECATE_DISABLE_REASONS[reason]
    else
      reason
    end

    message = if reason.present?
      "#{type(formula_or_cask)} because it #{reason}!"
    else
      "#{type(formula_or_cask)}!"
    end

    disable_date = formula_or_cask.disable_date
    if !disable_date && formula_or_cask.deprecation_date
      disable_date = formula_or_cask.deprecation_date >> REMOVE_DISABLED_TIME_WINDOW
    end
    if disable_date
      message += if disable_date < Date.today
        " It was disabled on #{disable_date}."
      else
        " It will be disabled on #{disable_date}."
      end
    end

    replacement = if formula_or_cask.disabled?
      replacement_with_type(
        formula_or_cask.disable_replacement_formula,
        formula_or_cask.disable_replacement_cask,
      )
    elsif formula_or_cask.deprecated?
      replacement_with_type(
        formula_or_cask.deprecation_replacement_formula,
        formula_or_cask.deprecation_replacement_cask,
      )
    end

    if replacement.present?
      message << "\n"
      message << <<~EOS
        Replacement:
          brew install #{replacement}
      EOS
    end

    message
  end

  sig { params(string: T.nilable(String), type: Symbol).returns(T.nilable(T.any(String, Symbol))) }
  def to_reason_string_or_symbol(string, type:)
    return if string.nil?

    if (type == :formula && FORMULA_DEPRECATE_DISABLE_REASONS.key?(string.to_sym)) ||
       (type == :cask && CASK_DEPRECATE_DISABLE_REASONS.key?(string.to_sym))
      return string.to_sym
    end

    string
  end
end