Module: Philiprehberger::EnvLoader

Defined in:
lib/philiprehberger/env_loader.rb,
lib/philiprehberger/env_loader/version.rb

Defined Under Namespace

Classes: Error, ValidationError

Constant Summary collapse

VERSION = 
'0.2.1'

Class Method Summary collapse

Class Method Details

.generate_template(output:, keys: []) ⇒ void

This method returns an undefined value.

Generate a .env.template file listing all currently loaded keys.

Parameters:

  • output (String) —

    the output file path

  • keys (Array<String>) (defaults to: []) —

    keys to include (defaults to all loaded ENV keys)



62
63
64
65
66
 
# File 'lib/philiprehberger/env_loader.rb', line 62

def self.generate_template(output:, keys: [])
  target_keys = keys.empty? ? ENV.keys.sort : keys.map(&:to_s).sort
  content = target_keys.map { |key| "#{key}=" }.join("\n")
  File.write(output, "#{content}\n")
end

.load(*files, required: [], types: {}, defaults: {}, prefix: nil, strip_prefix: false) ⇒ Hash<String, String>

Load environment variables from one or more .env files with options.

Files are loaded in order; later files take precedence. Existing ENV values take precedence over all files unless overridden.

Parameters:

  • files (Array<String>) —

    paths to .env files

  • required (Array<String>) (defaults to: []) —

    keys that must be present after loading

  • types (Hash<String, Symbol>) (defaults to: {}) —

    type coercions (:integer, :float, :boolean)

  • defaults (Hash<String, String>) (defaults to: {}) —

    default values for missing keys

Returns:

  • (Hash<String, String>) —

    the loaded key-value pairs

Raises:



21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/philiprehberger/env_loader.rb', line 21

def self.load(*files, required: [], types: {}, defaults: {}, prefix: nil, strip_prefix: false)
  loaded = {}

  defaults.each { |key, value| loaded[key.to_s] = value.to_s }

  files.each do |file|
    next unless File.exist?(file)

    parse_file(file).each { |key, value| loaded[key] = value }
  end

  loaded.each { |key, value| ENV[key] = value unless ENV.key?(key) }

  missing = required.map(&:to_s).select { |key| ENV[key].nil? || ENV[key].empty? }
  raise ValidationError, "missing required keys: #{missing.join(', ')}" unless missing.empty?

  coerce_types(types)

  if prefix
    loaded = loaded.select { |key, _| key.start_with?(prefix) }
    loaded = loaded.transform_keys { |key| key.delete_prefix(prefix) } if strip_prefix
  end

  loaded
end

.validate!(*keys) ⇒ void

This method returns an undefined value.

Validate that all specified keys are present and non-empty in ENV.

Parameters:

  • keys (Array<String>) —

    keys to validate

Raises:



52
53
54
55
 
# File 'lib/philiprehberger/env_loader.rb', line 52

def self.validate!(*keys)
  missing = keys.map(&:to_s).select { |key| ENV[key].nil? || ENV[key].empty? }
  raise ValidationError, "missing required keys: #{missing.join(', ')}" unless missing.empty?
end