Class: Cask::Cask Private

Inherits:
Object show all
Extended by:
APIHashable, Forwardable, Utils::Output::Mixin
Includes:
Metadata
Defined in:
cask/cask.rb,
sorbet/rbi/dsl/cask/cask.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.

An instance of a cask.

Constant Summary

Constants included from Metadata

Metadata::METADATA_SUBDIR, Metadata::TIMESTAMP_FORMAT

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from APIHashable

deep_remove_placeholders, generated_hash!, generating_hash!, generating_hash?

Methods included from Utils::Output::Mixin

odebug, odeprecated, odie, odisabled, ofail, oh1, oh1_title, ohai, ohai_title, onoe, opoo, opoo_outside_github_actions, pretty_deprecated, pretty_disabled, pretty_duration, pretty_installed, pretty_outdated, pretty_uninstalled

Methods included from Metadata

#metadata_main_container_path, #metadata_subdir, #metadata_timestamped_path, #metadata_versioned_path

Constructor Details

#initialize(token, sourcefile_path: nil, source: nil, tap: nil, loaded_from_api: false, loaded_from_internal_api: false, api_source: nil, config: nil, allow_reassignment: false, loader: nil, &block) ⇒ 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.

Parameters:

  • token (String)
  • sourcefile_path (Pathname, nil) (defaults to: nil)
  • source (String, nil) (defaults to: nil)
  • tap (Tap, nil) (defaults to: nil)
  • loaded_from_api (Boolean) (defaults to: false)
  • loaded_from_internal_api (Boolean) (defaults to: false)
  • api_source (Hash{String => T.untyped}, nil) (defaults to: nil)
  • config (Config, nil) (defaults to: nil)
  • allow_reassignment (Boolean) (defaults to: false)
  • loader (CaskLoader::ILoader, nil) (defaults to: nil)
  • block (T.proc.bind(DSL).void, nil) 


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

def initialize(token, sourcefile_path: nil, source: nil, tap: nil, loaded_from_api: false,
               loaded_from_internal_api: false, api_source: nil, config: nil, allow_reassignment: false,
               loader: nil, &block)
  @token = token
  @sourcefile_path = sourcefile_path
  @source = source
  @tap = tap
  @allow_reassignment = allow_reassignment
  @loaded_from_api = loaded_from_api
  @loaded_from_internal_api = loaded_from_internal_api
  @api_source = api_source
  @loader = loader
  # Sorbet has trouble with bound procs assigned to instance variables:
  # https://github.com/sorbet/sorbet/issues/6843
  @block = T.let(block, T.untyped)

  @default_config = T.let(config || Config.new, Config)

  @config = T.let(if config_path.exist?
                    Config.from_json(File.read(config_path), ignore_invalid_keys: true)
                  else
                    @default_config
  end, Config)
  refresh
end

Instance Attribute Details

#allow_reassignment ⇒ 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) 


51
52
53
 
# File 'cask/cask.rb', line 51

def allow_reassignment
  @allow_reassignment
end

#api_source ⇒ Hash{String => T.untyped}? (readonly)

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:



132
133
134
 
# File 'cask/cask.rb', line 132

def api_source
  @api_source
end

#config ⇒ Config

This method is part of an internal API. This method may only be used internally in repositories owned by Homebrew, except in casks or formulae. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

The configuration of this Cask::Cask.

Returns:



33
34
35
 
# File 'cask/cask.rb', line 33

def config
  @config
end

#default_config ⇒ Config (readonly)

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:



42
43
44
 
# File 'cask/cask.rb', line 42

def default_config
  @default_config
end

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

Returns:



48
49
50
 
# File 'cask/cask.rb', line 48

def download
  @download
end

#loader ⇒ CaskLoader::ILoader? (readonly)

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:



45
46
47
 
# File 'cask/cask.rb', line 45

def loader
  @loader
end

#source ⇒ String? (readonly)

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:



39
40
41
 
# File 'cask/cask.rb', line 39

def source
  @source
end

#sourcefile_path ⇒ Pathname? (readonly)

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:



36
37
38
 
# File 'cask/cask.rb', line 36

def sourcefile_path
  @sourcefile_path
end

#token ⇒ String (readonly)

The unique identifier for this Cask::Cask, used to refer to it in commands and tap paths. e.g. firefox

Returns:



27
28
29
 
# File 'cask/cask.rb', line 27

def token
  @token
end

Class Method Details

.all(eval_all: false) ⇒ Array<Cask>

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:

  • eval_all (Boolean) (defaults to: false)

Returns:



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

def self.all(eval_all: false)
  if !eval_all && !Homebrew::EnvConfig.eval_all?
    raise ArgumentError, "Cask::Cask#all cannot be used without `--eval-all` or `HOMEBREW_EVAL_ALL=1`"
  end

  # Load core casks from tokens so they load from the API when the core cask is not tapped.
  tokens_and_files = CoreCaskTap.instance.cask_tokens
  tokens_and_files += Tap.reject(&:core_cask_tap?).flat_map(&:cask_files)
  tokens_and_files.filter_map do |token_or_file|
    CaskLoader.load(token_or_file)
  rescue CaskUnreadableError => e
    opoo e.message

    nil
  end
