@tiveor/scg 0.1.2 → 0.1.6

package/.prettierignore

@@ -0,0 +1 @@
+*.ejs

package/.travis.yml

@@ -0,0 +1,9 @@
+language: node_js
+sudo: false
+node_js:
+  - "10"
+  - "12"
+  - "14"
+branches:
+  only:
+  - master

package/.vscode/settings.json

@@ -0,0 +1,5 @@
+{
+  "emmet.includeLanguages": {
+    "ejs": "html"
+  }
+}

package/README.md

@@ -1,2 +1,64 @@
-# scg
-SCG a Random Library for Generators
+SCG a Random Library for Generators<br/>
+[![Build Status](https://travis-ci.org/tiveor/scg.svg?branch=master)](https://travis-ci.org/tiveor/scg)
+[![npm version](https://badge.fury.io/js/%40tiveor%2Fscg.svg)](https://badge.fury.io/js/%40tiveor%2Fscg)
+=============================
+
+## Installation
+```bash
+npm install @tiveor/scg
+```
+
+## Basic usage
+```javascript
+const { StringHelper } = require('@tiveor/scg');
+const replaced = StringHelper.replace('This is a {{test}}', '{{test}}', 'joke');
+// replaced = "This is a joke"
+```
+
+## TemplateBuilder usage
+```javascript
+const { TemplateBuilder, TEMPLATE_HANDLERS } = require('@tiveor/scg');
+
+const ejsBuilder = new TemplateBuilder(TEMPLATE_HANDLERS.EJS);
+ejsBuilder
+  .render('This is a <%= test %>', {
+    test: 'joke'
+  })
+  .then((replaced) => {
+    // replaced = "This is a joke"
+  });
+
+const pugBuilder = new TemplateBuilder(TEMPLATE_HANDLERS.PUG);
+pugBuilder
+  .render('This is a #{test}', {
+    test: 'joke'
+  })
+  .then((replaced) => {
+    // replaced = "This is a joke"
+  });
+
+const handlebarsBuilder = new TemplateBuilder(TEMPLATE_HANDLERS.HANDLEBARS);
+handlebarsBuilder
+  .render('This is a {{test}}', {
+    test: 'joke'
+  })
+  .then((replaced) => {
+    // replaced = "This is a joke"
+  });
+```
+
+## Example
+```bash
+node example/index.js
+```
+
+For more information about templates visit the official documentation for each one:
+
+* EJS <br/>
+https://ejs.co/#docs
+
+* PUG <br/>
+https://pugjs.org/api/getting-started.html
+
+* Handlebars <br>
+https://handlebarsjs.com/guide/

package/example/ejs/conditional.ejs

@@ -0,0 +1,9 @@
+<% if (isDark) { %>
+<div style="background: #333; color:#F0F0F0">
+  <%= text %>
+</div>
+<% } else { %>
+<div style="background: #F0F0F0; color: #333">
+  <%= text %>
+</div>
+<% } %>

package/example/ejs/hello.ejs

@@ -0,0 +1,8 @@
+<div class="container">
+  <h1>
+    <%= title %>
+  </h1>
+  <div class="body">
+    <%= body %>
+  </div>
+</div>

package/example/handlebars/conditional.handlebars

@@ -0,0 +1,9 @@
+{{#if isDark}}
+<div style="background: #333; color:#F0F0F0">
+  {{text}}
+</div>
+{{else}}
+<div style="background: #F0F0F0; color: #333">
+  {{text}}
+</div>
+{{/if}}

package/example/handlebars/hello.handlebars

@@ -0,0 +1,6 @@
+<div class="container">
+  <h1>{{title}}</h1>
+  <div class="body">
+    {{body}}
+  </div>
+</div>

package/example/index.js

@@ -0,0 +1,180 @@
+const { StringHelper } = require('../src/string_helper');
+const { FileHelper } = require('../src/file_helper');
+const { CommandHelper } = require('../src/command_helper');
+const { ParamHelper } = require('../src/param_helper');
+const { TemplateBuilder } = require('../src/template_builder');
+const TEMPLATE_HANDLERS = require('../src/template_handlers');
+
+const initTest = (title) => {
+  console.log(`=================${title}=================`);
+};
+
+const endTest = () => {
+  console.log('================================');
+};
+
+//Usage StringHelper
+const testStringHelper = () => {
+  initTest('STRING HELPER');
+  const replaced = StringHelper.replace(
+    'This is a {{test}}',
+    '{{test}}',
+    'joke'
+  );
+  console.log(replaced);
+  endTest();
+};
+
+//Usage FileHelper
+const testFileHelper = () => {
+  initTest('FILE HELPER');
+  const packageObject = FileHelper.convertJsonFileToObject('package.json');
+  console.log(JSON.stringify(packageObject));
+  endTest();
+};
+
+//Usage ParamHelper
+const testParamHelper = () => {
+  initTest('Param HELPER');
+  ParamHelper.addCustomParam(`--config=123`);
+  ParamHelper.addCustomParam(`--test="this is a test"`);
+  const params = ParamHelper.getParams();
+  console.log('params', params);
+  const config = ParamHelper.getCommandByIndex(2);
+  const test = ParamHelper.getCommandByIndex(3);
+  console.log('config', config);
+  console.log('test', test);
+  endTest();
+};
+
+//Usage CommandHelper
+const testCommandHelper = () => {
+  initTest('Command HELPER');
+  CommandHelper.runClean('.', 'pwd').then((res) => {
+    console.log(res);
+    endTest();
+  });
+};
+
+//Usage TemplateBuilder with EJS
+const testTemplateEJS = async () => {
+  initTest('TemplateBuilder with EJS');
+  const builder = new TemplateBuilder(TEMPLATE_HANDLERS.EJS);
+  builder
+    .renderFile(
+      'example/ejs/hello.ejs',
+      { title: 'Hello EJS world', body: 'this is the body' },
+      {}
+    )
+    .then((html) => {
+      console.log(html);
+      endTest();
+    });
+
+  builder
+    .renderFile(
+      'example/ejs/conditional.ejs',
+      { isDark: true, text: 'Hello Dark World' },
+      {}
+    )
+    .then((html) => {
+      console.log(html);
+      endTest();
+    });
+
+  builder
+    .renderFile(
+      'example/ejs/conditional.ejs',
+      { isDark: false, text: 'Hello Light World' },
+      {}
+    )
+    .then((html) => {
+      console.log(html);
+      endTest();
+    });
+};
+
+//Usage TemplateBuilder with handlebars
+const testTemplateHandlebars = async () => {
+  initTest('TemplateBuilder with handlebars');
+  const builder = new TemplateBuilder(TEMPLATE_HANDLERS.HANDLEBARS);
+  builder
+    .renderFile(
+      'example/handlebars/hello.handlebars',
+      { title: 'Hello handlebars world', body: 'this is the body' },
+      {}
+    )
+    .then((html) => {
+      console.log(html);
+      endTest();
+    });
+
+  builder
+    .renderFile(
+      'example/handlebars/conditional.handlebars',
+      { isDark: true, text: 'Hello Dark World' },
+      {}
+    )
+    .then((html) => {
+      console.log(html);
+      endTest();
+    });
+
+  builder
+    .renderFile(
+      'example/handlebars/conditional.handlebars',
+      { isDark: false, text: 'Hello Light World' },
+      {}
+    )
+    .then((html) => {
+      console.log(html);
+      endTest();
+    });
+};
+
+//Usage TemplateBuilder with pug
+const testTemplatePug = async () => {
+  initTest('TemplateBuilder with pug');
+  const builder = new TemplateBuilder(TEMPLATE_HANDLERS.PUG);
+  builder
+    .renderFile(
+      'example/pug/hello.pug',
+      { title: 'Hello pug world', body: 'this is the body' },
+      {}
+    )
+    .then((html) => {
+      console.log(html);
+      endTest();
+    });
+
+  builder
+    .renderFile(
+      'example/pug/conditional.pug',
+      { isDark: true, text: 'Hello Dark World' },
+      {}
+    )
+    .then((html) => {
+      console.log(html);
+      endTest();
+    });
+
+  builder
+    .renderFile(
+      'example/pug/conditional.pug',
+      { isDark: false, text: 'Hello Light World' },
+      {}
+    )
+    .then((html) => {
+      console.log(html);
+      endTest();
+    });
+};
+
+console.log('\nSCG Examples\n');
+//testStringHelper();
+//testFileHelper();
+//testParamHelper();
+//testCommandHelper();
+//testTemplateEJS();
+//testTemplatePug();
+testTemplateHandlebars();

package/example/pug/conditional.pug

@@ -0,0 +1,4 @@
+if isDark
+  div(style="background: #333; color:#F0F0F0") #{text}
+else
+  div(style="background: #F0F0F0; color: #333") #{text}

package/example/pug/hello.pug

@@ -0,0 +1,3 @@
+div(class="container")
+  h1 #{title}
+  div(class="body") #{body}

package/index.js

@@ -1,9 +1,15 @@
-const { StringHelper } = require("./src/string_helper");
-const { FileHelper } = require("./src/file_helper");
-const { CommandHelper } = require("./src/command_helper");
+const { StringHelper } = require('./src/string_helper');
+const { FileHelper } = require('./src/file_helper');
+const { CommandHelper } = require('./src/command_helper');
+const { ParamHelper } = require('./src/param_helper');
+const { TemplateBuilder } = require('./src/template_builder');
+const TEMPLATE_HANDLERS = require('./src/template_handlers');
 
 module.exports = {
   StringHelper,
   FileHelper,
-  CommandHelper
-};
+  CommandHelper,
+  ParamHelper,
+  TemplateBuilder,
+  TEMPLATE_HANDLERS
+};

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@tiveor/scg",
-  "version": "0.1.2",
+  "version": "0.1.6",
   "description": "SCG a Random Library for Generators",
   "main": "index.js",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "mocha ./test"
   },
   "repository": {
     "type": "git",
@@ -17,6 +17,12 @@
   },
   "homepage": "https://github.com/tiveor/scg#readme",
   "devDependencies": {
+    "mocha": "^8.3.0",
     "prettier": "^2.2.1"
+  },
+  "dependencies": {
+    "ejs": "^3.1.6",
+    "handlebars": "^4.7.7",
+    "pug": "^3.0.2"
   }
 }

package/src/ejs_helper.js

@@ -0,0 +1,30 @@
+const ejs = require("ejs");
+
+//https://ejs.co/
+//https://github.com/mde/ejs
+class EjsHelper {
+  static render(source, data, options) {
+    return new Promise((resolve, reject) => {
+      try {
+        const template = ejs.render(source, data, options);
+        resolve(template);
+      } catch (error) {
+        reject(error);
+      }
+    });
+  }
+
+  static renderFile(fileName, data, options) {
+    return new Promise((resolve, reject) => {
+      ejs.renderFile(fileName, data, options, function (err, str) {
+        if (err) {
+          reject(err)
+          return;
+        }
+
+        resolve(str);
+      });
+    });
+  }
+}
+exports.EjsHelper = EjsHelper;

package/src/file_helper.js

@@ -1,12 +1,16 @@
 const fs = require("fs");
 const readline = require("readline");
-const { exec } = require("child_process");
 const { StringHelper } = require("./string_helper");
+const { CommandHelper } = require("./command_helper");
 
 class FileHelper {
+  static readFileToString(fileName) {
+    return fs.readFileSync(fileName, 'utf8');
+  }
+
   static convertJsonFileToObject(fileName) {
-    let rawdata = fs.readFileSync(fileName);
-    return JSON.parse(rawdata);
+    const rawString = this.readFileToString(fileName);
+    return JSON.parse(rawString);
   }
 
   static simpleReplace(line, replacement) {
@@ -122,15 +126,16 @@ class FileHelper {
       fs.mkdirSync(`./${folderName}/`, { recursive: true });
   }
 
-  static removeFolder(folderName, callback) {
-    exec(`rm -Rf '${folderName}'`, function (err, stdout, stderr) {
-      if (err || stderr) {
-        console.log("err:", err);
-        console.log("stderr:", stderr);
-      } else {
-        callback();
-      }
-    });
+  static removeFolder(folderName) {
+    return CommandHelper.runClean(
+      ".",
+      `rm -Rf '${folderName}'`);
+  }
+
+  static removeFile(filename) {
+    return CommandHelper.runClean(
+      ".",
+      `rm -f '${filename}'`);
   }
 }
 

package/src/handlebars_helper.js

@@ -0,0 +1,32 @@
+const Handlebars = require("handlebars");
+const { FileHelper } = require("./file_helper");
+
+//https://handlebarsjs.com/
+//https://github.com/handlebars-lang/handlebars.js
+class HandlebarsHelper {
+  static render(source, data, options) {
+    return new Promise((resolve, reject) => {
+      try {
+        const template = Handlebars.compile(source, options);
+        const res = template(data);
+        resolve(res);
+      } catch (error) {
+        reject(error);
+      }
+    });
+  }
+
+  static renderFile(fileName, data, options) {
+    return new Promise((resolve, reject) => {
+      try {
+        const source = FileHelper.readFileToString(fileName);
+        const template = Handlebars.compile(source, options);
+        const res = template(data);
+        resolve(res);
+      } catch (error) {
+        reject(error);
+      }
+    });
+  }
+}
+exports.HandlebarsHelper = HandlebarsHelper;

package/src/param_helper.js

@@ -0,0 +1,25 @@
+class ParamHelper {
+  static addCustomParam(customParam) {
+    process.argv.push(customParam);
+  }
+
+  static getCommandByIndex(index) {
+    return process.argv.length > index ? process.argv[index] : "";
+  }
+
+  static getParams() {
+    const argv = (() => {
+      let paramsObj = {};
+      process.argv.slice(2).map((element) => {
+        const matches = element.match('--([a-zA-Z0-9]+)=(.*)');
+        if (matches) {
+          paramsObj[matches[1]] = matches[2]
+            .replace(/^['"]/, '').replace(/['"]$/, '');
+        }
+      });
+      return paramsObj;
+    })();
+    return argv;
+  }
+}
+exports.ParamHelper = ParamHelper;

package/src/pug_helper.js

@@ -0,0 +1,28 @@
+const pug = require('pug');
+
+//https://github.com/pugjs/pug
+//https://pugjs.org/api/getting-started.html
+class PugHelper {
+  static render(source, data, options) {
+    return new Promise((resolve, reject) => {
+      try {
+        const template = pug.compile(source, options);
+        resolve(template(data));
+      } catch (error) {
+        reject(error);
+      }
+    });
+  }
+
+  static renderFile(fileName, data, options) {
+    return new Promise((resolve, reject) => {
+      try {
+        const template = pug.compileFile(fileName, options);
+        resolve(template(data));
+      } catch (error) {
+        reject(error);
+      }
+    });
+  }
+}
+exports.PugHelper = PugHelper;

package/src/string_helper.js

@@ -3,7 +3,7 @@ class StringHelper {
     return line.replace(new RegExp(token, "g"), value);
   }
 
-  static capitalize = (s) => {
+  static capitalize(s) {
     if (typeof s !== "string") return "";
     return s.charAt(0).toUpperCase() + s.slice(1);
   }

package/src/template_builder.js

@@ -0,0 +1,38 @@
+const { HandlebarsHelper } = require('./handlebars_helper');
+const { EjsHelper } = require('./ejs_helper');
+const { PugHelper } = require('./pug_helper');
+const TEMPLATE_HANDLERS = require('./template_handlers');
+
+class TemplateBuilder {
+  constructor(templateHandler) {
+    this.templateHandler = templateHandler;
+  }
+
+  render(source, data, options) {
+    switch (this.templateHandler) {
+      case TEMPLATE_HANDLERS.HANDLEBARS:
+        return HandlebarsHelper.render(source, data, options);
+      case TEMPLATE_HANDLERS.EJS:
+        return EjsHelper.render(source, data, options);
+      case TEMPLATE_HANDLERS.PUG:
+        return PugHelper.render(fileName, data, options);
+      default:
+        return HandlebarsHelper.render(source, data, options);
+    }
+  }
+
+  renderFile(fileName, data, options) {
+    switch (this.templateHandler) {
+      case TEMPLATE_HANDLERS.HANDLEBARS:
+        return HandlebarsHelper.renderFile(fileName, data, options);
+      case TEMPLATE_HANDLERS.EJS:
+        return EjsHelper.renderFile(fileName, data, options);
+      case TEMPLATE_HANDLERS.PUG:
+        return PugHelper.renderFile(fileName, data, options);
+      default:
+        return HandlebarsHelper.renderFile(fileName, data, options);
+    }
+  }
+}
+
+exports.TemplateBuilder = TemplateBuilder;

package/src/template_handlers.js

@@ -0,0 +1,7 @@
+const TEMPLATE_HANDLERS = {
+  HANDLEBARS: 'HANDLEBARS',
+  EJS: 'EJS',
+  PUG: 'PUG'
+};
+
+exports.TEMPLATE_HANDLERS = TEMPLATE_HANDLERS;

package/test/test.js

@@ -0,0 +1,11 @@
+var assert = require('assert');
+const { StringHelper } = require("../src/string_helper");
+
+describe("StringHelper", () => {
+  describe("replace", () => {
+    it('should search and replace the test param', function () {
+      const replaced = StringHelper.replace("This is a {{test}}", "{{test}}", "joke");
+      assert.strictEqual(replaced, "This is a joke");
+    });
+  })
+});

package/example.js

@@ -1,27 +0,0 @@
-const { StringHelper } = require("./src/string_helper");
-const { FileHelper } = require("./src/file_helper");
-const { CommandHelper } = require("./src/command_helper");
-
-console.log("\nSCG Examples\n");
-
-//Usage StringHelper
-console.log("================================");
-console.log("STRING HELPER");
-const replaced = StringHelper.replace("This is a {{test}}", "{{test}}", "joke");
-console.log(replaced);
-console.log("================================");
-
-//Usage FileHelper
-console.log("================================");
-console.log("FILE HELPER");
-const packageObject = FileHelper.convertJsonFileToObject("package.json");
-console.log(JSON.stringify(packageObject));
-console.log("================================");
-
-//Usage CommandHelper
-console.log("================================");
-console.log("Command HELPER");
-CommandHelper.runClean(".", "pwd").then((res) => {
-  console.log(res);
-  console.log("================================");
-});