module Config

Get a Config value

This is the preferred and uniform way to access config vars because defaults are included in the lookup

Uses defaults if available. Converts upper-case ENV var names to lower-case default names.

Order of precedence is: 1) app’s local ENV 2) default values

Config == nil

Config.default(:foo, ‘bar’) Config == ‘bar’

ENV = ‘baz’ Config == ‘baz’

@param key [Symbol] The lower-case name of the ENV value @return [String] The value of the ENV value or default.

# File lib/env-conf.rb, line 31
def self.[](name)
  var_name = name.to_s.upcase
  default_name = name.to_s.downcase.to_sym
  ENV[var_name] || @@dotenv[var_name] || @@defaults[default_name]
end

The ‘APP_DEPLOY` env var is used to identify which deploy of the codebase is running in librato. This usually matches the name of the environment such as local, production, staging, etc.

@return [String] The deploy/environment of the app

# File lib/env-conf.rb, line 112
def self.app_deploy
  env("APP_DEPLOY")
end

The ‘RACK_ENV` env var is used to identify the app mode

@return [Symbol] The environment of the app

# File lib/env-conf.rb, line 119
def self.app_env
  env!("RACK_ENV").to_sym
end

The ‘APP_NAME` env var is used to identify which codebase is running in librato. This usually matches the name of the repository.

@return [String] The name of the app

# File lib/env-conf.rb, line 103
def self.app_name
  env("APP_NAME")
end

Comma-separated words converted to an array.

@param name [String] The name of the environment variable to fetch an

array for.

@raise [RuntimeError] Raised if the environment variable is not defined. @return [Array] An array of values.

# File lib/env-conf.rb, line 156
def self.array(name)
  env(name).to_s.split(',')
end

An environment variable converted to a bool.

@param name [String] The name of the environment variable to fetch a

boolean for.

@return [bool] True if the value is ‘true`, otherwise false.

# File lib/env-conf.rb, line 165
def self.bool?(name)
  self[name] == true || self[name] == 'true'
end

The database URL from the environment.

@param kind [String] Optionally, the leading name of ‘*_DATABASE_URL`

environment variable.  Defaults to `DATABASE_URL`.

@raise [RuntimeError] Raised if the environment variable is not defined.

# File lib/env-conf.rb, line 135
def self.database_url(kind = '')
  kind = "#{kind}_".upcase unless kind.empty?
  env!("#{kind}DATABASE_URL")
end

Set a default Defaults are supplied when accessing via Config

@param key [Symbol/String] The lower-case name of the default @return [String] The value of the default

# File lib/env-conf.rb, line 58
def self.default(key, value)
  @@defaults[key.to_s.downcase.to_sym] = value
end

Get all the defaults @return [Hash] The current set of defaults

# File lib/env-conf.rb, line 64
def self.defaults
  @@defaults
end

@return [Bool] True if the service is in development mode.

# File lib/env-conf.rb, line 95
def self.development?
  self['RACK_ENV'] == 'development'
end

Loads a “.env” file, using Dotenv to parse but not fuck up the ENV

# File lib/env-conf.rb, line 187
def self.dotenv!
  return if Config.production?
  require 'dotenv'
  ['.env','.env.local',".env.#{Config[:rack_env]}",".env.#{Config[:rack_env]}.local"].each do |filename|
    if File.exists?(filename)
      @@dotenv.update(Dotenv::Parser.call(File.read(filename)))
    end
  end
end

An environment variable.

@param name [String] The name of the environment variable to fetch a

value for.

@return [String] The value of the environment variable or nil if no

match is available.

# File lib/env-conf.rb, line 49
def self.env(name)
  self[name]
end

An environment variable.

@param name [String] The name of the environment variable to fetch a

value for.

@raise [RuntimeError] Raised if the environment variable is not defined. @return [String] The value of the environment variable.

# File lib/env-conf.rb, line 74
def self.env!(name)
  self[name] || raise("missing #{name}")
end

An environment variable converted to a Fixnum.

@param name [String] The name of the environment variable to fetch a

Fixnum for.

@return [Fixnum] The number or nil if the value couldn’t be coerced to a

Fixnum.

# File lib/env-conf.rb, line 146
def self.int(name)
  self[name] && Integer(self[name])
end

The port to listen on for web requests.

@return [Fixnum] The port to listen on for web requests.

# File lib/env-conf.rb, line 126
def self.port
  env!("PORT").to_i
end

The ‘RACK_ENV` environment variable is used to determine whether the service is in production mode or not.

@return [Bool] True if the service is in production mode.

# File lib/env-conf.rb, line 82
def self.production?
  self['RACK_ENV'] == 'production'
end

Reset defaults values

# File lib/env-conf.rb, line 38
def self.reset!
  @@defaults = {}
  @@dotenv   = {}
end

The ‘RACK_ENV` environment variable is used to determine whether the service is in test mode or not.

@return [Bool] True if the service is in test mode.

# File lib/env-conf.rb, line 90
def self.test?
  self['RACK_ENV'] == 'test'
end

An environment variable converted to a time.

@param name [String|Symbol] The name of the environment variable to fetch a

boolean for.

@return [Time] Time if the value is parseable, otherwise false.

# File lib/env-conf.rb, line 174
def self.time(name)
  self[name] && Time.parse(self[name])
end

An environment variable converted to a URI.

@param name [String|Symbol] The name of the environment variable. @return [URI] URI if the value is parseable, otherwise false.

# File lib/env-conf.rb, line 182
def self.uri(name)
  self[name] && URI.parse(self[name])
end