From af9f01c920deccc70cdaed230246c8f10e85b60f Mon Sep 17 00:00:00 2001
From: Mike McQuaid <mike@mikemcquaid.com>
Date: Thu, 23 Jan 2025 16:13:06 +0000
Subject: [PATCH] bundle: add upgrade switch and command.

This allows overriding the `HOMEBREW_BUNDLE_NO_UPGRADE` environment
variable. The environment variable wasn't really documented specifically
before so let's do that here, too.

Also, add `brew bundle upgrade` for a shorthand version.
---
 cmd/bundle.rb  | 17 ++++++++++++++---
 cmd/bundle.rbi |  3 +++
 2 files changed, 17 insertions(+), 3 deletions(-)

diff --git a/cmd/bundle.rb b/cmd/bundle.rb
index 8128c4291..813a54110 100755
--- a/cmd/bundle.rb
+++ b/cmd/bundle.rb
@@ -29,6 +29,9 @@ class BundleCmd < AbstractCommand
 
           You can skip the installation of dependencies by adding space-separated values to one or more of the following environment variables: `HOMEBREW_BUNDLE_BREW_SKIP`, `HOMEBREW_BUNDLE_CASK_SKIP`, `HOMEBREW_BUNDLE_MAS_SKIP`, `HOMEBREW_BUNDLE_WHALEBREW_SKIP`, `HOMEBREW_BUNDLE_TAP_SKIP`.
 
+          `brew bundle upgrade`:
+          Shorthand for `brew bundle install --upgrade`.
+
           `brew bundle dump`:
           Write all installed casks/formulae/images/taps into a `Brewfile` in the current directory.
 
@@ -66,7 +69,11 @@ class BundleCmd < AbstractCommand
                env:         :bundle_no_upgrade,
                description: "`install` does not run `brew upgrade` on outdated dependencies. " \
                             "`check` does not check for outdated dependencies. " \
-                            "Note they may still be upgraded by `brew install` if needed."
+                            "Note they may still be upgraded by `brew install` if needed." \
+                            "This is enabled by default if `HOMEBREW_BUNDLE_NO_UPGRADE` is set."
+        switch "--upgrade",
+               description: "`install` runs `brew upgrade` on outdated dependencies, " \
+                            "even if `HOMEBREW_BUNDLE_NO_UPGRADE` is set. "
         switch "-f", "--force",
                description: "`install` runs with `--force`/`--overwrite`. " \
                             "`dump` overwrites an existing `Brewfile`. " \
@@ -126,7 +133,11 @@ def run
         global = args.global?
         file = args.file
         args.zap?
-        no_upgrade = args.no_upgrade?
+        no_upgrade = if args.upgrade? || subcommand == "upgrade"
+          false
+        else
+          args.no_upgrade?
+        end
         verbose = args.verbose?
         force = args.force?
         zap = args.zap?
@@ -134,7 +145,7 @@ def run
         no_type_args = !args.brews? && !args.casks? && !args.taps? && !args.mas? && !args.whalebrew? && !args.vscode?
 
         case subcommand
-        when nil, "install"
+        when nil, "install", "upgrade"
           Bundle::Commands::Install.run(
             global:, file:, no_upgrade:, verbose:, force:,
             no_lock:    args.no_lock?,
diff --git a/cmd/bundle.rbi b/cmd/bundle.rbi
index b77e25c9d..a9b5fcea1 100644
--- a/cmd/bundle.rbi
+++ b/cmd/bundle.rbi
@@ -57,6 +57,9 @@ class Homebrew::Cmd::BundleCmd::Args < Homebrew::CLI::Args
   sig { returns(T::Boolean) }
   def taps?; end
 
+  sig { returns(T::Boolean) }
+  def upgrade?; end
+
   sig { returns(T::Boolean) }
   def verbose?; end