end

Instance Method Details

#app(*args, &block) ⇒ T.untyped

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:

  • args (T.untyped)
  • block (T.untyped)

Returns:

  • (T.untyped) 


10
 
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 10

def app(*args, &block); end

#appdir(*args, &block) ⇒ T.untyped

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:

  • args (T.untyped)
  • block (T.untyped)

Returns:

  • (T.untyped) 


13
 
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 13

def appdir(*args, &block); end

#arch(*args, &block) ⇒ T.untyped

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:

  • args (T.untyped)
  • block (T.untyped)

Returns:

  • (T.untyped) 


16
 
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 16

def arch(*args, &block); end

#artifact(*args, &block) ⇒ T.untyped

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:

  • args (T.untyped)
  • block (T.untyped)

Returns:

  • (T.untyped) 


19
 
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 19

def artifact(*args, &block); end

#artifacts(*args, &block) ⇒ T.untyped

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:

  • args (T.untyped)
  • block (T.untyped)

Returns:

  • (T.untyped) 


22
 
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 22

def artifacts(*args, &block); end

#artifacts_list(uninstall_only: false) ⇒ Array<Hash{Symbol => T.untyped}>

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:

  • uninstall_only (Boolean) (defaults to: false)

Returns:



607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
 
# File 'cask/cask.rb', line 607

def artifacts_list(uninstall_only: false)
  artifacts.filter_map do |artifact|
    case artifact
    when Artifact::AbstractFlightBlock
      uninstall_flight_block = artifact.directives.key?(:uninstall_preflight) ||
                               artifact.directives.key?(:uninstall_postflight)
      next if uninstall_only && !uninstall_flight_block

      # Only indicate whether this block is used as we don't load it from the API
      { artifact.summarize.to_sym => nil }
    else
      zap_artifact = artifact.is_a?(Artifact::Zap)
      uninstall_artifact = artifact.respond_to?(:uninstall_phase) || artifact.respond_to?(:post_uninstall_phase)
      next if uninstall_only && !zap_artifact && !uninstall_artifact

      { artifact.class.dsl_key => artifact.to_args }
    end
  end
end

#audio_unit_plugin(*args, &block) ⇒ T.untyped

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:

  • args (T.untyped)
  • block (T.untyped)

Returns:

  • (T.untyped) 


25
 
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 25

def audio_unit_plugin(*args, &block); end

#auto_updates(*args, &block) ⇒ T.untyped

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:

  • args (T.untyped)
  • block (T.untyped)

Returns:

  • (T.untyped) 


28
 
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 28

def auto_updates(*args, &block); end

#autobump?(*args, &block) ⇒ 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.

Parameters:

  • args (T.untyped)
  • block (T.untyped)

Returns:

  • (Boolean) 


31
 
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 31

def autobump?(*args, &block); end

#bash_completion(*args, &block) ⇒ T.untyped

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:

  • args (T.untyped)
  • block (T.untyped)

Returns:

  • (T.untyped) 


34
 
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 34

def bash_completion(*args, &block); end

#binary(*args, &block) ⇒ T.untyped

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:

  • args (T.untyped)
  • block (T.untyped)

Returns:

  • (T.untyped) 


37
 
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 37

def binary(*args, &block); end

#bundle_long_version ⇒ 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:



326
327
328
 
# File 'cask/cask.rb', line 326

def bundle_long_version
  bundle_version&.version
end

#bundle_short_version ⇒ 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:



321
322
323
 
# File 'cask/cask.rb', line 321

def bundle_short_version
  bundle_version&.short_version
end

#caskfile_only? ⇒ 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.

The caskfile is needed during installation when there are *flight blocks or the cask has multiple languages

Returns:

  • (Boolean) 


263
264
265
 
# File 'cask/cask.rb', line 263

def caskfile_only?
  languages.any? || artifacts.any?(Artifact::AbstractFlightBlock)
end

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

Returns:



374
375
376
 
# File 'cask/cask.rb', line 374

def caskroom_path
  @caskroom_path ||= T.let(Caskroom.path.join(token), T.nilable(Pathname))
end

#caveats(*args, &block) ⇒ T.untyped

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:

  • args (T.untyped)
  • block (T.untyped)

Returns:

  • (T.untyped) 


40
 
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 40

def caveats(*args, &block); end

#caveats_object ⇒ DSL::Caveats

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

def caveats_object = dsl!.caveats_object

#checksumable? ⇒ 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) 


341
342
343
344
345
 
# File 'cask/cask.rb', line 341

def checksumable?
  return false if (url = self.url).nil?

  DownloadStrategyDetector.detect(url.to_s, url.using) <= AbstractFileDownloadStrategy || false
end

#colorpicker(*args, &block) ⇒ T.untyped

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:

  • args (T.untyped)
  • block (T.untyped)

Returns:

  • (T.untyped) 


43
 
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 43

def colorpicker(*args, &block); end

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

Returns:



336
337
338
 
