option parser: check for extra named args

Library/Homebrew/cli/parser.rb

@@ -34,6 +34,7 @@ module Homebrew
         @conflicts = []
         @switch_sources = {}
         @processed_options = []
+        @max_named_args = nil
         @hide_from_man_page = false
         instance_eval(&block)
         post_initialize
@@ -139,6 +140,7 @@ module Homebrew
           raise e
         end
         check_constraint_violations
+        check_named_args(remaining_args)
         @args[:remaining] = remaining_args
         @args.freeze_processed_options!(@processed_options)
         Homebrew.args = @args
@@ -178,6 +180,10 @@ module Homebrew
         []
       end
 
+      def max_named(count)
+        @max_named_args = count
+      end
+
       def hide_from_man_page!
         @hide_from_man_page = true
       end
@@ -269,6 +275,10 @@ module Homebrew
         check_constraints
       end
 
+      def check_named_args(args)
+        raise NamedArgumentsError, @max_named_args if !@max_named_args.nil? && args.size > @max_named_args
+      end
+
       def process_option(*args)
         option, = @parser.make_switch(args)
         @processed_options << [option.short.first, option.long.first, option.arg, option.desc.first]
@@ -277,14 +287,10 @@ module Homebrew
 
     class OptionConstraintError < RuntimeError
       def initialize(arg1, arg2, missing: false)
-        if !missing
+        message = if !missing
-          message = <<~EOS
+          "`#{arg1}` and `#{arg2}` should be passed together."
-            `#{arg1}` and `#{arg2}` should be passed together.
-          EOS
         else
-          message = <<~EOS
+          "`#{arg2}` cannot be passed without `#{arg1}`."
-            `#{arg2}` cannot be passed without `#{arg1}`.
-          EOS
         end
         super message
       end
@@ -294,17 +300,27 @@ module Homebrew
       def initialize(args)
         args_list = args.map(&Formatter.public_method(:option))
                         .join(" and ")
-        super <<~EOS
+        super "Options #{args_list} are mutually exclusive."
-          Options #{args_list} are mutually exclusive.
-        EOS
       end
     end
 
     class InvalidConstraintError < RuntimeError
       def initialize(arg1, arg2)
-        super <<~EOS
+        super "`#{arg1}` and `#{arg2}` cannot be mutually exclusive and mutually dependent simultaneously."
-          `#{arg1}` and `#{arg2}` cannot be mutually exclusive and mutually dependent simultaneously.
+      end
-        EOS
+    end
+
+    class NamedArgumentsError < UsageError
+      def initialize(maximum)
+        message = case maximum
+        when 0
+          "This command does not take named arguments."
+        when 1
+          "This command does not take multiple named arguments."
+        else
+          "This command does not take more than #{maximum} named arguments."
+        end
+        super message
       end
     end
   end

Library/Homebrew/cmd/--version.rb

@@ -13,14 +13,13 @@ module Homebrew
         Print the version numbers of Homebrew, Homebrew/homebrew-core and Homebrew/homebrew-cask
         (if tapped) to standard output.
       EOS
+      max_named 0
     end
   end
 
   def __version
     __version_args.parse
 
-    odie "This command does not take arguments." if ARGV.any?
-
     puts "Homebrew #{HOMEBREW_VERSION}"
     puts "#{CoreTap.instance.full_name} #{CoreTap.instance.version_string}"
     puts "#{Tap.default_cask_tap.full_name} #{Tap.default_cask_tap.version_string}" if Tap.default_cask_tap.installed?

Library/Homebrew/cmd/analytics.rb

@@ -19,14 +19,13 @@ module Homebrew
       EOS
       switch :verbose
       switch :debug
+      max_named 1
     end
   end
 
   def analytics
     analytics_args.parse
 
-    raise UsageError if args.remaining.size > 1
-
     case args.remaining.first
     when nil, "state"
       if Utils::Analytics.disabled?

Library/Homebrew/cmd/cat.rb

@@ -12,6 +12,7 @@ module Homebrew
 
         Display the source of <formula>.
       EOS
+      max_named 1
     end
   end
 
@@ -22,7 +23,6 @@ module Homebrew
     # `brew cat` multiple times.
     formulae = Homebrew.args.formulae
     raise FormulaUnspecifiedError if formulae.empty?
-    raise "`brew cat` doesn't support multiple arguments" if args.remaining.size > 1
 
     cd HOMEBREW_REPOSITORY
     pager = if ENV["HOMEBREW_BAT"].nil?

Library/Homebrew/cmd/commands.rb

@@ -19,6 +19,7 @@ module Homebrew
              description: "Include aliases of internal commands."
       switch :verbose
       switch :debug
+      max_named 0
     end
   end
 

Library/Homebrew/cmd/config.rb

@@ -16,12 +16,12 @@ module Homebrew
       EOS
       switch :verbose
       switch :debug
+      max_named 0
     end
   end
 
   def config
     config_args.parse
