Module: EnvUtils

Defined in:
lib/env_utils.rb,
lib/env_utils/version.rb

Overview

EnvUtils is a library for getting environment variables.

Defined Under Namespace

Classes: Error

Constant Summary collapse

VERSION = 
"0.1.4"

Instance Method Summary collapse

Instance Method Details

#get_array_env(key, options = {}) ⇒ Object 



55
56
57
58
59
 
# File 'lib/env_utils.rb', line 55

def get_array_env(key, options = {})
  options.merge!({ is_array: true })

  get_env_var(key, options)
end

#get_bool_env(key, options = {}) ⇒ Object 



49
50
51
52
53
 
# File 'lib/env_utils.rb', line 49

def get_bool_env(key, options = {})
  options.merge!({ is_integer: false, is_boolean: true, is_array: false })

  get_env_var(key, options)
end

#get_env_var(key, options = {}) ⇒ String?

Get the value of an environment variable.

Parameters:

  • name (String) —

    the name of the environment variable

Returns:

  • (String, nil) —

    the value of the environment variable, or nil if it is not set



13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
 
# File 'lib/env_utils.rb', line 13

def get_env_var(key, options = {})
  fallback = ENV["RAILS_ENV"] == "development" ? options[:dev_default] : nil
  fallback ||= options[:default]

  env_value = ENV[key] || fallback

  is_string = env_value.is_a?(String)

  return nil if env_value.nil? && !options[:is_boolean]

  return env_value == "true" if options[:is_boolean]

  return env_value.split(options[:separator] || ",").collect(&:strip) if options[:is_array] && is_string

  return env_value.to_i if options[:is_integer] && is_string

  return env_value.to_f if options[:is_float] && is_string

  env_value
end

#get_float_env(key, options = {}) ⇒ Object 



44
45
46
47
 
# File 'lib/env_utils.rb', line 44

def get_float_env(key, options = {})
  options.merge!({ is_integer: false, is_boolean: false, is_array: false, is_float: true })
  get_env_var(key, options)
end

#get_integer_env(key, options = {}) ⇒ Object 



39
40
41
42
 
# File 'lib/env_utils.rb', line 39

def get_integer_env(key, options = {})
  options.merge!({ is_integer: true, is_boolean: false, is_array: false })
  get_env_var(key, options)
end

#get_string_env(key, options = {}) ⇒ Object 



34
35
36
37
 
# File 'lib/env_utils.rb', line 34

def get_string_env(key, options = {})
  options.merge!({ is_integer: false, is_boolean: false, is_array: false })
  get_env_var(key, options)
end