Introduction

The Athena::Dotenv component parses the .env files to make ENV vars stored within them accessible. Using Environment variables (ENV vars) is a common practice to configure options that depend on where the application is run; allowing the application's configuration to be de-coupled from its code. E.g. anything that changes from one machine to another, such as database credentials.

.env files are a convenient way to get the benefits of ENV vars, without taking on the extra complexity of other tools/abstractions until if/when they are needed. The file(s) can be defined at the root of your project for development, or placed next to the binary if running outside of a dev environment.

Installation

First, install the component by adding the following to your shard.yml, then running shards install:

dependencies:
  athena-dotenv:
    github: athena-framework/dotenv
    version: ~> 0.1.0

Usage

In most cases all that needs to be done is:

require "athena-dotenv"

# For most use cases, returns a `Athena::Dotenv` instance.
dotenv = Athena::Dotenv.load # Loads .env

# Multiple files may also be loaded if needed
Athena::Dotenv.load ".env", ".env.local"

For more complex setups, the Athena::Dotenv instance can be manually instantiated. E.g. to use the other helper methods such as #load_environment, #overload, or #populate

require "athena-dotenv"

dotenv = Athena::Dotenv.new

# Overrides existing variables
dotenv.overload ".env.overrides"

# Load all files for the current $APP_ENV
# .env, .env.local, and .env.$APP_ENV.local or .env.$APP_ENV
dotenv.load_environment ".env"

Athena::Dotenv::Exceptions::Path error will be raised if the provided file was not found, or is not readable.