Module: Homebrew::API::Formula Private

Extended by:
Cachable
Defined in:
api/formula.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 formula JSON API.

Class Method Summary collapse

Methods included from Cachable

cache, clear_cache

Class Method Details

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

  • (Hash) 


52
53
54
55
56
57
58
59
 
# File 'api/formula.rb', line 52

def all_aliases
  unless cache.key?("aliases")
    json_updated = download_and_cache_data!
    write_names_and_aliases(regenerate: json_updated)
  end

  cache["aliases"]
end

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

  • (Hash) 


42
43
44
45
46
47
48
49
 
# File 'api/formula.rb', line 42

def all_formulae
  unless cache.key?("formulae")
    json_updated = download_and_cache_data!
    write_names_and_aliases(regenerate: json_updated)
  end

  cache["formulae"]
end

.download_and_cache_data! ⇒ 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.

Returns:

  • (Boolean) 


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

def download_and_cache_data!
  json_formulae, updated = Homebrew::API.fetch_json_api_file "formula.jws.json",
                                                             target: HOMEBREW_CACHE_API/"formula.jws.json"

  cache["aliases"] = {}
  cache["formulae"] = json_formulae.to_h do |json_formula|
    json_formula["aliases"].each do |alias_name|
      cache["aliases"][alias_name] = json_formula["name"]
    end

    [json_formula["name"], json_formula.except("name")]
  end

  updated
end

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

  • (Hash) 


19
20
21
 
# File 'api/formula.rb', line 19

def fetch(name)
  Homebrew::API.fetch "formula/#{name}.json"
end

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


62
63
64
65
66
67
68
69
70
71
72
 
# File 'api/formula.rb', line 62

def write_names_and_aliases(regenerate: false)
  download_and_cache_data! unless cache.key?("formulae")

  return unless Homebrew::API.write_names_file(all_formulae.keys, "formula", regenerate: regenerate)

  (HOMEBREW_CACHE_API/"formula_aliases.txt").open("w") do |file|
    all_aliases.each do |alias_name, real_name|
      file.puts "#{alias_name}|#{real_name}"
    end
  end
end