config/ConfigServiceProvider.js

//--------------------------------------------------------
//-- Node IoC - Config - Config Service Provider
//--------------------------------------------------------

import ServiceProvider       from '../foundation/ServiceProvider';
import ConfigRepository      from './repositories/ConfigRepository';
import ConfigGrammar         from './services/ConfigGrammar';
import EnvironmentRepository from './repositories/EnvironmentRepository';
import Evaluator             from './services/Evaluator';


// eslint-disable-next-line jsdoc/require-description-complete-sentence
/**
 * The config service provider.
 * It binds the following services:
 *	<ul>
 *	   <li><a href="config.repositories.ConfigRepository.html">config</a></li>
 *	   <li><a href="config.repositories.EnvironmentRepository.html">env</a></li>
 *	   <li><a href="config.services.ConfigGrammar.html">config.grammar</a></li>
 *	   <li><a href="config.services.Evaluator.html">evaluator</a></li>
 * </ul>
 * Also, during register phase, it reads the "app.providers" configuration to register all listed service providers into the application.
 *
 * @memberof config
 * @augments foundation.ServiceProvider
 * @hideconstructor
 */
class ConfigServiceProvider extends ServiceProvider {

	/**
	 * @inheritdoc
	 */
	get name() {
		return 'Node IoC - Config';
	}

	/**
	 * Register the service provider.
	 */
	register() {
		this.bindConfigGrammar();
		this.bindEvaluator();
		this.bindConfigRepository();
		this.bindEnvironmentRepository();
		this.registerConfiguredProviders();
	}

	/**
	 * Bind config grammar service.
	 */
	bindConfigGrammar() {
		this.app.singleton('config.grammar', ConfigGrammar);
	}

	/**
	 * Bind evaluator service.
	 */
	bindEvaluator() {
		this.app.singleton('evaluator', Evaluator);
	}

	/**
	 * Bind configuration repository.
	 */
	bindConfigRepository() {
		this.app.singleton('config', ConfigRepository);
	}

	/**
	 * Bind environment repository.
	 */
	bindEnvironmentRepository() {
		this.app.singleton('env', EnvironmentRepository);
	}

	/**
	 * Register service providers from configuration file.
	 */
	registerConfiguredProviders() {
		this.app.make('config').get('app.providers', [])
			.forEach((provider) => {
				this.app.register(provider);
			});
	}

}


export default ConfigServiceProvider;