Class: Qonfig::Commands::LoadFromYAML Private

Inherits:
Base
  • Object
show all
Defined in:
lib/qonfig/commands/load_from_yaml.rb

Overview

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

Since:

  • 0.2.0

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(file_path, strict: true) ⇒ LoadFromYAML

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of LoadFromYAML.

Parameters:

  • file_path (String)
  • strict (Hash) (defaults to: true) —

    a customizable set of options

Options Hash (strict:):

  • (Boolean)

Since:

  • 0.2.0



23
24
25
26
 
# File 'lib/qonfig/commands/load_from_yaml.rb', line 23

def initialize(file_path, strict: true)
  @file_path = file_path
  @strict = strict
end

Instance Attribute Details

#file_path ⇒ String (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

  • (String)

Since:

  • 0.2.0



10
11
12
 
# File 'lib/qonfig/commands/load_from_yaml.rb', line 10

def file_path
  @file_path
end

#strict ⇒ Boolean (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

  • (Boolean)

Since:

  • 0.2.0



16
17
18
 
# File 'lib/qonfig/commands/load_from_yaml.rb', line 16

def strict
  @strict
end

Instance Method Details

#call(data_set, settings) ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Parameters:

Raises:

Since:

  • 0.2.0



36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/qonfig/commands/load_from_yaml.rb', line 36

def call(data_set, settings)
  yaml_data = Qonfig::Loaders::YAML.load_file(file_path, fail_on_unexist: strict)

  raise(
    Qonfig::IncompatibleYAMLStructureError,
    'YAML content should have a hash-like structure'
  ) unless yaml_data.is_a?(Hash)

  yaml_based_settings = build_data_set_klass(yaml_data).new.settings

  settings.__append_settings__(yaml_based_settings)
end