feat(core): add config manager getter support for multiple keys

Ovidiu Barabula · Ovidiu Barabula · commit 1c6ab5981671 · 2018-03-31T15:01:29.000+03:00
diff --git a/src/config-manager/index.spec.ts b/src/config-manager/index.spec.ts
@@ -4,7 +4,8 @@ import * as path from 'path';
 import { stdout } from 'test-console';
 import Logger from '../util/logger';
 import ConfigManager, { ERRORS, IConfigManager } from './index';
-import { Config, ConfigReader } from './package-json-config-reader';
+import { Config } from './index';
+import { ConfigReader } from './package-json-config-reader';
 
 describe('ConfigManager', () => {
   let configManager: IConfigManager;
@@ -62,6 +63,39 @@ describe('ConfigManager', () => {
   });
 
 
+  it('gets the keys from the passed array', async () => {
+    await configManager.set({
+      'plugin:optionA': 'valueA',
+      'plugin:optionB': 'valueB',
+      'plugin:optionC': 'valueC',
+    });
+
+    const validKeys = ['plugin:optionA', 'plugin:optionB', 'plugin:optionC'];
+    expect(await configManager.get(validKeys))
+      .to.be.an('object')
+      .to.contain.keys(...validKeys);
+
+    await configManager.remove(...validKeys);
+  });
+
+
+  it('gets only the existing keys from passed array', async () => {
+    await configManager.set({
+      'plugin:optionA': 'valueA',
+      'plugin:optionB': 'valueB',
+      'plugin:optionC': 'valueC',
+    });
+
+    const validKeys = ['plugin:optionA', 'plugin:optionB', 'plugin:optionC'];
+    const mixedKeys = [...validKeys, 'plugin:optionD', 'plugin:optionE'];
+    expect(await configManager.get(mixedKeys))
+      .to.be.an('object')
+      .to.contain.keys(...validKeys);
+
+    await configManager.remove(...validKeys);
+  });
+
+
   it('sets an option', async () => {
     configManager.set('key', 'value');
     expect(await configManager.get('key')).to.equal('value');
@@ -78,7 +112,7 @@ describe('ConfigManager', () => {
   });
 
 
-  it('returns false if not called properly', async () => {
+  it('returns false if .set() is not called properly', async () => {
     expect(await configManager.set({})).to.be.false;
   });
 
diff --git a/src/config-manager/index.ts b/src/config-manager/index.ts
@@ -18,7 +18,7 @@ export interface Config {
 
 export interface IConfigManager {
   has(key: string): Promise<boolean>;
-  get(key?: string): Promise<Config | any>;
+  get(key?: string | string[]): Promise<Config | any>;
   set(option: Config | string, value?: any): Promise<boolean|Error>;
   remove(...options: string[]): Promise<boolean|Error>;
   errorHandler?(error?: Error): Error;
@@ -92,13 +92,33 @@ async function ConfigManager(
    * Retrieve value from configuration
    * @param key Configuration option key
    */
-  async function get(key?: string): Promise<Config | any> {
+  async function get(key?: string | string[]): Promise<Config | any> {
     config = await configReader.fetch();
 
+    // If no key is specified, return the entire config object
     if (typeof key === 'undefined') {
       return config;
     }
 
+    // If an array is passed, return an object
+    // with the all the existing config keys from the array
+    if (Array.isArray(key)) {
+      // Assigning array to new variable so the naming makes sense
+      const keys = key;
+      // Create a new object with all available keys in the configuration
+      return keys.reduce((accumConfig, currKey) => {
+        // Check if configuration has provided key
+        if (typeof config[currKey] !== 'undefined') {
+          // Add the key value pair to the returning object
+          accumConfig = {...accumConfig,
+            ...{ [currKey]: config[currKey] },
+          };
+        }
+        return accumConfig;
+      }, {});
+    }
+
+    // Otherwise, return just the specified key
     return config[key];
   }
 
@@ -120,8 +140,7 @@ async function ConfigManager(
     }
 
     try {
-      const saved: boolean | Error = await configReader.update(config);
-      return saved;
+      return await configReader.update(config);
     } catch (error) {
       return Promise.reject(errorHandler(error));
     }
@@ -135,13 +154,13 @@ async function ConfigManager(
   async function remove(...options: string[]): Promise<boolean|Error> {
     options.forEach(item => delete config[item]);
     try {
-      const saved: boolean | Error = await configReader.update(config);
-      return saved;
+      return await configReader.update(config);
     } catch (error) {
       return Promise.reject(errorHandler(error));
     }
   }
 
+
   // Creating the public API object
   let publicApi: IConfigManager = {
     get,
