Module: Unifig::Init

Defined in:

lib/unifig/init.rb

Overview

Initializes Unifig with methods based on YAML.

Class Method Summary

• .load(str, env: nil) ⇒ Object

  Loads a string of YAML to configure Unifig.

• .load_file(file_path, env: nil) ⇒ Object

  Loads a YAML file to configure Unifig.

Class Method Details

.load(str, env: nil) ⇒ Object

Loads a string of YAML to configure Unifig.

Examples:

Unifig::Init.load("config:\n  envs:\n    development:\n      providers: local\n\nFOO_BAR:\n  value: \"baz\"\n", env: :development)

Raises:

• (YAMLSyntaxError) —

  • Invalid YAML

• (MissingRequiredError) —

  • One or more required variables are missing values.

• (MissingConfigError) —

  • No config section was provided.

• (MissingProviderError) —

  • The given provider is not in the list of available providers.

• (CyclicalSubstitutionError) —

  • Subtitutions resulted in a cyclical dependency.

• (MissingSubstitutionError) —

  • A substitution does not exist.

# File 'lib/unifig/init.rb', line 27

def load(str, env: nil)
  yml = Psych.load(str, symbolize_names: true)
  exec!(yml, env: env)
rescue Psych::SyntaxError, Psych::BadAlias => e
  raise YAMLSyntaxError, e.message
end

.load_file(file_path, env: nil) ⇒ Object

Loads a YAML file to configure Unifig.

Examples:

Unifig::Init.load_file('config.yml', env: :development)

Raises:

• (YAMLSyntaxError) —

  • Invalid YAML

• (MissingRequiredError) —

  • One or more required variables are missing values.

• (MissingConfigError) —

  • No config section was provided.

• (MissingProviderError) —

  • The given provider is not in the list of available providers.

• (CyclicalSubstitutionError) —

  • Subtitutions resulted in a cyclical dependency.

• (MissingSubstitutionError) —

  • A substitution does not exist.

# File 'lib/unifig/init.rb', line 43

def load_file(file_path, env: nil)
  # Ruby 2.7 Psych.load_file doesn't support the :symbolize_names flag.
  # After Ruby 2.7 this can be changed to Psych.load_file if that's faster.
  load(File.read(file_path), env: env)
end