metavida / dotenv-haiku

A super-powered dotenv-rails that loads supports non-rails apps & protects you in production.

dotenv-haiku

A replacement of for dotenv-rails that meets a few specific requirements

• Enforce specific load rules
  • Load the .env.custom file on development environments.
  • Load the ".env.#{Rails.env}" file and fail hard if the file does not exist on production.
• Better supports older Rails versions and non-Rails apps.

Installation

Add this line to the top of your application's Gemfile:

gem 'dotenv-haiku', require: 'dotenv-haiku', git: '[e-mail]:metavida/dotenv-haiku.git'

And then execute:

$ bundle

Rails 4

Note on load order

dotenv is initialized in your Rails app during the before_configuration callback, which is fired when the Application constant is defined in config/application.rb with class Application < Rails::Application. If you need it to be initialized sooner, you can manually call Dotenv::Railtie.load.

# config/application.rb
Bundler.require(*Rails.groups)

Dotenv::Railtie.load

HOSTNAME = ENV['HOSTNAME']

If you use gems that require environment variables to be set before they are loaded, then list dotenv-rails in the Gemfile before those other gems and require dotenv/rails-now.

gem 'dotenv-haiku', require: 'dotenv-haiku/now', git: '[e-mail]:metavida/dotenv-haiku.git'
gem 'gem-that-requires-env-variables'

Rails 3

As early as possible in your application bootstrap process, load .env:

# config/application.rb
require 'dotenv-haiku/now'

Rails 1

# config/environment.rb
# in the `Rails::Initializer.run do |config|` block
require 'dotenv-haiku/now'

non-Rails

Currently, the gem depends on ActiveSupport::StringInquirer behavior, so you have 2 options

Include the ActiveSupport gem

gem 'active_support'

And then execute:

$ bundle

As early as possible in your application bootstrap process, load .env:

require 'active_support/string_inquirer'
require 'dotenv-haiku'
Dotenv::App.load(:app_env => ActiveSupport::StringInquirer.new(ENV["RACK_ENV"]))
# Yup, that's right. These references to "rails"
# should work, even for non-Rails apps

Emulate StringInquirer behavior

As early as possible in your application bootstrap process, load .env:

class MyStringInquirer < String
  def method_missing(method_name, *arguments)
    if method_name.to_s[-1,1] == "?"
      self == method_name.to_s[0..-2]
    else
      super
    end
  end
end

require 'dotenv-haiku'
Dotenv::App.load(:app_env => MyStringInquirer.new(ENV["RACK_ENV"]))

Contributing

If you want a better idea of how dotenv works, check out the Ruby Rogues Code Reading of dotenv.

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Added some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request