Class: Cask::Cask Private
- Extended by:
- APIHashable, Forwardable, Utils::Output::Mixin
- Includes:
- Metadata
- Defined in:
- cask/cask.rb,
cask/cask_base.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 ⇒ Boolean private
- #api_source ⇒ Hash{String => T.untyped}? readonly private
-
#config ⇒ Config
internal
The configuration of this Cask.
- #default_config ⇒ Config readonly private
- #download ⇒ Pathname? private
- #loader ⇒ CaskLoader::ILoader? readonly private
- #source ⇒ String? readonly private
- #sourcefile_path ⇒ Pathname? readonly private
-
#temp ⇒ Pathname
internal
Private temporary storage for the current cask lifecycle operation.
-
#token ⇒ String
readonly
The unique identifier for this Cask, used to refer to it in commands and tap paths.
Class Method Summary collapse
- .all ⇒ Array<Cask> private
Instance Method Summary collapse
- #any_version_installed? ⇒ Boolean private
- #app(*args, &block) ⇒ T.untyped private
- #app_image(*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) ⇒ Array<Hash{Symbol => T.untyped}> private
- #audio_unit_plugin(*args, &block) ⇒ T.untyped private
- #auto_updates(*args, &block) ⇒ T.untyped private
- #autobump?(*args, &block) ⇒ Boolean private
- #bash_completion(*args, &block) ⇒ T.untyped private
- #binary(*args, &block) ⇒ T.untyped private
- #bundle_long_version ⇒ String? private
- #bundle_short_version ⇒ String? private
- #caskroom_path ⇒ Pathname private
- #caveats(*args, &block) ⇒ T.untyped private
- #caveats_object ⇒ DSL::Caveats private
- #checksumable? ⇒ Boolean private
-
#cleanup_temp(retain: false) ⇒ void
internal
Retain files on failure so an incomplete restoration cannot lose data.
- #colorpicker(*args, &block) ⇒ T.untyped private
- #command_wrapper(*args, &block) ⇒ T.untyped private
- #config_path ⇒ Pathname 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
- #deprecate_args(*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_cask(*args, &block) ⇒ T.untyped private
- #deprecation_replacement_formula(*args, &block) ⇒ T.untyped private
- #desc(*args, &block) ⇒ T.untyped private
- #dictionary(*args, &block) ⇒ T.untyped private
- #disable!(*args, &block) ⇒ T.untyped private
- #disable_args(*args, &block) ⇒ T.untyped private
- #disable_date(*args, &block) ⇒ T.untyped private
- #disable_reason(*args, &block) ⇒ T.untyped private
- #disable_replacement_cask(*args, &block) ⇒ T.untyped private
- #disable_replacement_formula(*args, &block) ⇒ T.untyped private
- #disabled?(*args, &block) ⇒ Boolean private
- #download_sha_path ⇒ Pathname private
- #fish_completion(*args, &block) ⇒ T.untyped private
- #font(*args, &block) ⇒ T.untyped private
- #font? ⇒ Boolean private
-
#full_name ⇒ String
internal
Alias for #full_token.
-
#full_token ⇒ String
internal
The fully-qualified token of this Cask.
- #generate_completions_from_executable(*args, &block) ⇒ T.untyped private
- #generated_script(*args, &block) ⇒ T.untyped private
- #homepage(*args, &block) ⇒ T.untyped private
- #homepage_browsed(*args, &block) ⇒ T.untyped private
- #initialize(token, sourcefile_path: nil, source: nil, tap: nil, loaded_from_api: false, loaded_from_internal_api: false, loaded_from_metadata: false, api_source: nil, config: nil, allow_reassignment: false, loader: nil, &block) ⇒ void constructor private
- #input_method(*args, &block) ⇒ T.untyped private
- #install_time ⇒ Time? private
- #installable_artifact? ⇒ Boolean 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, default: false, &block) ⇒ String? private
- #languages ⇒ Array<String> private
- #livecheck(*args, &block) ⇒ T.untyped private
- #livecheck_defined?(*args, &block) ⇒ Boolean private
- #loaded_from_api? ⇒ Boolean private
- #loaded_from_internal_api? ⇒ Boolean private
-
#loaded_from_metadata? ⇒ Boolean
private
Whether this cask was loaded from installed metadata.
- #manpage(*args, &block) ⇒ T.untyped private
- #mdimporter(*args, &block) ⇒ T.untyped private
- #name(*args, &block) ⇒ T.untyped private
- #new_download_sha ⇒ String private
- #no_autobump!(*args, &block) ⇒ T.untyped private
- #no_autobump_message(*args, &block) ⇒ T.untyped private
-
#old_tokens ⇒ Array<String>
private
An old name for the cask.
- #on_os_blocks_exist?(*args, &block) ⇒ Boolean private
- #on_system_block_min_os(*args, &block) ⇒ MacOSVersion? private
- #on_system_blocks_exist?(*args, &block) ⇒ Boolean private
- #os(*args, &block) ⇒ T.untyped private
-
#outdated?(greedy: false, greedy_latest: false, greedy_auto_updates: false, minimum_version: nil) ⇒ Boolean
internal
Check if the installed cask is outdated.
- #outdated_download_sha? ⇒ Boolean private
- #outdated_info(greedy, verbose, json, greedy_latest, greedy_auto_updates) ⇒ String, Hash{Symbol => T.untyped} private
- #outdated_version(greedy: false, greedy_latest: false, greedy_auto_updates: false) ⇒ String? private
- #pin ⇒ void private
- #pin_path ⇒ Pathname private
- #pinnable? ⇒ Boolean private
- #pinned? ⇒ Boolean private
- #pinned_version ⇒ String? private
- #pkg(*args, &block) ⇒ T.untyped private
- #platform_supported?(bottle_tag, installable: true) ⇒ Boolean private
- #populate_from_api!(cask_struct, tap_git_head:) ⇒ void private
- #postflight(*args, &block) ⇒ T.untyped private
- #postflight_steps(*args, &block) ⇒ T.untyped private
- #preflight(*args, &block) ⇒ T.untyped private
- #preflight_steps(*args, &block) ⇒ T.untyped private
- #prefpane(*args, &block) ⇒ T.untyped private
- #pwsh_completion(*args, &block) ⇒ T.untyped private
- #qlplugin(*args, &block) ⇒ T.untyped private
- #refresh ⇒ void private
-
#refresh_for_tag(tag, &_block) ⇒ T.type_parameter(:U)?
private
Refresh the cask as evaluated on
tagand yield. - #reloadable_ref ⇒ String, Pathname private
- #rename(*args, &block) ⇒ T.untyped private
- #rename_list(uninstall_only: false) ⇒ Array<Hash{Symbol => T.untyped}> private
- #ruby_source_checksum ⇒ Hash{Symbol => String, nil} private
- #ruby_source_path ⇒ String? 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
- #supports_linux? ⇒ Boolean private
- #supports_macos? ⇒ Boolean private
- #tab ⇒ Tab private
-
#tap(&blk) ⇒ T.untyped
private
This collides with Kernel#tap, complicating the type signature.
- #tap_git_head ⇒ String? private
- #timestamped_versions(caskroom_path: self.caskroom_path) ⇒ Array<Array<(String, String)>> private
- #to_h ⇒ Hash{String => T.untyped} private
- #to_h_with_language_variations ⇒ Hash{String => T.untyped} private
- #to_hash_with_variations ⇒ Hash{String => T.untyped} private
- #to_installed_json_hash ⇒ Hash{String => T.untyped} private
- #uninstall(*args, &block) ⇒ T.untyped private
- #uninstall_flight_blocks? ⇒ Boolean private
- #uninstall_postflight(*args, &block) ⇒ T.untyped private
- #uninstall_postflight_steps(*args, &block) ⇒ T.untyped private
- #uninstall_preflight(*args, &block) ⇒ T.untyped private
- #uninstall_preflight_steps(*args, &block) ⇒ T.untyped private
- #unpin ⇒ void private
- #url(*args, &block) ⇒ ::Cask::URL? private
-
#valid_platform? ⇒ Boolean
private
True if this cask can be installed on this platform.
- #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
- #zsh_completion(*args, &block) ⇒ T.untyped private
Methods included from APIHashable
deep_remove_placeholders, generating_hash!, generating_hash?
Methods included from Utils::Output::Mixin
issue_reporting_message, odebug, odeprecated, odie, odisabled, ofail, oh1, oh1_title, ohai, ohai_title, onoe, opoo, opoo_once, opoo_outside_github_actions, opoo_without_github_actions_annotation, pretty_cannot_install, pretty_deprecated, pretty_disabled, pretty_duration, pretty_install_status, pretty_installed, pretty_removed, pretty_uninstalled, pretty_unmarked, pretty_upgradable, pretty_warning
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, loaded_from_metadata: 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.
130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 |
# File 'cask/cask.rb', line 130 def initialize(token, sourcefile_path: nil, source: nil, tap: nil, loaded_from_api: false, loaded_from_internal_api: false, loaded_from_metadata: 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 @loaded_from_metadata = @api_source = api_source @language_evaluator = T.let(nil, T.nilable(T.proc.params(languages: T::Array[String]).returns(T.nilable(String)))) @loader = loader @temp = T.let(nil, T.nilable(Pathname)) # 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.
79 80 81 |
# File 'cask/cask.rb', line 79 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.
180 181 182 |
# File 'cask/cask.rb', line 180 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.
36 37 38 |
# File 'cask/cask.rb', line 36 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.
45 46 47 |
# File 'cask/cask.rb', line 45 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.
51 52 53 |
# File 'cask/cask.rb', line 51 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.
48 49 50 |
# File 'cask/cask.rb', line 48 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.
42 43 44 |
# File 'cask/cask.rb', line 42 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.
39 40 41 |
# File 'cask/cask.rb', line 39 def sourcefile_path @sourcefile_path end |
#temp ⇒ Pathname
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.
Private temporary storage for the current cask lifecycle operation.
59 60 61 |
# File 'cask/cask.rb', line 59 def temp @temp ||= Pathname(Dir.mktmpdir("cask-#{token}-", HOMEBREW_TEMP)) end |
#token ⇒ String (readonly)
The unique identifier for this Cask::Cask, used to refer to it in commands
and tap paths.
e.g. firefox
30 31 32 |
# File 'cask/cask.rb', line 30 def token @token end |
Class Method Details
.all ⇒ 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.
82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 |
# File 'cask/cask.rb', line 82 def self.all # 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) .then { |files| Homebrew::Trust.trusted_cask_files(files) } tokens_and_files.filter_map do |token_or_file| if token_or_file.is_a?(String) CaskLoader.load_from_name(token_or_file) else CaskLoader.from_path(token_or_file) end rescue CaskUnavailableError, CaskInvalidError => e # Don't let one broken cask break commands. But do complain. opoo e. nil end end |
Instance Method Details
#any_version_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.
282 |
# File 'cask/cask.rb', line 282 def any_version_installed? = installed? |
#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 |
#app_image(*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 app_image(*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) ⇒ 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.
753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 |
# File 'cask/cask.rb', line 753 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 entry = T.let( { artifact.class.dsl_key => artifact.to_args }, T::Hash[Symbol, T.any(String, T::Array[T.anything])], ) entry[:target] = artifact.target.to_s if !uninstall_only && artifact.is_a?(Artifact::Relocated) entry 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 |
#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.
34 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 34 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.
37 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 37 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.
40 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 40 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.
396 397 398 |
# File 'cask/cask.rb', line 396 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.
391 392 393 |
# File 'cask/cask.rb', line 391 def bundle_short_version bundle_version&.short_version 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.
444 445 446 |
# File 'cask/cask.rb', line 444 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.
43 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 43 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.
248 |
# File 'cask/cask.rb', line 248 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.
411 412 413 414 415 |
# File 'cask/cask.rb', line 411 def checksumable? return false if (url = self.url).nil? || url.to_s.blank? DownloadStrategyDetector.detect(url.to_s, url.using) <= AbstractFileDownloadStrategy || false end |
#cleanup_temp(retain: false) ⇒ void
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.
This method returns an undefined value.
Retain files on failure so an incomplete restoration cannot lose data.
66 67 68 69 70 71 72 73 74 75 76 |
# File 'cask/cask.rb', line 66 def cleanup_temp(retain: false) temporary = @temp @temp = nil return unless temporary&.exist? if retain ::Utils::Output.opoo "Temporary files retained at:\n#{temporary}" else FileUtils.remove_entry_secure(temporary) end 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.
46 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 46 def colorpicker(*args, &block); end |
#command_wrapper(*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 command_wrapper(*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.
406 407 408 |
# File 'cask/cask.rb', line 406 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.
52 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 52 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.
55 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 55 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.
58 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 58 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.
61 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 61 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.
64 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 64 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.
67 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 67 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.
70 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 70 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.
73 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 73 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.
76 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 76 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.
79 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 79 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.
82 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 82 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.
85 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 85 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.
88 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 88 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.
91 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 91 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.
94 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 94 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.
97 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 97 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.
100 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 100 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.
103 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 103 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.
106 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 106 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.
109 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 109 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.
418 419 420 |
# File 'cask/cask.rb', line 418 def download_sha_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.
112 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 112 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.
115 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 115 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.
285 286 287 |
# File 'cask/cask.rb', line 285 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.
274 |
# File 'cask/cask.rb', line 274 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.
263 264 265 266 267 268 |
# File 'cask/cask.rb', line 263 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.
118 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 118 def generate_completions_from_executable(*args, &block); end |
#generated_script(*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.
121 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 121 def generated_script(*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.
124 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 124 def homepage(*args, &block); end |
#homepage_browsed(*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 homepage_browsed(*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.
130 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 130 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.
331 332 333 334 335 |
# File 'cask/cask.rb', line 331 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 |
#installable_artifact? ⇒ 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.
290 291 292 293 294 |
# File 'cask/cask.rb', line 290 def installable_artifact? artifacts.any? do |artifact| artifact.respond_to?(:install_phase) || artifact.is_a?(Artifact::StageOnly) end 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.
277 278 279 |
# File 'cask/cask.rb', line 277 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.
338 339 340 |
# File 'cask/cask.rb', line 338 def installed_caskfile Caskroom.cask_installed_caskfile(token, old_tokens:) 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.
343 344 345 346 |
# File 'cask/cask.rb', line 343 def installed_version # <caskroom_path>/.metadata/<version>/<timestamp>/Casks/<token>.{rb,json} -> <version> Caskroom.cask_installed_version(token, old_tokens:) 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.
133 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 133 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.
136 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 136 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.
139 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 139 def keyboard_layout(*args, &block); end |
#language(*args, default: false, &block) ⇒ 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.
241 242 243 244 245 |
# File 'cask/cask.rb', line 241 def language(*args, default: false, &block) return @language_evaluator.call(config.languages) if args.empty? && block.nil? && @language_evaluator dsl!.language(*args, default:, &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.
554 555 556 |
# File 'cask/cask.rb', line 554 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.
142 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 142 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.
145 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 145 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.
163 |
# File 'cask/cask.rb', line 163 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.
166 |
# File 'cask/cask.rb', line 166 def loaded_from_internal_api? = @loaded_from_internal_api |
#loaded_from_metadata? ⇒ 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.
Whether this cask was loaded from installed metadata.
170 |
# File 'cask/cask.rb', line 170 def = @loaded_from_metadata |
#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.
148 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 148 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.
151 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 151 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.
154 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 154 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.
423 424 425 426 427 428 429 430 431 432 433 |
# File 'cask/cask.rb', line 423 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.
157 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 157 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.
160 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 160 def (*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.
184 185 186 187 188 189 190 191 192 193 194 |
# File 'cask/cask.rb', line 184 def old_tokens @old_tokens ||= T.let( if (t = tap) Tap.tap_migration_oldnames(t, token, cask: true) + 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.
163 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 163 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.
166 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 166 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.
169 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 169 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.
172 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 172 def os(*args, &block); end |
#outdated?(greedy: false, greedy_latest: false, greedy_auto_updates: false, minimum_version: nil) ⇒ 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.
459 460 461 462 463 464 465 466 467 468 469 470 471 |
# File 'cask/cask.rb', line 459 def outdated?(greedy: false, greedy_latest: false, greedy_auto_updates: false, minimum_version: nil) # Disabled casks cannot be upgraded, even when a newer version is available. return false if disabled? if minimum_version.present? require "minimum_version" return Homebrew::MinimumVersion.cask_installed_below?(self, minimum_version) end !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.
436 437 438 439 440 441 |
# File 'cask/cask.rb', line 436 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.
509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 |
# File 'cask/cask.rb', line 509 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, pinned: pinned?, pinned_version:, } else pinned = " [pinned at #{pinned_version}]" if pinned? "#{token} (#{installed_version}) != #{version}#{pinned}" 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.
477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 |
# File 'cask/cask.rb', line 477 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 unless Homebrew::EnvConfig.upgrade_auto_updates_casks? return installed_version if auto_updates_bundle_outdated? return end installed_version end |
#pin ⇒ 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.
349 350 351 352 353 354 355 356 357 358 359 360 |
# File 'cask/cask.rb', line 349 def pin return unless (installed_version = self.installed_version) versioned_path = caskroom_path/installed_version return unless versioned_path.exist? HOMEBREW_PINNED_CASKS.mkpath return if pinned? pin_path.unlink if pin_path.file? || pin_path.symlink? pin_path.make_relative_symlink(versioned_path) end |
#pin_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.
386 387 388 |
# File 'cask/cask.rb', line 386 def pin_path HOMEBREW_PINNED_CASKS/token end |
#pinnable? ⇒ 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.
374 375 376 377 378 |
# File 'cask/cask.rb', line 374 def pinnable? return false unless (installed_version = self.installed_version) (caskroom_path/installed_version).exist? end |
#pinned? ⇒ 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.
369 370 371 |
# File 'cask/cask.rb', line 369 def pinned? pin_path.symlink? && pin_path.exist? end |
#pinned_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.
381 382 383 |
# File 'cask/cask.rb', line 381 def pinned_version ::Utils::Path.resolved_path(pin_path).basename.to_s if pinned? 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.
175 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 175 def pkg(*args, &block); end |
#platform_supported?(bottle_tag, installable: true) ⇒ 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.
786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 |
# File 'cask/cask.rb', line 786 def platform_supported?(bottle_tag, installable: true) if bottle_tag.linux? return false unless supports_linux? else return false unless supports_macos? end return false if version.blank? || sha256.blank? || url.blank? return false if installable && !installable_artifact? arch_supported = depends_on.arch&.any? do |arch| required_arch = ::Utils::Bottles::Tag.new(system: bottle_tag.system, arch: arch[:type]).standardized_arch required_arch == bottle_tag.standardized_arch end return false if arch_supported == false return true unless bottle_tag.macos? [depends_on.macos, depends_on.maximum_macos].compact.all? do |requirement| requirement.allows?(bottle_tag.to_macos_version) end 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.
566 567 568 569 570 571 572 573 574 |
# File 'cask/cask.rb', line 566 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 @language_evaluator = ->(languages) { cask_struct.language(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.
178 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 178 def postflight(*args, &block); end |
#postflight_steps(*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 postflight_steps(*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.
184 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 184 def preflight(*args, &block); end |
#preflight_steps(*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 preflight_steps(*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.
190 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 190 def prefpane(*args, &block); end |
#pwsh_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.
193 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 193 def pwsh_completion(*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.
196 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 196 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.
204 205 206 207 208 209 210 211 212 |
# File 'cask/cask.rb', line 204 def refresh @dsl = T.let(DSL.new(self), T.nilable(DSL)) return unless @block dsl!.instance_eval(&@block) dsl!.language_eval rescue NoMethodError => e raise CaskInvalidError.new(token, e.), e.backtrace end |
#refresh_for_tag(tag, &_block) ⇒ T.type_parameter(:U)?
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
Refresh the cask as evaluated on tag and yield. Returns nil instead of
raising when the cask has on_system blocks that omit the tag.
221 222 223 224 225 226 227 228 229 230 |
# File 'cask/cask.rb', line 221 def refresh_for_tag(tag, &_block) Homebrew::SimulateSystem.with(os: tag.system, arch: tag.arch) do refresh yield end rescue CaskInvalidError, CaskUnreadableError raise unless on_system_blocks_exist? nil end |
#reloadable_ref ⇒ String, 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.
173 174 175 176 177 |
# File 'cask/cask.rb', line 173 def reloadable_ref return full_name if loaded_from_api? sourcefile_path || raise("unexpected nil cask sourcefile_path") 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.
199 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 199 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.
779 780 781 782 783 |
# File 'cask/cask.rb', line 779 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.
541 542 543 544 545 546 547 548 549 550 551 |
# File 'cask/cask.rb', line 541 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.
531 532 533 534 535 536 537 538 |
# File 'cask/cask.rb', line 531 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.
202 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 202 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.
205 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 205 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.
208 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 208 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.
211 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 211 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.
214 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 214 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.
217 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 217 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.
297 298 299 300 301 |
# File 'cask/cask.rb', line 297 def supports_linux? return true if depends_on.requires_linux? !depends_on.requires_macos? end |
#supports_macos? ⇒ 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.
304 305 306 |
# File 'cask/cask.rb', line 304 def supports_macos? !depends_on.requires_linux? 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.
401 402 403 |
# File 'cask/cask.rb', line 401 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.
108 109 110 111 112 |
# File 'cask/cask.rb', line 108 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.
559 560 561 562 563 |
# File 'cask/cask.rb', line 559 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.
251 252 253 254 255 256 257 |
# File 'cask/cask.rb', line 251 def (caskroom_path: self.caskroom_path) pattern = (version: "*", timestamp: "*", caskroom_path:).to_s Pathname.glob(pattern) .map { |p| p.relative_path_from(p.parent.parent) } .map { |p| [p.dirname.to_s, p.basename.to_s] } .sort_by(&:last) # sort by timestamp 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.
599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 |
# File 'cask/cask.rb', line 599 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" => , "skip_livecheck" => livecheck.skip?, "installed" => installed_version, "installed_time" => install_time&.to_i, "bundle_version" => bundle_long_version, "bundle_short_version" => bundle_short_version, "pinned" => pinned?, "pinned_version" => pinned_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_h_with_language_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.
709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 |
# File 'cask/cask.rb', line 709 def to_h_with_language_variations language_groups = dsl!.language_groups return to_h if language_groups.empty? default_language_group = dsl!.default_language_group raise CaskInvalidError.new(self, "No default language specified.") if default_language_group.nil? original_config = config language_hashes = language_groups.to_h do |languages| localised_config = original_config.dup localised_config.explicit = original_config.explicit.dup localised_config.languages = [languages.fetch(0)] self.config = localised_config [languages, [to_h, dsl!.language_eval]] end hash = language_hashes.fetch(default_language_group).first hash["language_variations"] = language_hashes.map do |languages, (language_hash, value)| variation = { "languages" => languages, "default" => languages == default_language_group, "value" => value, } language_hash.each do |key, language_value| next if HASH_KEYS_TO_SKIP.include? key next if language_value.to_s == hash[key].to_s variation[key] = language_value end variation end hash ensure self.config = original_config if original_config 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.
656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 |
# File 'cask/cask.rb', line 656 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_with_language_variations variations = {} supported_platforms = [] on_system_blocks_exist = dsl!.on_system_blocks_exist? if on_system_blocks_exist begin OnSystem::VALID_OS_ARCH_TAGS.each do |bottle_tag| macos_requirements = [depends_on.macos, depends_on.maximum_macos].compact next if bottle_tag.macos? && macos_requirements.present? && !dsl!.depends_on_set_in_block? && macos_requirements.any? do |requirement| # Avoid recursive equality between cached version-comparison keys across casks. !requirement.allows?(MacOSVersion.from_symbol(bottle_tag.system)) end refresh_for_tag(bottle_tag) do supported_platforms << bottle_tag.to_sym if platform_supported?(bottle_tag) to_h_with_language_variations.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 else supported_platforms = OnSystem::VALID_OS_ARCH_TAGS.filter_map do |bottle_tag| bottle_tag.to_sym if platform_supported?(bottle_tag) end end hash["variations"] = variations hash["supported_platforms"] = supported_platforms hash end |
#to_installed_json_hash ⇒ 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.
745 746 747 748 749 750 |
# File 'cask/cask.rb', line 745 def to_installed_json_hash cask_url = url return {} if cask_url.nil? || cask_url.only_path.blank? { "url_specs" => { "only_path" => cask_url.only_path } } 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.
220 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 220 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.
319 320 321 322 323 324 325 326 327 328 |
# File 'cask/cask.rb', line 319 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.
223 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 223 def uninstall_postflight(*args, &block); end |
#uninstall_postflight_steps(*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.
226 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 226 def uninstall_postflight_steps(*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.
229 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 229 def uninstall_preflight(*args, &block); end |
#uninstall_preflight_steps(*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.
232 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 232 def uninstall_preflight_steps(*args, &block); end |
#unpin ⇒ 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.
363 364 365 366 |
# File 'cask/cask.rb', line 363 def unpin pin_path.unlink if pin_path.symlink? ::Utils::Path.rmdir_if_possible(HOMEBREW_PINNED_CASKS) 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.
235 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 235 def url(*args, &block); end |
#valid_platform? ⇒ 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.
True if this cask can be installed on this platform.
310 311 312 313 314 315 316 |
# File 'cask/cask.rb', line 310 def valid_platform? if Homebrew::SimulateSystem.simulating_or_running_on_macos? supports_macos? else supports_linux? end 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.
238 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 238 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.
241 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 241 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.
244 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 244 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.
247 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 247 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.
250 |
# File 'sorbet/rbi/dsl/cask/cask.rbi', line 250 def zsh_completion(*args, &block); end |