Class: Cask::Cask Private

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

attr_predicate, attr_rw

Methods included from APIHashable

generated_hash!, generating_hash!, generating_hash?

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, 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)
  • 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) 


73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'cask/cask.rb', line 73

def initialize(token, sourcefile_path: nil, source: nil, tap: nil, loaded_from_api: false,
               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
  @loader = loader
  # Sorbet has trouble with bound procs assigned to instance variables:
  # https://github.com/sorbet/sorbet/issues/6843
  instance_variable_set(:@block, block)

  @default_config = config || Config.new

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

Instance Attribute Details

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



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

def allow_reassignment
  @allow_reassignment
end

#config ⇒ Object

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.



30
31
32
 
# File 'cask/cask.rb', line 30

def config
  @config
end

#default_config ⇒ Object (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. 



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

def default_config
  @default_config
end

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



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

def download
  @download
end

#loader ⇒ Object (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. 



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

def loader
  @loader
end

#source ⇒ Object (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. 



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

def source
  @source
end

#sourcefile_path ⇒ Object (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. 



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

def sourcefile_path
  @sourcefile_path
end

#token ⇒ Object (readonly)

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 token of this Cask::Cask.



25
26
27
 
# File 'cask/cask.rb', line 25

def token
  @token
end

Class Method Details

.all(eval_all: false) ⇒ Object

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning. 



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'cask/cask.rb', line 37

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"
  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

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



5
 
# File 'cask/cask.rbi', line 5

def appdir; end

#artifacts ⇒ Object

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning. 



7
 
# File 'cask/cask.rbi', line 7

def artifacts; end

#artifacts_list(compact: false, uninstall_only: false) ⇒ Object

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning. 



492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
 
# File 'cask/cask.rb', line 492

def artifacts_list(compact: false, 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
      # We can skip this entirely once we move to internal JSON v3.
      { artifact.summarize.to_sym => nil } unless compact
    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

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



9
 
# File 'cask/cask.rbi', line 9

def auto_updates; 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:



220
221
222
 
# File 'cask/cask.rb', line 220

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:



215
216
217
 
# File 'cask/cask.rb', line 215

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) 


158
159
160
 
# File 'cask/cask.rb', line 158

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:



259
260
261
 
# File 'cask/cask.rb', line 259

def caskroom_path
  @caskroom_path ||= Caskroom.path.join(token)
end

#caveats ⇒ Object

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning. 



11
 
# File 'cask/cask.rbi', line 11

def caveats; end

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


232
233
234
235
236
 
# File 'cask/cask.rb', line 232

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

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

#config_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. 



228
229
230
 
# File 'cask/cask.rb', line 228

def config_path
  metadata_main_container_path/"config.json"
end

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



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

def conflicts_with; end

#container ⇒ Object

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning. 



15
 
# File 'cask/cask.rbi', line 15

def container; end

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



17
 
# File 'cask/cask.rbi', line 17

def depends_on; end

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


23
 
# File 'cask/cask.rbi', line 23

def deprecated?; end

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



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

def deprecation_date; end

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



27
 
# File 'cask/cask.rbi', line 27

def deprecation_reason; end

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



29
 
# File 'cask/cask.rbi', line 29

def deprecation_replacement; end

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



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

def desc; end

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



33
 
# File 'cask/cask.rbi', line 33

def disable_date; end

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



35
 
# File 'cask/cask.rbi', line 35

def disable_reason; end

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



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

def disable_replacement; end

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


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

def disabled?; end

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


21
 
# File 'cask/cask.rbi', line 21

def discontinued?; end

#download_sha_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. 



238
239
240
 
# File 'cask/cask.rb', line 238

def download_sha_path
  metadata_main_container_path/"LATEST_DOWNLOAD_SHA256"
end

#full_name ⇒ Object

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.



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

def full_name = full_token

#full_token ⇒ Object

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.



139
140
141
142
143
144
 
# File 'cask/cask.rb', line 139

def full_token
  return token if tap.nil?
  return token if tap.core_cask_tap?

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

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



39
 
# File 'cask/cask.rbi', line 39

def homepage; 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:



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

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) 


