Class: Cask::Installer Private

Inherits:
Object
  • Object
show all
Extended by:
Predicable, T::Sig
Includes:
Staged
Defined in:
cask/installer.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.

Installer for a Cask.

Constant Summary

Constants included from Staged

Staged::Paths

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Predicable

attr_predicate

Methods included from Staged

#set_ownership, #set_permissions

Constructor Details

#initialize(cask, command: SystemCommand, force: false, skip_cask_deps: false, binaries: true, verbose: false, zap: false, require_sha: false, upgrade: false, installed_as_dependency: false, quarantine: true, verify_download_integrity: true, quiet: false) ⇒ Installer

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.

Returns a new instance of Installer.



30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'cask/installer.rb', line 30

def initialize(cask, command: SystemCommand, force: false,
               skip_cask_deps: false, binaries: true, verbose: false,
               zap: false, require_sha: false, upgrade: false,
               installed_as_dependency: false, quarantine: true,
               verify_download_integrity: true, quiet: false)
  @cask = cask
  @command = command
  @force = force
  @skip_cask_deps = skip_cask_deps
  @binaries = binaries
  @verbose = verbose
  @zap = zap
  @require_sha = require_sha
  @reinstall = false
  @upgrade = upgrade
  @installed_as_dependency = installed_as_dependency
  @quarantine = quarantine
  @verify_download_integrity = verify_download_integrity
  @quiet = quiet
end

Class Method Details

.caveats(cask) ⇒ 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. 



55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'cask/installer.rb', line 55

def self.caveats(cask)
  odebug "Printing caveats"

  caveats = cask.caveats
  return if caveats.empty?

  Homebrew.messages.record_caveats(cask.token, caveats)

  <<~EOS
    #{ohai_title "Caveats"}
    #{caveats}
  EOS
end

Instance Method Details

#arch_dependencies ⇒ 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.

Raises:



290
291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'cask/installer.rb', line 290

def arch_dependencies
  return if @cask.depends_on.arch.nil?

  @current_arch ||= { type: Hardware::CPU.type, bits: Hardware::CPU.bits }
  return if @cask.depends_on.arch.any? do |arch|
    arch[:type] == @current_arch[:type] &&
    Array(arch[:bits]).include?(@current_arch[:bits])
  end

  raise CaskError,
        "Cask #{@cask} depends on hardware architecture being one of " \
        "[#{@cask.depends_on.arch.map(&:to_s).join(", ")}], " \
        "but you are running #{@current_arch}."
end

#backup ⇒ 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. 



421
422
423
424
 
# File 'cask/installer.rb', line 421

def backup
  @cask.staged_path.rename backup_path
  @cask.metadata_versioned_path.rename backup_metadata_path
end

#backup_metadata_path ⇒ 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. 



494
495
496
497
498
 
# File 'cask/installer.rb', line 494

def backup_metadata_path
  return if @cask.metadata_versioned_path.nil?

  Pathname("#{@cask.metadata_versioned_path}.upgrading")
end

#backup_path ⇒ 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. 



488
489
490
491
492
 
# File 'cask/installer.rb', line 488

def backup_path
  return if @cask.staged_path.nil?

  Pathname("#{@cask.staged_path}.upgrading")
end

#cask_and_formula_dependencies ⇒ 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. 



334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'cask/installer.rb', line 334

def cask_and_formula_dependencies
  return if installed_as_dependency?

  formulae_and_casks = collect_cask_and_formula_dependencies

  return if formulae_and_casks.empty?

  missing_formulae_and_casks = missing_cask_and_formula_dependencies

  if missing_formulae_and_casks.empty?
    puts "All formula dependencies satisfied."
    return
  end

  ohai "Installing dependencies: #{missing_formulae_and_casks.map(&:to_s).join(", ")}"
  missing_formulae_and_casks.each do |cask_or_formula|
    if cask_or_formula.is_a?(Cask)
      if skip_cask_deps?
        opoo "`--skip-cask-deps` is set; skipping installation of #{cask_or_formula}."
        next
      end

      Installer.new(
        cask_or_formula,
        binaries:                binaries?,
        verbose:                 verbose?,
        installed_as_dependency: true,
        force:                   false,
      ).install
    else
      fi = FormulaInstaller.new(
        cask_or_formula,
        **{
          show_header:             true,
          installed_as_dependency: true,
          installed_on_request:    false,
          verbose:                 verbose?,
        }.compact,
      )
      fi.prelude
      fi.fetch
      fi.install
      fi.finish
    end
  end
