#123: add first ejs helpers

Author: robhrt7

app.js

@@ -76,6 +76,8 @@ if (!commander.watch) {
 
 /* App config */
 
+require('./core/ejsHelpers');
+
 // Version
 app.use(function (req, res, next) {
     res.header('X-powered-by', 'SourceJS ' + global.engineVersion);

core/ejsHelpers.js

@@ -0,0 +1,115 @@
+'use strict';
+
+var ejs = require('ejs');
+var fs = require('fs');
+var glob = require('glob');
+var path = require('path');
+var _ = require('lodash');
+var processMd = require(path.join(global.pathToApp,'core/lib/processMd'));
+
+var originalRenderer = ejs.render;
+
+var EJS_OPTS = ['cache', 'filename', 'sandbox', 'delimiter', 'scope', 'context', 'debug', 'compileDebug', 'client', '_with', 'rmWhitespace'
+];
+
+/**
+ * Copy properties in data object that are recognized as options to an
+ * options object.
+ *
+ * This is used for compatibility with earlier versions of EJS and Express.js.
+ *
+ * @memberof module:ejs-internal
+ * @param {Object}  data data object
+ * @param {Options} opts options object
+ * @static
+ */
+
+var cpOptsInData = function (data, opts) {
+    EJS_OPTS.forEach(function (p) {
+        if (typeof data[p] !== 'undefined') {
+            opts[p] = data[p];
+        }
+    });
+};
+
+var readFile = function (filePath, options) {
+    if (options.sandbox && path.relative(options.sandbox, filePath).substring(0, 2) === '..') {
+        throw new Error('reading files beyond sandbox is restricted, limit set to ' + options.sandbox);
+    }
+
+    return fs.readFileSync(filePath, 'utf-8');
+};
+
+var includeMD = module.exports.includeMD = function(data, options){
+    return function(mdPath){
+        if (!mdPath) return '';
+
+        var origionalFilename = options.filename;
+
+        if (!origionalFilename) throw new Error('`includeMD` requires the \'filename\' option.');
+
+        var fileToInclude = path.extname(mdPath) === '.md' ? mdPath : mdPath + '.md';
+        var filePath = path.join(path.dirname(origionalFilename), fileToInclude);
+        var fileContents = readFile(filePath, options);
+
+        options.filename = filePath;
+
+        var processedContents = ejs.render(fileContents, data, options);
+        var html = processMd(processedContents);
+
+        // Reset filename options on return
+        options.filename = origionalFilename;
+
+        return ejs.render(html, data, options);
+    };
+};
+
+var includeFiles = module.exports.includeFiles = function(data, options){
+    return function(pattern){
+        if (!pattern) return '';
+
+        var filename = options.filename;
+        var output = '';
+
+        if (!filename) throw new Error('`includeFiles` requires the \'filename\' option.');
+
+        var filesToInclude = glob.sync(pattern, {
+            cwd: path.dirname(filename),
+            root: global.pathToApp,
+            realpath: true
+        });
+
+        filesToInclude.forEach(function(filePath){
+            _.assign(options, {
+                filename: filePath
+            });
+
+            output += ejs.render(readFile(filePath, options), data, options);
+        });
+
+        // Reset filename options on return
+        _.assign(options, {
+            filename: filename
+        });
+
+        return output;
+    };
+};
+
+ejs.render = function(template, data, options){
+    data = data || {};
+    options = options || {};
+
+    // No options object -- if there are optiony names
+    // in the data, copy them to options
+    if (arguments.length == 2) {
+        cpOptsInData(data, options);
+    }
+
+    _.assign(data, {
+        includeMD: includeMD(data, options),
+        includeFiles: includeFiles(data, options)
+    });
+
+    return originalRenderer(template, data, options);
+};

package.json

@@ -29,6 +29,7 @@
     "flat": "^1.2.1",
     "fs-extra": "~0.11.1",
     "fs-finder": "operatino/node-fs-finder#fix-windows-find-up",
+    "glob": "^5.0.14",
     "grunt": "~0.4.5",
     "grunt-autoprefixer": "~1.0.0",
     "grunt-cli": "^0.1.13",
@@ -64,11 +65,14 @@
     "build": "npm i",
     "start": "node app",
     "test": "grunt ci-pre-run && node app.js --test",
+    "test:unit": "grunt test",
+    "test:func": "grunt test-func",
     "ci-test": "grunt ci-pre-run && node app.js --test --log trace",
     "ci-test-win": "grunt ci-pre-run && node app.js --post-grunt ci-post-run-win --test --log trace --no-watch"
   },
   "devDependencies": {
     "assert": "~1.1.1",
+    "chai": "^3.2.0",
     "cross-spawn": "^0.4.0",
     "grunt-casperjs": "^2.1.0",
     "grunt-mocha-test": "^0.12.4",

test/unit/ejsHelpersSpec.js

@@ -0,0 +1,70 @@
+var path = require('path');
+var ejs = require('ejs');
+var expect = require('chai').expect;
+
+var pathToMasterApp = path.resolve('./');
+var loadOptions = require(path.join(pathToMasterApp, 'core/loadOptions'));
+global.opts = loadOptions(path.resolve(pathToMasterApp));
+
+require(path.join(pathToMasterApp, 'core/ejsHelpers'));
+
+describe('includeMD', function () {
+    it('should properly include Markdown file', function (done) {
+        var result = ejs.render('<%- includeMD("partials/markdown") %>', {
+            filename: __filename
+        });
+
+        expect(result).to.equal('<p>Hello <strong>world</strong>!</p>\n');
+
+        done();
+    });
+
+    it('should properly include Markdown file with EJS includes', function (done) {
+        var result = ejs.render('<%- includeMD("partials/markdown-ejs") %>', {
+          world: 'world'
+        }, {
+            filename: __filename
+        });
+
+        expect(result).to.equal('<p>Hello <strong>world</strong>!</p>\n');
+
+        done();
+    });
+
+    it('should properly include Markdown with nested include', function (done) {
+        var result = ejs.render('<%- includeMD("partials/markdown-ejs-nested") %>', {
+          world: 'world'
+        }, {
+            filename: __filename
+        });
+
+        expect(result).to.contain('<p>Nested:</p><p>Hello <strong>world</strong>!</p>');
+
+        done();
+    });
+});
+
+describe('includeFiles', function () {
+    it('should include one file by glob', function (done) {
+        var result = ejs.render('<%- includeFiles("partials/mask-one.html") %>', {
+            filename: __filename
+        });
+
+        expect(result).to.equal('one<br>');
+
+        done();
+    });
+
+    it('should include multiple files by glob', function (done) {
+        var result = ejs.render('<%- includeFiles("partials/mask-*.html") %>', {
+            filename: __filename
+        });
+
+        expect(result).to.contain('one');
+        expect(result).to.contain('two');
+        expect(result).to.contain('three');
+        expect(result).to.contain('Hello');
+
+        done();
+    });
+});

test/unit/partials/markdown-ejs-nested.md

@@ -0,0 +1,3 @@
+Hello **<%= world %>**!
+
+Nested:<%- includeMD('markdown.md') %>

test/unit/partials/markdown-ejs.md

@@ -0,0 +1 @@
+Hello **<%= world %>**!

test/unit/partials/markdown.md

@@ -0,0 +1 @@
+Hello **world**!

test/unit/partials/mask-one.html

@@ -0,0 +1 @@
+one<br>

test/unit/partials/mask-two.html

@@ -0,0 +1,2 @@
+two<br>
+<%- includeFiles('three.html') %>

test/unit/partials/three.html

@@ -0,0 +1,2 @@
+three<br>
+<%- includeMD('markdown.md') %>