Use method result table

Homebrew · Dec 6, 2024 · e6c5e28 · e6c5e28
1 parent bbb9bd3
commit e6c5e28
Show file tree

Hide file tree

Showing 8 changed files with 49 additions and 35 deletions.
diff --git a/Library/Homebrew/Gemfile b/Library/Homebrew/Gemfile
@@ -80,6 +80,7 @@ gem "addressable"
 gem "concurrent-ruby"
 gem "patchelf"
 gem "plist"
+gem "pry-byebug"
 gem "ruby-macho"
 gem "sorbet-runtime"
 gem "warning"
diff --git a/Library/Homebrew/Gemfile.lock b/Library/Homebrew/Gemfile.lock
@@ -6,6 +6,7 @@ GEM
     ast (2.4.2)
     bigdecimal (3.1.8)
     bindata (2.5.0)
+    byebug (11.1.3)
     coderay (1.1.3)
     concurrent-ruby (1.3.4)
     diff-lcs (1.5.1)
@@ -40,6 +41,9 @@ GEM
     pry (0.15.0)
       coderay (~> 1.1)
       method_source (~> 1.0)
+    pry-byebug (3.8.0)
+      byebug (~> 11.0)
+      pry (~> 0.10)
     public_suffix (6.0.1)
     racc (1.8.1)
     rainbow (3.1.1)
@@ -164,6 +168,7 @@ DEPENDENCIES
   patchelf
   plist
   pry
+  pry-byebug
   redcarpet
   rexml
   rspec

diff --git a/Library/Homebrew/cli/args.rb b/Library/Homebrew/cli/args.rb
@@ -14,6 +14,9 @@ class Args
       sig { returns(T::Array[String]) }
       attr_reader :options_only, :flags_only, :remaining
 
+      sig { returns(T::Hash[Symbol, T.untyped]) }
+      attr_accessor :table
+
       sig { void }
       def initialize
         require "cli/named_args"
@@ -55,15 +58,9 @@ def build_bottle? = false
       sig { returns(T::Boolean) }
       def build_from_source? = false
 
-      sig { returns(T::Boolean) }
-      def cask? = false
-
       sig { returns(T::Boolean) }
       def force_bottle? = false
 
-      # Defined in extend/os:
-      # def formula; end
-
       sig { returns(T::Boolean) }
       def HEAD? = false
 
@@ -128,6 +125,8 @@ def context
 
       sig { returns(T.nilable(Symbol)) }
       def only_formula_or_cask
+        return unless respond_to?(:formula?) && respond_to?(:cask?)
+
         if formula? && !cask?
           :formula
         elsif cask? && !formula?
@@ -185,26 +184,18 @@ def cli_args
         @cli_args = []
         @processed_options.each do |short, long|
           option = long || short
-          switch_val = invoke_if_respond_to(:"#{option_to_name(option)}?")
-          flag_val = invoke_if_respond_to(option_to_name(option).to_sym)
-          if switch_val == true || flag_val == true
+          switch = :"#{option_to_name(option)}?"
+          flag = option_to_name(option).to_sym
+          if @table[switch] == true || @table[flag] == true
             @cli_args << option
-          elsif flag_val.instance_of? String
-            @cli_args << "#{option}=#{flag_val}"
-          elsif flag_val.instance_of? Array
-            @cli_args << "#{option}=#{flag_val.join(",")}"
+          elsif @table[flag].instance_of? String
+            @cli_args << "#{option}=#{@table[flag]}"
+          elsif @table[flag].instance_of? Array
+            @cli_args << "#{option}=#{@table[flag].join(",")}"
           end
         end
         @cli_args.freeze
       end
-
-      # FIXME: This is here for compatibility with the previous implementation that used OpenStruct.
-      # This is for args that need to determine whether they have been set or not, and thus may not support a default
-      # implementation.
-      sig { params(method: Symbol).returns(T.untyped) }
-      def invoke_if_respond_to(method)
-        public_send(method) if respond_to?(method)
-      end
     end
   end
 end
diff --git a/Library/Homebrew/cli/args.rbi b/Library/Homebrew/cli/args.rbi
@@ -16,4 +16,10 @@ class Homebrew::CLI::Args
 
   sig { returns(T::Boolean) }
   def verbose?; end
+
+  sig { returns(T::Boolean) }
+  def cask?; end
+
+  sig { returns(T::Boolean) }
+  def formula?; end
 end
diff --git a/Library/Homebrew/cli/parser.rb b/Library/Homebrew/cli/parser.rb
@@ -252,7 +252,7 @@ def comma_array(name, description: nil, hidden: false)
         description = option_description(description, name, hidden:)
         process_option(name, description, type: :comma_array, hidden:)
         @parser.on(name, OptionParser::REQUIRED_ARGUMENT, Array, *wrap_option_desc(description)) do |list|
-          @args.define_singleton_method(option_to_name(name)) { list }
+          set_args_method(option_to_name(name).to_sym, list)
         end
       end
 
