brew/Library/Homebrew/livecheck/skip_conditions.rb

# typed: strict
# frozen_string_literal: true

module Homebrew
  module Livecheck
    # The `Livecheck::SkipConditions` module primarily contains methods that
    # check for various formula/cask/resource conditions where a check should be skipped.
    module SkipConditions
      sig {
        params(
          package_or_resource: T.any(Formula, Cask::Cask, Resource),
          livecheck_defined:   T::Boolean,
          full_name:           T::Boolean,
          verbose:             T::Boolean,
        ).returns(T::Hash[Symbol, T.untyped])
      }
      private_class_method def self.package_or_resource_skip(
        package_or_resource,
        livecheck_defined,
        full_name: false,
        verbose: false
      )
        formula = package_or_resource if package_or_resource.is_a?(Formula)

        if (stable_url = formula&.stable&.url)
          stable_is_gist = stable_url.match?(%r{https?://gist\.github(?:usercontent)?\.com/}i)
          stable_from_google_code_archive = stable_url.match?(
            %r{https?://storage\.googleapis\.com/google-code-archive-downloads/}i,
          )
          stable_from_internet_archive = stable_url.match?(%r{https?://web\.archive\.org/}i)
        end

        skip_message = if package_or_resource.livecheck.skip_msg.present?
          package_or_resource.livecheck.skip_msg
        elsif !livecheck_defined
          if stable_from_google_code_archive
            "Stable URL is from Google Code Archive"
          elsif stable_from_internet_archive
            "Stable URL is from Internet Archive"
          elsif stable_is_gist
            "Stable URL is a GitHub Gist"
          end
        end

        return {} if !package_or_resource.livecheck.skip? && skip_message.blank?

        skip_messages = skip_message ? [skip_message] : nil
        Livecheck.status_hash(package_or_resource, "skipped", skip_messages, full_name:, verbose:)
      end

      sig {
        params(
          formula:            Formula,
          _livecheck_defined: T::Boolean,
          full_name:          T::Boolean,
          verbose:            T::Boolean,
        ).returns(T::Hash[Symbol, T.untyped])
      }
      private_class_method def self.formula_head_only(formula, _livecheck_defined, full_name: false, verbose: false)
        return {} if !formula.head_only? || formula.any_version_installed?

        Livecheck.status_hash(
          formula,
          "error",
          ["HEAD only formula must be installed to be checkable"],
          full_name:,
          verbose:,
        )
      end

      sig {
        params(
          formula:           Formula,
          livecheck_defined: T::Boolean,
          full_name:         T::Boolean,
          verbose:           T::Boolean,
        ).returns(T::Hash[Symbol, T.untyped])
      }
      private_class_method def self.formula_deprecated(formula, livecheck_defined, full_name: false, verbose: false)
        return {} if !formula.deprecated? || livecheck_defined

        Livecheck.status_hash(formula, "deprecated", full_name:, verbose:)
      end

      sig {
        params(
          formula:           Formula,
          livecheck_defined: T::Boolean,
          full_name:         T::Boolean,
          verbose:           T::Boolean,
        ).returns(T::Hash[Symbol, T.untyped])
      }
      private_class_method def self.formula_disabled(formula, livecheck_defined, full_name: false, verbose: false)
        return {} if !formula.disabled? || livecheck_defined

        Livecheck.status_hash(formula, "disabled", full_name:, verbose:)
      end

      sig {
        params(
          formula:           Formula,
          livecheck_defined: T::Boolean,
          full_name:         T::Boolean,
          verbose:           T::Boolean,
        ).returns(T::Hash[Symbol, T.untyped])
      }
      private_class_method def self.formula_versioned(formula, livecheck_defined, full_name: false, verbose: false)
        return {} if !formula.versioned_formula? || livecheck_defined

        Livecheck.status_hash(formula, "versioned", full_name:, verbose:)
      end

      sig {
        params(
          cask:              Cask::Cask,
          livecheck_defined: T::Boolean,
          full_name:         T::Boolean,
          verbose:           T::Boolean,
        ).returns(T::Hash[Symbol, T.untyped])
      }
      private_class_method def self.cask_deprecated(cask, livecheck_defined, full_name: false, verbose: false)
        return {} if !cask.deprecated? || livecheck_defined

        Livecheck.status_hash(cask, "deprecated", full_name:, verbose:)
      end

      sig {
        params(
          cask:              Cask::Cask,
          livecheck_defined: T::Boolean,
          full_name:         T::Boolean,
          verbose:           T::Boolean,
        ).returns(T::Hash[Symbol, T.untyped])
      }
      private_class_method def self.cask_disabled(cask, livecheck_defined, full_name: false, verbose: false)
        return {} if !cask.disabled? || livecheck_defined

        Livecheck.status_hash(cask, "disabled", full_name:, verbose:)
      end

      sig {
        params(
          cask:               Cask::Cask,
          _livecheck_defined: T::Boolean,
          full_name:          T::Boolean,
          verbose:            T::Boolean,
          extract_plist:      T::Boolean,
        ).returns(T::Hash[Symbol, T.untyped])
      }
      private_class_method def self.cask_extract_plist(
        cask,
        _livecheck_defined,
        full_name: false,
        verbose: false,
        extract_plist: false
      )
        return {} if extract_plist || cask.livecheck.strategy != :extract_plist

        Livecheck.status_hash(
          cask,
          "skipped",
          ["Use `--extract-plist` to enable checking multiple casks with ExtractPlist strategy"],
          full_name:,
          verbose:,
        )
      end

      sig {
        params(
          cask:              Cask::Cask,
          livecheck_defined: T::Boolean,
          full_name:         T::Boolean,
          verbose:           T::Boolean,
        ).returns(T::Hash[Symbol, T.untyped])
      }
      private_class_method def self.cask_version_latest(cask, livecheck_defined, full_name: false, verbose: false)
        return {} if !(cask.present? && cask.version&.latest?) || livecheck_defined

        Livecheck.status_hash(cask, "latest", full_name:, verbose:)
      end

      sig {
        params(
          cask:              Cask::Cask,
          livecheck_defined: T::Boolean,
          full_name:         T::Boolean,
          verbose:           T::Boolean,
        ).returns(T::Hash[Symbol, T.untyped])
      }
      private_class_method def self.cask_url_unversioned(cask, livecheck_defined, full_name: false, verbose: false)
        return {} if !(cask.present? && cask.url&.unversioned?) || livecheck_defined

        Livecheck.status_hash(cask, "unversioned", full_name:, verbose:)
      end

      # Skip conditions for formulae.
      FORMULA_CHECKS = T.let([
        :package_or_resource_skip,
        :formula_head_only,
        :formula_deprecated,
        :formula_disabled,
        :formula_versioned,
      ].freeze, T::Array[Symbol])
      private_constant :FORMULA_CHECKS

      # Skip conditions for casks.
      CASK_CHECKS = T.let([
        :package_or_resource_skip,
        :cask_deprecated,
        :cask_disabled,
        :cask_extract_plist,
        :cask_version_latest,
        :cask_url_unversioned,
      ].freeze, T::Array[Symbol])
      private_constant :CASK_CHECKS

      # Skip conditions for resources.
      RESOURCE_CHECKS = T.let([
        :package_or_resource_skip,
      ].freeze, T::Array[Symbol])
      private_constant :RESOURCE_CHECKS

      # If a formula/cask/resource should be skipped, we return a hash from
      # `Livecheck#status_hash`, which contains a `status` type and sometimes
      # error `messages`.
      sig {
        params(
          package_or_resource: T.any(Formula, Cask::Cask, Resource),
          full_name:           T::Boolean,
          verbose:             T::Boolean,
          extract_plist:       T::Boolean,
        ).returns(T::Hash[Symbol, T.untyped])
      }
      def self.skip_information(package_or_resource, full_name: false, verbose: false, extract_plist: true)
        livecheck_defined = package_or_resource.livecheck_defined?

        checks = case package_or_resource
        when Formula
          FORMULA_CHECKS
        when Cask::Cask
          CASK_CHECKS
        when Resource
          RESOURCE_CHECKS
        end

        checks.each do |method_name|
          skip_hash = case method_name
          when :cask_extract_plist
            send(method_name, package_or_resource, livecheck_defined, full_name:, verbose:, extract_plist:)
          else
            send(method_name, package_or_resource, livecheck_defined, full_name:, verbose:)
          end
          return skip_hash if skip_hash.present?
        end

        {}
      end

      # Skip conditions for formulae/casks/resources referenced in a `livecheck` block
      # are treated differently than normal. We only respect certain skip
      # conditions (returning the related hash) and others are treated as
      # errors.
      sig {
        params(
          livecheck_package_or_resource:     T.any(Formula, Cask::Cask, Resource),
          original_package_or_resource_name: String,
          full_name:                         T::Boolean,
          verbose:                           T::Boolean,
          extract_plist:                     T::Boolean,
        ).returns(T.nilable(T::Hash[Symbol, T.untyped]))
      }
      def self.referenced_skip_information(
        livecheck_package_or_resource,
        original_package_or_resource_name,
        full_name: false,
        verbose: false,
        extract_plist: true
      )
        skip_info = SkipConditions.skip_information(
          livecheck_package_or_resource,
          full_name:,
          verbose:,
          extract_plist:,
        )
        return if skip_info.blank?

        referenced_name = Livecheck.package_or_resource_name(livecheck_package_or_resource, full_name:)
        referenced_type = case livecheck_package_or_resource
        when Formula
          :formula
        when Cask::Cask
          :cask
        when Resource
          :resource
        end

        if skip_info[:status] != "error" &&
           !(skip_info[:status] == "skipped" && livecheck_package_or_resource.livecheck.skip?)
          error_msg_end = if skip_info[:status] == "skipped"
            "automatically skipped"
          else
            "skipped as #{skip_info[:status]}"
          end

          raise "Referenced #{referenced_type} (#{referenced_name}) is #{error_msg_end}"
        end

        skip_info[referenced_type] = original_package_or_resource_name
        skip_info
      end

      # Prints default livecheck output in relation to skip conditions.
      sig { params(skip_hash: T::Hash[Symbol, T.untyped]).void }
      def self.print_skip_information(skip_hash)
        return unless skip_hash.is_a?(Hash)

        name = if skip_hash[:formula].is_a?(String)
          skip_hash[:formula]
        elsif skip_hash[:cask].is_a?(String)
          skip_hash[:cask]
        elsif skip_hash[:resource].is_a?(String)
          "  #{skip_hash[:resource]}"
        end
        return unless name

        if skip_hash[:messages].is_a?(Array) && skip_hash[:messages].count.positive?
          # TODO: Handle multiple messages, only if needed in the future
          if skip_hash[:status] == "skipped"
            puts "#{Tty.red}#{name}#{Tty.reset}: skipped - #{skip_hash[:messages][0]}"
          else
            puts "#{Tty.red}#{name}#{Tty.reset}: #{skip_hash[:messages][0]}"
          end
        elsif skip_hash[:status].present?
          puts "#{Tty.red}#{name}#{Tty.reset}: #{skip_hash[:status]}"
        end
      end
    end
  end
end