Module: Homebrew::API::Cask Private

Extended by:
Cachable
Defined in:
api/cask.rb,
api/cask/cask_struct_generator.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.

Defined Under Namespace

Modules: CaskStructGenerator

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_casks ⇒ Hash{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:



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

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_renames ⇒ Hash{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:



130
131
132
133
134
135
136
137
 
# File 'api/cask.rb', line 130

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

  cache.fetch("renames")
end

.cached_json_file_path ⇒ Pathname

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

Returns:



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

def self.cached_json_file_path
  HOMEBREW_CACHE_API/DEFAULT_API_FILENAME
end

.cask_json(name) ⇒ 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:



21
22
23
24
25
 
# File 'api/cask.rb', line 21

def self.cask_json(name)
  fetch_cask_json! name if !cache.key?("cask_json") || !cache.fetch("cask_json").key?(name)

  cache.fetch("cask_json").fetch(name)
end

.fetch_api!(download_queue: Homebrew.default_download_queue, stale_seconds: nil, enqueue: false) ⇒ 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) (defaults to: Homebrew.default_download_queue)
  • stale_seconds (Integer, nil) (defaults to: nil)
  • enqueue (Boolean) (defaults to: false)

Returns:



87
88
89
 
# File 'api/cask.rb', line 87

def self.fetch_api!(download_queue: Homebrew.default_download_queue, stale_seconds: nil, enqueue: false)
  Homebrew::API.fetch_json_api_file DEFAULT_API_FILENAME, stale_seconds:, download_queue:, enqueue:
end

.fetch_cask_json!(name) ⇒ 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:



28
29
30
31
32
33
34
35
36
 
# File 'api/cask.rb', line 28

def self.fetch_cask_json!(name)
  endpoint = "cask/#{name}.json"
  json_cask, updated = Homebrew::API.fetch_json_api_file endpoint

  json_cask = JSON.parse((HOMEBREW_CACHE_API/endpoint).read) unless updated

  cache["cask_json"] ||= {}
  cache["cask_json"][name] = json_cask
end

.fetch_tap_migrations!(download_queue: Homebrew.default_download_queue, stale_seconds: nil, enqueue: false) ⇒ 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) (defaults to: Homebrew.default_download_queue)
  • stale_seconds (Integer, nil) (defaults to: nil)
  • enqueue (Boolean) (defaults to: false)

Returns:



95
96
97
98
 
# File 'api/cask.rb', line 95

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

.source_download(cask, download_queue: Homebrew.default_download_queue, enqueue: false) ⇒ Homebrew::API::SourceDownload

This method is part of a private API. This method may only be 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:



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'api/cask.rb', line 45

def self.source_download(cask, download_queue: Homebrew.default_download_queue, enqueue: false)
  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",
  )

  if enqueue
    download_queue.enqueue(download)
  elsif !download.symlink_location.exist?
    download.fetch
  end

  download
end

.source_download_cask(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:



71
72
73
74
75
76
 
# File 'api/cask.rb', line 71

def self.source_download_cask(cask)
  download = source_download(cask)

  ::Cask::CaskLoader::FromPathLoader.new(download.symlink_location)
                                    .load(config: cask.config)
end

.tap_migrations ⇒ 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:



140
141
142
143
144
145
146
147
 
# File 'api/cask.rb', line 140

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) 


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

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