defmodule Enux do @moduledoc """ A package for reading variables from env style and json configuration files and injecting them into your application. ## Installation ``` def deps do [ {:enux, "~> 0.9.2"}, # if you want to load json files, you should have either this {:jason, "~> 1.2"}, # or this {:poison, "~> 5.0"} ] end ``` ## Usage In elixir 1.11, `config/runtime.exs` was introduced. This is a file that is executed exactly before your application starts. This is a proper place to load any configuration variables into your app. If this file does not exist in your project directory, create it and add these lines to it: ``` import Config env = Enux.load() config :otp_app, env ``` When you start your application, you can access your configuration variables using `Applicatoin.get_env`. If you need to url encode your configuration values, just pass `url_encoded: true` to `Enux.load`. You should have either [poison](https://hex.pm/packages/poison) or [jason](https://hex.pm/packages/jason) in your dependencies if you want to use json files. You can load multiple files of different kinds: ``` import Config env1 = Enux.load("config/one.env", url_encoded: true) config :otp_app, env1 env2 = Enux.load("config/two.json") config :otp_app, :two, env2 ``` Another way of using Enux is using the `Enux.autoload` function which will load all `.env` and `.json` files in your `config` directory. it makes more sense to call this function in your `config/runtime.exs` but you can call it anywhere in your code. If you have `config/pg.env` and `config/redis.json` in your project directory, after calling `Enux.autoload(:otp_app)`, you can access the variables using `Application.get_env(:otp_app, :pg)` and `Application.get_env(:otp_app, :redis)`. if a file is named `.env` or `.json`, you should use `Application.get_env(:otp_app, :env)` or `Application.get_env(:otp_app, :json)` respectively. ``` Enux.autoload(:otp_app) ``` You may also use `Enux.expect` to both validate and document your required environment. first you need to define a schema: ``` schema = [ id: [&is_integer/1, fn id -> id > 1000 end], username: [&is_binary/1, fn u -> String.length(u) > 8 end], metadata: [], profile: [ full_name: [&is_binary/1], age: [&is_number/1] ] ] ``` then the following line will check for compliance of your environment under `:otp_app` and `:key` with the schema defined above (an empty list implies only checking for existence): ``` Enux.expect(:otp_app, :key, schema) ``` """ @doc """ reads the variables in `config/.env` and returns a formatted keyword list. all values are loaded as they are. """ def load() do File.stream!("config/.env", [], :line) |> Enux.Env.decode([]) end @doc """ reads the variables in `config/.env` and returns a formatted keyword list """ def load(opts) when is_list(opts) do File.stream!("config/.env", [], :line) |> Enux.Env.decode(opts) end @doc """ reads the variables in the given path(could be `.env` or `.json` file) and returns a formatted keyword list """ def load(path, opts \\ []) when is_binary(path) and is_list(opts) do case String.split(path, ".") |> Enum.at(1) |> String.to_atom() do :env -> File.stream!(path, [], :line) |> Enux.Env.decode(opts) :json -> File.read!(path) |> Enux.Json.decode(opts) ext -> raise RuntimeError, message: "unsupported file type: #{ext}" end end @doc """ automatically loads all `.env` and `.json` files in your `config` directory. pass your project's name as an atom. you can also still pass `url_encoded: true` to it. """ def autoload(app, opts \\ []) when is_atom(app) and is_list(opts) do files = File.ls!("config") |> Enum.map(fn f -> f |> String.split(".") end) |> Enum.filter(fn [_, ext] -> ext in ["json", "env"] end) |> Enum.map(fn f -> Enum.join(f, ".") end) cond do Enum.empty?(files) -> raise RuntimeError, message: "There is no .env or .json file in your config directory" true -> files |> Enum.map(fn f -> [f, Enux.load("config/#{f}", opts)] end) |> Enum.each(fn [f, kwl] -> key = case f do ".env" -> :env ".json" -> :json _ -> String.split(f, ".") |> Enum.at(0) |> String.to_atom() end Application.put_env(app, key, kwl) end) end end @doc """ checks if the environment variables under `app` and `key` comply with the given `schema`. any non-compliance results in an error. you can use this function for both validating and documenting your required environment. """ def expect(app, key, schema) when is_atom(app) and is_atom(key) and is_list(schema) do if !Keyword.keyword?(schema) do raise ArgumentError, message: "the third argument to Enux.expect/3 should be a keyword list" end case Application.get_env(app, key) do nil -> raise RuntimeError, message: "environment with key #{key} does not exist" env -> check(env, schema) end end defp check(env, schema, parents \\ []) when is_list(env) and is_list(schema) and is_list(parents) do schema |> Enum.each(fn {key, sub_schema} -> case env |> Keyword.get(key) do nil -> raise RuntimeError, message: "your environment should contain #{parents |> Enum.reverse() |> Enum.join(".")}.#{key}" value -> cond do Keyword.keyword?(value) -> check(value, sub_schema, [key | parents]) true -> check_item(value, sub_schema, [key | parents]) end end end) end defp check_item(value, conditions, parents) when is_list(conditions) and is_list(parents) do conditions |> Enum.each(fn c -> case check_item(value, c) do false -> raise RuntimeError, message: "condition #{inspect(c)} was not met for #{parents |> Enum.reverse() |> Enum.join(".")}" true -> nil end end) end defp check_item(value, condition) when is_function(condition) do condition.(value) end end