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.

Class Method Summary collapse

Methods included from Cachable

cache, clear_cache

Class Method Details

.all_casks ⇒ Hash{String => Hash}

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



61
62
63
64
65
66
67
68
 
# File 'api/cask.rb', line 61

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:



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

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

  cache.fetch("renames")
end

.fetch(token) ⇒ Hash

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



16
17
18
 
# File 'api/cask.rb', line 16

def self.fetch(token)
  Homebrew::API.fetch "cask/#{token}.json"
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:



21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
 
# File 'api/cask.rb', line 21

def self.source_download(cask)
  path = cask.ruby_source_path.to_s || "Casks/#{cask.token}.rb"
  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::Download.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

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


81
82
83
84
85
 
# File 'api/cask.rb', line 81

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