Class: Cask::Installer Private

Inherits:
Object show all
Extended by:
Attrable
Defined in:
cask/installer.rb,
sorbet/rbi/parlour.rbi

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.

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Attrable

attr_predicate, attr_rw

Constructor Details

#initialize(cask, command: SystemCommand, force: false, adopt: false, skip_cask_deps: false, binaries: true, verbose: false, zap: false, require_sha: false, upgrade: false, reinstall: 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.



21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
# File 'cask/installer.rb', line 21

def initialize(cask, command: SystemCommand, force: false, adopt: false,
               skip_cask_deps: false, binaries: true, verbose: false,
               zap: false, require_sha: false, upgrade: false, reinstall: false,
               installed_as_dependency: false, quarantine: true,
               verify_download_integrity: true, quiet: false)
  @cask = cask
  @command = command
  @force = force
  @adopt = adopt
  @skip_cask_deps = skip_cask_deps
  @binaries = binaries
  @verbose = verbose
  @zap = zap
  @require_sha = require_sha
  @reinstall = reinstall
  @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.



47
48
49
50
51
52
53
54
55
56
57
58
59
# File 'cask/installer.rb', line 47

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

#adopt?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.

Returns:

  • (Boolean)


324
# File 'sorbet/rbi/parlour.rbi', line 324

def adopt?; end

#backupObject

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.



434
435
436
437
# File 'cask/installer.rb', line 434

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

#backup_metadata_pathObject

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.



520
521
522
523
524
# File 'cask/installer.rb', line 520

def 
  return if @cask..nil?

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

#backup_pathObject

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.



514
515
516
517
518
# File 'cask/installer.rb', line 514

def backup_path
  return if @cask.staged_path.nil?

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

#binaries?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.

Returns:

  • (Boolean)


318
# File 'sorbet/rbi/parlour.rbi', line 318

def binaries?; end

#cask_and_formula_dependenciesObject

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.



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

def 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

#caveatsObject

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.



379
380
381
# File 'cask/installer.rb', line 379

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

#check_arch_requirementsObject

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:



287
288
289
290
291
292
293
294
295
296
297
298
299
300
# File 'cask/installer.rb', line 287

def check_arch_requirements
  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

#check_conflictsObject

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.



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
# File 'cask/installer.rb', line 146

def check_conflicts
  return unless @cask.conflicts_with

  @cask.conflicts_with[:cask].each do |conflicting_cask|
    if (conflicting_cask_tap_with_token = Tap.with_cask_token(conflicting_cask))
      conflicting_cask_tap, = conflicting_cask_tap_with_token
      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

#check_deprecate_disableObject

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.



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

def check_deprecate_disable
  deprecate_disable_type = DeprecateDisable.type(@cask)
  return if deprecate_disable_type.nil?

  message = DeprecateDisable.message(@cask)
  message_full = "#{@cask.token} has been #{message}"

  case deprecate_disable_type
  when :deprecated
    opoo message_full
  when :disabled
    GitHub::Actions.puts_annotation_if_env_set(:error, message)
    raise CaskCannotBeInstalledError.new(@cask, message)
  end
end

#check_macos_requirementsObject

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:



280
281
282
283
284
285
# File 'cask/installer.rb', line 280

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

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

#check_requirementsObject

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

def check_requirements
  check_macos_requirements
  check_arch_requirements
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:



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

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:, verify_download_integrity: @verify_download_integrity,
                                      timeout:)
end

#downloaderDownload

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:



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

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.



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

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("cask-installer", HOMEBREW_TEMP) do |tmpdir|
      tmpdir = Pathname(tmpdir)
      primary_container.extract(to: tmpdir, 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:, verbose: verbose?)
    end
  else
    primary_container.extract_nestedly(to:, basename:, verbose: verbose?)
  end

  return unless quarantine?
  return unless Quarantine.available?

  Quarantine.propagate(from: primary_container.path, 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)


