express-hbs 2.4.2 → 2.5.1

package/test/asyncSpecs.js

@@ -5,6 +5,7 @@ var assert = require('assert');
 var hbs = require('..');
 var asyncApp = require('./apps/async');
 var resolver = require('../lib/resolver');
+var H = require('./helpers');
 
 function makeUserRequest(app, user, cb) {
   request(app)
@@ -66,4 +67,63 @@ describe('async', function() {
       done();
     });
   });
+
+  describe('literal async id prefix in data', function () {
+    var dirname = __dirname + '/views/asyncPrefix';
+
+    function createRender() {
+      var hb = hbs.create();
+      hb.registerAsyncHelper('async', function (s, cb) {
+        setTimeout(function () {
+          cb(new hb.SafeString('async-' + s));
+        }, 1);
+      });
+      return hb.express4({ viewsDir: dirname });
+    }
+
+    function renderValue(file, locals, cb) {
+      var render = createRender();
+      render(dirname + '/' + file, H.createLocals('express4', dirname, locals), cb);
+    }
+
+    it('renders prefix text in the middle of data verbatim', function (done) {
+      renderValue('body.hbs', { body: 'x __aSyNcId__ y' }, function (err, html) {
+        if (err) return done(err);
+        assert.equal(html.trim(), 'hello x __aSyNcId__ y');
+        done();
+      });
+    });
+
+    [
+      '__aSyNcId__',
+      '__aSyNcId__ start',
+      'middle __aSyNcId__ text',
+      '__aSyNcId__<_abcdefgh__',
+      'x __aSyNcId__<_abcdefgh__ y',
+    ].forEach(function (value) {
+      it('renders ' + JSON.stringify(value) + ' escaped and unescaped', function (done) {
+        renderValue('index.hbs', { value: value }, function (err, html) {
+          if (err) return done(err);
+          var escaped = hbs.Utils.escapeExpression(value);
+          assert.equal(html.trim(), 'hello ' + escaped + '|' + value + '|async-a');
+          done();
+        });
+      });
+    });
+
+    it('renders prefix text in data alongside nested async helpers', function (done) {
+      var app = asyncApp.create(hbs.create(), 'production');
+      request(app)
+        .get('/')
+        .set('Cookie', 'user=__aSyNcId__')
+        .end(function (err, res) {
+          if (err) return done(err);
+          assert.notEqual(res.text.indexOf('Hello, __aSyNcId__'), -1);
+          assert.notEqual(res.text.indexOf('This should welcome __aSyNcId__.'), -1);
+          assert.notEqual(res.text.indexOf('Title 1 Comment 1'), -1);
+          assert.equal(res.text.indexOf('This should not show!'), -1);
+          done();
+        });
+    });
+  });
 });

package/test/customExtension.js

@@ -11,7 +11,8 @@ describe('custom extension for partials view', function() {
   var dirname = path.join(__dirname, 'views/customExtension');
   var render = hbs.create().express4({
       extname: '.server.view.html',
-      partialsDir: dirname + '/partialsDir'
+      partialsDir: dirname + '/partialsDir',
+      restrictLayoutsTo: dirname
   });
 
   it('should allow rendering multiple partials with custom extension', function(done) {

package/test/handlebarsSpecs.js

@@ -92,4 +92,23 @@ describe('express-hbs', function() {
       assert(hbs !== hbs2 && hbs !== hbs3 && hbs2 !== hbs3);
     });
   });
+
+  describe('compile', function () {
+    it('should pad a template that ends with its only closing tag', function () {
+      var hb = hbs.create();
+      hb.onCompile = function (exhbs, source) {
+        return source;
+      };
+      assert.equal(hb.compile('{{! comment }}'), '{{! comment }} ');
+    });
+
+    it('should not pad a one-character template', function () {
+      var hb = hbs.create();
+      hb.onCompile = function (exhbs, source) {
+        return source;
+      };
+      assert.equal(hb.compile('x'), 'x');
+      assert.equal(hb.compile(''), '');
+    });
+  });
 });

package/test/helperSpecs.js

