brew/Library/Homebrew/cask/cmd/abstract_command.rb

# frozen_string_literal: true

require "cask/config"
require "search"

module Cask
  class Cmd
    # Abstract superclass for all `brew cask` commands.
    #
    # @api private
    class AbstractCommand
      include Homebrew::Search

      def self.min_named
        nil
      end

      def self.max_named
        nil
      end

      def self.banner_args
        if min_named == :cask && max_named != 1
          " <cask>"
        elsif max_named&.zero?
          ""
        else
          " [<cask>]"
        end
      end

      def self.banner_headline
        "`#{command_name}` [<options>]#{banner_args}"
      end

      def self.parser(&block)
        banner = <<~EOS
          `cask` #{banner_headline}

          #{description}
        EOS

        min_n = min_named
        max_n = max_named

        Cmd.parser do
          usage_banner banner

          instance_eval(&block) if block_given?

          switch "--[no-]binaries",
                 description: "Disable/enable linking of helper executables to `#{Config.global.binarydir}`. " \
                              "Default: enabled",
                 env:         :cask_opts_binaries

          switch "--require-sha",
                 description: "Require all casks to have a checksum.",
                 env:         :cask_opts_require_sha

          switch "--[no-]quarantine",
                 description: "Disable/enable quarantining of downloads. Default: enabled",
                 env:         :cask_opts_quarantine

          min_named min_n unless min_n.nil?
          max_named max_n unless max_n.nil?
        end
      end

      def self.command_name
        @command_name ||= name.sub(/^.*:/, "").gsub(/(.)([A-Z])/, '\1_\2').downcase
      end

      def self.abstract?
        name.split("::").last.match?(/^Abstract[^a-z]/)
      end

      def self.visible?
        true
      end

      def self.help
        parser.generate_help_text
      end

      def self.short_description
        description.split(".").first
      end

      def self.run(*args)
        new(*args).run
      end

      attr_reader :args

      def initialize(*args)
        @args = self.class.parser.parse(args)
      end

      private

      def casks(alternative: -> { [] })
        return @casks if defined?(@casks)

        casks = args.named.empty? ? alternative.call : args.named
        @casks = casks.map { |cask| CaskLoader.load(cask) }
      rescue CaskUnavailableError => e
        reason = [e.reason, *suggestion_message(e.token)].join(" ")
        raise e.class.new(e.token, reason)
      end

      def suggestion_message(cask_token)
        matches = search_casks(cask_token)

        if matches.one?
          "Did you mean “#{matches.first}”?"
        elsif !matches.empty?
          "Did you mean one of these?\n#{Formatter.columns(matches.take(20))}"
        end
      end
    end
  end
end