62
63
64
65
66
67
68
69
70
71
72
73
74
75
# File 'cask/installer.rb', line 62

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

  load_cask_from_source_api! if @cask.loaded_from_api? && @cask.caskfile_only?
  verify_has_sha if require_sha? && !force?
  check_requirements

  download(quiet:, timeout:)

  satisfy_cask_and_formula_dependencies

  forbidden_tap_check
  forbidden_cask_and_formula_check
end

#finalize_upgradeObject

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.



456
457
458
459
460
461
462
# File 'cask/installer.rb', line 456

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

  purge_backed_up_versioned_files

  puts summary
end

#forbidden_cask_and_formula_checkvoid

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.



614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
# File 'cask/installer.rb', line 614

def forbidden_cask_and_formula_check
  forbidden_formulae = Set.new(Homebrew::EnvConfig.forbidden_formulae.to_s.split)
  forbidden_casks = Set.new(Homebrew::EnvConfig.forbidden_casks.to_s.split)
  return if forbidden_formulae.blank? && forbidden_casks.blank?

  owner = Homebrew::EnvConfig.forbidden_owner
  owner_contact = if (contact = Homebrew::EnvConfig.forbidden_owner_contact.presence)
    "\n#{contact}"
  end

  unless skip_cask_deps?
    cask_and_formula_dependencies.each do |dep_cask_or_formula|
      dep_name, dep_type, variable = if dep_cask_or_formula.is_a?(Cask) && forbidden_casks.present?
        dep_cask = dep_cask_or_formula
        dep_cask_name = if forbidden_casks.include?(dep_cask.token)
          dep_cask.token
        elsif dep_cask.tap.present? &&
              forbidden_casks.include?(dep_cask.full_name)
          dep_cask.full_name
        end
        [dep_cask_name, "cask", "HOMEBREW_FORBIDDEN_CASKS"]
      elsif dep_cask_or_formula.is_a?(Formula) && forbidden_formulae.present?
        dep_formula = dep_cask_or_formula
        formula_name = if forbidden_formulae.include?(dep_formula.name)
          dep_formula.name
        elsif dep_formula.tap.present? &&
              forbidden_formulae.include?(dep_formula.full_name)
          dep_formula.full_name
        end
        [formula_name, "formula", "HOMEBREW_FORBIDDEN_FORMULAE"]
      end
      next if dep_name.blank?

      raise CaskCannotBeInstalledError.new(@cask, <<~EOS
        The installation of #{@cask} has a dependency #{dep_name}
        but the #{dep_name} #{dep_type} was forbidden by #{owner} in `#{variable}`.#{owner_contact}
      EOS
      )
    end
  end
  return if forbidden_casks.blank?

  cask_name = if forbidden_casks.include?(@cask.token)
    @cask.token
  elsif forbidden_casks.include?(@cask.full_name)
    @cask.full_name
  else
    return
  end

  raise CaskCannotBeInstalledError.new(@cask, <<~EOS
    The installation of #{cask_name} was forbidden by #{owner}
    in `HOMEBREW_FORBIDDEN_CASKS`.#{owner_contact}
  EOS
  )
end

#forbidden_tap_checkvoid

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.



575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
# File 'cask/installer.rb', line 575