end

#caveats ⇒ 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. 



381
382
383
 
# File 'cask/installer.rb', line 381

def caveats
  self.class.caveats(@cask)
end

#check_conflicts ⇒ 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. 



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'cask/installer.rb', line 131

def check_conflicts
  return unless @cask.conflicts_with

  @cask.conflicts_with[:cask].each do |conflicting_cask|
    if (match = conflicting_cask.match(HOMEBREW_TAP_CASK_REGEX))
      conflicting_cask_tap = Tap.fetch(match[1], match[2])
      next unless conflicting_cask_tap.installed?
    end

    conflicting_cask = CaskLoader.load(conflicting_cask)
    raise CaskConflictError.new(@cask, conflicting_cask) if conflicting_cask.installed?
  rescue CaskUnavailableError
    next # Ignore conflicting Casks that do not exist.
  end
end

#collect_cask_and_formula_dependencies ⇒ 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.

Raises:



305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'cask/installer.rb', line 305

def collect_cask_and_formula_dependencies
  return @cask_and_formula_dependencies if @cask_and_formula_dependencies

  graph = ::Utils::TopologicalHash.graph_package_dependencies(@cask)

  raise CaskSelfReferencingDependencyError, cask.token if graph[@cask].include?(@cask)

  ::Utils::TopologicalHash.graph_package_dependencies(primary_container.dependencies, graph)

  begin
    @cask_and_formula_dependencies = graph.tsort - [@cask]
  rescue TSort::Cyclic
    strongly_connected_components = graph.strongly_connected_components.sort_by(&:count)
    cyclic_dependencies = strongly_connected_components.last - [@cask]
    raise CaskCyclicDependencyError.new(@cask.token, cyclic_dependencies.to_sentence)
  end
end

#download(quiet: nil, timeout: nil) ⇒ Pathname

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.

Parameters:

  • quiet (Boolean, nil) (defaults to: nil)
  • timeout (Integer, Float, nil) (defaults to: nil)

Returns:



183
184
185
186
187
 
# File 'cask/installer.rb', line 183

def download(quiet: nil, timeout: nil)
  # Store cask download path in cask to prevent multiple downloads in a row when checking if it's outdated
  @cask.download ||= downloader.fetch(quiet: quiet, verify_download_integrity: @verify_download_integrity,
                                      timeout: timeout)
end

#downloader ⇒ Download

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.

Returns:



178
179
180
 
# File 'cask/installer.rb', line 178

def downloader
  @downloader ||= Download.new(@cask, quarantine: quarantine?)
end

#extract_primary_container(to: @cask.staged_path) ⇒ 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. 



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
 
# File 'cask/installer.rb', line 206

def extract_primary_container(to: @cask.staged_path)
  odebug "Extracting primary container"

  odebug "Using container class #{primary_container.class} for #{primary_container.path}"

  basename = downloader.basename

  if (nested_container = @cask.container&.nested)
    Dir.mktmpdir do |tmpdir|
      tmpdir = Pathname(tmpdir)
      primary_container.extract(to: tmpdir, basename: basename, verbose: verbose?)

      FileUtils.chmod_R "+rw", tmpdir/nested_container, force: true, verbose: verbose?

      UnpackStrategy.detect(tmpdir/nested_container, merge_xattrs: true)
                    .extract_nestedly(to: to, verbose: verbose?)
    end
  else
    primary_container.extract_nestedly(to: to, basename: basename, verbose: verbose?)
  end

  return unless quarantine?
  return unless Quarantine.available?

  Quarantine.propagate(from: primary_container.path, to: to)
end

#fetch(quiet: nil, timeout: nil) ⇒ 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.

Parameters:

  • quiet (Boolean, nil) (defaults to: nil)
  • timeout (Integer, Float, nil) (defaults to: nil) 


70
71
72
73
74
75
76
77
78
 
