feat(config): add remove method and support for setting multiple keys at once

Ovidiu Barabula · Ovidiu Barabula · commit 02667966b46f · 2018-03-12T18:35:10.000+02:00
diff --git a/src/config-manager/index.spec.ts b/src/config-manager/index.spec.ts
@@ -9,11 +9,12 @@ describe('ConfigManager', () => {
   const configFile = 'package.json';
   let configManager: IConfigManager;
 
+
   beforeEach(async () => configManager = await ConfigManagerFactory('frontvue'));
 
 
   it('instantiates', async () => {
-    expect(configManager).to.be.an('object').to.have.all.keys('has', 'set', 'get');
+    expect(configManager).to.be.an('object').to.have.all.keys('get', 'has', 'remove', 'set');
   });
 
 
@@ -32,26 +33,55 @@ describe('ConfigManager', () => {
     };
 
     const customConfigManager = await ConfigManagerFactory('frontvue', customReader);
-    expect(customConfigManager).to.be.an('object').to.have.all.keys('has', 'set', 'get');
+    expect(customConfigManager).to.be.an('object').to.have.all.keys('get', 'has', 'remove', 'set');
   });
 
 
   it('gets all options', async () => {
-    expect(configManager.get()).to.be.an('object');
+    expect(await configManager.get()).to.be.an('object');
   });
 
 
   it('sets an option', async () => {
     configManager.set('key', 'value');
-    expect(configManager.get('key')).to.equal('value');
+    expect(await configManager.get('key')).to.equal('value');
   });
 
-  it('gets one option', async () => {
-    expect(configManager.get('key')).to.equal('value');
+
+  it('sets an object of options', async () => {
+    const saved = await configManager.set({
+      key2: 'value2',
+      key3: 'value3',
+    });
+    expect(await configManager.has('key2')).to.be.true;
+    expect(await configManager.has('key3')).to.be.true;
+  });
+
+
+  it('returns false if not called properly', async () => {
+    expect(await configManager.set({})).to.be.false;
   });
 
 
   it('checks if option exists', async () => {
-    expect(configManager.has('key')).to.be.true;
+    expect(await configManager.has('key')).to.be.true;
+  });
+
+
+  it('gets one option', async () => {
+    expect(await configManager.get('key')).to.equal('value');
+  });
+
+
+  it('removes one option', async () => {
+    const removed = await configManager.remove('key');
+    const config = await configManager.get();
+    expect(Object.keys(config).includes('key')).to.be.false;
+  });
+
+
+  it('removes multiple options', async () => {
+    const removed = await configManager.remove('key2', 'key3');
+    expect(await configManager.get()).to.eql({});
   });
 });
diff --git a/src/config-manager/index.ts b/src/config-manager/index.ts
@@ -13,9 +13,10 @@ import PackageJsonConfigReader, {
 
 
 export interface IConfigManager {
-  has(key: string): boolean;
-  get(key?: string): any;
-  set(key: string, value: any): Promise<boolean>;
+  has(key: string): Promise<boolean>;
+  get(key?: string): Promise<Config | any>;
+  set(option: Config | string, value?: any): Promise<boolean>;
+  remove(...options: string[]): Promise<boolean>;
 }
 
 /**
@@ -39,14 +40,15 @@ async function ConfigManagerFactory(
   }
 
   // Get the configuration contents
-  const config: Config = await configReader.fetch();
+  let config: Config = await configReader.fetch();
 
 
   /**
    * Check if key exists in config
    * @param key Configuration option key
    */
-  function has(key: string): boolean {
+  async function has(key: string): Promise<boolean> {
+    config = await configReader.fetch();
     return config.hasOwnProperty(key);
   }
 
@@ -55,7 +57,9 @@ async function ConfigManagerFactory(
    * Retrieve value from configuration
    * @param key Configuration option key
    */
-  function get(key?: string): Config | any {
+  async function get(key?: string): Promise<Config | any> {
+    config = await configReader.fetch();
+
     if (typeof key === 'undefined') {
       return config;
     }
@@ -65,20 +69,42 @@ async function ConfigManagerFactory(
 
 
   /**
-   * Set new value for configuration option
-   * @param key Configuration option key
-   * @param value New value to be set
+   * Set new value(s) in configuration
+   * @param option Configuration object or object key
+   * @param value New value to be set if option is an object key ("string")
    */
-  async function set(key: string, value: any): Promise<boolean> {
-    config[key] = value;
-    const saved = await configReader.update(config);
+  async function set(option: Config | string, value?: any): Promise<boolean> {
+    // If we're passing in a "key" and a "value"
+    if (typeof option === 'string' && typeof value !== 'undefined') {
+      config[option] = value;
+    // If we're passing in an object of key/value pairs
+    } else if (typeof option === 'object' && Object.keys(option).length > 0) {
+      config = { ...config, ...option };
+    } else {
+      return false;
+    }
+
+    const saved: boolean = await configReader.update(config);
     return saved;
   }
 
+
+  /**
+   * Removes one or more options from config
+   * @param option Option name or array of option names
+   */
+  async function remove(...options: string[]): Promise<boolean> {
+    options.forEach(item => delete config[item]);
+    const saved: boolean = await configReader.update(config);
+    return saved;
+  }
+
+
   // Returning config manager public API
   return Object.freeze({
     get,
     has,
+    remove,
     set,
   });
 }
