exenv.ex

defmodule Exenv do
  @moduledoc """
  Loads env vars using an adapter-based approach.

  Exenv dynamically assigns env vars on application start using whatever adapters
  have been configured to run. By default, Exenv is setup to use the included
  `Exenv.Adapters.Dotenv` adapter - loading env vars from a `.env` file in your
  projects directory on startup.

  ## Configuration

  If you need to further configure Exenv - it is typically done via application config.

      config :exenv, [
        adapters: [
          {Exenv.Adapters.Dotenv, [file: "path/to/.env"]}
        ]
      ]

  You can simply list the adapters and any options you would like to pass to it
  via `{MyAdapter, opts}` - where `opts` is a keyword list of options defined by
  the adapter.

  Alternatively, you can also configure Exenv to be used via your own supervision
  tree. In this case simply add the following to your config:

      config :exenv, start_on_application: false

  You can then add Exenv to your supervisor.

      children = [
        {Exenv, [adapters: [{Exenv.Adapters.Dotenv, [file: "path/to/.env"]}]]}
      ]

  ## Encryption

  Exenv has support for encryption out of the box. This allows you to keep an
  encrypted secrets file checked into your repository. Please see `Exenv.Encryption`
  for more details.

  """

  use Application

  alias Exenv.Utils

  @type on_load :: [{Exenv.Adapter.t(), Exenv.Adapter.result()}]

  @impl true
  @spec start(any(), any()) :: {:ok, pid()}
  def start(_type, _args) do
    if Exenv.Config.get(:start_on_application) do
      start_link()
    else
      Supervisor.start_link([], strategy: :one_for_one)
    end
  end

  @doc """
  Starts the Exenv process.
  """
  @spec start_link(any()) :: Supervisor.on_start()
  def start_link(opts \\ []) do
    Exenv.Supervisor.start_link(opts)
  end

  @doc false
  def child_spec(opts \\ []) do
    %{
      id: Exenv.Supervisor,
      start: {Exenv.Supervisor, :start_link, [opts]}
    }
  end

  @doc """
  Returns `{:ok, binary}`, where binary is a binary data object that contains the
  contents of path, or `{:error, reason}` if an error occurs.

  You can optionally pass an mfa `{module, function, args}` that will be evaluated
  and should return the intended path. This allows for runtime setup.

  ## Options
    * `:encryption` - options used to decrypt the binary result if required.

    ```
    # Decrypts the file using the MASTER_KEY env var
    [encryption: true]

    # Decrypts the file using the master key file
    [encryption: [master_key: "/path/to/master.key"]]
    ```

  """
  @spec read_file(binary() | mfa(), keyword()) :: {:ok, binary} | {:error, any()}
  def read_file(path_or_mfa, opts \\ []) do
    try do
      path = Utils.build_path(path_or_mfa)
      encryption = Keyword.get(opts, :encryption, false)

      file =
        if encryption do
          encryption = if is_list(encryption), do: encryption, else: []

          encryption
          |> Keyword.get(:master_key)
          |> Exenv.Encryption.get_master_key!()
          |> Exenv.Encryption.decrypt_secrets!(path)
        else
          File.read!(path)
        end

      {:ok, file}
    rescue
      error -> {:error, error}
    end
  end

  @doc """
  Loads all env vars using the adapters defined within our config.
  """
  @spec load() :: on_load()
  def load do
    Exenv.Server.load()
  end

  @doc """
  Loads all env vars using the adapter config provided.
  """
  @spec load(adapters :: [Exenv.Adapter.config()]) :: on_load()
  def load(adapters) when is_list(adapters) do
    for {adapter, opts} <- adapters do
      result = load(adapter, opts)
      {adapter, result}
    end
  end

  @doc """
  Loads env vars using the adapter and options provided.
  """
  @spec load(adapter :: Exenv.Adapter.t(), opts :: keyword()) :: Exenv.Adapter.result()
  def load(adapter, opts) when is_atom(adapter) and is_list(opts) do
    apply(adapter, :load, [opts])
  end
end