# File 'cask/cask.rb', line 336

def config_path
  metadata_main_container_path/"config.json"
end

#conflicts_with(*args, &block) ⇒ T.untyped

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:

  • args (T.untyped)
  • block (T.untyped)

Returns:

  • (T.untyped) 


46
 
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 46

def conflicts_with(*args, &block); end

#container(*args, &block) ⇒ T.untyped

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:

  • args (T.untyped)
  • block (T.untyped)

Returns:

  • (T.untyped) 


49
 
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 49

def container(*args, &block); end

#contains_os_specific_artifacts? ⇒ 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) 


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

def contains_os_specific_artifacts?
  return false unless @dsl&.on_system_blocks_exist?

  return @contains_os_specific_artifacts unless @contains_os_specific_artifacts.nil?

  any_loaded = T.let(false, T::Boolean)
  OnSystem::VALID_OS_ARCH_TAGS.each do |bottle_tag|
    Homebrew::SimulateSystem.with_tag(bottle_tag) do
      refresh

      any_loaded = true if artifacts.any? do |artifact|
        (bottle_tag.linux? && ::Cask::Artifact::MACOS_ONLY_ARTIFACTS.include?(artifact.class)) ||
        (bottle_tag.macos? && ::Cask::Artifact::LINUX_ONLY_ARTIFACTS.include?(artifact.class))
      end
    end
  rescue CaskInvalidError
    # Invalid for this OS/arch tag; treat as having no OS-specific artifacts.
    next
  ensure
    refresh
  end

  @contains_os_specific_artifacts = T.let(any_loaded, T.nilable(T::Boolean))
  any_loaded
end

#depends_on(*args, &block) ⇒ T.untyped

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:

  • args (T.untyped)
  • block (T.untyped)

Returns:

  • (T.untyped) 


52
 
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 52

def depends_on(*args, &block); end

#depends_on_set_in_block?(*args, &block) ⇒ 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.

Parameters:

  • args (T.untyped)
  • block (T.untyped)

Returns:

  • (Boolean) 


55
 
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 55

def depends_on_set_in_block?(*args, &block); end

#deprecate!(*args, &block) ⇒ T.untyped

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:

  • args (T.untyped)
  • block (T.untyped)

Returns:

  • (T.untyped) 


58
 
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 58

def deprecate!(*args, &block); end

#deprecate_args(*args, &block) ⇒ T.untyped

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:

  • args (T.untyped)
  • block (T.untyped)

Returns:

  • (T.untyped) 


61
 
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 61

def deprecate_args(*args, &block); end

#deprecated?(*args, &block) ⇒ 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.

Parameters:

  • args (T.untyped)
  • block (T.untyped)

Returns:

  • (Boolean) 


64
 
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 64

def deprecated?(*args, &block); end

#deprecation_date(*args, &block) ⇒ T.untyped

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:

  • args (T.untyped)
  • block (T.untyped)

Returns:

  • (T.untyped) 


67
 
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 67

def deprecation_date(*args, &block); end

#deprecation_reason(*args, &block) ⇒ T.untyped

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:

  • args (T.untyped)
  • block (T.untyped)

Returns:

  • (T.untyped) 


70
 
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 70

def deprecation_reason(*args, &block); end

#deprecation_replacement_cask(*args, &block) ⇒ T.untyped

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:

  • args (T.untyped)
  • block (T.untyped)

Returns:

  • (T.untyped) 


73
 
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 73

def deprecation_replacement_cask(*args, &block); end

#deprecation_replacement_formula(*args, &block) ⇒ T.untyped

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:

  • args (T.untyped)
  • block (T.untyped)

Returns:

  • (T.untyped) 


76
 
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 76

def deprecation_replacement_formula(*args, &block); end

#desc(*args, &block) ⇒ T.untyped

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:

  • args (T.untyped)
  • block (T.untyped)

Returns:

  • (T.untyped) 


79
 
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 79

def desc(*args, &block); end

#dictionary(*args, &block) ⇒ T.untyped

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:

  • args (T.untyped)
  • block (T.untyped)

Returns:

  • (T.untyped) 


82
 
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 82

def dictionary(*args, &block); end

#disable!(*args, &block) ⇒ T.untyped

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:

  • args (T.untyped)
  • block (T.untyped)

Returns:

  • (T.untyped) 


85
 
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 85

def disable!(*args, &block); end

#disable_args(*args, &block) ⇒ T.untyped

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:

  • args (T.untyped)
  • block (T.untyped)

Returns:

  • (T.untyped) 


88
 
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 88

def disable_args(*args, &block); end

#disable_date(*args, &block) ⇒ T.untyped

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:

  • args (T.untyped)
  • block (T.untyped)

Returns:

  • (T.untyped) 


91
 
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 91

def disable_date(*args, &block); end

#disable_reason(*args, &block) ⇒ T.untyped

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:

  • args (T.untyped)
  • block (T.untyped)

Returns:

  • (T.untyped) 


94
 
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 94

def disable_reason(*args, &block); end

#disable_replacement_cask(*args, &block) ⇒ T.untyped

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:

  • args (T.untyped)
  • block (T.untyped)

