Module: ConfigToolkit::ConfigToolkitConfig::UnknownConfigParamBehavior

Defined in:
lib/configtoolkit/configtoolkitconfig.rb

Overview

This module is a (hacky) enumeration of the possible values for the ConfigToolkitConfig’s unknown_config_param_behavior parameter.

Constant Summary collapse

IGNORE =

The ConfigToolkit will ignore unknown configuration parameters when loading a configuration.

:ignore
WARN =

The ConfigToolkit will warn about unknown configuration parameters when loading a configuration. This is the default.

:warn
ERROR =

The ConfigToolkit will raise an error when it encounters an unknown configuration paramater when loading a configuration.

:error

Class Method Summary collapse

Class Method Details

.valid?(value) ⇒ Boolean

Description:

This class method returns true if and only if value is a valid UnknownConfigParamBehavior constant.

Parameters:

value

The value to verify

Returns:

True if and only if value is a valid UnknownConfigParamBehavior constant.

Returns:



54
55
56
57
58
 
# File 'lib/configtoolkit/configtoolkitconfig.rb', line 54

def self.valid?(value)
  return (value == UnknownConfigParamBehavior::IGNORE ||
          value == UnknownConfigParamBehavior::WARN ||
          value == UnknownConfigParamBehavior::ERROR)
end