Module: NcsNavigator

Defined in:

lib/ncs_navigator/configuration.rb,
lib/ncs_navigator/configuration/version.rb

Defined Under Namespace

Classes: Configuration

Constant Summary

DEFAULT_CONFIGURATION_PATH =

The location from which the global configuration instance is read if a global instance is not explicitly set.

'/etc/nubic/ncs/navigator.ini'

Class Method Summary

• .configuration ⇒ Configuration

  The global configuration instance.

• .configuration=(config)

  Replaces the global configuration with a provided instance.

Class Method Details

.configuration ⇒ Configuration

The global configuration instance. Automatically instantiated on first reference from DEFAULT_CONFIGURATION_PATH if it is not set explicitly.

Returns:

• (Configuration)

# File 'lib/ncs_navigator/configuration.rb', line 22

def self.configuration
  @configuration ||= Configuration.new(DEFAULT_CONFIGURATION_PATH)
end

.configuration=(config)

This method returns an undefined value.

Replaces the global configuration with a provided instance. Set to nil to reload from DEFAULT_CONFIGURATION_PATH.

Parameters:

• config (Configuration, nil) —

  the new configuration

# File 'lib/ncs_navigator/configuration.rb', line 32

def self.configuration=(config)
  @configuration = config
end