Returns:

  • (T.untyped) 


97
 
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 97

def disable_replacement_cask(*args, &block); end

#disable_replacement_formula(*args, &block) ⇒ T.untyped

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:

  • args (T.untyped)
  • block (T.untyped)

Returns:

  • (T.untyped) 


100
 
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 100

def disable_replacement_formula(*args, &block); end

#disabled?(*args, &block) ⇒ 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.

Parameters:

  • args (T.untyped)
  • block (T.untyped)

Returns:

  • (Boolean) 


103
 
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 103

def disabled?(*args, &block); end

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

Returns:



348
349
350
 
# File 'cask/cask.rb', line 348

def download_sha_path
  metadata_main_container_path/"LATEST_DOWNLOAD_SHA256"
end

#fish_completion(*args, &block) ⇒ T.untyped

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:

  • args (T.untyped)
  • block (T.untyped)

Returns:

  • (T.untyped) 


106
 
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 106

def fish_completion(*args, &block); end

#font(*args, &block) ⇒ T.untyped

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:

  • args (T.untyped)
  • block (T.untyped)

Returns:

  • (T.untyped) 


109
 
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 109

def font(*args, &block); end

#font? ⇒ 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) 


206
207
208
 
# File 'cask/cask.rb', line 206

def font?
  artifacts.all?(Artifact::Font)
end

#full_name ⇒ String

This method is part of an internal API. This method may only be used internally in repositories owned by Homebrew, except in casks or formulae. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Alias for #full_token.

Returns:



198
 
# File 'cask/cask.rb', line 198

def full_name = full_token

#full_token ⇒ String

This method is part of an internal API. This method may only be used internally in repositories owned by Homebrew, except in casks or formulae. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

The fully-qualified token of this Cask::Cask.

Returns:



187
188
189
190
191
192
 
# File 'cask/cask.rb', line 187

def full_token
  return token if (t = tap).nil?
  return token if t.core_cask_tap?

  "#{t.name}/#{token}"
end

#generate_completions_from_executable(*args, &block) ⇒ T.untyped

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:

  • args (T.untyped)
  • block (T.untyped)

Returns:

  • (T.untyped) 


112
 
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 112

def generate_completions_from_executable(*args, &block); end

#homepage(*args, &block) ⇒ T.untyped

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:

  • args (T.untyped)
  • block (T.untyped)

Returns:

  • (T.untyped) 


115
 
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 115

def homepage(*args, &block); end

#input_method(*args, &block) ⇒ T.untyped

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:

  • args (T.untyped)
  • block (T.untyped)

Returns:

  • (T.untyped) 


118
 
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 118

def input_method(*args, &block); end

#install_time ⇒ Time?

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:



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

def install_time
  # <caskroom_path>/.metadata/<version>/<timestamp>/Casks/<token>.{rb,json} -> <timestamp>
  caskfile = installed_caskfile
  Time.strptime(caskfile.dirname.dirname.basename.to_s, Metadata::TIMESTAMP_FORMAT) if caskfile
end

#installed? ⇒ 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) 


201
202
203
 
# File 'cask/cask.rb', line 201

def installed?
  installed_caskfile&.exist? || false
end

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

Returns:



287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'cask/cask.rb', line 287

def installed_caskfile
  installed_caskroom_path = caskroom_path
  installed_token = token

  # Check if the cask is installed with an old name.
  old_tokens.each do |old_token|
    old_caskroom_path = Caskroom.path/old_token
    next if !old_caskroom_path.directory? || old_caskroom_path.symlink?

    installed_caskroom_path = old_caskroom_path
    installed_token = old_token
    break
  end

  installed_version = timestamped_versions(caskroom_path: installed_caskroom_path).last
  return unless installed_version

  caskfile_dir = metadata_main_container_path(caskroom_path: installed_caskroom_path)
                 .join(*installed_version, "Casks")

  ["internal.json", "json", "rb"]
    .map { |ext| caskfile_dir.join("#{installed_token}.#{ext}") }
    .find(&:exist?)
end

#installed_version ⇒ 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:



313
314
315
316
317
318
 
# File 'cask/cask.rb', line 313

def installed_version
  return unless (installed_caskfile = self.installed_caskfile)

  # <caskroom_path>/.metadata/<version>/<timestamp>/Casks/<token>.{rb,json} -> <version>
  installed_caskfile.dirname.dirname.dirname.basename.to_s
end

#installer(*args, &block) ⇒ T.untyped

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:

  • args (T.untyped)
  • block (T.untyped)

Returns:

  • (T.untyped) 


121
 
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 121

def installer(*args, &block); end

#internet_plugin(*args, &block) ⇒ T.untyped

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:

  • args (T.untyped)
  • block (T.untyped)

Returns:

  • (T.untyped) 


124
 
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 124

def internet_plugin(*args, &block); end

#keyboard_layout(*args, &block) ⇒ T.untyped

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:

  • args (T.untyped)
  • block (T.untyped)

Returns:

  • (T.untyped) 


127
 
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 127

