Method: Unifig::Init.load_file

Defined in:

lib/unifig/init.rb

.load_file(file_path, env: nil) ⇒ Object

Loads a YAML file to configure Unifig.

Examples:

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

Parameters:

• file_path (String) —

  The path to a YAML config file.

• env (Symbol) (defaults to: nil) —

  An environment name to load.

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.

• (InvalidTypeError) —

  • A type 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