express-hbs 2.4.2 → 3.0.0

package/test/layoutSpecs.js

@@ -1,8 +1,8 @@
 var request = require('supertest');
 var assert = require('assert');
+var path = require('path');
 var hbs = require('..');
 
-
 function stripWs(s) {
   return s.replace(/\s+/g, '');
 }
@@ -12,7 +12,7 @@ function createLocals(which, viewsDir, locals) {
   var opts = {};
   if (which === 'express3') {
     opts.settings = {
-      views: viewsDir
+      views: viewsDir,
     };
     opts.cache = process.env.NODE_ENV === 'production';
     opts.settings.views = viewsDir;
@@ -24,77 +24,93 @@ function createLocals(which, viewsDir, locals) {
   return opts;
 }
 
-describe('layouts', function() {
+describe('layouts', function () {
   var app;
 
-  beforeEach(function() {
+  beforeEach(function () {
     var example = require('../example/app');
     app = example.create(hbs.create());
   });
 
-
-  describe('layoutsDir', function() {
+  describe('layoutsDir', function () {
     var app;
 
-    beforeEach(function() {
+    beforeEach(function () {
       app = require('../example/app-layoutsDir');
     });
 
-    it('should render layout declared in markup', function(done) {
+    it('should render layout declared in markup', function (done) {
       request(app)
         .get('/fruits')
         .expect(/DECLARATIVE LAYOUT/, done);
     });
 
-    it('should allow specifying layout in locals without dir', function(done) {
+    it('should allow specifying layout in locals without dir', function (done) {
       request(app)
         .get('/veggies')
         .expect(/PROGRAMMATIC LAYOUT/, done);
     });
 
-    it('should still allow specifying layout in locals with dir', function(done) {
+    it('should still allow specifying layout in locals with dir', function (done) {
       request(app)
         .get('/veggies/explicit-dir')
         .expect(/PROGRAMMATIC LAYOUT/, done);
     });
   });
 
-
-  describe('options.layout', function() {
+  describe('options.layout', function () {
     var dirname = __dirname + '/views/disableLayoutDirective';
 
-    it ('should process template-specified layout without option', function(done) {
+    it('should process template-specified layout without option', function (done) {
       var render = hbs.create().express3({
+        restrictLayoutsTo: dirname,
       });
       var locals = createLocals('express3', dirname);
 
-      render(dirname + '/index.hbs', locals, function(err, html) {
+      render(dirname + '/index.hbs', locals, function (err, html) {
         assert.equal('<dld>dld</dld>', stripWs(html));
         done();
       });
     });
 
-    it ('should allow options.layout to be specified', function(done) {
+    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' });
 
-      render(dirname + '/aside.hbs', locals, function(err, html) {
+      render(dirname + '/aside.hbs', locals, function (err, html) {
         assert.equal('<dld>aside</dld>', stripWs(html));
         done();
       });
     });
 
-    it ('should not process template-specified layout when options.layout is falsy', function(done) {
+    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 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 });
 
-      render(dirname + '/index.hbs', locals, function(err, html) {
+      render(dirname + '/index.hbs', locals, function (err, html) {
         assert.equal('dld', stripWs(html));
         done();
       });
     });
   });
-
 });

package/test/localTemplateOptions.js

@@ -8,110 +8,116 @@ describe('local template options', function () {
   var dirname = path.join(__dirname, 'localTemplateOptions');
 
   describe('express3', 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,',
-            firstName: 'Freddy',
-            lastName: 'Krueger'
-          } 
+        data: {
+          greeting: 'Hello,',
+          firstName: 'Freddy',
+          lastName: 'Krueger',
+        },
       });
 
       var locals = H.createLocals('express3', dirname, {
         _templateOptions: {
           data: {
-            lastName: 'Mercury'
-          } 
-        } 
+            lastName: 'Mercury',
+          },
+        },
       });
 
       render(path.join(dirname, 'template.hbs'), locals, function (err, html) {
         assert.ifError(err);
-        assert.strictEqual(H.stripWs(html), H.stripWs('Hello, Freddy Mercury')); 
+        assert.strictEqual(H.stripWs(html), H.stripWs('Hello, Freddy Mercury'));
         done(err);
       });
     });
 
     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,',
-            firstName: 'Freddy',
-            lastName: 'Krueger'
-          } 
+        data: {
+          greeting: 'Hello,',
+          firstName: 'Freddy',
+          lastName: 'Krueger',
+        },
       });
 
       var locals = H.createLocals('express3', dirname, {
         _templateOptions: {
           data: {
-            lastName: 'Mercury'
-          } 
-        } 
+            lastName: 'Mercury',
+          },
+        },
       });
 
       render(path.join(dirname, 'data-access-template.hbs'), locals, function (err, html) {
         assert.ifError(err);
-        assert.strictEqual(H.stripWs(html), H.stripWs('')); 
+        assert.strictEqual(H.stripWs(html), H.stripWs(''));
         done(err);
       });
     });
   });
 
   describe('express4', 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,',
-            firstName: 'Freddy',
-            lastName: 'Krueger'
-          } 
+        data: {
+          greeting: 'Hello,',
+          firstName: 'Freddy',
+          lastName: 'Krueger',
+        },
       });
 
       var locals = H.createLocals('express4', dirname, {
         _templateOptions: {
           data: {
-            lastName: 'Mercury'
-          } 
-        } 
+            lastName: 'Mercury',
+          },
+        },
       });
 
       render(path.join(dirname, 'template.hbs'), locals, function (err, html) {
         assert.ifError(err);
-        assert.strictEqual(H.stripWs(html), H.stripWs('Hello, Freddy Mercury')); 
+        assert.strictEqual(H.stripWs(html), H.stripWs('Hello, Freddy Mercury'));
         done(err);
       });
     });
 
     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,',
-            firstName: 'Freddy',
-            lastName: 'Krueger'
-          } 
+        data: {
+          greeting: 'Hello,',
+          firstName: 'Freddy',
+          lastName: 'Krueger',
+        },
       });
 
       var locals = H.createLocals('express3', dirname, {
         _templateOptions: {
           data: {
-            lastName: 'Mercury'
-          } 
-        } 
+            lastName: 'Mercury',
+          },
+        },
       });
 
       render(path.join(dirname, 'data-access-template.hbs'), locals, function (err, html) {
         assert.ifError(err);
-        assert.strictEqual(H.stripWs(html), H.stripWs('')); 
+        assert.strictEqual(H.stripWs(html), H.stripWs(''));
         done(err);
       });
     });

