Class: Cask::Cask Private
- Extended by:
- APIHashable, Attrable, Forwardable
- 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
- #allow_reassignment ⇒ Object private
-
#config ⇒ Object
internal
The configuration of this Cask.
- #default_config ⇒ Object readonly private
- #download ⇒ Object private
- #loader ⇒ Object readonly private
- #source ⇒ Object readonly private
- #sourcefile_path ⇒ Object readonly private
-
#token ⇒ Object
readonly
internal
The token of this Cask.
Class Method Summary collapse
- .all(eval_all: false) ⇒ Object private
Instance Method Summary collapse
- #app(*args, &block) ⇒ T.untyped private
- #appcast(*args, &block) ⇒ T.untyped private
- #appdir(*args, &block) ⇒ T.untyped private
- #arch(*args, &block) ⇒ T.untyped private
- #artifact(*args, &block) ⇒ T.untyped private
- #artifacts(*args, &block) ⇒ T.untyped private
- #artifacts_list(uninstall_only: false) ⇒ Object private
- #audio_unit_plugin(*args, &block) ⇒ T.untyped private
- #auto_updates(*args, &block) ⇒ T.untyped private
- #binary(*args, &block) ⇒ T.untyped private
- #bundle_long_version ⇒ String? private
- #bundle_short_version ⇒ String? private
-
#caskfile_only? ⇒ Boolean
private
The caskfile is needed during installation when there are
*flight
blocks or the cask has multiple languages. - #caskroom_path ⇒ Pathname private
- #caveats(*args, &block) ⇒ T.untyped private
- #checksumable? ⇒ Boolean private
- #colorpicker(*args, &block) ⇒ T.untyped private
- #config_path ⇒ Object private
- #conflicts_with(*args, &block) ⇒ T.untyped private
- #container(*args, &block) ⇒ T.untyped private
- #depends_on(*args, &block) ⇒ T.untyped private
- #depends_on_set_in_block?(*args, &block) ⇒ Boolean private
- #deprecate!(*args, &block) ⇒ T.untyped private
- #deprecated?(*args, &block) ⇒ Boolean private
- #deprecation_date(*args, &block) ⇒ T.untyped private
- #deprecation_reason(*args, &block) ⇒ T.untyped private
- #deprecation_replacement(*args, &block) ⇒ T.untyped private
- #desc(*args, &block) ⇒ T.untyped private
- #dictionary(*args, &block) ⇒ T.untyped private
- #disable!(*args, &block) ⇒ T.untyped private
- #disable_date(*args, &block) ⇒ T.untyped private
- #disable_reason(*args, &block) ⇒ T.untyped private
- #disable_replacement(*args, &block) ⇒ T.untyped private
- #disabled?(*args, &block) ⇒ Boolean private
- #discontinued?(*args, &block) ⇒ Boolean private
- #download_sha_path ⇒ Object private
- #font(*args, &block) ⇒ T.untyped private
-
#full_name ⇒ Object
internal
Alias for #full_token.
-
#full_token ⇒ Object
internal
The fully-qualified token of this Cask.
- #homepage(*args, &block) ⇒ T.untyped private
- #initialize(token, sourcefile_path: nil, source: nil, tap: nil, loaded_from_api: false, config: nil, allow_reassignment: false, loader: nil, &block) ⇒ void constructor private
- #input_method(*args, &block) ⇒ T.untyped private
- #install_time ⇒ Time? private
- #installed? ⇒ Boolean private
- #installed_caskfile ⇒ Pathname? private
- #installed_version ⇒ String? private
- #installer(*args, &block) ⇒ T.untyped private
- #internet_plugin(*args, &block) ⇒ T.untyped private
- #keyboard_layout(*args, &block) ⇒ T.untyped private
- #language(*args, &block) ⇒ T.untyped private
- #languages ⇒ Object private
- #livecheck(*args, &block) ⇒ T.untyped private
- #livecheck_defined?(*args, &block) ⇒ Boolean private
- #livecheckable?(*args, &block) ⇒ Boolean private
- #loaded_from_api? ⇒ Boolean private
- #manpage(*args, &block) ⇒ T.untyped private
- #mdimporter(*args, &block) ⇒ T.untyped private
- #name(*args, &block) ⇒ T.untyped private
- #new_download_sha ⇒ Object private
-
#old_tokens ⇒ Array<String>
private
An old name for the cask.
- #on_system_block_min_os(*args, &block) ⇒ MacOSVersion? private
- #on_system_blocks_exist?(*args, &block) ⇒ Boolean private
-
#outdated?(greedy: false, greedy_latest: false, greedy_auto_updates: false) ⇒ Boolean
internal
Check if the installed cask is outdated.
- #outdated_download_sha? ⇒ Boolean private
- #outdated_info(greedy, verbose, json, greedy_latest, greedy_auto_updates) ⇒ Object private
- #outdated_version(greedy: false, greedy_latest: false, greedy_auto_updates: false) ⇒ Object private
- #pkg(*args, &block) ⇒ T.untyped private
- #populate_from_api!(json_cask) ⇒ Object private
- #postflight(*args, &block) ⇒ T.untyped private
- #preflight(*args, &block) ⇒ T.untyped private
- #prefpane(*args, &block) ⇒ T.untyped private
- #qlplugin(*args, &block) ⇒ T.untyped private
- #refresh ⇒ Object private
- #ruby_source_checksum ⇒ Hash{Symbol => String} private
- #ruby_source_path ⇒ Object private
- #screen_saver(*args, &block) ⇒ T.untyped private
- #service(*args, &block) ⇒ T.untyped private
- #sha256(*args, &block) ⇒ T.untyped private
- #stage_only(*args, &block) ⇒ T.untyped private
- #staged_path(*args, &block) ⇒ T.untyped private
- #suite(*args, &block) ⇒ T.untyped private
- #tab ⇒ Object private
- #tap ⇒ Object private
- #tap_git_head ⇒ Object private
- #timestamped_versions(caskroom_path: self.caskroom_path) ⇒ Array<Array<(String, String)>> private
- #to_h ⇒ Object private
- #to_hash_with_variations ⇒ Object private
- #uninstall(*args, &block) ⇒ T.untyped private
- #uninstall_flight_blocks? ⇒ Boolean private
- #uninstall_postflight(*args, &block) ⇒ T.untyped private
- #uninstall_preflight(*args, &block) ⇒ T.untyped private
- #url(*args, &block) ⇒ ::Cask::URL? private
- #version(*args, &block) ⇒ T.untyped private
- #vst3_plugin(*args, &block) ⇒ T.untyped private
- #vst_plugin(*args, &block) ⇒ T.untyped private
- #zap(*args, &block) ⇒ T.untyped private
Methods included from Attrable
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.
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. 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.
10 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 10 def app(*args, &block); end |
#appcast(*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.
13 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 13 def appcast(*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.
16 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 16 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.
19 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 19 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.
22 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 22 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.
25 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 25 def artifacts(*args, &block); end |
#artifacts_list(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.
443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 |
# File 'cask/cask.rb', line 443 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.
28 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 28 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.
31 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 31 def auto_updates(*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.
34 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 34 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.
219 220 221 |
# File 'cask/cask.rb', line 219 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.
214 215 216 |
# File 'cask/cask.rb', line 214 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
157 158 159 |
# File 'cask/cask.rb', line 157 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.
258 259 260 |
# File 'cask/cask.rb', line 258 def caskroom_path @caskroom_path ||= Caskroom.path.join(token) 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.
37 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 37 def caveats(*args, &block); 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.
231 232 233 234 235 |
# File 'cask/cask.rb', line 231 def checksumable? return false if (url = self.url).nil? DownloadStrategyDetector.detect(url.to_s, url.using) <= AbstractFileDownloadStrategy 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.
40 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 40 def colorpicker(*args, &block); 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.
227 228 229 |
# File 'cask/cask.rb', line 227 def config_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.
43 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 43 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.
46 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 46 def container(*args, &block); 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.
49 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 49 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.
52 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 52 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.
55 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 55 def deprecate!(*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.
58 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 58 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.
61 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 61 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.
64 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 64 def deprecation_reason(*args, &block); end |
#deprecation_replacement(*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.
67 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 67 def deprecation_replacement(*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.
70 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 70 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.
73 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 73 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.
76 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 76 def disable!(*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.
79 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 79 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.
82 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 82 def disable_reason(*args, &block); end |
#disable_replacement(*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.
85 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 85 def disable_replacement(*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.
88 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 88 def disabled?(*args, &block); end |
#discontinued?(*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.
91 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 91 def discontinued?(*args, &block); 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.
237 238 239 |
# File 'cask/cask.rb', line 237 def download_sha_path /"LATEST_DOWNLOAD_SHA256" 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.
94 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 94 def font(*args, &block); 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.
148 |
# File 'cask/cask.rb', line 148 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.
138 139 140 141 142 143 |
# File 'cask/cask.rb', line 138 def full_token return token if tap.nil? return token if tap.core_cask_tap? "#{tap.name}/#{token}" 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.
97 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 97 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.
100 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 100 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.
173 174 175 176 177 |
# File 'cask/cask.rb', line 173 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.
151 152 153 |
# File 'cask/cask.rb', line 151 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.
180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 |
# File 'cask/cask.rb', line 180 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 = (caskroom_path: installed_caskroom_path).last return unless installed_version caskfile_dir = (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.
206 207 208 209 210 211 |
# File 'cask/cask.rb', line 206 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.
103 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 103 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.
106 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 106 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.
109 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 109 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.
112 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 112 def language(*args, &block); 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.
321 322 323 |
# File 'cask/cask.rb', line 321 def languages @languages ||= @dsl.languages 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.
115 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 115 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.
118 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 118 def livecheck_defined?(*args, &block); end |
#livecheckable?(*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.
121 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 121 def livecheckable?(*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.
124 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 124 def loaded_from_api?; end |
#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.
127 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 127 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.
130 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 130 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.
133 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 133 def name(*args, &block); 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.
241 242 243 244 245 246 247 248 |
# File 'cask/cask.rb', line 241 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.
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(*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.
136 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 136 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.
139 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 139 def on_system_blocks_exist?(*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.
265 266 267 268 |
# File 'cask/cask.rb', line 265 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.
250 251 252 253 254 255 |
# File 'cask/cask.rb', line 250 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.
288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 |
# File 'cask/cask.rb', line 288 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.
270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 |
# File 'cask/cask.rb', line 270 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 |
#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.
142 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 142 def pkg(*args, &block); 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.
331 332 333 334 335 336 337 338 339 340 341 342 343 |
# File 'cask/cask.rb', line 331 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 |
#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.
145 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 145 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.
148 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 148 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.
151 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 151 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.
154 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 154 def qlplugin(*args, &block); 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 119 |
# File 'cask/cask.rb', line 112 def refresh @dsl = DSL.new(self) return unless @block @dsl.instance_eval(&@block) @dsl.add_implicit_macos_dependency @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.
315 316 317 318 319 |
# File 'cask/cask.rb', line 315 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.
305 306 307 308 309 310 311 312 |
# File 'cask/cask.rb', line 305 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 |
#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.
157 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 157 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.
160 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 160 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.
163 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 163 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.
166 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 166 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.
169 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 169 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.
172 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 172 def suite(*args, &block); 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.
223 224 225 |
# File 'cask/cask.rb', line 223 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.
325 326 327 328 329 |
# File 'cask/cask.rb', line 325 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.
124 125 126 127 128 129 130 131 132 133 |
# File 'cask/cask.rb', line 124 def (caskroom_path: self.caskroom_path) relative_paths = Pathname.glob(( 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.
363 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 |
# File 'cask/cask.rb', line 363 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 ⇒ 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.
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 |
# File 'cask/cask.rb', line 405 def to_hash_with_variations if loaded_from_api? && !Homebrew::EnvConfig.no_install_from_api? return api_to_local_hash(Homebrew::API::Cask.all_casks[token].dup) end hash = to_h 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 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.
175 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 175 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.
161 162 163 164 165 166 167 168 169 170 |
# File 'cask/cask.rb', line 161 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.
178 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 178 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.
181 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 181 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.
184 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 184 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.
187 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 187 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.
190 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 190 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.
193 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 193 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.
196 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 196 def zap(*args, &block); end |