Packages
surgex
2.0.0
6.0.1
6.0.0
5.1.1
5.1.0
5.0.0
5.0.0-git-015aa39a
4.15.2
4.15.1
4.15.1-git-98b3
4.15.0
4.15.0-git-943e
4.15.0-git-5806
4.14.1
4.14.0
4.13.1
4.13.0
4.12.0
4.11.0
4.11.0-git-97d4
4.11.0-git-14c8
4.10.0
4.10.0-git-37f2
4.9.0
4.9.0-git-9d5f
4.8.1-git-80a7
4.8.0
4.8.0-git-fbda
4.8.0-git-e058
4.7.0
4.7.0-git-5414
4.6.1
4.6.0
4.5.0
4.4.0
4.3.0
4.2.1
4.2.0
4.1.1
4.1.1-git-9f6b
4.1.1-git-6f0cd
4.1.0
4.1.0-git-e934
4.1.0-git-8c28
4.1.0-git-56a9
4.1.0-git-55fd
4.0.0
3.2.8
3.2.7
3.2.6
3.2.5
3.2.4
3.2.3
3.2.2
3.2.1
3.2.0
retired
3.1.0
3.0.0
2.24.1
2.24.0
retired
2.23.0
2.22.0
2.21.0
2.20.1
2.20.0
2.19.0
2.18.1
2.18.0
2.17.0
2.16.0
2.15.0
2.14.0
2.13.0
2.12.1
2.12.0
2.11.0
2.10.0
2.9.0
2.8.0
2.7.0
2.6.0
2.5.1
2.5.0
2.4.0
retired
2.3.0
2.2.1
2.2.0
2.1.1
2.1.0
2.0.0
1.6.0
1.5.2
1.5.1
1.5.0
1.4.0
1.3.1
retired
1.3.0
retired
1.2.1
1.2.0
1.1.0
1.0.0
0.5.2
0.5.1
0.5.0
0.4.3
0.4.2
0.4.1
0.4.0
0.3.3
0.3.2
0.3.1
0.3.0
0.2.0
0.1.0
All Things Elixir @ Surge Ventures Inc, the creators of Fresha
Current section
Files
Jump to
Current section
Files
lib/surgex/config/config.ex
defmodule Surgex.Config do
@moduledoc """
Application config getter, aka. `Application.get_env` on steroids.
This getter embodies the usage of `{:system, "ENV_VAR_NAME"}` convention for managing configs via
system env vars on environments like Heroku. This convention is further extended here to allow
type casting and falling back to defaults in such tuples.
Configs are assumed to live in app-specific parent scope, which is by default set to `:surgex`,
but should be set to actual application name. Then, all Mix configs that will be fetched via
`Surgex.Config` should be nested in that scope.
Here's how your `prod.exs` may look:
config :surgex,
config_app_name: :my_project
config :my_project,
pool_size: {:system, "POOL_SIZE", :integer, 5},
feature_x_enabled: {:system, "FEATURE_X_ENABLED", :boolean, false}
config :my_project, :api,
url: {:system, "API_URL"},
enabled: {:system, "API_ENABLED", :boolean, true}
> In other env configs, like `config.exs` and `dev.exs`, you'll usually follow the Elixir
convention to simply fill the relevant keys with hard-coded values, optionally extracting them
to `*.secret.exs` gitignored files to hold out-of-repo settings.
Having that, you can use either `get/1` or `get/2` to get specific config values in all envs.
"""
@app_name Application.get_env(:surgex, :config_app_name, :surgex)
@doc """
Gets the config value for specified scope and key.
## Examples
iex> Mix.Config.persist(surgex: [api: [url: "example.com"]])
[:surgex]
iex> Surgex.Config.get(:api, :url)
"example.com"
"""
def get(scope, key) do
@app_name
|> Application.get_env(scope)
|> Keyword.fetch(key)
|> parse_fetch
end
@doc """
Gets the config value for specified key.
## Examples
iex> Mix.Config.persist(surgex: [feature_enabled: true])
[:surgex]
iex> Surgex.Config.get(:feature_enabled)
true
"""
def get(key) do
@app_name
|> Application.fetch_env(key)
|> parse_fetch
end
defp parse_fetch({:ok, value}), do: parse(value)
defp parse_fetch(:error), do: nil
@doc """
Parses a config value which may or may not be a system tuple.
## Examples
iex> Surgex.Config.parse("value")
"value"
iex> Surgex.Config.parse({:system, "NON_EXISTING_ENV_VAR"})
nil
iex> Surgex.Config.parse({:system, "NON_EXISTING_ENV_VAR", "default value"})
"default value"
"""
def parse({:system, env}), do: get_env(env)
def parse({:system, env, opts}) do
type = Keyword.get(opts, :type)
default = Keyword.get(opts, :default)
env
|> get_env
|> apply_type(type)
|> apply_default(default)
end
def parse(value), do: value
defp get_env(env) when is_binary(env), do: System.get_env(env)
defp get_env(envs) when is_list(envs) do
Enum.find_value(envs, &get_env/1)
end
defp apply_type(value, nil), do: value
defp apply_type("1", :boolean), do: true
defp apply_type("0", :boolean), do: false
defp apply_type(_, :boolean), do: nil
defp apply_type(value, :integer) when is_binary(value) do
case Integer.parse(value) do
{integer, ""} -> integer
_ -> nil
end
end
defp apply_type(_, :integer), do: nil
defp apply_default(value, nil), do: value
defp apply_default(nil, default), do: default
defp apply_default(value, _default), do: value
end