AtpClient.Config (AtpClient v0.3.0)

Resolves configuration for each backend by merging (in increasing precedence):

Library defaults declared in this module under @defaults.
Application configuration under the :atp_client OTP app.
Per-call options passed as a Keyword.t().

Defaults are merged per key, so a partial config :atp_client, :sotptp, … in config.exs only overrides the keys it names; it cannot accidentally clobber :url and leave the library with no endpoint.

Example

In config/config.exs:

config :atp_client, :starexec,
  base_url: "https://starexec.example.org/starexec",
  username: System.get_env("STAREXEC_USER"),
  password: System.get_env("STAREXEC_PASS")

config :atp_client, :isabelle,
  host: "isabelle.example.org",
  port: 9999,
  password: System.get_env("ISABELLE_PASSWORD"),
  # `:local_dir` defaults to a subdirectory of `System.tmp_dir!/0`.
  # Only set it (and `:isabelle_dir`) when the BEAM and the Isabelle
  # server see the shared directory under different paths.
  session: "HOL"

Any setting may be overridden per call. For instance,

AtpClient.Isabelle.query(theory, "Example", session: "Main")

forces the Main session for that single query regardless of what is set in config.exs.

Summary

Types

backend()

Functions

defaults()

Returns the library defaults that get/2 layers underneath the Application env. Exposed mainly so tests and tooling can inspect what ships out of the box without parsing mix.exs.

fetch(backend, key, default, opts \\ [])

Returns the value of key from the resolved settings for backend, falling back to the given default if unset or set to nil.

fetch!(backend, key, opts \\ [])

Returns the value of key from the resolved settings for backend, raising a descriptive ArgumentError if unset or nil.

get(backend, opts \\ [])

Returns the fully resolved settings for the given backend as a keyword list.