def keyboard_layout(*args, &block); end

#language(*args, &block) ⇒ T.untyped

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:

  • args (T.untyped)
  • block (T.untyped)

Returns:

  • (T.untyped) 


130
 
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 130

def language(*args, &block); end

#languages ⇒ Array<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:



465
466
467
 
# File 'cask/cask.rb', line 465

def languages
  @languages ||= T.let(dsl!.languages, T.nilable(T::Array[String]))
end

#livecheck(*args, &block) ⇒ T.untyped

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:

  • args (T.untyped)
  • block (T.untyped)

Returns:

  • (T.untyped) 


133
 
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 133

def livecheck(*args, &block); end

#livecheck_defined?(*args, &block) ⇒ 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.

Parameters:

  • args (T.untyped)
  • block (T.untyped)

Returns:

  • (Boolean) 


136
 
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 136

def livecheck_defined?(*args, &block); end

#loaded_from_api? ⇒ 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) 


126
 
# File 'cask/cask.rb', line 126

def loaded_from_api? = @loaded_from_api

#loaded_from_internal_api? ⇒ 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) 


129
 
# File 'cask/cask.rb', line 129

def loaded_from_internal_api? = @loaded_from_internal_api

#manpage(*args, &block) ⇒ T.untyped

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:

  • args (T.untyped)
  • block (T.untyped)

Returns:

  • (T.untyped) 


139
 
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 139

def manpage(*args, &block); end

#mdimporter(*args, &block) ⇒ T.untyped

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:

  • args (T.untyped)
  • block (T.untyped)

Returns:

  • (T.untyped) 


142
 
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 142

def mdimporter(*args, &block); end

#name(*args, &block) ⇒ T.untyped

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:

  • args (T.untyped)
  • block (T.untyped)

Returns:

  • (T.untyped) 


145
 
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 145

def name(*args, &block); end

#new_download_sha ⇒ 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:



353
354
355
356
357
358
359
360
361
362
363
 
# File 'cask/cask.rb', line 353

def new_download_sha
  require "cask/installer"

  # Call checksumable? before hashing
  @new_download_sha ||= T.let(
    Installer.new(self, verify_download_integrity: false)
             .download(quiet: true)
             .instance_eval { |x| Digest::SHA256.file(x).hexdigest },
    T.nilable(String),
  )
end

#no_autobump!(*args, &block) ⇒ T.untyped

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:

  • args (T.untyped)
  • block (T.untyped)

Returns:

  • (T.untyped) 


148
 
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 148

def no_autobump!(*args, &block); end

#no_autobump_message(*args, &block) ⇒ T.untyped

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:

  • args (T.untyped)
  • block (T.untyped)

Returns:

  • (T.untyped) 


151
 
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 151

def no_autobump_message(*args, &block); end

#old_tokens ⇒ Array<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.

An old name for the cask.

Returns:



136
137
138
139
140
141
142
143
144
145
146
 
# File 'cask/cask.rb', line 136

def old_tokens
  @old_tokens ||= T.let(
    if (t = tap)
      Tap.tap_migration_oldnames(t, token) +
        t.cask_reverse_renames.fetch(token, [])
    else
      []
    end,
    T.nilable(T::Array[String]),
  )
end

#on_os_blocks_exist?(*args, &block) ⇒ 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.

Parameters:

  • args (T.untyped)
  • block (T.untyped)

Returns:

  • (Boolean) 


154
 
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 154

def on_os_blocks_exist?(*args, &block); end

#on_system_block_min_os(*args, &block) ⇒ MacOSVersion?

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:

  • args (T.untyped)
  • block (T.untyped)

Returns:



157
 
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 157

def on_system_block_min_os(*args, &block); end

#on_system_blocks_exist?(*args, &block) ⇒ 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.

Parameters:

  • args (T.untyped)
  • block (T.untyped)

Returns:

  • (Boolean) 


160
 
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 160

def on_system_blocks_exist?(*args, &block); end

#os(*args, &block) ⇒ T.untyped

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:

  • args (T.untyped)
  • block (T.untyped)

Returns:

  • (T.untyped) 


163
 
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 163

def os(*args, &block); end

#outdated?(greedy: false, greedy_latest: false, greedy_auto_updates: false) ⇒ Boolean

This method is part of an internal API. This method may only be used internally in repositories owned by Homebrew, except in casks or formulae. Third parties should avoid using this method if possible, as it may be removed or changed without warning.

Check if the installed cask is outdated.

Parameters:

  • greedy (Boolean) (defaults to: false)
  • greedy_latest (Boolean, nil) (defaults to: false)
  • greedy_auto_updates (Boolean, nil) (defaults to: false)

Returns:

  • (Boolean) 


385
386
387
388
 
# File 'cask/cask.rb', line 385

def outdated?(greedy: false, greedy_latest: false, greedy_auto_updates: false)
  !outdated_version(greedy:, greedy_latest:,
                    greedy_auto_updates:).nil?
end

#outdated_download_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) 


366
367
368
369
370
371
 
# File 'cask/cask.rb', line 366