-    raise UsageError unless args.remaining.empty?
 
     SystemConfig.dump_verbose_config
   end

Library/Homebrew/cmd/diy.rb

@@ -21,6 +21,7 @@ module Homebrew
              description: "Explicitly set the <version> of the package being installed."
       switch :verbose
       switch :debug
+      max_named 0
     end
   end
 

Library/Homebrew/cmd/gist-logs.rb

@@ -28,6 +28,7 @@ module Homebrew
                           "be accessible with its link."
       switch :verbose
       switch :debug
+      max_named 1
     end
   end
 

Library/Homebrew/cmd/leaves.rb

@@ -15,6 +15,7 @@ module Homebrew
         List installed formulae that are not dependencies of another installed formula.
       EOS
       switch :debug
+      max_named 0
     end
   end
 

Library/Homebrew/cmd/log.rb

@@ -22,6 +22,7 @@ module Homebrew
              description: "Print only one line per commit."
       flag   "-1", "--max-count",
              description: "Print only one or a specified number of commits."
+      max_named 1
     end
   end
 

Library/Homebrew/cmd/sh.rb

@@ -22,6 +22,7 @@ module Homebrew
              description: "Use the standard `PATH` instead of superenv's when `std` is passed."
       switch :verbose
       switch :debug
+      max_named 0
     end
   end
 

Library/Homebrew/cmd/switch.rb

@@ -16,6 +16,7 @@ module Homebrew
       EOS
       switch :verbose
       switch :debug
+      max_named 2
     end
   end
 

Library/Homebrew/cmd/tap.rb

@@ -38,6 +38,7 @@ module Homebrew
       switch "-q", "--quieter",
              description: "Suppress any warnings."
       switch :debug
+      max_named 2
     end
   end
 

Library/Homebrew/dev-cmd/bump-formula-pr.rb

@@ -65,6 +65,7 @@ module Homebrew
       switch :debug
       conflicts "--no-audit", "--strict"
       conflicts "--url", "--tag"
+      max_named 1
     end
   end
 

Library/Homebrew/dev-cmd/bump-revision.rb

@@ -22,6 +22,7 @@ module Homebrew
       switch :quiet
       switch :verbose
       switch :debug
+      max_named 1
     end
   end
 
@@ -34,7 +35,6 @@ module Homebrew
 
     formulae = Homebrew.args.formulae
     raise FormulaUnspecifiedError if formulae.empty?
-    raise "Multiple formulae given, only one is allowed." if formulae.length > 1
 
     formula = formulae.first
     current_revision = formula.revision

Library/Homebrew/dev-cmd/create.rb

@@ -49,6 +49,7 @@ module Homebrew
       switch :verbose
       switch :debug
       conflicts "--autotools", "--cmake", "--go", "--meson", "--perl", "--python", "--rust"
+      max_named 1
     end
   end
 

Library/Homebrew/dev-cmd/extract.rb

@@ -91,6 +91,7 @@ module Homebrew
              description: "Extract the specified <version> of <formula> instead of the most recent."
       switch :force
       switch :debug
+      max_named 2
     end
   end
 

Library/Homebrew/dev-cmd/install-bundler-gems.rb

@@ -14,6 +14,7 @@ module Homebrew
         Install Homebrew's Bundler gems.
       EOS
       switch :debug
+      max_named 0
     end
   end
 

Library/Homebrew/dev-cmd/man.rb

@@ -28,14 +28,13 @@ module Homebrew
                           "comparison without factoring in the date)."
       switch "--link",
              description: "This is now done automatically by `brew update`."
+      max_named 0
     end
   end
 
   def man
     man_args.parse
 
-    raise UsageError unless ARGV.named.empty?
-
     odie "`brew man --link` is now done automatically by `brew update`." if args.link?
 
     regenerate_man_pages

Library/Homebrew/dev-cmd/release-notes.rb

@@ -16,6 +16,7 @@ module Homebrew
       EOS
       switch "--markdown",
              description: "Print as a Markdown list."
+      max_named 2
     end
   end
 

Library/Homebrew/dev-cmd/tap-new.rb

@@ -15,6 +15,7 @@ module Homebrew
       EOS
       switch :verbose
       switch :debug
+      max_named 1
     end
   end
 

Library/Homebrew/dev-cmd/tests.rb

@@ -29,6 +29,7 @@ module Homebrew
              description: "Randomise tests with the specified <value> instead of a random seed."
       switch :verbose
       switch :debug
+      max_named 0
     end
   end
 

Library/Homebrew/dev-cmd/update-test.rb

@@ -23,6 +23,7 @@ module Homebrew
              description: "Use the commit at the specified <date> as the start commit."
       switch :verbose
       switch :debug
+      max_named 0
     end
   end
 

Library/Homebrew/dev-cmd/vendor-gems.rb

@@ -14,6 +14,7 @@ module Homebrew
         Install and commit Homebrew's vendored gems.
       EOS
       switch :debug
+      max_named 0
     end
   end