# File 'cask/installer.rb', line 70

def fetch(quiet: nil, timeout: nil)
  odebug "Cask::Installer#fetch"

  verify_has_sha if require_sha? && !force?

  download(quiet: quiet, timeout: timeout)

  satisfy_dependencies
end

#finalize_upgrade ⇒ 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. 



442
443
444
445
446
447
448
 
# File 'cask/installer.rb', line 442

def finalize_upgrade
  ohai "Purging files for version #{@cask.version} of Cask #{@cask}"

  purge_backed_up_versioned_files

  puts summary
end

#gain_permissions_remove(path) ⇒ 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. 



500
501
502
 
# File 'cask/installer.rb', line 500

def gain_permissions_remove(path)
  Utils.gain_permissions_remove(path, command: @command)
end

#install ⇒ 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. 



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
 
# File 'cask/installer.rb', line 92

def install
  start_time = Time.now
  odebug "Cask::Installer#install"

  old_config = @cask.config
  if @cask.installed? && !force? && !reinstall? && !upgrade?
    return if quiet?

    raise CaskAlreadyInstalledError, @cask
  end

  check_conflicts

  print caveats
  fetch
  uninstall_existing_cask if reinstall?

  backup if force? && @cask.staged_path.exist? && @cask.metadata_versioned_path.exist?

  oh1 "Installing Cask #{Formatter.identifier(@cask)}"
  opoo "macOS's Gatekeeper has been disabled for this Cask" unless quarantine?
  stage

  @cask.config = @cask.default_config.merge(old_config)

  install_artifacts

  ::Utils::Analytics.report_event("cask_install", @cask.token) unless @cask.tap&.private?

  purge_backed_up_versioned_files

  puts summary
  end_time = Time.now
  Homebrew.messages.package_installed(@cask.token, end_time - start_time)
rescue
  restore_backup
  raise
end

#install_artifacts ⇒ 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. 



233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'cask/installer.rb', line 233

def install_artifacts
  artifacts = @cask.artifacts
  already_installed_artifacts = []

  odebug "Installing artifacts"
  odebug "#{artifacts.length} #{"artifact".pluralize(artifacts.length)} defined", artifacts

  artifacts.each do |artifact|
    next unless artifact.respond_to?(:install_phase)

    odebug "Installing artifact of class #{artifact.class}"

    next if artifact.is_a?(Artifact::Binary) && !binaries?

    artifact.install_phase(command: @command, verbose: verbose?, force: force?)
    already_installed_artifacts.unshift(artifact)
  end

  save_config_file
  save_download_sha if @cask.version.latest?
rescue => e
  begin
    already_installed_artifacts.each do |artifact|
      if artifact.respond_to?(:uninstall_phase)
        odebug "Reverting installation of artifact of class #{artifact.class}"
        artifact.uninstall_phase(command: @command, verbose: verbose?, force: force?)
      end

      next unless artifact.respond_to?(:post_uninstall_phase)

      odebug "Reverting installation of artifact of class #{artifact.class}"
      artifact.post_uninstall_phase(command: @command, verbose: verbose?, force: force?)
    end
  ensure
    purge_versioned_files
    raise e
  end
end

#macos_dependencies ⇒ 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.

Raises:



283
284
285
286
287
288
 
# File 'cask/installer.rb', line 283

def macos_dependencies
  return unless @cask.depends_on.macos
  return if @cask.depends_on.macos.satisfied?

  raise CaskError, @cask.depends_on.macos.message(type: :cask)
end

#missing_cask_and_formula_dependencies ⇒ 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. 



323
324
325
326
327
328
329
330
331
332
 
# File 'cask/installer.rb', line 323

def missing_cask_and_formula_dependencies
  collect_cask_and_formula_dependencies.reject do |cask_or_formula|
    installed = if cask_or_formula.respond_to?(:any_version_installed?)
      cask_or_formula.any_version_installed?
    else
      cask_or_formula.try(:installed?)
    end
    installed && (cask_or_formula.respond_to?(:optlinked?) ? cask_or_formula.optlinked? : true)
  end
end

#primary_container ⇒ 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. 



199
200
201
202
203
204
 
