Class: Cask::Cmd::Upgrade Private
- Inherits:
-
AbstractCommand
- Object
- AbstractCommand
- Cask::Cmd::Upgrade
- Extended by:
- T::Sig
- Defined in:
- cask/cmd/upgrade.rb
Overview
This class is part of a private API. This class may only be used in the Homebrew/brew repository. Third parties should avoid using this class if possible, as it may be removed or changed without warning.
Cask implementation of the brew upgrade
command.
Constant Summary collapse
- OPTIONS =
This constant is part of a private API. This constant may only be used in the Homebrew/brew repository. Third parties should avoid using this constant if possible, as it may be removed or changed without warning.
[ [:switch, "--skip-cask-deps", { description: "Skip installing cask dependencies.", }], [:switch, "--greedy", { description: "Also include casks with `auto_updates true` or `version :latest`.", }], [:switch, "--greedy-latest", { description: "Also include casks with `version :latest`.", }], [:switch, "--greedy-auto-updates", { description: "Also include casks with `auto_updates true`.", }], ].freeze
Instance Attribute Summary
Attributes inherited from AbstractCommand
Class Method Summary collapse
-
.parser ⇒ Homebrew::CLI::Parser
private
-
.upgrade_cask(old_cask, new_cask, binaries:, force:, quarantine:, require_sha:, skip_cask_deps:, verbose:) ⇒ Object
private
-
.upgrade_casks(*casks, args:, force: false, greedy: false, greedy_latest: false, greedy_auto_updates: false, dry_run: false, skip_cask_deps: false, verbose: false, binaries: nil, quarantine: nil, require_sha: nil) ⇒ Boolean
private
Instance Method Summary collapse
-
#run ⇒ void
private
Methods inherited from AbstractCommand
abstract?, command_name, help, #initialize, run, short_description, visible?
Methods included from Homebrew::Search
#query_regexp, #search_casks, #search_descriptions, #search_formulae, #search_taps
Methods included from Homebrew::Search::Extension
#search_casks, #search_descriptions
Constructor Details
This class inherits a constructor from Cask::Cmd::AbstractCommand
Class Method Details
.parser ⇒ Homebrew::CLI::Parser
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
31 32 33 34 35 36 37 38 39 40 41 42 |
# File 'cask/cmd/upgrade.rb', line 31 def self.parser super do switch "--force", description: "Force overwriting existing files." switch "--dry-run", description: "Show what would be upgraded, but do not actually upgrade anything." OPTIONS.each do |option| send(*option) end end end |
.upgrade_cask(old_cask, new_cask, binaries:, force:, quarantine:, require_sha:, skip_cask_deps:, verbose:) ⇒ Object
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 |
# File 'cask/cmd/upgrade.rb', line 171 def self.upgrade_cask( old_cask, new_cask, binaries:, force:, quarantine:, require_sha:, skip_cask_deps:, verbose: ) require "cask/installer" start_time = Time.now odebug "Started upgrade process for Cask #{old_cask}" old_config = old_cask.config = { binaries: binaries, verbose: verbose, force: force, upgrade: true, }.compact old_cask_installer = Installer.new(old_cask, **) new_cask.config = new_cask.default_config.merge(old_config) = { binaries: binaries, verbose: verbose, force: force, skip_cask_deps: skip_cask_deps, require_sha: require_sha, upgrade: true, quarantine: quarantine, }.compact new_cask_installer = Installer.new(new_cask, **) started_upgrade = false new_artifacts_installed = false begin oh1 "Upgrading #{Formatter.identifier(old_cask)}" # Start new cask's installation steps new_cask_installer.check_conflicts if (caveats = new_cask_installer.caveats) puts caveats end new_cask_installer.fetch # Move the old cask's artifacts back to staging old_cask_installer.start_upgrade # And flag it so in case of error started_upgrade = true # Install the new cask new_cask_installer.stage new_cask_installer.install_artifacts new_artifacts_installed = true # If successful, wipe the old cask from staging old_cask_installer.finalize_upgrade rescue => e new_cask_installer.uninstall_artifacts if new_artifacts_installed new_cask_installer.purge_versioned_files old_cask_installer.revert_upgrade if started_upgrade raise e end end_time = Time.now Homebrew..package_installed(new_cask.token, end_time - start_time) end |
.upgrade_casks(*casks, args:, force: false, greedy: false, greedy_latest: false, greedy_auto_updates: false, dry_run: false, skip_cask_deps: false, verbose: false, binaries: nil, quarantine: nil, require_sha: nil) ⇒ Boolean
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 |
# File 'cask/cmd/upgrade.rb', line 79 def self.upgrade_casks( *casks, args:, force: false, greedy: false, greedy_latest: false, greedy_auto_updates: false, dry_run: false, skip_cask_deps: false, verbose: false, binaries: nil, quarantine: nil, require_sha: nil ) quarantine = true if quarantine.nil? outdated_casks = if casks.empty? Caskroom.casks(config: Config.from_args(args)).select do |cask| cask.outdated?(greedy: greedy, greedy_latest: greedy_latest, greedy_auto_updates: greedy_auto_updates) end else casks.select do |cask| raise CaskNotInstalledError, cask if !cask.installed? && !force if cask.outdated?(greedy: true) true elsif cask.version.latest? opoo "Not upgrading #{cask.token}, the downloaded artifact has not changed" false else opoo "Not upgrading #{cask.token}, the latest version is already installed" false end end end manual_installer_casks = outdated_casks.select do |cask| cask.artifacts.any?(Artifact::Installer::ManualInstaller) end if manual_installer_casks.present? count = manual_installer_casks.count ofail "Not upgrading #{count} `installer manual` #{"cask".pluralize(count)}." puts manual_installer_casks.map(&:to_s) outdated_casks -= manual_installer_casks end return false if outdated_casks.empty? if casks.empty? && !greedy if !greedy_auto_updates && !greedy_latest ohai "Casks with 'auto_updates true' or 'version :latest' " \ "will not be upgraded; pass `--greedy` to upgrade them." end if greedy_auto_updates && !greedy_latest ohai "Casks with 'version :latest' will not be upgraded; pass `--greedy-latest` to upgrade them." end if !greedy_auto_updates && greedy_latest ohai "Casks with 'auto_updates true' will not be upgraded; pass `--greedy-auto-updates` to upgrade them." end end verb = dry_run ? "Would upgrade" : "Upgrading" oh1 "#{verb} #{outdated_casks.count} outdated #{"package".pluralize(outdated_casks.count)}:" caught_exceptions = [] upgradable_casks = outdated_casks.map { |c| [CaskLoader.load(c.installed_caskfile), c] } puts upgradable_casks .map { |(old_cask, new_cask)| "#{new_cask.full_name} #{old_cask.version} -> #{new_cask.version}" } .join("\n") return true if dry_run upgradable_casks.each do |(old_cask, new_cask)| upgrade_cask( old_cask, new_cask, binaries: binaries, force: force, skip_cask_deps: skip_cask_deps, verbose: verbose, quarantine: quarantine, require_sha: require_sha ) rescue => e caught_exceptions << e.exception("#{new_cask.full_name}: #{e}") next end return true if caught_exceptions.empty? raise MultipleCaskErrors, caught_exceptions if caught_exceptions.count > 1 raise caught_exceptions.first if caught_exceptions.count == 1 end |
Instance Method Details
#run ⇒ void
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
This method returns an undefined value.
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 |
# File 'cask/cmd/upgrade.rb', line 45 def run verbose = ($stdout.tty? || args.verbose?) && !args.quiet? self.class.upgrade_casks( *casks, force: args.force?, greedy: args.greedy?, greedy_latest: args.greedy_latest?, greedy_auto_updates: args.greedy_auto_updates?, dry_run: args.dry_run?, binaries: args.binaries?, quarantine: args.quarantine?, require_sha: args.require_sha?, skip_cask_deps: args.skip_cask_deps?, verbose: verbose, args: args, ) end |