Merge pull request #155 from allouis/add-support-for-dynamic-template…

…-options-v1x

Adds support for local template options

lib/hbs.js

@@ -5,6 +5,7 @@ var path = require('path');
 var readdirp = require('readdirp');
 var handlebars = require('handlebars');
 var async = require('./async');
+var _ = require('lodash');
 
 /**
  * Regex pattern for layout directive. {{!< layout }}
@@ -397,10 +398,22 @@ ExpressHbs.prototype.registerAsyncHelper = function(name, fn) {
   });
 };
 
+ExpressHbs.prototype.getTemplateOptions = function() {
+  return this._options.templateOptions;
+};
+
 ExpressHbs.prototype.updateTemplateOptions = function(templateOptions) {
   this._options.templateOptions = templateOptions;
 };
 
+ExpressHbs.prototype.getLocalTemplateOptions = function(locals) {
+  return locals._templateOptions || {};
+};
+
+ExpressHbs.prototype.updateLocalTemplateOptions = function(locals, localTemplateOptions) {
+  return locals._templateOptions = localTemplateOptions;
+};
+
 /**
  * Creates a new instance of ExpressHbs.
  */
@@ -480,7 +493,10 @@ ExpressHbs.prototype.___express = function ___express(filename, source, options,
     var res;
 
     try {
-      res = template(locals, self._options.templateOptions);
+      var localTemplateOptions = self.getLocalTemplateOptions(locals);
+      var localsClone = _.extend({}, locals);
+      self.updateLocalTemplateOptions(localsClone, undefined);
+      res = template(localsClone, _.merge({}, self._options.templateOptions, localTemplateOptions));
     } catch (err) {
       if (err.message) {
         err.message = '[' + template.__filename + '] ' + err.message;

package.json

@@ -39,6 +39,7 @@
   "dependencies": {
     "handlebars": "4.0.13",
     "js-beautify": "1.6.8",
+    "lodash": "4.17.11",
     "readdirp": "2.1.0"
   }
 }

test/helpers.js

@@ -5,7 +5,7 @@ function stripWs(s) {
 function createLocals(which, viewsDir, locals) {
   if (!locals) locals = {};
   var opts = {};
-  if (which === 'express3') {
+  if (which === 'express3' || which === 'express4') {
     opts.settings = {
       views: viewsDir
     };

test/localTemplateOptions.js

@@ -0,0 +1,119 @@
+'use strict';
+var assert = require('assert');
+var path = require('path');
+var hbs = require('..');
+var H = require('./helpers');
+
+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({});
+      instance.updateTemplateOptions({
+          data: {
+            greeting: 'Hello,',
+            firstName: 'Freddy',
+            lastName: 'Krueger'
+          } 
+      });
+
+      var locals = H.createLocals('express3', dirname, {
+        _templateOptions: {
+          data: {
+            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')); 
+        done(err);
+      });
+    });
+
+    it('removes _templateOptions from the locals data', function (done) {
+      var instance = hbs.create();
+      var render = instance.express3({});
+      instance.updateTemplateOptions({
+          data: {
+            greeting: 'Hello,',
+            firstName: 'Freddy',
+            lastName: 'Krueger'
+          } 
+      });
+
+      var locals = H.createLocals('express3', dirname, {
+        _templateOptions: {
+          data: {
+            lastName: 'Mercury'
+          } 
+        } 
+      });
+
+      render(path.join(dirname, 'data-access-template.hbs'), locals, function (err, html) {
+        assert.ifError(err);
+        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({});
+      instance.updateTemplateOptions({
+          data: {
+            greeting: 'Hello,',
+            firstName: 'Freddy',
+            lastName: 'Krueger'
+          } 
+      });
+
+      var locals = H.createLocals('express4', dirname, {
+        _templateOptions: {
+          data: {
+            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')); 
+        done(err);
+      });
+    });
+
+    it('removes _templateOptions from the locals data', function (done) {
+      var instance = hbs.create();
+      var render = instance.express3({});
+      instance.updateTemplateOptions({
+          data: {
+            greeting: 'Hello,',
+            firstName: 'Freddy',
+            lastName: 'Krueger'
+          } 
+      });
+
+      var locals = H.createLocals('express3', dirname, {
+        _templateOptions: {
+          data: {
+            lastName: 'Mercury'
+          } 
+        } 
+      });
+
+      render(path.join(dirname, 'data-access-template.hbs'), locals, function (err, html) {
+        assert.ifError(err);
+        assert.strictEqual(H.stripWs(html), H.stripWs('')); 
+        done(err);
+      });
+    });
+  });
+});

test/localTemplateOptions/data-access-template.hbs

@@ -0,0 +1 @@
+{{_templateOptions.data.greeting}} {{_templateOptions.data.firstName}} {{_templateOptions.data.lastName}}

test/localTemplateOptions/template.hbs

@@ -0,0 +1 @@
+{{@greeting}} {{@firstName}} {{@lastName}}