@@ -277,7 +277,7 @@ def flag(*names, description: nil, replacement: nil, depends_on: nil, hidden: fa
           # This odisabled should stick around indefinitely.
           odisabled "the `#{names.first}` flag", replacement unless replacement.nil?
           names.each do |name|
-            @args.define_singleton_method(option_to_name(name)) { option_value }
+            set_args_method(option_to_name(name).to_sym, option_value)
           end
         end
 
@@ -286,6 +286,17 @@ def flag(*names, description: nil, replacement: nil, depends_on: nil, hidden: fa
         end
       end
 
+      sig { params(name: Symbol, value: T.untyped).void }
+      def set_args_method(name, value)
+        @args.table[name] = value
+        return if @args.respond_to?(name)
+
+        @args.define_singleton_method(name) do
+          T.bind(self, Args)
+          table.fetch(name)
+        end
+      end
+
       sig { params(options: String).returns(T::Array[T::Array[String]]) }
       def conflicts(*options)
         @conflicts << options.map { |option| option_to_name(option) }
@@ -552,7 +563,7 @@ def generate_banner
       def set_switch(*names, value:, from:)
         names.each do |name|
           @switch_sources[option_to_name(name)] = from
-          @args.define_singleton_method(:"#{option_to_name(name)}?") { value }
+          set_args_method(:"#{option_to_name(name)}?", value)
         end
       end
 
@@ -564,7 +575,7 @@ def disable_switch(*args)
           else
             false
           end
-          @args.define_singleton_method(:"#{option_to_name(name)}?") { result }
+          set_args_method(:"#{option_to_name(name)}?", result)
         end
       end
 
@@ -673,7 +684,7 @@ def process_option(*args, type:, hidden: false)
           disable_switch(*args)
         else
           args.each do |name|
-            @args.define_singleton_method(option_to_name(name)) { nil }
+            set_args_method(option_to_name(name).to_sym, nil)
           end
         end
 

diff --git a/Library/Homebrew/extend/os/linux/cli/parser.rb b/Library/Homebrew/extend/os/linux/cli/parser.rb
@@ -9,8 +9,14 @@ module Parser
 
         requires_ancestor { Homebrew::CLI::Parser }
 
+        sig { void }
+        def set_default_options
+          args.table[:"formula?"] = true if args.respond_to?(:formula?)
+        end
+
         sig { void }
         def validate_options
+          return unless args.respond_to?(:cask?)
           return unless args.cask?
 
           # NOTE: We don't raise an error here because we don't want

diff --git a/Library/Homebrew/extend/os/parser.rb b/Library/Homebrew/extend/os/parser.rb
@@ -2,12 +2,3 @@
 # frozen_string_literal: true
 
 require "extend/os/linux/cli/parser" if OS.linux?
-
-module Homebrew
-  module CLI
-    class Args
-      sig { returns(T::Boolean) }
-      def formula? = OS.linux?
-    end
-  end
-end
diff --git a/Library/Homebrew/vendor/bundle/bundler/setup.rb b/Library/Homebrew/vendor/bundle/bundler/setup.rb
@@ -40,6 +40,8 @@ def self.extension_api_version
 $:.unshift File.expand_path("#{__dir__}/../#{RUBY_ENGINE}/#{Gem.ruby_api_version}/extensions/arm64-darwin-20/#{Gem.extension_api_version}/bigdecimal-3.1.8")
 $:.unshift File.expand_path("#{__dir__}/../#{RUBY_ENGINE}/#{Gem.ruby_api_version}/gems/bigdecimal-3.1.8/lib")
 $:.unshift File.expand_path("#{__dir__}/../#{RUBY_ENGINE}/#{Gem.ruby_api_version}/gems/bindata-2.5.0/lib")
+$:.unshift File.expand_path("#{__dir__}/../#{RUBY_ENGINE}/#{Gem.ruby_api_version}/extensions/arm64-darwin-20/#{Gem.extension_api_version}/byebug-11.1.3")
+$:.unshift File.expand_path("#{__dir__}/../#{RUBY_ENGINE}/#{Gem.ruby_api_version}/gems/byebug-11.1.3/lib")
 $:.unshift File.expand_path("#{__dir__}/../#{RUBY_ENGINE}/#{Gem.ruby_api_version}/gems/coderay-1.1.3/lib")
 $:.unshift File.expand_path("#{__dir__}/../#{RUBY_ENGINE}/#{Gem.ruby_api_version}/gems/concurrent-ruby-1.3.4/lib/concurrent-ruby")
 $:.unshift File.expand_path("#{__dir__}/../#{RUBY_ENGINE}/#{Gem.ruby_api_version}/gems/diff-lcs-1.5.1/lib")
@@ -69,6 +71,7 @@ def self.extension_api_version
 $:.unshift File.expand_path("#{__dir__}/../#{RUBY_ENGINE}/#{Gem.ruby_api_version}/extensions/arm64-darwin-20/#{Gem.extension_api_version}/prism-1.2.0")
 $:.unshift File.expand_path("#{__dir__}/../#{RUBY_ENGINE}/#{Gem.ruby_api_version}/gems/prism-1.2.0/lib")
 $:.unshift File.expand_path("#{__dir__}/../#{RUBY_ENGINE}/#{Gem.ruby_api_version}/gems/pry-0.15.0/lib")
+$:.unshift File.expand_path("#{__dir__}/../#{RUBY_ENGINE}/#{Gem.ruby_api_version}/gems/pry-byebug-3.8.0/lib")
 $:.unshift File.expand_path("#{__dir__}/../#{RUBY_ENGINE}/#{Gem.ruby_api_version}/gems/rainbow-3.1.1/lib")
 $:.unshift File.expand_path("#{__dir__}/../#{RUBY_ENGINE}/#{Gem.ruby_api_version}/gems/sorbet-runtime-0.5.11681/lib")
 $:.unshift File.expand_path("#{__dir__}/../#{RUBY_ENGINE}/#{Gem.ruby_api_version}/gems/rbi-0.2.1/lib")