def outdated_download_sha?
  return true unless checksumable?

  current_download_sha = download_sha_path.read if download_sha_path.exist?
  current_download_sha.blank? || current_download_sha != new_download_sha
end

#outdated_info(greedy, verbose, json, greedy_latest, greedy_auto_updates) ⇒ String, Hash{Symbol => T.untyped}

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:

  • greedy (Boolean)
  • verbose (Boolean)
  • json (Boolean)
  • greedy_latest (Boolean)
  • greedy_auto_updates (Boolean)

Returns:



424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
 
# File 'cask/cask.rb', line 424

def outdated_info(greedy, verbose, json, greedy_latest, greedy_auto_updates)
  return token if !verbose && !json

  installed_version = outdated_version(greedy:, greedy_latest:,
                                       greedy_auto_updates:).to_s

  if json
    {
      name:               token,
      installed_versions: [installed_version],
      current_version:    version,
    }
  else
    "#{token} (#{installed_version}) != #{version}"
  end
end

#outdated_version(greedy: false, greedy_latest: false, greedy_auto_updates: false) ⇒ 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.

Parameters:

  • greedy (Boolean) (defaults to: false)
  • greedy_latest (Boolean, nil) (defaults to: false)
  • greedy_auto_updates (Boolean, nil) (defaults to: false)

Returns:



394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
 
# File 'cask/cask.rb', line 394

def outdated_version(greedy: false, greedy_latest: false, greedy_auto_updates: false)
  # special case: tap version is not available
  return if version.nil?

  if version.latest?
    return installed_version if (greedy || greedy_latest) && outdated_download_sha?

    return
  end

  return if installed_version == version

  if auto_updates && !greedy && !greedy_auto_updates
    return installed_version if auto_updates_bundle_outdated?

    return
  end

  installed_version
end

#pkg(*args, &block) ⇒ T.untyped

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:

  • args (T.untyped)
  • block (T.untyped)

Returns:

  • (T.untyped) 


166
 
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 166

def pkg(*args, &block); end

#populate_from_api!(cask_struct, tap_git_head:) ⇒ 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:

Raises:

  • (ArgumentError) 


477
478
479
480
481
482
483
484
 
# File 'cask/cask.rb', line 477

def populate_from_api!(cask_struct, tap_git_head:)
  raise ArgumentError, "Expected cask to be loaded from the API" unless loaded_from_api?

  @languages = cask_struct.languages
  @tap_git_head = tap_git_head
  @ruby_source_path = cask_struct.ruby_source_path
  @ruby_source_checksum = cask_struct.ruby_source_checksum
end

#postflight(*args, &block) ⇒ T.untyped

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:

  • args (T.untyped)
  • block (T.untyped)

Returns:

  • (T.untyped) 


169
 
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 169

def postflight(*args, &block); end

#preflight(*args, &block) ⇒ T.untyped

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:

  • args (T.untyped)
  • block (T.untyped)

Returns:

  • (T.untyped) 


172
 
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 172

def preflight(*args, &block); end

#prefpane(*args, &block) ⇒ T.untyped

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:

  • args (T.untyped)
  • block (T.untyped)

Returns:

  • (T.untyped) 


175
 
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 175

def prefpane(*args, &block); end

#qlplugin(*args, &block) ⇒ T.untyped

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:

  • args (T.untyped)
  • block (T.untyped)

Returns:

  • (T.untyped) 


178
 
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 178

def qlplugin(*args, &block); end

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



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

def refresh
  @dsl = T.let(DSL.new(self), T.nilable(DSL))
  @contains_os_specific_artifacts = nil
  return unless @block

  dsl!.instance_eval(&@block)
  dsl!.add_implicit_macos_dependency
  dsl!.language_eval
rescue NoMethodError => e
  raise CaskInvalidError.new(token, e.message), e.backtrace
end

#rename(*args, &block) ⇒ T.untyped

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:

  • args (T.untyped)
  • block (T.untyped)

Returns:

  • (T.untyped) 


181
 
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 181

def rename(*args, &block); end

#rename_list(uninstall_only: false) ⇒ Array<Hash{Symbol => T.untyped}>

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:

  • uninstall_only (Boolean) (defaults to: false)

Returns:



628
629
630
631
632
 
# File 'cask/cask.rb', line 628

def rename_list(uninstall_only: false)
  rename.filter_map do |rename|
    { from: rename.from, to: rename.to }
  end
end

#ruby_source_checksum ⇒ Hash{Symbol => String, nil}

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:



452
453
454
455
456
457
458
459
460
461
462
 
# File 'cask/cask.rb', line 452

def ruby_source_checksum
  @ruby_source_checksum ||= T.let(
    begin
      sfp = sourcefile_path
      {
        sha256: sfp ? Digest::SHA256.file(sfp).hexdigest : nil,
      }.freeze
    end,
    T.nilable(T::Hash[Symbol, T.nilable(String)]),
  )
end

#ruby_source_path ⇒ 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:



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

def ruby_source_path
  return @ruby_source_path if defined?(@ruby_source_path)

  return unless (sfp = sourcefile_path)
  return unless (t = tap)

  @ruby_source_path = T.let(sfp.relative_path_from(t.path).to_s, T.nilable(String))