# File 'cask/installer.rb', line 199

def primary_container
  @primary_container ||= begin
    downloaded_path = download(quiet: true)
    UnpackStrategy.detect(downloaded_path, type: @cask.container&.type, merge_xattrs: true)
  end
end

#purge_backed_up_versioned_files ⇒ 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. 



504
505
506
507
508
509
510
511
512
513
514
515
 
# File 'cask/installer.rb', line 504

def purge_backed_up_versioned_files
  # versioned staged distribution
  gain_permissions_remove(backup_path) if backup_path&.exist?

  # Homebrew Cask metadata
  return unless backup_metadata_path.directory?

  backup_metadata_path.children.each do |subdir|
    gain_permissions_remove(subdir)
  end
  backup_metadata_path.rmdir_if_possible
end

#purge_caskroom_path ⇒ 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. 



537
538
539
540
 
# File 'cask/installer.rb', line 537

def purge_caskroom_path
  odebug "Purging all staged versions of Cask #{@cask}"
  gain_permissions_remove(@cask.caskroom_path)
end

#purge_versioned_files ⇒ 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. 



517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
 
# File 'cask/installer.rb', line 517

def purge_versioned_files
  ohai "Purging files for version #{@cask.version} of Cask #{@cask}"

  # versioned staged distribution
  gain_permissions_remove(@cask.staged_path) if @cask.staged_path&.exist?

  # Homebrew Cask metadata
  if @cask.metadata_versioned_path.directory?
    @cask.metadata_versioned_path.children.each do |subdir|
      gain_permissions_remove(subdir)
    end

    @cask.metadata_versioned_path.rmdir_if_possible
  end
  @cask.metadata_main_container_path.rmdir_if_possible unless upgrade?

  # toplevel staged distribution
  @cask.caskroom_path.rmdir_if_possible unless upgrade?
end

#reinstall ⇒ 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. 



147
148
149
150
151
 
# File 'cask/installer.rb', line 147

def reinstall
  odebug "Cask::Installer#reinstall"
  @reinstall = true
  install
end

#remove_config_file ⇒ 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. 



411
412
413
414
 
# File 'cask/installer.rb', line 411

def remove_config_file
  FileUtils.rm_f @cask.config_path
  @cask.config_path.parent.rmdir_if_possible
end

#restore_backup ⇒ 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. 



426
427
428
429
430
431
432
433
434
 
# File 'cask/installer.rb', line 426

def restore_backup
  return if !backup_path.directory? || !backup_metadata_path.directory?

  Pathname.new(@cask.staged_path).rmtree if @cask.staged_path.exist?
  Pathname.new(@cask.metadata_versioned_path).rmtree if @cask.metadata_versioned_path.exist?

  backup_path.rename @cask.staged_path
  backup_metadata_path.rename @cask.metadata_versioned_path
end

#revert_upgrade ⇒ 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. 



436
437
438
439
440
 
# File 'cask/installer.rb', line 436

def revert_upgrade
  opoo "Reverting upgrade for Cask #{@cask}"
  restore_backup
  install_artifacts
end

#satisfy_dependencies ⇒ 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. 



275
276
277
278
279
280
281
 
# File 'cask/installer.rb', line 275

def satisfy_dependencies
  return unless @cask.depends_on

  macos_dependencies
  arch_dependencies
  cask_and_formula_dependencies
end

#save_caskfile ⇒ 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. 



385
386
387
388
389
390
391
392
393
 
# File 'cask/installer.rb', line 385

def save_caskfile
  old_savedir = @cask.metadata_timestamped_path

  return if @cask.source.blank?

  savedir = @cask.metadata_subdir("Casks", timestamp: :now, create: true)
  (savedir/"#{@cask.token}.rb").write @cask.source
  old_savedir&.rmtree
end

#save_config_file ⇒ 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. 



395
396
397
 
# File 'cask/installer.rb', line 395

def save_config_file
  @cask.config_path.atomic_write(@cask.config.to_json)
end

#save_download_sha ⇒ 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. 



399
400
401
 
# File 'cask/installer.rb', line 399

def save_download_sha
  @cask.download_sha_path.atomic_write(@cask.new_download_sha)
end

#stage ⇒ 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. 



