1027167519

Build Type

github

Committed by GitHub

Commit Message

Merge c4efc83a1 into d1150f022

Pull Request Pull Request #47: fix: select env after merging all files together

Run Details

178 of 211 branches covered (84.36%)

Branch coverage included in aggregate %.

48 of 49 new or added lines in 3 files covered. (97.96%)

1 existing line in 1 file now uncovered.

995 of 1084 relevant lines covered (91.79%)

213.43 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

91.8

/lib/index.js

/**
 * @projectName gofigure
 * @github http://github.com/C2FO/gofigure
 * @header [../README.md]
 * @includeDoc [Change Log] ../History.md
 */

const _ = require('lodash');
const PatternEventEmitter = require('./PatternEventEmitter');
const loader = require('./loader');
const processor = require('./processor');

class ConfigLoader extends PatternEventEmitter {
  /**
   * Aggregate class to load configurations from and merge into a single config.
   *
   *  @param loaderConfig a the configuration to pass to [loader}
   * @param [options.environment=process.env.NODE_ENV] the environment to use when loading configurations
   * @param [options.nodeType=process.env.NODE_TYPE] the node type to use when loading configurations
   * @param [options.environmentVariables=process.env] an object of environment variables to use
   * @param [options.defaultEnvironment='*'] the name of the default environment to use as a base to merge other
   * environments into
   * @param [options.monitor=false] the name of the default environment to use as a base to merge other environments
   * into.
   */
  constructor(loaderConfig, opts) {
    super({});
    if (!loaderConfig) {
      throw new Error('A loader configuration is required');
    }
    const options = opts || {};
    this.environment = options.environment || process.env.NODE_ENV || null;
    this.nodeType = options.nodeType || process.env.NODE_TYPE || null;
    this.environmentVariables = options.environmentVariables || process.env || {};
    this.defaultEnvironment = options.defaultEnvironment || '*';
    this.config = {};
    this.monitor = !!options.monitor;
    this.loaderConfig = loaderConfig;
    this.loaded = false;
  }

  /**
   * Stops monitoring confgurations for changes.
   *
   * @return {Config} this config object.
   */
  stop() {
    this.__loaders.forEach((l) => l.unWatch());
    return this;
  }

  /**
   * Asynchronously loads configs.
   *
   * @example
   * configLoader.load().then((config) => {
   *     // use the config.
   * })
   *
   * @return {Promise<any>|Promise<any[] | never>} resolves with the merged configuration from all locations.s
   */
  load() {
    if (this.__loaded) {
      return Promise.resolve(this.config);
    }
    return loader.createLoadersAsync(this.loaderConfig, { monitor: this.monitor }).then((loaders) => {
      this.__loaders = loaders;
      const loads = loaders.map((l) => l.load());
      return Promise.all(loads).then((configs) => this.__postLoad(configs));
    });
  }

  /**
   * Synchronously loads configurations.
   *
   * @example
   * const config = configLoader.loadSync()
   * //use your config.
   *
   * @return {Object} the merged configuration from all locations.
   */
  loadSync() {
    if (this.__loaded) {
      return this.config;
    }
    this.__loaders = loader.createLoadersSync(this.loaderConfig, { monitor: this.monitor });
    return this.__postLoad(this.__loaders.map((l) => l.loadSync()));
  }

  __mergeConfigs(configs) {
    return processor(_.cloneDeep(this.config), configs, {
      environment: this.environment,
      defaultEnvironment: this.defaultEnvironment,
      nodeType: this.nodeType,
      eventEmitter: this,
      environmentVariables: this.environmentVariables,
    });
  }

  /**
   *  Merges configs and starts monitoring of configs if `monitor` is true.
   * @param configs {Array<Object>} an array of configurations to merge into a single object.
   * @return {Object} the merged config
   * @private
   */
  __postLoad(configs) {
    this.config = this.__mergeConfigs(configs);
    this.__listenToChanges();
    this.__loaded = true;
    return this.config;
  }