def forbidden_tap_check
  return if Tap.allowed_taps.blank? && Tap.forbidden_taps.blank?

  owner = Homebrew::EnvConfig.forbidden_owner
  owner_contact = if (contact = Homebrew::EnvConfig.forbidden_owner_contact.presence)
    "\n#{contact}"
  end

  unless skip_cask_deps?
    cask_and_formula_dependencies.each do |cask_or_formula|
      dep_tap = cask_or_formula.tap
      next if dep_tap.blank? || (dep_tap.allowed_by_env? && !dep_tap.forbidden_by_env?)

      dep_full_name = cask_or_formula.full_name
      error_message = +"The installation of #{@cask} has a dependency #{dep_full_name}\n" \
                       "from the #{dep_tap} tap but #{owner} "
      error_message << "has not allowed this tap in `HOMEBREW_ALLOWED_TAPS`" unless dep_tap.allowed_by_env?
      error_message << " and\n" if !dep_tap.allowed_by_env? && dep_tap.forbidden_by_env?
      error_message << "has forbidden this tap in `HOMEBREW_FORBIDDEN_TAPS`" if dep_tap.forbidden_by_env?
      error_message << ".#{owner_contact}"

      raise CaskCannotBeInstalledError.new(@cask, error_message)
    end
  end

  cask_tap = @cask.tap
  return if cask_tap.blank? || (cask_tap.allowed_by_env? && !cask_tap.forbidden_by_env?)

  error_message = +"The installation of #{@cask.full_name} has the tap #{cask_tap}\n" \
                   "but #{owner} "
  error_message << "has not allowed this tap in `HOMEBREW_ALLOWED_TAPS`" unless cask_tap.allowed_by_env?
  error_message << " and\n" if !cask_tap.allowed_by_env? && cask_tap.forbidden_by_env?
  error_message << "has forbidden this tap in `HOMEBREW_FORBIDDEN_TAPS`" if cask_tap.forbidden_by_env?
  error_message << ".#{owner_contact}"

  raise CaskCannotBeInstalledError.new(@cask, error_message)
end

#force?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.

Returns:

  • (Boolean)


321
# File 'sorbet/rbi/parlour.rbi', line 321

def force?; 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.



526
527
528
# File 'cask/installer.rb', line 526

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

#installObject

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.



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

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

  Migrator.migrate_if_needed(@cask)

  old_config = @cask.config
  predecessor = @cask if reinstall? && @cask.installed?

  check_deprecate_disable
  check_conflicts

  print caveats
  fetch
  uninstall_existing_cask if reinstall?

  backup if force? && @cask.staged_path.exist? && @cask..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(predecessor:)

  if (tap = @cask.tap) && tap.should_report_analytics?
    ::Utils::Analytics.report_package_event(:cask_install, package_name: @cask.token, tap_name: tap.name,
on_request: true)
  end

  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(predecessor: 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:

  • predecessor (Cask, nil) (defaults to: nil)


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
271
272
273
# File 'cask/installer.rb', line 235

def install_artifacts(predecessor: nil)
  artifacts = @cask.artifacts
  already_installed_artifacts = []

  odebug "Installing 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?, adopt: adopt?, force: force?, predecessor:,
    )
    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

#installed_as_dependency?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.

Returns:

  • (Boolean)


345
# File 'sorbet/rbi/parlour.rbi', line 345

def installed_as_dependency?; end

#metadata_subdirObject

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.



383
384
385
# File 'cask/installer.rb', line 383

def 
  @metadata_subdir ||= @cask.("Casks", timestamp: :now, create: true)
end

#missing_cask_and_formula_dependenciesObject

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.



320
321
322
323
324
325
326
327
328
329
# File 'cask/installer.rb', line 320

def missing_cask_and_formula_dependencies
  cask_and_formula_dependencies.reject do |cask_or_formula|
    case cask_or_formula
    when Formula
      cask_or_formula.any_version_installed? && cask_or_formula.optlinked?
    when Cask
      cask_or_formula.installed?
    end
  end
end

#primary_containerObject

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.



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

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_filesObject

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.



530
531
532
533
534
535
536
537
538
539
540
541
# File 'cask/installer.rb', line 530

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

  # Homebrew Cask metadata
  return unless .directory?

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

#purge_caskroom_pathObject

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.



569
570
571
572
# File 'cask/installer.rb', line 569

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

#purge_versioned_filesObject

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.



543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
# File 'cask/installer.rb', line 543

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..directory?
    @cask..children.each do |subdir|
      gain_permissions_remove(subdir)
    end

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

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

  # Remove symlinks for renamed casks if they are now broken.
  @cask.old_tokens.each do |old_token|
    old_caskroom_path = Caskroom.path/old_token
    FileUtils.rm old_caskroom_path if old_caskroom_path.symlink? && !old_caskroom_path.exist?
  end
end

#quarantine?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.

Returns:

  • (Boolean)


348
# File 'sorbet/rbi/parlour.rbi', line 348

def quarantine?; end

#quiet?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.