end

#screen_saver(*args, &block) ⇒ T.untyped

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:

  • args (T.untyped)
  • block (T.untyped)

Returns:

  • (T.untyped) 


184
 
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 184

def screen_saver(*args, &block); end

#service(*args, &block) ⇒ T.untyped

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:

  • args (T.untyped)
  • block (T.untyped)

Returns:

  • (T.untyped) 


187
 
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 187

def service(*args, &block); end

#sha256(*args, &block) ⇒ T.untyped

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:

  • args (T.untyped)
  • block (T.untyped)

Returns:

  • (T.untyped) 


190
 
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 190

def sha256(*args, &block); end

#stage_only(*args, &block) ⇒ T.untyped

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:

  • args (T.untyped)
  • block (T.untyped)

Returns:

  • (T.untyped) 


193
 
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 193

def stage_only(*args, &block); end

#staged_path(*args, &block) ⇒ T.untyped

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:

  • args (T.untyped)
  • block (T.untyped)

Returns:

  • (T.untyped) 


196
 
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 196

def staged_path(*args, &block); end

#suite(*args, &block) ⇒ T.untyped

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:

  • args (T.untyped)
  • block (T.untyped)

Returns:

  • (T.untyped) 


199
 
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 199

def suite(*args, &block); end

#supports_linux? ⇒ 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) 


211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'cask/cask.rb', line 211

def supports_linux?
  return true if font?

  # Bare `depends_on :macos` explicitly marks a cask as macOS-only
  return false if (macos_requirement = depends_on.macos) && !macos_requirement.version_specified?

  # Cache the os value before contains_os_specific_artifacts? refreshes the cask
  # (the refresh clears @dsl.os in generic/non-OS-specific contexts)
  os_value = dsl!.os

  return false if contains_os_specific_artifacts?

  # Casks with OS-specific blocks rely on the os stanza for Linux support
  return os_value.present? if dsl!.on_os_blocks_exist?

  # Platform-agnostic casks: reject macOS-only artifacts and manual installers
  artifacts.none? do |a|
    Artifact::MACOS_ONLY_ARTIFACTS.include?(a.class) ||
      (a.is_a?(Artifact::Installer) && a.manual_install)
  end
end

#tab ⇒ Tab

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:



331
332
333
 
# File 'cask/cask.rb', line 331

def tab
  Tab.for_cask(self)
end

#tap(&blk) ⇒ T.untyped

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 collides with Kernel#tap, complicating the type signature. Overload sigs are not supported by Sorbet, otherwise we would use:

sig { params(blk: T.proc.params(arg0: Cask).void).returns(T.self_type) }
sig { params(blk: NilClass).returns(T.nilable(Tap)) }

Using a union type would require casts or type guards at call sites, so T.untyped is used as the return type instead.

Parameters:

  • blk (T.proc.params(arg0: Cask).void, nil)

Returns:

  • (T.untyped) 


78
79
80
81
82
 
# File 'cask/cask.rb', line 78

def tap(&blk)
  return super if block_given? # Kernel#tap

  @tap
end

#tap_git_head ⇒ 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:



470
471
472
473
474
 
# File 'cask/cask.rb', line 470

def tap_git_head
  @tap_git_head ||= T.let(tap&.git_head, T.nilable(String))
rescue TapUnavailableError
  nil
end

#timestamped_versions(caskroom_path: self.caskroom_path) ⇒ Array<Array<(String, 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.

Parameters:

  • caskroom_path (Pathname) (defaults to: self.caskroom_path)

Returns:



174
175
176
177
178
179
180
181
 
# File 'cask/cask.rb', line 174

def timestamped_versions(caskroom_path: self.caskroom_path)
  pattern = metadata_timestamped_path(version: "*", timestamp: "*", caskroom_path:).to_s
  relative_paths = Pathname.glob(pattern)
                           .map { |p| p.relative_path_from(p.parent.parent) }
  # Sorbet is unaware that Pathname is sortable: https://github.com/sorbet/sorbet/issues/6844
  T.unsafe(relative_paths).sort_by(&:basename) # sort by timestamp
   .map { |p| p.split.map(&:to_s) }
end

#to_h ⇒ Hash{String => T.untyped}

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:



509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
 
# File 'cask/cask.rb', line 509