80
81
82
83
84
85
86
87
88
89
90
 
# File 'cask/installer.rb', line 80

def stage
  odebug "Cask::Installer#stage"

  Caskroom.ensure_caskroom_exists

  extract_primary_container
  save_caskfile
rescue => e
  purge_versioned_files
  raise e
end

#start_upgrade ⇒ 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. 



416
417
418
419
 
# File 'cask/installer.rb', line 416

def start_upgrade
  uninstall_artifacts
  backup
end

#summary ⇒ String

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.

Returns:



170
171
172
173
174
175
 
# File 'cask/installer.rb', line 170

def summary
  s = +""
  s << "#{Homebrew::EnvConfig.install_badge}  " unless Homebrew::EnvConfig.no_emoji?
  s << "#{@cask} was successfully #{upgrade? ? "upgraded" : "installed"}!"
  s.freeze
end

#uninstall ⇒ 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. 



403
404
405
406
407
408
409
 
# File 'cask/installer.rb', line 403

def uninstall
  oh1 "Uninstalling Cask #{Formatter.identifier(@cask)}"
  uninstall_artifacts(clear: true)
  remove_config_file if !reinstall? && !upgrade?
  purge_versioned_files
  purge_caskroom_path if force?
end

#uninstall_artifacts(clear: false) ⇒ 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. 



450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
 
# File 'cask/installer.rb', line 450

def uninstall_artifacts(clear: false)
  artifacts = @cask.artifacts

  odebug "Uninstalling artifacts"
  odebug "#{artifacts.length} #{"artifact".pluralize(artifacts.length)} defined", artifacts

  artifacts.each do |artifact|
    if artifact.respond_to?(:uninstall_phase)
      odebug "Uninstalling artifact of class #{artifact.class}"
      artifact.uninstall_phase(
        command: @command, verbose: verbose?, skip: clear, force: force?, upgrade: upgrade?,
      )
    end

    next unless artifact.respond_to?(:post_uninstall_phase)

    odebug "Post-uninstalling artifact of class #{artifact.class}"
    artifact.post_uninstall_phase(
      command: @command, verbose: verbose?, skip: clear, force: force?, upgrade: upgrade?,
    )
  end
end

#uninstall_existing_cask ⇒ 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. 



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'cask/installer.rb', line 153

def uninstall_existing_cask
  return unless @cask.installed?

  # use the same cask file that was used for installation, if possible
  installed_caskfile = @cask.installed_caskfile
  installed_cask = begin
    installed_caskfile.exist? ? CaskLoader.load(installed_caskfile) : @cask
  rescue CaskInvalidError # could be thrown by call to CaskLoader#load with outdated caskfile
    @cask # default
  end

  # Always force uninstallation, ignore method parameter
  cask_installer = Installer.new(installed_cask, verbose: verbose?, force: true, upgrade: upgrade?)
  zap? ? cask_installer.zap : cask_installer.uninstall
end

#verify_has_sha ⇒ 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.

Raises:



189
190
191
192
193
194
195
196
197
 
# File 'cask/installer.rb', line 189

def verify_has_sha
  odebug "Checking cask has checksum"
  return unless @cask.sha256 == :no_check

  raise CaskError, <<~EOS
    Cask '#{@cask}' does not have a sha256 checksum defined and was not installed.
    This means you have the #{Formatter.identifier("--require-sha")} option set, perhaps in your HOMEBREW_CASK_OPTS.
  EOS
end

#zap ⇒ 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. 



473
474
475
476
477
478
479
480
481
482
483
484
485
486
 
# File 'cask/installer.rb', line 473

def zap
  ohai "Implied `brew uninstall --cask #{@cask}`"
  uninstall_artifacts
  if (zap_stanzas = @cask.artifacts.select { |a| a.is_a?(Artifact::Zap) }).empty?
    opoo "No zap stanza present for Cask '#{@cask}'"
  else
    ohai "Dispatching zap stanza"
    zap_stanzas.each do |stanza|
      stanza.zap_phase(command: @command, verbose: verbose?, force: force?)
    end
  end
  ohai "Removing all staged versions of Cask '#{@cask}'"
  purge_caskroom_path
end