doc and test for options.matcher

billykong · Apr 22, 2020 · 2294281 · 2294281
1 parent c316c3f
commit 2294281
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 9 deletions.
diff --git a/readme.md b/readme.md
@@ -10,14 +10,12 @@
 ```JavaScript
 var templeteEngine = require('./simple_templating_engine.js');
 var template = "Hello, <% change_me %>";
-
-
 var handlerWorld = function(key) { return { '<% change_me %>': 'World' } };
+
 templeteEngine.populate(template, handlerWorld).then(populated => {
     console.log(populated); // "Hello, World"
 });
 
-
 var handlerAsyncWorld = function(key) { return { '<% change_me %>': 'Async World' } };
 (async function() {
   let populated = await templeteEngine.populate(template, handlerAsyncWorld);
@@ -29,7 +27,6 @@ var handlerAsyncWorld = function(key) { return { '<% change_me %>': 'Async World
 It also work with JSON template:
 ```JavaScript
 var templateJSON = `{ "root": <% change_me %> }`;
-
 var handlerJSON = function(key) { 
   return { 
     '<% change_me %>': { 
@@ -59,3 +56,14 @@ templeteEngine.populate(templateJSON, handlerJSON).then(populated => {
     console.log(populated); 
 });
 ```
+
+You can also use another matcher pattern other than `<% ... %>`:
+```JavaScript
+var template = "Hello, {_ change_me _}";
+var options = { matcher: /"{_([^%>]+)?_}"/g}
+var handler = function(key) { return { '{_ change_me _}': 'World' } };
+
+templeteEngine.populate(template, handler, options).then(populated => {
+    console.log(populated); // "Hello, World"
+});
+```
diff --git a/simple_templating_engine.js b/simple_templating_engine.js
@@ -10,7 +10,7 @@ function parse(template, options={}) {
   let re = options.matcher || /"<%([^%>]+)?%>"/g;
   let match;
   while(match = re.exec(template)) {
-    keys.push(match[0]);
+    keys.push(match[0]); // this line is never executed
   }
   return [template, keys];
 };
@@ -23,8 +23,6 @@ function merge(template, data, options={}) {
   // console.log(data)
   console.log("\nPopulating...")
   Object.keys(data).forEach(key => {
-    let re = options.matcher || /"<%([^%>]+)?%>"/g;
-    let match;
     while(template.includes(key)) {
       if (typeof data[key] === 'string') {
         console.log(`- mapping ${key} to ${data[key]}`);
@@ -33,7 +31,6 @@ function merge(template, data, options={}) {
         console.log(`- mapping ${key} to ${JSON.stringify(data[key])}`);
         template = template.replace(key, JSON.stringify(data[key]));
       }
-
     }
   });
   console.log("\nFinishing...");

diff --git a/test/simple_templating_engine_test.js b/test/simple_templating_engine_test.js
@@ -55,8 +55,19 @@ describe('templateEngine#populate()', function() {
       let populated = await templeteEngine.populate(template, handler);
       assert(_.isEqual(JSON.parse(populated), { root: { key1: 'value1', key2: 'value2' }}));
     });
+  });
 
+  context('with custom matcher regex in options', function() {
+    let template, options, handler;
+    beforeEach(function() {
+      template = "Hello, {_ change_me _}";
+      options = { matcher: /"{_([^%>]+)?_}"/g}
+      handler = function(key) { return { '{_ change_me _}': 'World' } }
+    });
 
+    it('should replace the placeholder with the async handler', async function() {
+      let populated = await templeteEngine.populate(template, handler, options);
+      assert.equal(populated, 'Hello, World');
+    });
   });
-
 });