recink/src/config/abstract-config.js

Rethink CI for JavaScript applications

'use strict';

const fs = require('fs');
const pify = require('pify');
const fse = require('fs-extra');

/**
 * Abstract configuration manager
 */
class AbstractConfig {
  /**
   * @param {string} file
   */
  constructor(file = null) {
    this._file = file;
  }
  
  /**
   * @returns {string}
   */
  get file() {
    return this._file;
  }
  
  /**
   * @param {string} file
   *
   * @returns {Promise}
   */
  load(file = null) {
    const configFile = file || this.file;
    
    return fse.pathExists(configFile)
      .then(exists => {
        if (!exists) {
          return Promise.reject(new Error(
            `Missing configuration file ${ configFile }`
          ));
        }
        
        return pify(fs.readFile)(configFile)
          .then(rawConfig => this.decode(rawConfig));
      });
  }
  
  /**
   * @param {*} config
   * @param {string} file
   *
   * @returns {Promise}
   */
  dump(config, file = null) {
    return this.encode(config)
      .then(rawConfig => pify(fs.writeFile)(file || this.file, rawConfig));
  }
  
  /**
   * @param {string} rawConfig
   *
   * @returns {Promise}
   */
  decode(rawConfig) {
    return Promise.reject(new Error(`${ this.constructor.name }.decode(rawConfig) not implemented!`));
  }
  
  /**
   * @param {*} config
   *
   * @returns {Promise}
   */
  encode(config) {
    return Promise.reject(new Error(`${ this.constructor.name }.encode(config) not implemented!`));
  }
}

module.exports = AbstractConfig;