152
153
154
 
# File 'cask/cask.rb', line 152

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:



181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'cask/cask.rb', line 181

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")

  ["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:



207
208
209
210
211
212
 
# File 'cask/cask.rb', line 207

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

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



41
 
# File 'cask/cask.rbi', line 41

def language; end

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



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

def languages
  @languages ||= @dsl.languages
end

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



45
 
# File 'cask/cask.rbi', line 45

def livecheck; end

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


47
 
# File 'cask/cask.rbi', line 47

def livecheck_defined?; end

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


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

def livecheckable?; 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) 


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

def loaded_from_api?; end

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



51
 
# File 'cask/cask.rbi', line 51

def name; end

#new_download_sha ⇒ Object

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning. 



242
243
244
245
246
247
248
249
 
# File 'cask/cask.rb', line 242

def new_download_sha
  require "cask/installer"

  # Call checksumable? before hashing
  @new_download_sha ||= Installer.new(self, verify_download_integrity: false)
                                 .download(quiet: true)
                                 .instance_eval { |x| Digest::SHA256.file(x).hexdigest }
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:



97
98
99
100
101
102
103
104
 
# File 'cask/cask.rb', line 97

def old_tokens
  @old_tokens ||= if (tap = self.tap)
    Tap.tap_migration_oldnames(tap, token) +
      tap.cask_reverse_renames.fetch(token, [])
  else
    []
  end
end

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

Returns:



56
 
# File 'cask/cask.rbi', line 56

def on_system_block_min_os; end

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


53
 
# File 'cask/cask.rbi', line 53

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

Returns:

  • (Boolean) 


266
267
268
269
 
# File 'cask/cask.rb', line 266

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) 


251
252
253
254
255
256
 
# File 'cask/cask.rb', line 251

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) ⇒ 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. 



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

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) ⇒ 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. 



271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'cask/cask.rb', line 271

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
  elsif auto_updates && !greedy && !greedy_auto_updates
    return
  end

  # not outdated unless there is a different version on tap
  return if installed_version == version

  installed_version
end

#populate_from_api!(json_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.

Raises:

  • (ArgumentError) 


332
333
334
335
336
337
338
339
340
341
342
343
344
 
# File 'cask/cask.rb', line 332

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

  @languages = json_cask.fetch(:languages, [])
  @tap_git_head = json_cask.fetch(:tap_git_head, "HEAD")

  @ruby_source_path = json_cask[:ruby_source_path]

  # TODO: Clean this up when we deprecate the current JSON API and move to the internal JSON v3.
  ruby_source_sha256 = json_cask.dig(:ruby_source_checksum, :sha256)
  ruby_source_sha256 ||= json_cask[:ruby_source_sha256]
  @ruby_source_checksum = { sha256: ruby_source_sha256 }
end

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



112
113
114
115
116
117
118
 
# File 'cask/cask.rb', line 112

def refresh
  @dsl = DSL.new(self)
  return unless @block

  @dsl.instance_eval(&@block)
  @dsl.language_eval
end

#ruby_source_checksum ⇒ Hash{Symbol => 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:



316
317
318
319
320
 
# File 'cask/cask.rb', line 316

def ruby_source_checksum
  @ruby_source_checksum ||= {
    sha256: Digest::SHA256.file(sourcefile_path).hexdigest,
  }.freeze
end

#ruby_source_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. 



306
307
308
309
310
311
312
313
 
# File 'cask/cask.rb', line 306

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

  return unless sourcefile_path
  return unless tap

  @ruby_source_path = sourcefile_path.relative_path_from(tap.path)
end

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



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

def sha256; end

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



60
 
# File 'cask/cask.rbi', line 60

def staged_path; end

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



224
225
226
 
# File 'cask/cask.rb', line 224

def tab
  Tab.for_cask(self)
end

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



54
55
56
57
58
 
# File 'cask/cask.rb', line 54

def tap
  return super if block_given? # Object#tap

  @tap
end

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



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