  __listenToChanges() {
    this.__loaders.forEach((l) =>
      l.on('change', (path, config) => {
        this.config = this.__mergeConfigs([config]);
      }),
    );
  }
}
/**
 * Factory method to create a new {@link ConfigLoader}.
 *
 * @example
 *
 * const loader = gofigure({locations: ["path/to/config.json"]})
 *
 * @example
 * const loader = gofigure({locations: ["path/to/config_dir"]})
 *
 * @param options {{locations: String|String}}
 * @param options.locations locations to load files from
 * @param [options.environment=process.env.NODE_ENV] the environment to use when loading configurations
 * @param [options.nodeType=process.env.NODE_TYPE] the node type to use when loading configurations
 * @param [options.environmentVariables=process.env] an object of environment variables to use
 * @param [options.defaultEnvironment='*'] the name of the default environment to use as a base to merge other
 * environments into
 * @param [options.monitor=false] the name of the default environment to use as a base to merge other environments into.
 * @return {ConfigLoader} the Config to use to load configurations.
 */
function gofigure(options = {}) {
  const locations = (options.locations || [])
    .map((file) => {
      if (_.isPlainObject(file)) {
        return file;
      }
      return { file };
    })
    .reverse();
  if (!locations) {
    throw new Error('Please provide locations to load configurations from');
  }
  return new ConfigLoader({ locations }, options);
}

module.exports = gofigure;

