brew/Library/Homebrew/sorbet/tapioca/compilers/args.rb

# typed: strict
# frozen_string_literal: true

require_relative "../../../global"
require "cli/parser"

module Tapioca
  module Compilers
    class Args < Tapioca::Dsl::Compiler
      GLOBAL_OPTIONS = T.let(
        Homebrew::CLI::Parser.global_options.map do |short_option, long_option, _|
          [short_option, long_option].map { "#{Homebrew::CLI::Parser.option_to_name(_1)}?" }
        end.flatten.freeze, T::Array[String]
      )

      Parsable = T.type_alias { T.any(T.class_of(Homebrew::CLI::Args), T.class_of(Homebrew::AbstractCommand)) }
      ConstantType = type_member { { fixed: Parsable } }
      sig { override.returns(T::Enumerable[Parsable]) }
      def self.gather_constants
        # require all the commands to ensure the command subclasses are defined
        ["cmd", "dev-cmd"].each do |dir|
          Dir[File.join(__dir__, "../../../#{dir}", "*.rb")].each { require(_1) }
        end
        Homebrew::AbstractCommand.subclasses
      end

      sig { override.void }
      def decorate
        cmd = T.cast(constant, T.class_of(Homebrew::AbstractCommand))
        # This is a dummy class to make the `brew` command parsable
        return if cmd == Homebrew::Cmd::Brew

        args_class_name = T.must(T.must(cmd.args_class).name)
        root.create_class(args_class_name, superclass_name: "Homebrew::CLI::Args") do |klass|
          create_args_methods(klass, cmd.parser)
        end
        root.create_path(constant) do |klass|
          klass.create_method("args", return_type: args_class_name)
        end
      end

      sig { params(parser: Homebrew::CLI::Parser).returns(T::Array[Symbol]) }
      def args_table(parser) = parser.args.methods(false)

      sig { params(parser: Homebrew::CLI::Parser).returns(T::Array[Symbol]) }
      def comma_arrays(parser)
        parser.instance_variable_get(:@non_global_processed_options)
              .filter_map { |k, v| parser.option_to_name(k).to_sym if v == :comma_array }
      end

      sig { params(method_name: Symbol, comma_array_methods: T::Array[Symbol]).returns(String) }
      def get_return_type(method_name, comma_array_methods)
        if comma_array_methods.include?(method_name)
          "T.nilable(T::Array[String])"
        elsif method_name.end_with?("?")
          "T::Boolean"
        else
          "T.nilable(String)"
        end
      end

      private

      sig { params(klass: RBI::Scope, parser: Homebrew::CLI::Parser).void }
      def create_args_methods(klass, parser)
        comma_array_methods = comma_arrays(parser)
        args_table(parser).each do |method_name|
          method_name_str = method_name.to_s
          next if GLOBAL_OPTIONS.include?(method_name_str)

          return_type = get_return_type(method_name, comma_array_methods)
          klass.create_method(method_name_str, return_type:)
        end
      end
    end
  end
end