def to_h
  {
    "token"                           => token,
    "full_token"                      => full_name,
    "old_tokens"                      => old_tokens,
    "tap"                             => tap&.name,
    "name"                            => name,
    "desc"                            => desc,
    "homepage"                        => homepage,
    "url"                             => url,
    "url_specs"                       => url_specs,
    "version"                         => version,
    "autobump"                        => autobump?,
    "no_autobump_message"             => no_autobump_message,
    "skip_livecheck"                  => livecheck.skip?,
    "installed"                       => installed_version,
    "installed_time"                  => install_time&.to_i,
    "bundle_version"                  => bundle_long_version,
    "bundle_short_version"            => bundle_short_version,
    "outdated"                        => outdated?,
    "sha256"                          => sha256,
    "artifacts"                       => artifacts_list,
    "caveats"                         => caveats_for_api,
    "caveats_rosetta"                 => caveats_object.invoked?(:requires_rosetta) || nil,
    "depends_on"                      => depends_on,
    "conflicts_with"                  => conflicts_with,
    "container"                       => container&.pairs,
    "rename"                          => rename_list,
    "auto_updates"                    => auto_updates,
    "deprecated"                      => deprecated?,
    "deprecation_date"                => deprecation_date,
    "deprecation_reason"              => deprecation_reason,
    "deprecation_replacement_formula" => deprecation_replacement_formula,
    "deprecation_replacement_cask"    => deprecation_replacement_cask,
    "deprecate_args"                  => deprecate_args,
    "disabled"                        => disabled?,
    "disable_date"                    => disable_date,
    "disable_reason"                  => disable_reason,
    "disable_replacement_formula"     => disable_replacement_formula,
    "disable_replacement_cask"        => disable_replacement_cask,
    "disable_args"                    => disable_args,
    "tap_git_head"                    => tap_git_head,
    "languages"                       => languages,
    "ruby_source_path"                => ruby_source_path,
    "ruby_source_checksum"            => ruby_source_checksum,
  }
end

#to_hash_with_variations ⇒ Hash{String => T.untyped}

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:



564
565
566
567
568
569
570
571
572
573
574
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
 
# File 'cask/cask.rb', line 564

def to_hash_with_variations
  if loaded_from_internal_api?
    raise UsageError, "Cannot call #to_hash_with_variations on casks loaded from the internal API"
  end

  if loaded_from_api? && (json_cask = api_source) && !Homebrew::EnvConfig.no_install_from_api?
    return api_to_local_hash(json_cask.dup)
  end

  hash = to_h
  variations = {}

  if dsl!.on_system_blocks_exist?
    begin
      OnSystem::VALID_OS_ARCH_TAGS.each do |bottle_tag|
        next if bottle_tag.linux? && dsl!.os.nil?
        next if bottle_tag.macos? &&
                depends_on.macos &&
                !dsl!.depends_on_set_in_block? &&
                !depends_on.macos.allows?(bottle_tag.to_macos_version)

        Homebrew::SimulateSystem.with_tag(bottle_tag) do
          refresh

          to_h.each do |key, value|
            next if HASH_KEYS_TO_SKIP.include? key
            next if value.to_s == hash[key].to_s

            variations[bottle_tag.to_sym] ||= {}
            variations[bottle_tag.to_sym][key] = value
          end
        end
      end
    ensure
      refresh
    end
  end

  hash["variations"] = variations
  hash
end

#uninstall(*args, &block) ⇒ T.untyped

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:

  • args (T.untyped)
  • block (T.untyped)

Returns:

  • (T.untyped) 


202
 
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 202

def uninstall(*args, &block); end

#uninstall_flight_blocks? ⇒ 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) 


268
269
270
271
272
273
274
275
276
277
 
# File 'cask/cask.rb', line 268

def uninstall_flight_blocks?
  artifacts.any? do |artifact|
    case artifact
    when Artifact::PreflightBlock
      artifact.directives.key?(:uninstall_preflight)
    when Artifact::PostflightBlock
      artifact.directives.key?(:uninstall_postflight)
    end
  end
end

#uninstall_postflight(*args, &block) ⇒ T.untyped

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:

  • args (T.untyped)
  • block (T.untyped)

Returns:

  • (T.untyped) 


205
 
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 205

def uninstall_postflight(*args, &block); end

#uninstall_preflight(*args, &block) ⇒ T.untyped

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:

  • args (T.untyped)
  • block (T.untyped)

Returns:

  • (T.untyped) 


208
 
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 208

def uninstall_preflight(*args, &block); end

#url(*args, &block) ⇒ ::Cask::URL?

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:

  • args (T.untyped)
  • block (T.untyped)

Returns:



211
 
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 211

def url(*args, &block); end

#version(*args, &block) ⇒ T.untyped

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:

  • args (T.untyped)
  • block (T.untyped)

Returns:

  • (T.untyped) 


214
 
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 214

def version(*args, &block); end

#vst3_plugin(*args, &block) ⇒ T.untyped

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:

  • args (T.untyped)
  • block (T.untyped)

Returns:

  • (T.untyped) 


217
 
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 217

def vst3_plugin(*args, &block); end

#vst_plugin(*args, &block) ⇒ T.untyped

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:

  • args (T.untyped)
  • block (T.untyped)

Returns:

  • (T.untyped) 


220
 
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 220

def vst_plugin(*args, &block); end

#zap(*args, &block) ⇒ T.untyped

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:

  • args (T.untyped)
  • block (T.untyped)

Returns:

  • (T.untyped) 


223
 
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 223

def zap(*args, &block); end

#zsh_completion(*args, &block) ⇒ T.untyped

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:

  • args (T.untyped)
  • block (T.untyped)

Returns:

  • (T.untyped) 


226
 
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 226

def zsh_completion(*args, &block); end