Module: Homebrew::API::Cask Private

Extended by:
Cachable
Defined in:
api/cask.rb

Overview

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

Helper functions for using the cask JSON API.

Constant Summary collapse

DEFAULT_API_FILENAME =

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

"cask.jws.json"

Class Method Summary collapse

Methods included from Cachable

cache, clear_cache

Class Method Details

.all_casksHash{String => Hash{String => T.untyped}}

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

Returns:



93
94
95
96
97
98
99
100
# File 'api/cask.rb', line 93

def self.all_casks
  unless cache.key?("casks")
    json_updated = download_and_cache_data!
    write_names(regenerate: json_updated)
  end

  cache.fetch("casks")
end

.all_renamesHash{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.

Returns:



103
104
105
106
107
108
109
110
# File 'api/cask.rb', line 103

def self.all_renames
  unless cache.key?("renames")
    json_updated = download_and_cache_data!
    write_names(regenerate: json_updated)
  end

  cache.fetch("renames")
end

.api_filenameString

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

Returns:



18
19
20
21
22
# File 'api/cask.rb', line 18

def self.api_filename
  return DEFAULT_API_FILENAME unless ENV.fetch("HOMEBREW_USE_INTERNAL_API", false)

  "cask.#{SimulateSystem.current_tag}.jws.json"
end

.cached_json_file_pathPathname

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

Returns:



53
54
55
# File 'api/cask.rb', line 53

def self.cached_json_file_path
  HOMEBREW_CACHE_API/api_filename
end

.fetch(token) ⇒ 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.

Parameters:

Returns:



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

def self.fetch(token)
  Homebrew::API.fetch "cask/#{token}.json"
end

.fetch_api!(download_queue: nil, stale_seconds: Homebrew::EnvConfig.api_auto_update_secs.to_i) ⇒ Array<([Array<T.untyped>, Hash{String => T.untyped}], Boolean)>

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

Parameters:

  • download_queue (::Homebrew::DownloadQueue, nil) (defaults to: nil)
  • stale_seconds (Integer) (defaults to: Homebrew::EnvConfig.api_auto_update_secs.to_i)

Returns:



61
62
63
# File 'api/cask.rb', line 61

def self.fetch_api!(download_queue: nil, stale_seconds: Homebrew::EnvConfig.api_auto_update_secs.to_i)
  Homebrew::API.fetch_json_api_file api_filename, stale_seconds:, download_queue:
end

.fetch_tap_migrations!(download_queue: nil, stale_seconds: Homebrew::API::TAP_MIGRATIONS_STALE_SECONDS) ⇒ Array<([Array<T.untyped>, Hash{String => T.untyped}], Boolean)>

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

Parameters:

  • download_queue (::Homebrew::DownloadQueue, nil) (defaults to: nil)
  • stale_seconds (Integer) (defaults to: Homebrew::API::TAP_MIGRATIONS_STALE_SECONDS)

Returns:



69
70
71
# File 'api/cask.rb', line 69

def self.fetch_tap_migrations!(download_queue: nil, stale_seconds: Homebrew::API::TAP_MIGRATIONS_STALE_SECONDS)
  Homebrew::API.fetch_json_api_file "cask_tap_migrations.jws.json", stale_seconds:, download_queue:
end

.source_download(cask) ⇒ ::Cask::Cask

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

Parameters:

Returns:



32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
# File 'api/cask.rb', line 32

def self.source_download(cask)
  path = cask.ruby_source_path.to_s
  sha256 = cask.ruby_source_checksum[:sha256]
  checksum = Checksum.new(sha256) if sha256
  git_head = cask.tap_git_head || "HEAD"
  tap = cask.tap&.full_name || "Homebrew/homebrew-cask"

  download = Homebrew::API::SourceDownload.new(
    "https://raw.githubusercontent.com/#{tap}/#{git_head}/#{path}",
    checksum,
    mirrors: [
      "#{HOMEBREW_API_DEFAULT_DOMAIN}/cask-source/#{File.basename(path)}",
    ],
    cache:   HOMEBREW_CACHE_API_SOURCE/"#{tap}/#{git_head}/Cask",
  )
  download.fetch
  ::Cask::CaskLoader::FromPathLoader.new(download.symlink_location)
                                    .load(config: cask.config)
end

.tap_migrationsHash{String => T.untyped}

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

Returns:



113
114
115
116
117
118
119
120
# File 'api/cask.rb', line 113

def self.tap_migrations
  unless cache.key?("tap_migrations")
    json_migrations, = fetch_tap_migrations!
    cache["tap_migrations"] = json_migrations
  end

  cache.fetch("tap_migrations")
end

.write_names(regenerate: false) ⇒ void

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

This method returns an undefined value.

Parameters:

  • regenerate (Boolean) (defaults to: false)


123
124
125
126
127
# File 'api/cask.rb', line 123

def self.write_names(regenerate: false)
  download_and_cache_data! unless cache.key?("casks")

  Homebrew::API.write_names_file!(all_casks.keys, "cask", regenerate:)
end