Class: Qonfig::Commands::Instantiation::ValuesFile Private

Inherits:
Base
  • Object
show all
Defined in:
lib/qonfig/commands/instantiation/values_file.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.17.0

Constant Summary collapse

SELF_LOCATED_FILE_DEFINITION =

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

Returns:

  • (Symbol)

Since:

  • 0.17.0

:self
NO_EXPOSE =

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

Returns:

  • (NilClass)

Since:

  • 0.17.0

nil
DEFAULT_STRICT_BEHAVIOR =

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

Returns:

  • (Boolean)

Since:

  • 0.17.0

false
DEFAULT_FORMAT =

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

Returns:

  • (Symbol)

Since:

  • 0.17.0

:dynamic

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Base

inheritable=, inheritable?, #inheritable?, inherited

Constructor Details

#initialize(file_path, caller_location, format: DEFAULT_FORMAT, strict: DEFAULT_STRICT_BEHAVIOR, expose: NO_EXPOSE) ⇒ 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.

Parameters:

  • file_path (String, Symbol)
  • caller_location (String)
  • format (Hash) (defaults to: DEFAULT_FORMAT) —

    a customizable set of options

  • strict (Hash) (defaults to: DEFAULT_STRICT_BEHAVIOR) —

    a customizable set of options

  • expose (Hash) (defaults to: NO_EXPOSE) —

    a customizable set of options

Options Hash (format:):

  • (String, Symbol)

Options Hash (strict:):

  • (Boolean)

Options Hash (expose:):

  • (NilClass, String, Symbol)

Since:

  • 0.17.0



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/qonfig/commands/instantiation/values_file.rb', line 72

def initialize(
  file_path,
  caller_location,
  format: DEFAULT_FORMAT,
  strict: DEFAULT_STRICT_BEHAVIOR,
  expose: NO_EXPOSE
)
  prevent_incompatible_attributes!(file_path, format, strict, expose)

  @file_path = file_path
  @caller_location = caller_location
  @format = format
  @strict = strict
  @expose = expose
end

Instance Attribute Details

#caller_location ⇒ 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.17.0



43
44
45
 
# File 'lib/qonfig/commands/instantiation/values_file.rb', line 43

def caller_location
  @caller_location
end

#expose ⇒ NilClass, ... (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:

  • (NilClass, String, Symbol)

Since:

  • 0.17.0



61
62
63
 
# File 'lib/qonfig/commands/instantiation/values_file.rb', line 61

def expose
  @expose
end

#file_path ⇒ String, Symbol (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, Symbol)

Since:

  • 0.17.0



37
38
39
 
# File 'lib/qonfig/commands/instantiation/values_file.rb', line 37

def file_path
  @file_path
end

#format ⇒ String, Symbol (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, Symbol)

Since:

  • 0.17.0



49
50
51
 
# File 'lib/qonfig/commands/instantiation/values_file.rb', line 49

def format
  @format
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.17.0



55
56
57
 
# File 'lib/qonfig/commands/instantiation/values_file.rb', line 55

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:

Since:

  • 0.17.0



94
95
96
97
98
99
 
# File 'lib/qonfig/commands/instantiation/values_file.rb', line 94

def call(data_set, settings)
  settings_values = load_settings_values
  return unless settings_values
  settings_values = (settings_values[expose.to_sym] || settings_values[expose.to_s]) if expose
  data_set.configure(settings_values) if settings_values
end