1	/**	3✔
2	* @projectName gofigure	3✔
3	* @github http://github.com/C2FO/gofigure	3✔
4	* @header [../README.md]	3✔
5	* @includeDoc [Change Log] ../History.md	3✔
6	*/	3✔
7		3✔
8	const _ = require('lodash');	3✔
9	const PatternEventEmitter = require('./PatternEventEmitter');	3✔
10	const loader = require('./loader');	3✔
11	const processor = require('./processor');	3✔
12		3✔
13	class ConfigLoader extends PatternEventEmitter {	3✔
14	/**	3✔
15	* Aggregate class to load configurations from and merge into a single config.	3✔
16	*	3✔
17	* @param loaderConfig a the configuration to pass to [loader}	3✔
18	* @param [options.environment=process.env.NODE_ENV] the environment to use when loading configurations	3✔
19	* @param [options.nodeType=process.env.NODE_TYPE] the node type to use when loading configurations	3✔
20	* @param [options.environmentVariables=process.env] an object of environment variables to use	3✔
21	* @param [options.defaultEnvironment='*'] the name of the default environment to use as a base to merge other	3✔
22	* environments into	3✔
23	* @param [options.monitor=false] the name of the default environment to use as a base to merge other environments	3✔
24	* into.	3✔
25	*/	3✔
26	constructor(loaderConfig, opts) {	3✔
27	super({});	192✔
28	if (!loaderConfig) {	192!
29	throw new Error('A loader configuration is required');	×
30	}	×
31	const options = opts \|\| {};	192!
32	this.environment = options.environment \|\| process.env.NODE_ENV \|\| null;	192✔
33	this.nodeType = options.nodeType \|\| process.env.NODE_TYPE \|\| null;	192✔
34	this.environmentVariables = options.environmentVariables \|\| process.env \|\| {};	192!
35	this.defaultEnvironment = options.defaultEnvironment \|\| '*';	192✔
36	this.config = {};	192✔
37	this.monitor = !!options.monitor;	192✔
38	this.loaderConfig = loaderConfig;	192✔
39	this.loaded = false;	192✔
40	}	192✔
41		3✔
42	/**	3✔
43	* Stops monitoring confgurations for changes.	3✔
44	*	3✔
45	* @return {Config} this config object.	3✔
46	*/	3✔
47	stop() {	3✔
48	this.__loaders.forEach((l) => l.unWatch());	42✔
49	return this;	42✔
50	}	42✔
51		3✔
52	/**	3✔
53	* Asynchronously loads configs.	3✔
54	*	3✔
55	* @example	3✔
56	* configLoader.load().then((config) => {	3✔
57	* // use the config.	3✔
58	* })	3✔
59	*	3✔
60	* @return {Promise<any>\|Promise<any[] \| never>} resolves with the merged configuration from all locations.s	3✔
61	*/	3✔
62	load() {	3✔
63	if (this.__loaded) {	75!
64	return Promise.resolve(this.config);	×
65	}	×
66	return loader.createLoadersAsync(this.loaderConfig, { monitor: this.monitor }).then((loaders) => {	75✔
67	this.__loaders = loaders;	75✔
68	const loads = loaders.map((l) => l.load());	75✔
69	return Promise.all(loads).then((configs) => this.__postLoad(configs));	75✔
70	});	75✔
71	}	75✔
72		3✔
73	/**	3✔
74	* Synchronously loads configurations.	3✔
75	*	3✔
76	* @example	3✔
77	* const config = configLoader.loadSync()	3✔
78	* //use your config.	3✔
79	*	3✔
80	* @return {Object} the merged configuration from all locations.	3✔
81	*/	3✔
82	loadSync() {	3✔
83	if (this.__loaded) {	117!
NEW 84	return this.config;	×
UNCOV 85	}	×
86	this.__loaders = loader.createLoadersSync(this.loaderConfig, { monitor: this.monitor });	117✔
87	return this.__postLoad(this.__loaders.map((l) => l.loadSync()));	117✔
88	}	117✔
89		3✔
90	__mergeConfigs(configs) {	3✔
91	return processor(_.cloneDeep(this.config), configs, {	384✔
92	environment: this.environment,	384✔
93	defaultEnvironment: this.defaultEnvironment,	384✔
94	nodeType: this.nodeType,	384✔
95	eventEmitter: this,	384✔
96	environmentVariables: this.environmentVariables,	384✔
97	});	384✔
98	}	384✔
99		3✔
100	/**	3✔
101	* Merges configs and starts monitoring of configs if `monitor` is true.	3✔
102	* @param configs {Array<Object>} an array of configurations to merge into a single object.	3✔
103	* @return {Object} the merged config	3✔
104	* @private	3✔
105	*/	3✔
106	__postLoad(configs) {	3✔
107	this.config = this.__mergeConfigs(configs);	192✔
108	this.__listenToChanges();	192✔
109	this.__loaded = true;	192✔
110	return this.config;	192✔
111	}	192✔
112		3✔
113	__listenToChanges() {	3✔
114	this.__loaders.forEach((l) =>	192✔
115	l.on('change', (path, config) => {	357✔
116	this.config = this.__mergeConfigs([config]);	192✔
117	}),	192✔
118	);	192✔
119	}	192✔
120	}	3✔
121	/**	3✔
122	* Factory method to create a new {@link ConfigLoader}.	3✔
123	*	3✔
124	* @example	3✔
125	*	3✔
126	* const loader = gofigure({locations: ["path/to/config.json"]})	3✔
127	*	3✔
128	* @example	3✔
129	* const loader = gofigure({locations: ["path/to/config_dir"]})	3✔
130	*	3✔
131	* @param options {{locations: String\|String}}	3✔
132	* @param options.locations locations to load files from	3✔
133	* @param [options.environment=process.env.NODE_ENV] the environment to use when loading configurations	3✔
134	* @param [options.nodeType=process.env.NODE_TYPE] the node type to use when loading configurations	3✔
135	* @param [options.environmentVariables=process.env] an object of environment variables to use	3✔
136	* @param [options.defaultEnvironment='*'] the name of the default environment to use as a base to merge other	3✔
137	* environments into	3✔
138	* @param [options.monitor=false] the name of the default environment to use as a base to merge other environments into.	3✔
139	* @return {ConfigLoader} the Config to use to load configurations.	3✔
140	*/	3✔
141	function gofigure(options = {}) {	192✔
142	const locations = (options.locations \|\| [])	192!
143	.map((file) => {	192✔
144	if (_.isPlainObject(file)) {	213✔
145	return file;	6✔
146	}	6✔
147	return { file };	207✔
148	})	207✔
149	.reverse();	192✔
150	if (!locations) {	192!
151	throw new Error('Please provide locations to load configurations from');	×
152	}	×
153	return new ConfigLoader({ locations }, options);	192✔
154	}	192✔
155		3✔
156	module.exports = gofigure;	3✔

C2FO / gofigure / 1027167519

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous