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_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:



67
68
69
70
71
72
73
74
 
# File 'api/cask.rb', line 67

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:



77
78
79
80
81
82
83
84
 
# File 'api/cask.rb', line 77

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 ⇒ Object

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



43
44
45
 
# File 'api/cask.rb', line 43

def self.cached_json_file_path
  HOMEBREW_CACHE_API/DEFAULT_API_FILENAME
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:



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

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:



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

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) 


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

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