coz-engine
Version:
Abstract engine for coz
170 lines (150 loc) • 12.6 kB
JavaScript
/**
* Abstract engine. All engine should inherit this class.
* @memberof module:coz-engine/lib
* @inner
* @constructor Engine
* @param {object} [options] - Optional settings.
*/
;
/** @lends Engine */
var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
var _typeof2 = _interopRequireDefault(require("@babel/runtime/helpers/typeof"));
function Engine() {
var s = this;
s.init.apply(s, arguments);
}
Engine.prototype = {
// ------------------------
// Public methods
// ------------------------
/**
* Initialize a engine.
* @abstract
* @param {object} options - Optional settings.
* @param {string} [options.basedir] - Base directory path.
*/
init: function init(options) {
var s = this;
options = options || {};
s.basedir = options.basedir || s.basedir;
},
/**
* Base directory path.
*/
basedir: process.cwd(),
/**
* Clone this engine.
* @returns {*} - Clone of engine.
*/
clone: function clone() {
var s = this;
var Constructor = s._constructor;
var clone = new Constructor(s);
clone.set(s);
return clone;
},
/**
* Get a property.
* @param {string} key - Key for property.
* @returns {*} - Property value.
*/
get: function get(key) {
var s = this;
return s[key];
},
/**
* Set a property to this property.
* You set multiple properties by passing a single, object-type argument.
* @param {string|object} key - Key for property.
* @param {?*} [val] - Value to set.
* @returns {Engine} - Returns self for chaining.
* @example
* engine.set('foo', 'bar')
* engine.set({foo: 'bar'})
*/
set: function set(key, val) {
var s = this;
var args = arguments;
var multiple = (0, _typeof2.default)(args[0]) === 'object';
if (multiple) {
s._setProperties(args[0]);
} else {
s._setProperty(key, val);
}
return s;
},
/**
* Precompile a template string.
* Precompiled template is a string with represents compiled template function.
* @abstract
* @param {string} source - Template source string.
* @param {module:coz-engine/lib~precompileCallback} callback - callback when done.
*/
precompile: function precompile(source, callback) {
throw new Error('[engine.precompile]Not implemented!');
},
/**
* Compile a template string.
* Compiled template is a function.
* @abstract
* @param {string} source - Template source string.
* @param {module:coz-engine/lib~compileCallback} callback - Callback when done.
*/
compile: function compile(source, callback) {
throw new Error('[engine.compile]Not implemented!');
},
// ------------------------
// Private properties
// ------------------------
/**
* Constructor class.
* @function
* @private
*/
_constructor: Engine,
/**
* Set a property.
* @param {string} key - Key for property.
* @param {*} val - Value to set.
* @returns {Engine} - Returns self for chaining.
* @private
*/
_setProperty: function _setProperty(key, val) {
var s = this;
s[key] = val;
return s;
},
/**
* Set multiple properties.
* @param {object} values - Properties to set.
* @returns {Engine} - Returns self for chaining.
* @private
*/
_setProperties: function _setProperties(values) {
var s = this;
var keys = Object.keys(values || {});
for (var i = 0, len = keys.length; i < len; i++) {
var key = keys[i];
s._setProperty(key, values[key]);
}
return s;
}
};
module.exports = Engine;
/**
* Callback for engine precompile function.
* @memberof module:coz-engine/lib
* @inner
* @callback precompileCallback
* @param {?Error} err - precompile error.
* @param {string} tmplFunctionString - Precompiled template function.
*/
/**
* Callback for engine compile function.
* @memberof module:coz-engine/lib
* @inner
* @callback compileCallback
* @param {?Error} err - Compile err
* @param {function} tmpl - Compiled template function.
*/
//# sourceMappingURL=data:application/json;charset=utf-8;base64,{"version":3,"sources":["engine.js"],"names":["Engine","s","init","apply","arguments","prototype","options","basedir","process","cwd","clone","Constructor","_constructor","set","get","key","val","args","multiple","_setProperties","_setProperty","precompile","source","callback","Error","compile","values","keys","Object","i","len","length","module","exports"],"mappings":"AAAA;;;;;;;AAQA;AAEA;;;;;;AACA,SAASA,MAAT,GAAmB;AACjB,MAAMC,CAAC,GAAG,IAAV;AACAA,EAAAA,CAAC,CAACC,IAAF,CAAOC,KAAP,CAAaF,CAAb,EAAgBG,SAAhB;AACD;;AAEDJ,MAAM,CAACK,SAAP,GAAmB;AAEjB;AACA;AACA;;AACA;;;;;;AAMAH,EAAAA,IAXiB,gBAWXI,OAXW,EAWF;AACb,QAAML,CAAC,GAAG,IAAV;AACAK,IAAAA,OAAO,GAAGA,OAAO,IAAI,EAArB;AACAL,IAAAA,CAAC,CAACM,OAAF,GAAYD,OAAO,CAACC,OAAR,IAAmBN,CAAC,CAACM,OAAjC;AACD,GAfgB;;AAgBjB;;;AAGAA,EAAAA,OAAO,EAAEC,OAAO,CAACC,GAAR,EAnBQ;;AAoBjB;;;;AAIAC,EAAAA,KAxBiB,mBAwBR;AACP,QAAMT,CAAC,GAAG,IAAV;AACA,QAAIU,WAAW,GAAGV,CAAC,CAACW,YAApB;AACA,QAAIF,KAAK,GAAG,IAAIC,WAAJ,CAAgBV,CAAhB,CAAZ;AACAS,IAAAA,KAAK,CAACG,GAAN,CAAUZ,CAAV;AACA,WAAOS,KAAP;AACD,GA9BgB;;AA+BjB;;;;;AAKAI,EAAAA,GApCiB,eAoCZC,GApCY,EAoCP;AACR,QAAMd,CAAC,GAAG,IAAV;AACA,WAAOA,CAAC,CAAEc,GAAF,CAAR;AACD,GAvCgB;;AAwCjB;;;;;;;;;;AAUAF,EAAAA,GAlDiB,eAkDZE,GAlDY,EAkDPC,GAlDO,EAkDF;AACb,QAAMf,CAAC,GAAG,IAAV;AACA,QAAIgB,IAAI,GAAGb,SAAX;AACA,QAAIc,QAAQ,GAAG,sBAAOD,IAAI,CAAE,CAAF,CAAX,MAAqB,QAApC;;AACA,QAAIC,QAAJ,EAAc;AACZjB,MAAAA,CAAC,CAACkB,cAAF,CAAiBF,IAAI,CAAE,CAAF,CAArB;AACD,KAFD,MAEO;AACLhB,MAAAA,CAAC,CAACmB,YAAF,CAAeL,GAAf,EAAoBC,GAApB;AACD;;AACD,WAAOf,CAAP;AACD,GA5DgB;;AA6DjB;;;;;;;AAOAoB,EAAAA,UApEiB,sBAoELC,MApEK,EAoEGC,QApEH,EAoEa;AAC5B,UAAM,IAAIC,KAAJ,CAAU,qCAAV,CAAN;AACD,GAtEgB;;AAuEjB;;;;;;;AAOAC,EAAAA,OA9EiB,mBA8ERH,MA9EQ,EA8EAC,QA9EA,EA8EU;AACzB,UAAM,IAAIC,KAAJ,CAAU,kCAAV,CAAN;AACD,GAhFgB;AAiFjB;AACA;AACA;;AAEA;;;;;AAKAZ,EAAAA,YAAY,EAAEZ,MA1FG;;AA2FjB;;;;;;;AAOAoB,EAAAA,YAlGiB,wBAkGHL,GAlGG,EAkGEC,GAlGF,EAkGO;AACtB,QAAMf,CAAC,GAAG,IAAV;AACAA,IAAAA,CAAC,CAAEc,GAAF,CAAD,GAAWC,GAAX;AACA,WAAOf,CAAP;AACD,GAtGgB;;AAuGjB;;;;;;AAMAkB,EAAAA,cA7GiB,0BA6GDO,MA7GC,EA6GO;AACtB,QAAMzB,CAAC,GAAG,IAAV;AACA,QAAI0B,IAAI,GAAGC,MAAM,CAACD,IAAP,CAAYD,MAAM,IAAI,EAAtB,CAAX;;AACA,SAAK,IAAIG,CAAC,GAAG,CAAR,EAAWC,GAAG,GAAGH,IAAI,CAACI,MAA3B,EAAmCF,CAAC,GAAGC,GAAvC,EAA4CD,CAAC,EAA7C,EAAiD;AAC/C,UAAId,GAAG,GAAGY,IAAI,CAAEE,CAAF,CAAd;;AACA5B,MAAAA,CAAC,CAACmB,YAAF,CAAeL,GAAf,EAAoBW,MAAM,CAAEX,GAAF,CAA1B;AACD;;AACD,WAAOd,CAAP;AACD;AArHgB,CAAnB;AAwHA+B,MAAM,CAACC,OAAP,GAAiBjC,MAAjB;AAEA;;;;;;;;;AASA","sourceRoot":"../../lib","sourcesContent":["/**\n * Abstract engine. All engine should inherit this class.\n * @memberof module:coz-engine/lib\n * @inner\n * @constructor Engine\n * @param {object} [options] - Optional settings.\n */\n\n'use strict'\n\n/** @lends Engine */\nfunction Engine () {\n  const s = this\n  s.init.apply(s, arguments)\n}\n\nEngine.prototype = {\n\n  // ------------------------\n  // Public methods\n  // ------------------------\n  /**\n   * Initialize a engine.\n   * @abstract\n   * @param {object} options - Optional settings.\n   * @param {string} [options.basedir] - Base directory path.\n   */\n  init (options) {\n    const s = this\n    options = options || {}\n    s.basedir = options.basedir || s.basedir\n  },\n  /**\n   * Base directory path.\n   */\n  basedir: process.cwd(),\n  /**\n   * Clone this engine.\n   * @returns {*} - Clone of engine.\n   */\n  clone () {\n    const s = this\n    var Constructor = s._constructor\n    var clone = new Constructor(s)\n    clone.set(s)\n    return clone\n  },\n  /**\n   * Get a property.\n   * @param {string} key - Key for property.\n   * @returns {*} - Property value.\n   */\n  get (key) {\n    const s = this\n    return s[ key ]\n  },\n  /**\n   * Set a property to this property.\n   * You set multiple properties by passing a single, object-type argument.\n   * @param {string|object} key - Key for property.\n   * @param {?*} [val] - Value to set.\n   * @returns {Engine} - Returns self for chaining.\n   * @example\n   *  engine.set('foo', 'bar')\n   *  engine.set({foo: 'bar'})\n   */\n  set (key, val) {\n    const s = this\n    var args = arguments\n    var multiple = typeof args[ 0 ] === 'object'\n    if (multiple) {\n      s._setProperties(args[ 0 ])\n    } else {\n      s._setProperty(key, val)\n    }\n    return s\n  },\n  /**\n   * Precompile a template string.\n   * Precompiled template is a string with represents compiled template function.\n   * @abstract\n   * @param {string} source - Template source string.\n   * @param {module:coz-engine/lib~precompileCallback} callback - callback when done.\n   */\n  precompile (source, callback) {\n    throw new Error('[engine.precompile]Not implemented!')\n  },\n  /**\n   * Compile a template string.\n   * Compiled template is a function.\n   * @abstract\n   * @param {string} source - Template source string.\n   * @param {module:coz-engine/lib~compileCallback} callback - Callback when done.\n   */\n  compile (source, callback) {\n    throw new Error('[engine.compile]Not implemented!')\n  },\n  // ------------------------\n  // Private properties\n  // ------------------------\n\n  /**\n   * Constructor class.\n   * @function\n   * @private\n   */\n  _constructor: Engine,\n  /**\n   * Set a property.\n   * @param {string} key - Key for property.\n   * @param {*} val - Value to set.\n   * @returns {Engine} - Returns self for chaining.\n   * @private\n   */\n  _setProperty (key, val) {\n    const s = this\n    s[ key ] = val\n    return s\n  },\n  /**\n   * Set multiple properties.\n   * @param {object} values - Properties to set.\n   * @returns {Engine} - Returns self for chaining.\n   * @private\n   */\n  _setProperties (values) {\n    const s = this\n    let keys = Object.keys(values || {})\n    for (var i = 0, len = keys.length; i < len; i++) {\n      var key = keys[ i ]\n      s._setProperty(key, values[ key ])\n    }\n    return s\n  }\n}\n\nmodule.exports = Engine\n\n/**\n * Callback for engine precompile function.\n * @memberof module:coz-engine/lib\n * @inner\n * @callback precompileCallback\n * @param {?Error} err - precompile error.\n * @param {string} tmplFunctionString - Precompiled template function.\n */\n\n/**\n * Callback for engine compile function.\n * @memberof module:coz-engine/lib\n * @inner\n * @callback compileCallback\n * @param {?Error} err - Compile err\n * @param {function} tmpl - Compiled template function.\n */\n"]}