def tap_git_head
  @tap_git_head ||= tap&.git_head
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:



125
126
127
128
129
130
131
132
133
134
 
# File 'cask/cask.rb', line 125

def timestamped_versions(caskroom_path: self.caskroom_path)
  relative_paths = Pathname.glob(metadata_timestamped_path(
                                   version: "*", timestamp: "*",
                                   caskroom_path:
                                 ))
                           .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 ⇒ 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. 



364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
 
# File 'cask/cask.rb', line 364

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,
    "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 unless caveats.empty?),
    "depends_on"              => depends_on,
    "conflicts_with"          => conflicts_with,
    "container"               => container&.pairs,
    "auto_updates"            => auto_updates,
    "deprecated"              => deprecated?,
    "deprecation_date"        => deprecation_date,
    "deprecation_reason"      => deprecation_reason,
    "deprecation_replacement" => deprecation_replacement,
    "disabled"                => disabled?,
    "disable_date"            => disable_date,
    "disable_reason"          => disable_reason,
    "disable_replacement"     => disable_replacement,
    "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_method: :to_h) ⇒ 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. 



447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
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
 
# File 'cask/cask.rb', line 447

def to_hash_with_variations(hash_method: :to_h)
  case hash_method
  when :to_h
    if loaded_from_api? && !Homebrew::EnvConfig.no_install_from_api?
      return api_to_local_hash(Homebrew::API::Cask.all_casks[token].dup)
    end
  when :to_internal_api_hash
    raise ArgumentError, "API Hash must be generated from Ruby source files" if loaded_from_api?
  else
    raise ArgumentError, "Unknown hash method #{hash_method.inspect}"
  end

  hash = public_send(hash_method)
  variations = {}

  if @dsl.on_system_blocks_exist?
    begin
      MacOSVersion::SYMBOLS.keys.product(OnSystem::ARCH_OPTIONS).each do |os, arch|
        bottle_tag = ::Utils::Bottles::Tag.new(system: os, arch:)
        next unless bottle_tag.valid_combination?
        next if depends_on.macos &&
                !@dsl.depends_on_set_in_block? &&
                !depends_on.macos.allows?(bottle_tag.to_macos_version)

        Homebrew::SimulateSystem.with(os:, arch:) do
          refresh

          public_send(hash_method).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 if hash_method != :to_internal_api_hash || variations.present?
  hash
end

#to_internal_api_hash ⇒ Object

This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning. 



403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
 
# File 'cask/cask.rb', line 403

def to_internal_api_hash
  api_hash = {
    "token"              => token,
    "name"               => name,
    "desc"               => desc,
    "homepage"           => homepage,
    "url"                => url,
    "version"            => version,
    "sha256"             => sha256,
    "artifacts"          => artifacts_list(compact: true),
    "ruby_source_path"   => ruby_source_path,
    "ruby_source_sha256" => ruby_source_checksum.fetch(:sha256),
  }

  if deprecation_date
    api_hash["deprecation_date"] = deprecation_date
    api_hash["deprecation_reason"] = deprecation_reason
    api_hash["deprecation_replacement"] = deprecation_replacement
  end

  if disable_date
    api_hash["disable_date"] = disable_date
    api_hash["disable_reason"] = disable_reason
    api_hash["disable_replacement"] = disable_replacement
  end

  if (url_specs_hash = url_specs).present?
    api_hash["url_specs"] = url_specs_hash
  end

  api_hash["caskfile_only"] = true if caskfile_only?
  api_hash["conflicts_with"] = conflicts_with if conflicts_with.present?
  api_hash["depends_on"] = depends_on if depends_on.present?
  api_hash["container"] = container.pairs if container
  api_hash["caveats"] = caveats if caveats.present?
  api_hash["auto_updates"] = auto_updates if auto_updates
  api_hash["languages"] = languages if languages.present?

  api_hash
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) 


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

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

#url ⇒ ::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.

Returns:



63
 
# File 'cask/cask.rbi', line 63

def url; end

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



65
 
# File 'cask/cask.rbi', line 65

def version; end