feat(config): add ConfigManager

Ovidiu Barabula · Ovidiu Barabula · commit 8e23bd06b041 · 2018-03-12T15:39:33.000+02:00
diff --git a/src/config-manager/index.spec.ts b/src/config-manager/index.spec.ts
@@ -0,0 +1,57 @@
+import { assert, expect } from 'chai';
+import 'mocha';
+import * as path from 'path';
+import ConfigManagerFactory, { IConfigManager } from './index';
+import { Config, ConfigReaderFactory, IConfigReader } from './package-json-config-reader';
+
+describe('ConfigManager', () => {
+  const testDir = '/tmp/tests/';
+  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');
+  });
+
+
+  it('instantiates with custom config reader', async () => {
+    const customReader: ConfigReaderFactory = (namespace: string) => {
+      let config: Config = {};
+      return {
+        fetch(): Promise<Config> {
+          return Promise.resolve(config);
+        },
+        update(object: object): Promise<boolean> {
+          config = {...config, ...object};
+          return Promise.resolve(true);
+        },
+      };
+    };
+
+    const customConfigManager = await ConfigManagerFactory('frontvue', customReader);
+    expect(customConfigManager).to.be.an('object').to.have.all.keys('has', 'set', 'get');
+  });
+
+
+  it('gets all options', async () => {
+    expect(configManager.get()).to.be.an('object');
+  });
+
+
+  it('sets an option', async () => {
+    configManager.set('key', 'value');
+    expect(configManager.get('key')).to.equal('value');
+  });
+
+  it('gets one option', async () => {
+    expect(configManager.get('key')).to.equal('value');
+  });
+
+
+  it('checks if option exists', async () => {
+    expect(configManager.has('key')).to.be.true;
+  });
+});
diff --git a/src/config-manager/index.ts b/src/config-manager/index.ts
@@ -0,0 +1,86 @@
+/**
+ * Name: config-manager.ts
+ * Description: Config Manager Factory
+ * Author: Ovidiu Barabula <lectii2008@gmail.com>
+ * @since 0.1.0
+ */
+
+import PackageJsonConfigReader, {
+  Config,
+  ConfigReaderFactory,
+  IConfigReader,
+} from './package-json-config-reader';
+
+
+export interface IConfigManager {
+  has(key: string): boolean;
+  get(key?: string): any;
+  set(key: string, value: any): Promise<boolean>;
+}
+
+/**
+ * Create Configuration manager
+ * @param namespace Configuration namespace, usually app name (used in package.json { config: { <namespace>: {} } })
+ * @param customReader Custom ConfigReader
+ */
+async function ConfigManagerFactory(
+  namespace: string,
+  customReader?: ConfigReaderFactory,
+): Promise<IConfigManager> {
+  let configReader: IConfigReader;
+
+  // Check for custom config reader
+  if (customReader && typeof customReader === 'function') {
+    // Initialize custom config reader
+    configReader = customReader(namespace);
+  } else {
+    // If not, stick with the default config reader
+    configReader = await PackageJsonConfigReader(namespace);
+  }
+
+  // Get the configuration contents
+  const config: Config = await configReader.fetch();
+
+
+  /**
+   * Check if key exists in config
+   * @param key Configuration option key
+   */
+  function has(key: string): boolean {
+    return config.hasOwnProperty(key);
+  }
+
+
+  /**
+   * Retrieve value from configuration
+   * @param key Configuration option key
+   */
+  function get(key?: string): Config | any {
+    if (typeof key === 'undefined') {
+      return config;
+    }
+
+    return config[key];
+  }
+
+
+  /**
+   * Set new value for configuration option
+   * @param key Configuration option key
+   * @param value New value to be set
+   */
+  async function set(key: string, value: any): Promise<boolean> {
+    config[key] = value;
+    const saved = await configReader.update(config);
+    return saved;
+  }
+
+  // Returning config manager public API
+  return Object.freeze({
+    get,
+    has,
+    set,
+  });
+}
+
+export default ConfigManagerFactory;
