Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

enable typed: strict in Homebrew::CLI::Args #18083

Merged
merged 3 commits into from
Aug 20, 2024
Merged

enable typed: strict in Homebrew::CLI::Args #18083

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3943ff1
Strict type Homebrew::CLI::Args
dduugg Aug 19, 2024
4bbad3c
Add documentation for OptionsType
dduugg Aug 19, 2024
7acddd7
Remove unused processed option element
dduugg Aug 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 29 additions & 11 deletions Library/Homebrew/cli/args.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,17 @@
# typed: true # rubocop:disable Sorbet/StrictSigil
# typed: strict
# frozen_string_literal: true

require "ostruct"

module Homebrew
module CLI
class Args < OpenStruct
# FIXME: Enable cop again when https://github.com/sorbet/sorbet/issues/3532 is fixed.
# rubocop:disable Style/MutableConstant
OptionsType = T.type_alias { T::Array[[String, T.nilable(String), T.nilable(String), String, T::Boolean]] }
carlocab marked this conversation as resolved.
Show resolved Hide resolved
# rubocop:enable Style/MutableConstant

sig { returns(T::Array[String]) }
attr_reader :options_only, :flags_only

# undefine tap to allow --tap argument
Expand All @@ -17,21 +23,25 @@ def initialize

super

@processed_options = []
@options_only = []
@flags_only = []
@cask_options = false
@cli_args = T.let(nil, T.nilable(T::Array[String]))
@processed_options = T.let([], OptionsType)
@options_only = T.let([], T::Array[String])
@flags_only = T.let([], T::Array[String])
@cask_options = T.let(false, T::Boolean)
@table = T.let({}, T::Hash[Symbol, T.untyped])

# Can set these because they will be overwritten by freeze_named_args!
# (whereas other values below will only be overwritten if passed).
self[:named] = NamedArgs.new(parent: self)
self[:remaining] = []
end

sig { params(remaining_args: T::Array[T.any(T::Array[String], String)]).void }
def freeze_remaining_args!(remaining_args)
self[:remaining] = remaining_args.freeze
end

sig { params(named_args: T::Array[String], cask_options: T::Boolean, without_api: T::Boolean).void }
def freeze_named_args!(named_args, cask_options:, without_api:)
options = {}
options[:force_bottle] = true if self[:force_bottle?]
Expand All @@ -46,15 +56,16 @@ def freeze_named_args!(named_args, cask_options:, without_api:)
)
end

sig { params(processed_options: OptionsType).void }
def freeze_processed_options!(processed_options)
# Reset cache values reliant on processed_options
@cli_args = nil

@processed_options += processed_options
@processed_options.freeze

@options_only = cli_args.select { |a| a.start_with?("-") }.freeze
@flags_only = cli_args.select { |a| a.start_with?("--") }.freeze
@options_only = cli_args.select { _1.start_with?("-") }.freeze
@flags_only = cli_args.select { _1.start_with?("--") }.freeze
end

sig { returns(NamedArgs) }
Expand All @@ -63,10 +74,10 @@ def named
self[:named]
end

def no_named?
named.blank?
end
sig { returns(T::Boolean) }
def no_named? = named.blank?

sig { returns(T::Array[String]) }
def build_from_source_formulae
if build_from_source? || self[:HEAD?] || self[:build_bottle?]
named.to_formulae.map(&:full_name)
Expand All @@ -75,6 +86,7 @@ def build_from_source_formulae
end
end

sig { returns(T::Array[String]) }
def include_test_formulae
if include_test?
named.to_formulae.map(&:full_name)
Expand All @@ -83,6 +95,7 @@ def include_test_formulae
end
end

sig { params(name: String).returns(T.nilable(String)) }
def value(name)
arg_prefix = "--#{name}="
flag_with_value = flags_only.find { |arg| arg.start_with?(arg_prefix) }
Expand All @@ -96,6 +109,7 @@ def context
Context::ContextStruct.new(debug: debug?, quiet: quiet?, verbose: verbose?)
end

sig { returns(T.nilable(Symbol)) }
def only_formula_or_cask
if formula? && !cask?
:formula
Expand Down Expand Up @@ -141,11 +155,13 @@ def os_arch_combinations

private

sig { params(option: String).returns(String) }
def option_to_name(option)
option.sub(/\A--?/, "")
.tr("-", "_")
end

sig { returns(T::Array[String]) }
def cli_args
return @cli_args if @cli_args

Expand All @@ -165,10 +181,12 @@ def cli_args
@cli_args.freeze
end

def respond_to_missing?(method_name, *)
sig { params(method_name: Symbol, _include_private: T::Boolean).returns(T::Boolean) }
def respond_to_missing?(method_name, _include_private = false)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure why it didn't error here, but it's now erroring on master:

https://github.com/Homebrew/brew/actions/runs/10469292764/job/28991992536#step:7:14

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

#18097

@table.key?(method_name)
end

sig { params(method_name: Symbol, args: T.untyped).returns(T.untyped) }
def method_missing(method_name, *args)
return_value = super

Expand Down
5 changes: 2 additions & 3 deletions Library/Homebrew/cli/parser.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ class Parser
# FIXME: Enable cop again when https://github.com/sorbet/sorbet/issues/3532 is fixed.
# rubocop:disable Style/MutableConstant
ArgType = T.type_alias { T.any(NilClass, Symbol, T::Array[String], T::Array[Symbol]) }
OptionsType = T.type_alias { T::Array[[String, T.nilable(String), T.nilable(String), String, T::Boolean]] }
# rubocop:enable Style/MutableConstant
HIDDEN_DESC_PLACEHOLDER = "@@HIDDEN@@"
SYMBOL_TO_USAGE_MAPPING = T.let({
Expand All @@ -25,7 +24,7 @@ class Parser
}.freeze, T::Hash[Symbol, String])
private_constant :ArgType, :HIDDEN_DESC_PLACEHOLDER, :SYMBOL_TO_USAGE_MAPPING

sig { returns(OptionsType) }
sig { returns(Args::OptionsType) }
attr_reader :processed_options

sig { returns(T::Boolean) }
Expand Down Expand Up @@ -177,7 +176,7 @@ def initialize(cmd = nil, &block)
@constraints = T.let([], T::Array[[String, String]])
@conflicts = T.let([], T::Array[T::Array[String]])
@switch_sources = T.let({}, T::Hash[String, Symbol])
@processed_options = T.let([], OptionsType)
@processed_options = T.let([], Args::OptionsType)
@non_global_processed_options = T.let([], T::Array[[String, ArgType]])
@named_args_type = T.let(nil, T.nilable(ArgType))
@max_named_args = T.let(nil, T.nilable(Integer))
Expand Down