@@ -15,7 +15,8 @@ describe('helpers', function() {
       var hb = hbs.create();
       hb.registerHelper("sync", sync);
       var render = hb.express3({
-        viewsDir: dirname
+        viewsDir: dirname,
+        restrictLayoutsTo: dirname
       });
       var locals = H.createLocals('express3', dirname);
 
@@ -38,7 +39,8 @@ describe('helpers', function() {
       hb.registerAsyncHelper("async", async);
 
       var render = hb.express3({
-        viewsDir: dirname
+        viewsDir: dirname,
+        restrictLayoutsTo: dirname
       });
       var locals = H.createLocals('express3', dirname);
 

package/test/issues.js

@@ -9,7 +9,9 @@ describe('issue-22 template', function() {
   var dirname = path.join(__dirname, 'issues/22');
 
   it('should use multiple layouts with caching', function(done) {
-    var render = hbs.create().express3({});
+    var render = hbs.create().express3({
+      restrictLayoutsTo: dirname
+    });
     var locals1 = H.createLocals('express3', dirname, { layout: 'layout1', cache: true });
     var locals2 = H.createLocals('express3', dirname, { layout: 'layout2', cache: true });
 
@@ -30,7 +32,8 @@ describe('issue-23', function() {
 
   it('should not pass an empty or missing partial to handlebars', function(done) {
     var render = hbs.create().express3({
-      partialsDir: [dirname + '/partials']
+      partialsDir: [dirname + '/partials'],
+      restrictLayoutsTo: dirname
     });
 
     function check(err, html) {
@@ -43,7 +46,8 @@ describe('issue-23', function() {
 
   it('should handle empty string', function(done) {
     var render = hbs.create().express3({
-      partialsDir: [dirname + '/partials']
+      partialsDir: [dirname + '/partials'],
+      restrictLayoutsTo: dirname
     });
 
     function check(err, html) {
@@ -58,7 +62,8 @@ describe('issue-23', function() {
   it('should register empty partial', function(done) {
     var hb = hbs.create();
     var render = hb.express3({
-      partialsDir: [dirname + '/partials']
+      partialsDir: [dirname + '/partials'],
+      restrictLayoutsTo: dirname
     });
     hb.handlebars.registerPartial('emptyPartial', '');
 
@@ -82,7 +87,8 @@ describe('issue-23', function() {
   it('should register partial that results in empty string (comment)', function(done) {
     var hb = hbs.create();
     var render = hb.express3({
-      partialsDir: [dirname + '/partials']
+      partialsDir: [dirname + '/partials'],
+      restrictLayoutsTo: dirname
     });
     // this fails
     //hb.handlebars.registerPartial('emptyComment', '{{! just a comment}}');
@@ -110,7 +116,8 @@ describe('issue-23', function() {
 describe('issue-21', function() {
   var dirname =  path.join(__dirname, 'issues/21');
   var render = hbs.create().express3({
-    layoutsDir: dirname + '/views/layouts'
+    layoutsDir: dirname + '/views/layouts',
+    restrictLayoutsTo: dirname
   });
 
   it('should allow specifying layouts without the parent dir', function(done) {
@@ -158,7 +165,9 @@ describe('issue-21', function() {
 
   it('should treat layouts relative to views directory if layoutsDir is not passed', function(done) {
     var dirname =  path.join(__dirname, 'issues/21');
-    var render = hbs.create().express3();
+    var render = hbs.create().express3({
+      restrictLayoutsTo: dirname
+    });
 
     function check(err, html) {
       assert.ifError(err);
@@ -177,7 +186,9 @@ describe('issue-49', function() {
 
   it('should report filename with error', function(done) {
     var hb = hbs.create()
-    var render = hb.express3({});
+    var render = hb.express3({
+      restrictLayoutsTo: dirname
+    });
     var locals = H.createLocals('express3', dirname, {});
     render(dirname + '/error.hbs', locals, function(err, html) {
       assert(err.stack.indexOf('[error.hbs]') > 0);
@@ -187,7 +198,9 @@ describe('issue-49', function() {
 
   it('should report relative filename with error', function(done) {
     var hb = hbs.create()
-    var render = hb.express3({});
+    var render = hb.express3({
+      restrictLayoutsTo: dirname
+    });
     var locals = H.createLocals('express3', dirname, {});
     render(dirname + '/front/error.hbs', locals, function(err, html) {
       assert(err.stack.indexOf('[front/error.hbs]') > 0);
@@ -198,7 +211,8 @@ describe('issue-49', function() {
   it('should report filename with partial error', function(done) {
     var hb = hbs.create()
     var render = hb.express3({
-      partialsDir: dirname + '/partials'
+      partialsDir: dirname + '/partials',
+      restrictLayoutsTo: dirname
     });
     var locals = H.createLocals('express3', dirname, {});
     render(dirname + '/partial.hbs', locals, function(err, html) {
@@ -210,7 +224,8 @@ describe('issue-49', function() {
   it('should report filename with layout error', function(done) {
     var hb = hbs.create()
     var render = hb.express3({
-      partialsDir: dirname + '/partials'
+      partialsDir: dirname + '/partials',
+      restrictLayoutsTo: dirname
     });
     var locals = H.createLocals('express3', dirname, {});
     render(dirname + '/index.hbs', locals, function(err, html) {
@@ -231,7 +246,9 @@ describe('issue-53', function() {
         resultcb(++res);
       }, 1)
     });
-    var render = hb.express3({});
+    var render = hb.express3({
+      restrictLayoutsTo: dirname
+    });
     var locals = H.createLocals('express3', dirname, {});
     render(dirname + '/index.hbs', locals, function(err, html) {
       assert.ifError(err);
@@ -253,7 +270,8 @@ describe('issue-59', function() {
     hb.registerAsyncHelper("async", async);
 
     var render = hb.express3({
-      viewsDir: dirname
+      viewsDir: dirname,
+      restrictLayoutsTo: dirname
     });
     var locals = H.createLocals('express3', dirname);
 
@@ -272,7 +290,8 @@ describe('issue-59', function() {
     hb.registerAsyncHelper('async', async);
 
     var render = hb.express3({
-      viewsDir: dirname
+      viewsDir: dirname,
+      restrictLayoutsTo: dirname
     });
     var locals = H.createLocals('express3', dirname);
 
@@ -290,6 +309,7 @@ describe('issue-73', function() {
     var render = hb.express3({
       viewsDir: dirname,
       partialsDir: dirname + '/partials',
+      restrictLayoutsTo: dirname,
       onCompile: function(eh, source, filename) {
         var options;
         if (filename && filename.indexOf('partials')) {
@@ -329,7 +349,8 @@ describe('issue-62', function() {
     hb.registerAsyncHelper("async", async);
 
     var render = hb.express3({
-      viewsDir: dirname
+      viewsDir: dirname,
+      restrictLayoutsTo: dirname
     });
     var locals = H.createLocals('express3', dirname);
 
@@ -359,7 +380,8 @@ describe('issue-62', function() {
     hb.registerAsyncHelper("async", async);
 
     var render = hb.express3({
-      viewsDir: dirname
+      viewsDir: dirname,
+      restrictLayoutsTo: dirname
     });
     var locals = H.createLocals('express3', dirname);
 
@@ -380,7 +402,8 @@ describe('issue-76', function() {
     var hb = hbs.create();
 
     var render = hb.express3({
-      partialsDir: dirname
+      partialsDir: dirname,
+      restrictLayoutsTo: dirname
     });
 
     hb.cachePartials(function (err) {
@@ -396,7 +419,8 @@ describe('issue-84', function () {
 
   it('should render deeply nested partials', function (done) {
     var render = hbs.create().express3({
-      partialsDir: [dirname + '/partials']
+      partialsDir: [dirname + '/partials'],
+      restrictLayoutsTo: dirname
     });
 
     function check(err, html) {
@@ -421,7 +445,9 @@ describe('issue-144', function() {
         resultcb(new hbs.SafeString('<p><code>\'$example$\'</code> abcd</p>'));
       }, 1)
     });
-    var render = hb.express3({});
+    var render = hb.express3({
+      restrictLayoutsTo: dirname
+    });
     var locals = H.createLocals('express3', dirname, {});
     render(dirname + '/index.hbs', locals, function(err, html) {
       assert.equal('<div><p><code>\'$example$\'</code> abcd</p></div>\n', html);
@@ -441,7 +467,9 @@ describe('issue-153', function() {
       done();
     }
     var hb = hbs.create()
-    var render = hb.express3({});
+    var render = hb.express3({
+      restrictLayoutsTo: dirname
+    });
     var locals = H.createLocals('express3', dirname, { });
     render(dirname + '/index.hbs', locals, check);
   });

package/test/layoutSpecs.js

@@ -1,5 +1,6 @@
 var request = require('supertest');
 var assert = require('assert');
+var path = require('path');
 var hbs = require('..');
 
 
@@ -65,6 +66,7 @@ describe('layouts', function() {
 
     it ('should process template-specified layout without option', function(done) {
       var render = hbs.create().express3({
+        restrictLayoutsTo: dirname
       });
       var locals = createLocals('express3', dirname);
 
@@ -76,6 +78,7 @@ describe('layouts', function() {
 
     it ('should allow options.layout to be specified', function(done) {
       var render = hbs.create().express3({
+        restrictLayoutsTo: dirname
       });
       var locals = createLocals('express3', dirname, { layout: 'layouts/default' });
 
@@ -85,8 +88,53 @@ describe('layouts', function() {
       });
     });
 
+    it('should error when using a layout outside of the restrictLayoutsTo', function(done) {
+      var render = hbs.create().express3({
+        restrictLayoutsTo: path.resolve(path.join(__dirname, '../'))
+      });
+      var locals = createLocals('express3', dirname, {layout: '/Users/egg/Code/Ghost/ghost/core/package.json'});
+
+      render(dirname + '/aside.hbs', locals, function (err, html) {
+        if (!err) {
+          return done(new Error('We expect an error when reading'));
+        }
+        return done();
+      });
+    });
+
+    it('should allow a layout inside a relative restrictLayoutsTo', function(done) {
+      var render = hbs.create().express3({
+        restrictLayoutsTo: path.relative(process.cwd(), dirname)
+      });
+      var locals = createLocals('express3', dirname, { layout: 'layouts/default' });
+
+      render(dirname + '/aside.hbs', locals, function(err, html) {
+        if (err) return done(err);
+        assert.equal('<dld>aside</dld>', stripWs(html));
+        done();
+      });
+    });
+
+    it('should error when a layout is in a sibling directory sharing the restrictLayoutsTo prefix', function(done) {
+      var restrictLayoutsTo = path.join(dirname, 'lay');
+      var render = hbs.create().express3({
+        restrictLayoutsTo: restrictLayoutsTo
+      });
+      var locals = createLocals('express3', dirname, { layout: 'layouts/default' });
+
+      render(dirname + '/aside.hbs', locals, function(err) {
+        assert.ok(err, 'expected an error');
+        assert.ok(
+          err.message.includes('does not reside in ' + restrictLayoutsTo),
+          'unexpected error: ' + err.message
+        );
+        done();
+      });
+    });
+
     it ('should not process template-specified layout when options.layout is falsy', function(done) {
       var render = hbs.create().express3({
+        restrictLayoutsTo: dirname
       });
       var locals = createLocals('express3', dirname, { layout: false });
 

package/test/localTemplateOptions.js

@@ -11,7 +11,9 @@ describe('local template options', function () {
 
     it('merges res.locals._templateOptions with the self._templateOptions', function (done) {
       var instance = hbs.create();
-      var render = instance.express3({});
+      var render = instance.express3({
+        restrictLayoutsTo: dirname
+      });
       instance.updateTemplateOptions({
           data: {
             greeting: 'Hello,',
@@ -37,7 +39,9 @@ describe('local template options', function () {
 
     it('removes _templateOptions from the locals data', function (done) {
       var instance = hbs.create();
-      var render = instance.express3({});
+      var render = instance.express3({
+        restrictLayoutsTo: dirname
+      });
       instance.updateTemplateOptions({
           data: {
             greeting: 'Hello,',
@@ -66,7 +70,9 @@ describe('local template options', function () {
 
     it('merges res.locals._templateOptions with the self._templateOptions', function (done) {
       var instance = hbs.create();
-      var render = instance.express4({});
+      var render = instance.express4({
+        restrictLayoutsTo: dirname
+      });
       instance.updateTemplateOptions({
           data: {
             greeting: 'Hello,',
@@ -92,7 +98,9 @@ describe('local template options', function () {
 
     it('removes _templateOptions from the locals data', function (done) {
       var instance = hbs.create();
-      var render = instance.express3({});
+      var render = instance.express3({
+        restrictLayoutsTo: dirname
+      });
       instance.updateTemplateOptions({
           data: {
             greeting: 'Hello,',

package/test/multiple.js

@@ -10,7 +10,9 @@ describe('multiple directories', function() {
 
   beforeEach(function() {
     app = express();
-    app.engine('hbs', hbs.express3());
+    app.engine('hbs', hbs.express3({
+      restrictLayoutsTo: './test/views/multiple'
+    }));
     app.set('view engine', 'hbs');
     app.get('/test1', function (req, res) {
       res.render('test1');

package/test/nonExpress.js

@@ -9,7 +9,8 @@ describe('non-express', function() {
 
     it ('should use viewsDir options', function(done) {
       var render = hbs.create().express3({
-        viewsDir: dirname
+        viewsDir: dirname,
+        restrictLayoutsTo: dirname
       });
       var locals = H.createLocals('express3', dirname);
 
@@ -22,7 +23,8 @@ describe('non-express', function() {
     it ('should work with layoutsDir', function(done) {
       var render = hbs.create().express3({
         viewsDir: dirname,
-        layoutsDir: dirname + '/layouts'
+        layoutsDir: dirname + '/layouts',
+        restrictLayoutsTo: dirname
       });
       var locals = H.createLocals('express3', dirname, {layout: 'default.hbs'});
 

package/test/optionsSpecs.js

@@ -10,7 +10,7 @@ describe('options', function() {
 
   it('should pretty print HTML', function(done) {
     var hb = hbs.create();
-    var render = hb.express3({beautify: true});
+    var render = hb.express3({beautify: true, restrictLayoutsTo: dirname});
     var locals = H.createLocals('express3', dirname, {});
 
     render(dirname + '/index.hbs', locals, function(err, html) {

package/test/resolverSpecs.js

@@ -0,0 +1,70 @@
+'use strict';
+
+var assert = require('assert');
+var generateId = require('../lib/generate-id');
+var resolver = require('../lib/resolver');
+
+describe('resolver', function () {
+  it('detects an unresolved helper at the start of rendered output', function () {
+    assert.equal(resolver.hasResolvers('__aSyNcId__<_12345678__'), true);
+  });
+
+  it('does not report rendered output without a resolver marker', function () {
+    assert.equal(resolver.hasResolvers('rendered output'), false);
+  });
+
+  it('ignores prefix text that is not a cached helper id', function () {
+    var cache = { '__aSyNcId__<_abcdefgh__': Promise.resolve('') };
+    assert.equal(resolver.hasResolvers('x __aSyNcId__ y', cache), false);
+    assert.equal(resolver.hasResolvers('__aSyNcId__<_zzzzzzzz__', cache), false);
+  });
+
+  it('detects cached helper ids in raw and escaped form', function () {
+    var cache = { '__aSyNcId__<_abcdefgh__': Promise.resolve('') };
+    function escape(s) {
+      return s.replace('<', '&lt;');
+    }
+    assert.equal(resolver.hasResolvers('a __aSyNcId__<_abcdefgh__ b', cache, escape), true);
+    assert.equal(resolver.hasResolvers('a __aSyNcId__&lt;_abcdefgh__ b', cache, escape), true);
+    assert.equal(resolver.hasResolvers('a __aSyNcId__&lt;_abcdefgh__ b', cache), false);
+  });
+
+  it('resolves asynchronous helper output with its context', function (done) {
+    var cache = {};
+    var id = resolver.resolve(
+      cache,
+      function (context, callback) {
+        callback(context.value);
+      },
+      { value: 'resolved' },
+    );
+
+    resolver.done(cache, function (err, values) {
+      assert.ifError(err);
+      assert.equal(values[id], 'resolved');
+      done();
+    });
+  });
+
+  it('reports synchronous helper failures', function (done) {
+    var cache = {};
+    resolver.resolve(cache, function () {
+      throw new Error('helper failed');
+    });
+
+    resolver.done(cache, function (err) {
+      assert.equal(err.message, 'helper failed');
+      done();
+    });
+  });
+});
+
+describe('generateId', function () {
+  it('uses an eight-character default', function () {
+    assert.match(generateId(), /^[A-Za-z_]{8}$/);
+  });
+
+  it('uses the requested length', function () {
+    assert.match(generateId(16), /^[A-Za-z_]{16}$/);
+  });
+});

package/test/views/asyncPrefix/body.hbs

@@ -0,0 +1 @@
+hello {{body}}

package/test/views/asyncPrefix/index.hbs

@@ -0,0 +1 @@
+hello {{value}}|{{{value}}}|{{async "a"}}