mm_tpl 2.4.3 → 2.4.5

package/index.js

@@ -1,6 +1,8 @@
-require('mm_expand');
 const template = require('art-template');
 const Hook = require('./hook.js');
+const {
+	Base
+} = require('mm_expand');
 const {
 	nativeRule,
 	artRule,
@@ -22,18 +24,13 @@ if (!$.hook) {
  * 模板类
  * @class
  */
-class Tpl {
+class Tpl extends Base {
 	/**
-	 * 创建模板帮助类函数 (构造函数)
-	 * @param {String} scope 作用域
-	 * @param {String} dir 文件存储路径
-	 * @constructor
+	 * 创建模板实例
+	 * @param {Object} config - 配置选项
 	 */
 	constructor(config) {
-		/**
-		 * 配置参数
-		 */
-		this.config = {
+		super(Object.assign({
 			root: $.runPath + '',
 			default_dir: "./template/",
 			default_theme: 'default',
@@ -42,7 +39,7 @@ class Tpl {
 			cache_root: './cache'.fullname(),
 			cache_extname: '.cache.html',
 			change_str: ["\\#", "\\<", "\\${", "\\/*", '\\"""'],
-		};
+		}, config));
 
 		/**
 		 * 模板引擎
@@ -50,13 +47,10 @@ class Tpl {
 		this.template = template;
 
 		/**
-		 * 视图背包
+		 * 视图数据
 		 */
 		this.viewBag = {};
 
-		// 修改配置
-		this.set_config(config);
-
 		/**
 		 * 模板根目录
 		 */
@@ -86,10 +80,10 @@ class Tpl {
 }
 
 /**
- * 修改配置
- * @param {Object} config 配置参数
+ * 设置配置
+ * @param {Object} config - 配置参数
  */
-Tpl.prototype.set_config = function(config) {
+Tpl.prototype.setConfig = function (config) {
 	if (config) {
 		this.config = Object.assign(this.config, config);
 	}
@@ -104,35 +98,44 @@ Tpl.prototype.set_config = function(config) {
 
 
 /**
- * 执行函数钩子
- * @param {String} name 名称
- * @param {Object} req 请求参数
- * @param {Object} args 附加参数
+ * 执行钩子函数
+ * @param {string} name - 钩子名称
+ * @param {Object} req - 请求参数
+ * @param {...any} args - 附加参数
+ * @returns {any} 执行结果
  */
-Tpl.prototype.runFunc = function(name, req, ...args) {
+Tpl.prototype.runFunc = function (name, req, ...args) {
 	return $.hook.runFunc(name, this.viewBag, req, ...args);
 }
 
+/**
+ * 执行钩子函数
+ * @param {string} name - 钩子名称
+ * @param {Object} req - 请求参数
+ * @param {...any} args - 附加参数
+ * @returns {any} 执行结果
+ */
+Tpl.prototype.runHook = Tpl.prototype.runFunc;
 
 /**
- * 初始化之前
- * @param {Object} config 配置参数
+ * 初始化前处理
+ * @param {Object} config - 配置参数
  */
-Tpl.prototype.init_before = function(config) {}
+Tpl.prototype._initBefore = function (config) { }
 
 /**
- * 初始化主体
- * @param {Object} config 配置参数
+ * 初始化主处理
+ * @param {Object} config - 配置参数
  */
-Tpl.prototype.init_main = function(config) {
-	this.set_config(config);
+Tpl.prototype._initMain = function (config) {
+	this.setConfig(config);
 }
 
 /**
- * 初始化之后
- * @param {Object} config 配置参数
+ * 初始化后处理
+ * @param {Object} config - 配置参数
  */
-Tpl.prototype.init_after = function(config) {
+Tpl.prototype._initAfter = function (config) {
 	var lt = this.config.change_str;
 	for (var i = 0; i < lt.length; i++) {
 		var str = lt[i];
@@ -141,30 +144,30 @@ Tpl.prototype.init_after = function(config) {
 		this.regex_in.push(new RegExp(rx_in, "gi"));
 		var str_in = str.split("").join("·") + "·";
 		this.str_in.push(str_in);
-		var rx_out = str_in.replace("\\", "\\\\").replace("$", "\\$").replace("[", "\\[").replace("]", "\\]")
-			.replace(
-				"{", "\\{").replace("}", "\\}").replace("/", "\\/").replace("*", "\\*");
+		var rx_out = str_in.replace("\\", "\\\\").replace("$", "\\$").replace("[", "\\[").replace("]", "\\]").replace(
+			"{", "\\{").replace("}", "\\}").replace("/", "\\/").replace("*", "\\*");
 		this.regex_out.push(new RegExp(rx_out, "gi"));
 		this.str_out.push(str.replace("\\", ""));
 	}
 }
 
 /**
- * 初始化
- * @param {Object} config 配置参数
+ * 初始化模板
+ * @param {Object} config - 配置参数
  */
-Tpl.prototype.init = function(config) {
-	this.init_before(config);
-	this.init_main(config);
-	this.init_after(config);
+Tpl.prototype.init = function (config) {
+	this._initBefore(config);
+	this._initMain(config);
+	this._initAfter(config);
 }
 
 /**
- * 转译字符
- * @param {String} body 字符串
- * @param {Boolean} restore 是否还原 
+ * 转义字符
+ * @param {string} body - 字符串
+ * @param {boolean} restore - 是否还原 
+ * @returns {string} 转义后的字符串
  */
-Tpl.prototype.change = function(body, restore) {
+Tpl.prototype.escape = function (body, restore) {
 	if (!body) {
 		return body
 	}
@@ -181,18 +184,18 @@ Tpl.prototype.change = function(body, restore) {
 }
 
 /**
- * 渲染模板(之前)
- * @param {String} body 模板
- * @param {Object} model 数据模型
- * @param {Object} options 配置参数
- * @return {String} 渲染结果
+ * 渲染前处理
+ * @param {string} body - 模板内容
+ * @param {Object} model - 数据模型
+ * @param {Object} options - 配置参数
+ * @returns {string} 渲染结果
  */
-Tpl.prototype.render_before = function(body, model, options) {
+Tpl.prototype._renderBefore = function (body, model, options) {
 	var ret = "";
 	if (options && options.cache) {
 		var f = options.cache_filename;
 		if (f) {
-			if (f.replace('./', '').indexOf('.') == -1 && !f.endWith(this.config.cache_extname)) {
+			if (f.replace('./', '').indexOf('.') == -1 && !f.endsWith(this.config.cache_extname)) {
 				f += this.config.cache_extname;
 			}
 			var file = f.fullname(this.config.cache_root);
@@ -206,10 +209,11 @@ Tpl.prototype.render_before = function(body, model, options) {
 };
 
 /**
- * 用于注入全局函数
- * @param {Object} m
+ * 注入全局函数前处理
+ * @param {Object} m - 模型对象
+ * @returns {Object} 处理后的模型
  */
-Tpl.prototype.loadFunc_before = function(m) {
+Tpl.prototype._loadFuncBefore = function (m) {
 	// m.$i18n = function(key) {
 	// 	return $.i18n(key);
 	// }
@@ -217,38 +221,44 @@ Tpl.prototype.loadFunc_before = function(m) {
 }
 
 /**
- * 加载函数
- * @param {Object} m 模型
+ * 加载函数到模型
+ * @param {Object} m - 模型对象
+ * @returns {Object} 处理后的模型
  */
-Tpl.prototype.loadFunc = function(m) {
-	this.loadFunc_before(m);
+Tpl.prototype.loadFunc = function (m) {
+	this._loadFuncBefore(m);
 	var _this = this;
-	m.view = function(file, model, options) {
+	m.view = function (file, model, options) {
 		return _this.view(file, Object.assign({}, m, model), options);
 	}
-	m.render = function(body, model, options) {
+	m.render = function (body, model, options) {
 		return _this.render(body, Object.assign({}, m, model), options);
 	}
-	m.hook_action = function(name, ...args) {
+	m.hookAction = function (name, ...args) {
 		return $.hook.runAction(name, m, ...args);
 	}
-	m.hook_filter = function(name, content, ...args) {
+	m.hookFilter = function (name, content, ...args) {
 		if (!content) {
 			content = "";
 		}
 		return $.hook.runFilter(name, m, content, ...args);
 	}
+	if (global.$ && $.lang) {
+		m.$t = function (key, ...args) {
+			return $.lang.get(key, ...args);
+		}
+	}
 	return m;
 }
 
 /**
- * 渲染模板(主要)
- * @param {String} body 模板
- * @param {Object} model 数据模型
- * @param {Object} options 配置参数
- * @return {String} 渲染结果
+ * 渲染主处理
+ * @param {string} body - 模板内容
+ * @param {Object} model - 数据模型
+ * @param {Object} options - 配置参数
+ * @returns {string} 渲染结果
  */
-Tpl.prototype.render_main = function(body, model, options) {
+Tpl.prototype._renderMain = function (body, model, options) {
 	var ret = "";
 	if (body) {
 		var m = Object.assign({}, {
@@ -262,18 +272,18 @@ Tpl.prototype.render_main = function(body, model, options) {
 };
 
 /**
- * 渲染模板(之后)
- * @param {String} body 模板
- * @param {Object} model 数据模型
- * @param {Object} options 配置参数
- * @return {String} 渲染结果
+ * 渲染后处理
+ * @param {string} body - 模板内容
+ * @param {Object} model - 数据模型
+ * @param {Object} options - 配置参数
+ * @returns {string} 渲染结果
  */
-Tpl.prototype.render_after = function(body, model, options) {
+Tpl.prototype._renderAfter = function (body, model, options) {
 	if (body) {
 		if (options) {
 			var f = options.cache_filename;
 			if (f) {
-				if (f.replace('./', '').indexOf('.') == -1 && !f.endWith(this.config.cache_extname)) {
+				if (f.replace('./', '').indexOf('.') == -1 && !f.endsWith(this.config.cache_extname)) {
 					f += this.config.cache_extname;
 				}
 				var file = f.fullname(this.config.cache_root);
@@ -285,18 +295,18 @@ Tpl.prototype.render_after = function(body, model, options) {
 };
 
 /**
- * 渲染模板
- * @param {String} body 模板
- * @param {Object} model 数据模型
- * @param {Object} options 配置参数
- * @return {String} view 渲染后的视图
+ * 渲染子模板
+ * @param {string} body - 模板内容
+ * @param {Object} model - 数据模型
+ * @param {Object} options - 配置参数
+ * @returns {string} 渲染结果
  */
-Tpl.prototype.render_sub = function(body, model, options) {
-	var ret = this.render_before(body, model, options);
+Tpl.prototype._renderSub = function (body, model, options) {
+	var ret = this._renderBefore(body, model, options);
 	if (!ret) {
-		ret = this.render_main(body, model, options);
+		ret = this._renderMain(body, model, options);
 		if (ret) {
-			ret = this.render_after(ret, model, options);
+			ret = this._renderAfter(ret, model, options);
 		}
 	}
 	return ret;
@@ -304,36 +314,36 @@ Tpl.prototype.render_sub = function(body, model, options) {
 
 /**
  * 渲染模板
- * @param {String} body 模板
- * @param {Object} model 数据模型
- * @param {Object} options 配置参数
- * @return {String} view 渲染后的视图
+ * @param {string} body - 模板内容
+ * @param {Object} model - 数据模型
+ * @param {Object} options - 配置参数
+ * @returns {string} 渲染结果
  */
-Tpl.prototype.render = function(body, model, options) {
-	body = this.change(body);
-	body = this.render_sub(body, model, options);
-	return this.change(body, true);
+Tpl.prototype.render = function (body, model, options) {
+	body = this.escape(body);
+	body = this._renderSub(body, model, options);
+	return this.escape(body, true);
 };
 
 /**
- * 编译模板并返回渲染函数
- * @param {String} body 模板
- * @param {Object} options 配置参数
- * @return {Function} 渲染函数
+ * 编译模板
+ * @param {string} body - 模板内容
+ * @param {Object} options - 配置参数
+ * @returns {Function} 渲染函数
  */
-Tpl.prototype.compile = function(body, options) {
+Tpl.prototype.compile = function (body, options) {
 	return template.compile(body, options);
 };
 
 /**
  * 渲染模板文件
- * @param {String} file 模板文件路径
- * @param {Object} model 数据模型
- * @param {Object} options 配置参数
- * @return {String} 渲染后的视图
+ * @param {string} file - 模板文件路径
+ * @param {Object} model - 数据模型
+ * @param {Object} options - 配置参数
+ * @returns {string} 渲染结果
  */
-Tpl.prototype.view = function(file, model, options) {
-	if (file.replace('./', '').indexOf('.') === -1 && !file.endWith(this.config.extname)) {
+Tpl.prototype.view = function (file, model, options) {
+	if (file.replace('./', '').indexOf('.') === -1 && !file.endsWith(this.config.extname)) {
 		file += this.config.extname;
 	}
 	var f = file.fullname(this.dir + 'diy');
@@ -361,9 +371,9 @@ Tpl.prototype.view = function(file, model, options) {
 	}
 	var body = f.loadText();
 	if (body) {
-		body = this.change(body);
-		body = this.render_sub(body, model, options);
-		body = this.change(body, true);
+		body = this.escape(body);
+		body = this._renderSub(body, model, options);
+		body = this.escape(body, true);
 		return body;
 	} else {
 		return "";
@@ -371,42 +381,42 @@ Tpl.prototype.view = function(file, model, options) {
 };
 
 /**
- * 设置视图背包成员
- * @param {Object} obj 设置的对象
+ * 设置视图数据
+ * @param {Object} obj - 要设置的数据对象
  */
-Tpl.prototype.set = function(obj) {
+Tpl.prototype.set = function (obj) {
 	$.push(this.viewBag, obj, true);
 };
 
 /**
- * 删除视图背包成员
- * @param {Array|String} arrOrStr 删除的键或键数组
+ * 删除视图数据
+ * @param {Array|string} keys - 要删除的键或键数组
  */
-Tpl.prototype.del = function(arrOrStr) {
-	if (typeof(arrOrStr) == 'string') {
-		delete this.viewBag[arrOrStr];
+Tpl.prototype.del = function (keys) {
+	if (typeof (keys) == 'string') {
+		delete this.viewBag[keys];
 	} else {
-		arr.map(function(k) {
+		keys.map(function (k) {
 			delete this.viewBag[k];
 		});
 	}
 };
 
 /**
- * 获取视图背包成员
- * @param {String} key 获取的对象键名
- * @return {Object} 值
+ * 获取视图数据
+ * @param {string} key - 数据键名
+ * @returns {any} 数据值
  */
-Tpl.prototype.get = function(key) {
+Tpl.prototype.get = function (key) {
 	return this.viewBag[key];
 };
 
 /**
  * 清除缓存
- * @param {Object} path 检索的路径
- * @param {Object} file 文件名
+ * @param {string} path - 缓存路径
+ * @param {string} file - 文件名
  */
-Tpl.prototype.clear_cache = function(path, file) {
+Tpl.prototype.clearCache = function (path, file) {
 	var cg = this.config;
 	var root = cg.cache_root;
 	var dir = path ? path.fullname(root) : root;
@@ -421,9 +431,11 @@ Tpl.prototype.clear_cache = function(path, file) {
 	});
 };
 
-if (global.$) {
+if (global.$ && !global.$.Tpl) {
 	$.Tpl = Tpl;
 	$.tpl = new Tpl();
 }
 
-module.exports = Tpl;
+module.exports = {
+	Tpl
+};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "mm_tpl",
-    "version": "2.4.3",
+    "version": "2.4.5",
     "description": "这是超级美眉模板帮助类模块，用于MVC模式下的视图渲染",
     "main": "index.js",
     "scripts": {
@@ -28,6 +28,6 @@
     "homepage": "https://gitee.com/qiuwenwu91/mm_tpl#readme",
     "dependencies": {
         "art-template": "^4.13.4",
-        "mm_expand": "^1.8.3"
+        "mm_expand": "^1.9.7"
     }
 }

package/template/diy/ad.html

@@ -6,8 +6,8 @@
 	</head>
 	<body>
 		<h5>${viewBag.name}</h5>
-		<p>${@hook_filter('test', '你真的是人才！')}</p>
-		<p><!--{@hook_filter('test', '你真的是人才！', {key: '123'})}--></p>
+		<p>${@hookFilter('test', '你真的是人才！')}</p>
+		<p><!--{@hookFilter('test', '你真的是人才！', {key: '123'})}--></p>
 		<ul>
 			${loop arr value idx}
 			<li>\${ value }</li>
@@ -20,9 +20,10 @@
 		</ul>
 		<ul>
 			<!--{loop arr value idx}-->
-			<li>\${ value }</li>
+			<li>${ value }</li>
 			<!--{/loop}-->
 		</ul>
+		<strong>${message}</strong>
 		<script type="text/javascript">
 			/*[loop arr value idx]*/
 			var a_${idx} = ${value};

package/template/game/bar.html

@@ -1,5 +1,5 @@
 <div class="bar_user">
-	${@hook_filter('test', hook_action('test', '好的'), '真的')}
+	${@hookFilter('test', hook_action('test', '好的'), '真的')}
 	<div>用户ID：${viewBag.user_id}</div>
 	<div>当前项目ID：${viewBag.project_id}</div>
 	<div>${message}</div>

package/test.js

@@ -1,4 +1,4 @@
-const Tpl = require('./index.js');
+const {Tpl} = require('./index.js');
 
 /**
  * 基础模板渲染测试函数
@@ -10,7 +10,7 @@ async function test() {
 	var body = tpl.render("<a>${test} + 123123</a>", {
 		test: 123
 	});
-	console.log(body);
+	$.log.debug(body);
 }
 
 /**
@@ -34,7 +34,7 @@ async function test() {
 	// each循环示例
 	// var body = tpl.render("<a>${ each arr } ${ arr[$index] } ${/each} + 123123</a>", { arr: [123,234] });
 	// var view = tpl.render("<a>${ each arr } ${ $value } ${/each} + 123123</a>", { arr: [123,234] });
-	console.log(body);
+	$.log.debug(body);
 }
 
 /**
@@ -43,7 +43,7 @@ async function test() {
  * @async
  */
 async function test() {
-	console.log("测试开始")
+	$.log.debug("测试开始")
 	var tpl = new Tpl();
 	// 设置全局变量
 	$.globalBag.name = "超级美眉Art模板引擎";
@@ -53,8 +53,8 @@ async function test() {
 
 	// 渲染视图
 	var body = tpl.view("./test.html", { arr: [123,234] });
-	console.log(tpl.error);
-	console.log(body);
+	$.log.debug(tpl.error);
+	$.log.debug(body);
 }
 
 /**
@@ -75,6 +75,7 @@ async function test() {
 
 	// 添加列表函数钩子
 	$.hook.addFunc('list', async function(m, req, type) {
+		console.log("参数", m, req, type);
 		var query = req.query;
 		if (query.user_id) {
 			m.user_id = query.user_id;
@@ -82,7 +83,7 @@ async function test() {
 		if (query.project_id) {
 			m.project_id = query.project_id;
 		}
-		console.log("列表", m);
+		$.log.debug("列表", m);
 	});
 
 	// 添加动作钩子
@@ -96,7 +97,7 @@ async function test() {
 
 	// 添加过滤器钩子
 	$.hook.addFilter('test', function(m, ret, param) {
-		console.log("测试", ret);
+		$.log.debug("测试", ret);
 		return ret.replace("你", "您");
 	}, 1, "测试过滤");
 
@@ -125,7 +126,7 @@ async function test() {
 	});
 	// 删除指定目录下的缓存文件
 	// tpl.clear_cache('./mall');
-	console.log(body);
+	$.log.debug("渲染结果", body);
 }
 
 // 执行测试