package/test/multiple.js

@@ -5,12 +5,17 @@ var assert = require('assert');
 var express = require('express');
 var hbs = require('..');
 
-describe('multiple directories', function() {
+describe('multiple directories', function () {
   var app;
 
-  beforeEach(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');
@@ -26,7 +31,7 @@ describe('multiple directories', function() {
     });
   });
 
-  it('should handle single folder', function(done) {
+  it('should handle single folder', function (done) {
     app.set('views', './test/views/multiple/views1');
     request(app)
       .get('/test1')
@@ -38,7 +43,7 @@ describe('multiple directories', function() {
       });
   });
 
-  it('should handle multiple folders', function(done) {
+  it('should handle multiple folders', function (done) {
     app.set('views', ['./test/views/multiple/views1', './test/views/multiple/views2']);
     request(app)
       .get('/test2')
@@ -50,9 +55,8 @@ describe('multiple directories', function() {
       });
   });
 
-  describe('should handle multiple folders in specific order', function() {
-
-    it('views1, views2', function(done) {
+  describe('should handle multiple folders in specific order', function () {
+    it('views1, views2', function (done) {
       app.set('views', ['./test/views/multiple/views1', './test/views/multiple/views2']);
       request(app)
         .get('/collide')
@@ -64,7 +68,7 @@ describe('multiple directories', function() {
         });
     });
 
-    it('views2, views1', function(done) {
+    it('views2, views1', function (done) {
       app.set('views', ['./test/views/multiple/views2', './test/views/multiple/views1']);
       request(app)
         .get('/collide')
@@ -75,43 +79,37 @@ describe('multiple directories', function() {
           done();
         });
     });
-
   });
 
-  /* eslint-disable no-unused-vars */
-  describe('should report the filename in error', function() {
-
-    it('should report from first folder', function(done) {
+  describe('should report the filename in error', function () {
+    it('should report from first folder', function (done) {
       app.set('views', ['./test/views/multiple/views1', './test/views/multiple/views2']);
-      app.use(function(err, req, res, next) {
+      app.use(function (err, req, res, next) {
         res.status(500).send(err.stack);
       });
 
       request(app)
-      .get('/error')
-      .end(function(err, res) {
-        assert.ifError(err);
-        assert(res.error.text.indexOf('views1/error.hbs]') > 0);
-        done();
-      });
+        .get('/error')
+        .end(function (err, res) {
+          assert.ifError(err);
+          assert(res.error.text.indexOf('views1/error.hbs]') > 0);
+          done();
+        });
     });
 
-
-    it('should report from second folder', function(done) {
+    it('should report from second folder', function (done) {
       app.set('views', ['./test/views/multiple/views2', './test/views/multiple/views1']);
-      app.use(function(err, req, res, next) {
+      app.use(function (err, req, res, next) {
         res.status(500).send(err.stack);
       });
 
       request(app)
-      .get('/error')
-      .end(function(err, res) {
-        assert.ifError(err);
-        assert(res.error.text.indexOf('views2/error.hbs]') > 0);
-        done();
-      });
+        .get('/error')
+        .end(function (err, res) {
+          assert.ifError(err);
+          assert(res.error.text.indexOf('views2/error.hbs]') > 0);
+          done();
+        });
     });
   });
-  /* eslint-enable no-unused-vars */
-
 });

package/test/nonExpress.js

@@ -2,31 +2,32 @@ var assert = require('assert');
 var hbs = require('..');
 var H = require('./helpers');
 
-describe('non-express', function() {
-
-  describe('viewsDir', function() {
+describe('non-express', function () {
+  describe('viewsDir', function () {
     var dirname = __dirname + '/views/viewsDir';
 
-    it ('should use viewsDir options', function(done) {
+    it('should use viewsDir options', function (done) {
       var render = hbs.create().express3({
-        viewsDir: dirname
+        viewsDir: dirname,
+        restrictLayoutsTo: dirname,
       });
       var locals = H.createLocals('express3', dirname);
 
-      render(dirname + '/sub/directive.hbs', locals, function(err, html) {
+      render(dirname + '/sub/directive.hbs', locals, function (err, html) {
         assert.equal('<vd>directive</vd>', H.stripWs(html));
         done();
       });
     });
 
-    it ('should work with layoutsDir', function(done) {
+    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'});
+      var locals = H.createLocals('express3', dirname, { layout: 'default.hbs' });
 
-      render(dirname + '/sub/lay.hbs', locals, function(err, html) {
+      render(dirname + '/sub/lay.hbs', locals, function (err, html) {
         assert.equal('<vd>lay</vd>', H.stripWs(html));
         done();
       });

package/test/optionsSpecs.js

@@ -4,16 +4,15 @@ var path = require('path');
 var H = require('./helpers');
 var fs = require('fs');
 
+describe('options', function () {
+  var dirname = path.join(__dirname, 'views/beautify');
 
-describe('options', function() {
-  var dirname =  path.join(__dirname, 'views/beautify');
-
-  it('should pretty print HTML', function(done) {
+  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) {
+    render(dirname + '/index.hbs', locals, function (err, html) {
       assert.ifError(err);
       var expected = fs.readFileSync(dirname + '/expected.hbs', 'utf8');
       assert.equal(html.trim(), expected.trim());
@@ -21,4 +20,3 @@ describe('options', function() {
     });
   });
 });
-

package/test/resolverSpecs.js

@@ -0,0 +1,54 @@
+'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('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/.eslintrc

@@ -1,42 +0,0 @@
-{
-  "env": {
-    "node": true
-  },
-
-  "globals": {
-    "describe": true,
-    "beforeEach": true,
-    "it": true
-  },
-
-  "rules": {
-    "brace-style": [1, "1tbs"],
-    "curly": [0, "multi"],
-    "eqeqeq": [1, "smart"],
-    "max-depth": [1, 4],
-    "max-params": [1, 5],
-    "new-cap": 2,
-    "new-parens": 0,
-    "no-constant-condition": 0,
-    "no-div-regex": 1,
-    "no-else-return": 1,
-    "no-extra-parens": 1,
-    "no-floating-decimal": 2,
-    "no-inner-declarations": 2,
-    "no-lonely-if": 1,
-    "no-multi-str": 0,
-    "no-nested-ternary": 2,
-    "no-new-object": 0,
-    "no-new-func": 0,
-    "no-shadow": 0,
-    "no-underscore-dangle": 0,
-    "no-unused-vars": 2,
-    "quotes": [2, "single", "avoid-escape"],
-    "radix": 2,
-    "keyword-spacing": "error",
-    "object-curly-spacing": ["error", "never"],
-    "array-bracket-spacing": ["error", "never"],
-    "strict": 2,
-    "wrap-iife": 2
-  }
-}