brew/Library/Homebrew/api/formula.rb

# typed: false
# frozen_string_literal: true

module Homebrew
  module API
    # Helper functions for using the formula JSON API.
    #
    # @api private
    module Formula
      class << self
        extend T::Sig

        sig { returns(String) }
        def formula_api_path
          "formula"
        end
        alias generic_formula_api_path formula_api_path

        sig { returns(String) }
        def cached_formula_json_file
          HOMEBREW_CACHE_API/"#{formula_api_path}.json"
        end

        sig { params(name: String).returns(Hash) }
        def fetch(name)
          Homebrew::API.fetch "#{formula_api_path}/#{name}.json"
        end

        sig { returns(Array) }
        def all_formulae
          @all_formulae ||= begin
            curl_args = %w[--compressed --silent https://formulae.brew.sh/api/formula.json]
            if cached_formula_json_file.exist? && !cached_formula_json_file.empty?
              curl_args.prepend("--time-cond", cached_formula_json_file)
            end
            curl_download(*curl_args, to: cached_formula_json_file, max_time: 5)

            json_formulae = JSON.parse(cached_formula_json_file.read)

            json_formulae.to_h do |json_formula|
              [json_formula["name"], json_formula.except("name")]
            end
          end
        end
      end
    end
  end
end