Returns:

  • (Boolean)


351
# File 'sorbet/rbi/parlour.rbi', line 351

def quiet?; end

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

Returns:

  • (Boolean)


333
# File 'sorbet/rbi/parlour.rbi', line 333

def reinstall?; end

#remove_config_fileObject

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.



418
419
420
421
# File 'cask/installer.rb', line 418

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

#remove_download_shaObject

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.



423
424
425
426
# File 'cask/installer.rb', line 423

def remove_download_sha
  FileUtils.rm_f @cask.download_sha_path
  @cask.download_sha_path.parent.rmdir_if_possible
end

#require_sha?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.

Returns:

  • (Boolean)


330
# File 'sorbet/rbi/parlour.rbi', line 330

def require_sha?; end

#restore_backupObject

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.



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

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

  @cask.staged_path.rmtree if @cask.staged_path.exist?
  @cask..rmtree if @cask..exist?

  backup_path.rename @cask.staged_path
  .rename @cask.
end

#revert_upgrade(predecessor:) ⇒ 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:

  • predecessor (Cask)


450
451
452
453
454
# File 'cask/installer.rb', line 450

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

#satisfy_cask_and_formula_dependenciesObject

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.



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

def satisfy_cask_and_formula_dependencies
  return if installed_as_dependency?

  formulae_and_casks = 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 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,
        adopt:                   adopt?,
        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

#save_caskfileObject

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.



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

def save_caskfile
  old_savedir = @cask.

  return if @cask.source.blank?

  extension = @cask.loaded_from_api? ? "json" : "rb"
  (/"#{@cask.token}.#{extension}").write @cask.source
  old_savedir&.rmtree
end

#save_config_fileObject

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.



397
398
399
# File 'cask/installer.rb', line 397

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

#save_download_shaObject

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.



401
402
403
# File 'cask/installer.rb', line 401

def save_download_sha
  @cask.download_sha_path.atomic_write(@cask.new_download_sha) if @cask.checksumable?
end

#skip_cask_deps?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.

Returns:

  • (Boolean)


327
# File 'sorbet/rbi/parlour.rbi', line 327

def skip_cask_deps?; end

#stageObject

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.



77
78
79
80
81
82
83
84
85
86
87
# File 'cask/installer.rb', line 77

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(successor:) ⇒ 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:

  • successor (Cask, nil)


429
430
431
432
# File 'cask/installer.rb', line 429

def start_upgrade(successor:)
  uninstall_artifacts(successor:)
  backup
end

#summaryString

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:



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

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

#uninstall(successor: 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:

  • successor (Cask, nil) (defaults to: nil)


406
407
408
409
410
411
412
413
414
415
416
# File 'cask/installer.rb', line 406

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

#uninstall_artifacts(clear: false, successor: 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:

  • clear (Boolean) (defaults to: false)
  • successor (Cask, nil) (defaults to: nil)


465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
# File 'cask/installer.rb', line 465

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

  odebug "Uninstalling artifacts"
  odebug "#{::Utils.pluralize("artifact", artifacts.length, include_count: true)} 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?,
        successor:,
        upgrade:   upgrade?,
        reinstall: reinstall?,
      )
    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?,
      successor:,
    )
  end
end

#uninstall_existing_caskObject

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.



162
163
164
165
166
167
168
# File 'cask/installer.rb', line 162

def uninstall_existing_cask
  return unless @cask.installed?

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

#upgrade?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.

Returns:

  • (Boolean)


336
# File 'sorbet/rbi/parlour.rbi', line 336

def upgrade?; end

#verbose?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.

Returns:

  • (Boolean)


339
# File 'sorbet/rbi/parlour.rbi', line 339

def verbose?; end

#verify_has_shaObject

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:



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

def verify_has_sha
  odebug "Checking cask has checksum"
  return if @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

#zapObject

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.



498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
# File 'cask/installer.rb', line 498

def zap
  load_installed_caskfile!
  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

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

Returns:

  • (Boolean)


342
# File 'sorbet/rbi/parlour.rbi', line 342

def zap?; end