Merge pull request #34 from rachx/support-variables

Support user-defined variables #143

Author: acjh

lib/Page.js

@@ -23,6 +23,7 @@ function Page(pageConfig) {
   this.baseUrl = pageConfig.baseUrl;
   this.asset = pageConfig.asset;
   this.baseUrlMap = pageConfig.baseUrlMap;
+  this.userDefinedVariablesMap = pageConfig.userDefinedVariablesMap;
   this.includedFiles = {};
 }
 
@@ -80,6 +81,7 @@ Page.prototype.generate = function (builtFiles) {
   return new Promise((resolve, reject) => {
     markbinder.includeFile(this.sourcePath, {
       baseUrlMap: this.baseUrlMap,
+      userDefinedVariablesMap: this.userDefinedVariablesMap,
       rootPath: this.rootPath,
     })
       .then(result => markbinder.resolveBaseUrl(result, {
@@ -157,6 +159,7 @@ Page.prototype.resolveDependency = function (dependency, builtFiles) {
     }
     return markbinder.includeFile(file, {
       baseUrlMap: this.baseUrlMap,
+      userDefinedVariablesMap: this.userDefinedVariablesMap,
       rootPath: this.rootPath,
     })
       .then(result => markbinder.resolveBaseUrl(result, {

lib/Site.js

@@ -1,3 +1,4 @@
+const cheerio = require('cheerio');
 const path = require('path');
 const ignore = require('ignore');
 const ejs = require('ejs');
@@ -17,6 +18,7 @@ const BOILERPLATE_FOLDER_NAME = '_boilerplates';
 const SITE_ASSET_FOLDER_NAME = 'asset';
 const TEMPLATE_ROOT_FOLDER_NAME = 'template';
 const TEMPLATE_SITE_ASSET_FOLDER_NAME = 'markbind';
+const USER_VARIABLES_PATH = '_markbind/variables.md';
 
 const SITE_CONFIG_DEFAULT = {
   baseUrl: '',
@@ -38,6 +40,11 @@ const SITE_CONFIG_DEFAULT = {
 
 const INDEX_MARKDOWN_DEFAULT = '# Hello world\nWelcome to your page generated with MarkBind.\n';
 
+const USER_VARIABLES_DEFAULT = '<span id="example">\n'
+  + 'To inject this HTML segment in your markbind files, use {{ example }} where you want to place it.\n'
+  + 'More generally, surround the segment\'s id with double curly braces.\n'
+  + '</span>';
+
 function Site(rootPath, outputPath) {
   this.rootPath = rootPath;
   this.outputPath = outputPath;
@@ -84,6 +91,7 @@ Site.initSite = function (rootPath) {
   const boilerplatePath = path.join(rootPath, BOILERPLATE_FOLDER_NAME);
   const configPath = path.join(rootPath, SITE_CONFIG_NAME);
   const indexPath = path.join(rootPath, INDEX_MARKDOWN_FILE);
+  const userDefinedVariablesPath = path.join(rootPath, USER_VARIABLES_PATH);
   // TODO: log the generate info
   return new Promise((resolve, reject) => {
     fs.accessAsync(boilerplatePath)
@@ -107,6 +115,13 @@ Site.initSite = function (rootPath) {
         }
         return fs.outputFileAsync(indexPath, INDEX_MARKDOWN_DEFAULT);
       })
+      .then(() => fs.accessAsync(userDefinedVariablesPath))
+      .catch(() => {
+        if (fs.existsSync(userDefinedVariablesPath)) {
+          return Promise.resolve();
+        }
+        return fs.outputFileAsync(userDefinedVariablesPath, USER_VARIABLES_DEFAULT);
+      })
       .then(resolve)
       .catch(reject);
   });
@@ -153,6 +168,7 @@ Site.prototype.createPageData = function (config) {
     baseUrl: config.baseUrl,
     pageTemplate: config.pageTemplate,
     baseUrlMap: this.baseUrlMap,
+    userDefinedVariablesMap: this.userDefinedVariablesMap,
     asset: {
       bootstrap: path.relative(path.dirname(resultPath),
                                path.join(this.siteAssetsDestPath, 'css', 'bootstrap.min.css')),
@@ -185,6 +201,38 @@ Site.prototype.collectBaseUrl = function () {
   return Promise.resolve();
 };
 
+/**
+ * Collects the user defined variables map in the site/subsites
+ */
+Site.prototype.collectUserDefinedVariablesMap = function () {
+  // The key is the base directory of the site/subsites,
+  // while the value is a mapping of user defined variables
+  this.userDefinedVariablesMap = {};
+
+  Object.keys(this.baseUrlMap).forEach((base) => {
+    const userDefinedVariables = {};
+    let content;
+    try {
+      const userDefinedVariablesPath = path.resolve(base, USER_VARIABLES_PATH);
+      content = fs.readFileSync(userDefinedVariablesPath, 'utf8');
+    } catch (e) {
+      content = '';
+      logger.warn(e.message);
+    }
+    const $ = cheerio.load(content);
+    $.root().children().each(function () {
+      const id = $(this).attr('id');
+      const html = $(this).html();
+      userDefinedVariables[id] = html;
+    });
+
+    // This is to prevent the first nunjuck call from converting {{baseUrl}} to an empty string
+    // and let the baseUrl value be injected later.
+    userDefinedVariables.baseUrl = '{{baseUrl}}';
+    this.userDefinedVariablesMap[base] = userDefinedVariables;
+  });
+};
+
 Site.prototype.generate = function () {
   // Create the .tmp folder for storing intermediate results.
   fs.emptydirSync(this.tempPath);
@@ -193,6 +241,7 @@ Site.prototype.generate = function () {
   return new Promise((resolve, reject) => {
     this.readSiteConfig()
       .then(() => this.collectBaseUrl())
+      .then(() => this.collectUserDefinedVariablesMap())
       .then(() => this.buildAssets())
       .then(() => this.buildSourceFiles())
       .then(() => this.copyMarkBindAsset())

package.json

@@ -19,6 +19,7 @@
   "dependencies": {
     "bluebird": "^3.4.7",
     "chalk": "^1.1.3",
+    "cheerio": "^0.22.0",
     "chokidar": "^1.6.1",
     "clear": "^0.0.1",
     "commander": "^2.9.0",