express-hbs 2.5.0 → 2.5.1

package/.claude/worktrees/node-20-26-migration-7de0c3/pnpm-workspace.yaml

@@ -0,0 +1,6 @@
+strictDepBuilds: true
+minimumReleaseAge: 4320
+blockExoticSubdeps: true
+
+minimumReleaseAgeExclude:
+  - '@tryghost/*'

package/.claude/worktrees/node-20-26-migration-7de0c3/renovate.json

@@ -0,0 +1,13 @@
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "extends": [
+    "local>TryGhost/renovate-config"
+  ],
+  "packageRules": [
+    {
+      "description": "Keep caret ranges on published dependencies so consumers can dedupe; bump the floor to the tested version",
+      "matchDepTypes": ["dependencies", "optionalDependencies"],
+      "rangeStrategy": "bump"
+    }
+  ]
+}

package/.claude/worktrees/node-20-26-migration-7de0c3/test/apps/async/index.js

@@ -0,0 +1,139 @@
+'use strict';
+
+var express = require('express');
+var cookieParser = require('cookie-parser');
+var fs = require('fs');
+var path = require('path');
+var url = require('url');
+
+var pages = [
+  {
+    id: 1,
+    title: 'Title 1',
+  },
+  {
+    id: 2,
+    title: 'Title 2',
+  },
+  {
+    id: 3,
+    title: 'Title 3',
+  },
+];
+
+var comments = [
+  {
+    id: 1,
+    page: 1,
+    subject: 'Title 1 Comment 1',
+    auther: 'JT',
+  },
+  {
+    id: 2,
+    page: 1,
+    subject: 'Title 1 Comment 2',
+    auther: 'Anna',
+  },
+  {
+    id: 3,
+    page: 1,
+    subject: 'Title 1 Comment 3',
+    auther: 'Jane',
+  },
+  {
+    id: 4,
+    page: 1,
+    subject: 'Title 1 Comment 4',
+    auther: 'Bob',
+  },
+  {
+    id: 5,
+    page: 4,
+    subject: 'This should not show!',
+    auther: 'Jill',
+  },
+];
+
+function getRandomNumber(min, max) {
+  return Math.random() * (max - min) + min;
+}
+
+function create(hbs, env) {
+  if (env) process.env.NODE_ENV = env;
+  var app = express();
+  var viewsDir = path.join(__dirname, 'views');
+
+  // Hook in express-hbs and tell it where known directories reside
+  app.engine(
+    'hbs',
+    hbs.express4({
+      defaultLayout: path.join(viewsDir, 'layout.hbs'),
+      restrictLayoutsTo: viewsDir,
+    }),
+  );
+  app.set('view engine', 'hbs');
+  app.set('views', viewsDir);
+
+  app.use(cookieParser());
+
+  app.get('/', function (req, res) {
+    res.render('index', {
+      message: 'Hello,',
+      username: req.cookies.user,
+    });
+  });
+
+  app.get('/fail', function (req, res) {
+    res.render('failer');
+  });
+
+  hbs.registerAsyncHelper('user', function (username, resultcb) {
+    setTimeout(
+      function () {
+        resultcb(username);
+      },
+      getRandomNumber(100, 900),
+    );
+  });
+
+  hbs.registerAsyncHelper('pages', function (options, resultcb) {
+    var self = this;
+    setTimeout(
+      function () {
+        var result = [];
+        for (var i = 0; i < pages.length; i++) {
+          options.data.page = pages[i];
+          result.push(options.fn.call(self, pages[i], options));
+        }
+        resultcb(result.join(''));
+      },
+      getRandomNumber(100, 900),
+    );
+  });
+
+  hbs.registerAsyncHelper('comments', function (options, resultcb) {
+    var self = this;
+    setTimeout(
+      function () {
+        var result = [];
+        for (var i = 0; i < comments.length; i++) {
+          if (options.hash.page === comments[i].page) {
+            result.push(options.fn(comments[i]));
+          }
+        }
+        resultcb(result.join(''));
+      },
+      getRandomNumber(100, 300),
+    );
+  });
+
+  hbs.registerAsyncHelper('failer', function (_, resultcb) {
+    setTimeout(function () {
+      resultcb(options.fn());
+    }, 100);
+  });
+
+  return app;
+}
+
+exports.create = create;

package/.claude/worktrees/node-20-26-migration-7de0c3/test/apps/async/views/failer.hbs

@@ -0,0 +1,4 @@
+{{#contentFor "title"}}
+  Failer
+{{/contentFor}}
+<span id="text">This should fail {{#failer}}for sure{{/failer}}.</span>

package/.claude/worktrees/node-20-26-migration-7de0c3/test/apps/async/views/index.hbs

@@ -0,0 +1,16 @@
+{{#contentFor "title"}}
+  {{message}} {{{user username}}}
+{{/contentFor}}
+<span id="text">This should welcome {{username}}.</span>
+<div class="pages">
+{{#pages filter="tags:test"}}
+  <div class="page">
+    <span class="title">{{title}}</title>
+    <div class="top-comments">
+    {{#comments top="3" page=id}}
+      <span class="subject">{{subject}}</span>-<span class="auther">{{auther}}</span>
+    {{/comments}}
+    </div>
+  </div>
+{{/pages}}
+</div>

package/.claude/worktrees/node-20-26-migration-7de0c3/test/apps/async/views/layout.hbs

@@ -0,0 +1 @@
+<html><title>{{{block "title"}}}</title><body>{{{body}}}</body></html>

package/.claude/worktrees/node-20-26-migration-7de0c3/test/apps/i18n/index.js

@@ -0,0 +1,57 @@
+/**
+ * This example is intended to show a cookie usage in express setup
+ * with handlebars (hbs) template engine and also to be run
+ * as integration test for concurrency issues.
+ *
+ * Please remove setTimeout(), if you intend to use it as a blueprint!
+ *
+ */
+
+function create(hbs, env) {
+  'use strict';
+
+  if (env) process.env.NODE_ENV = env;
+
+  var express = require('express');
+  var cookieParser = require('cookie-parser');
+  var app = express();
+  var fs = require('fs');
+  var path = require('path');
+  var viewsDir = __dirname + '/views';
+  var i18n = require('i18n');
+  var url = require('url');
+
+  // minimal config
+  i18n.configure({
+    locales: ['en', 'fr'],
+    cookie: 'locale',
+    directory: __dirname + '/locales',
+  });
+
+  // Hook in express-hbs and tell it where known directories reside
+  app.engine(
+    'hbs',
+    hbs.express3({
+      i18n: i18n,
+      restrictLayoutsTo: viewsDir,
+    }),
+  );
+  app.set('view engine', 'hbs');
+  app.set('views', viewsDir);
+
+  // you'll need cookies
+  app.use(cookieParser());
+
+  // init i18n module for this loop
+  app.use(i18n.init);
+
+  app.get('/', function (req, res) {
+    res.render('index', {
+      array: [1, 2],
+    });
+  });
+
+  return app;
+}
+
+exports.create = create;

package/.claude/worktrees/node-20-26-migration-7de0c3/test/apps/i18n/locales/en.json

@@ -0,0 +1,8 @@
+{
+	"text to test": "text to test",
+	"%d cat": {
+		"one": "%d cat",
+		"other": "%d cats"
+	},
+	"each": "each"
+}

package/.claude/worktrees/node-20-26-migration-7de0c3/test/apps/i18n/locales/fr.json

@@ -0,0 +1,8 @@
+{
+    "text to test": "Texte à tester",
+    "%d cat": {
+        "one": "%d chat",
+        "other": "%d chats"
+    },
+    "each": "chaque"
+}

package/.claude/worktrees/node-20-26-migration-7de0c3/test/apps/i18n/views/index.hbs

@@ -0,0 +1,3 @@
+<span id="text">{{__ "text to test"}}</span>
+<br>
+{{#each array}}<span class="{{__ "each"}}">{{__n "%d cat" "%d cats" .}}</span>{{/each}}

package/.claude/worktrees/node-20-26-migration-7de0c3/test/asyncSpecs.js

@@ -0,0 +1,69 @@
+'use stirct';
+
+var request = require('supertest');
+var assert = require('assert');
+var hbs = require('..');
+var asyncApp = require('./apps/async');
+var resolver = require('../lib/resolver');
+
+function makeUserRequest(app, user, cb) {
+  request(app)
+    .get('/')
+    .set('Cookie', 'user=' + user)
+    .end(function (err, res) {
+      if (err) cb(err);
+      if (res.text.search('Hello, ' + user) <= 0) {
+        return cb(new Error('Wrong template send for user ' + user + ': ' + res.text), user);
+      }
+      return cb(null, user, res.text);
+    });
+}
+
+function requestAll(app, users, cb) {
+  var status = {};
+  for (var i = 0; i < users.length; i++) {
+    status[users[i]] = 'Pending';
+    makeUserRequest(app, users[i], function (err, user) {
+      if (err) {
+        status[user] = 'Error: ' + err.message;
+      } else {
+        status[user] = 'Completed';
+      }
+    });
+  }
+  var checkTimer = setInterval(function () {
+    for (var i = 0; i < users.length; i++) {
+      if (status[users[i]] === 'Pending') {
+        return;
+      }
+    }
+    clearInterval(checkTimer);
+    cb(status);
+  }, 100);
+}
+
+describe('async', function () {
+  it('should render all async helpers', function (done) {
+    var app = asyncApp.create(hbs.create(), 'production');
+    requestAll(app, ['jt', 'anna', 'joe', 'jeff', 'jane'], function (results) {
+      assert.equal(results.jt, 'Completed');
+      assert.equal(results.anna, 'Completed');
+      assert.equal(results.joe, 'Completed');
+      assert.equal(results.jeff, 'Completed');
+      assert.equal(results.jane, 'Completed');
+      done();
+    });
+  });
+
+  it('should render nested async helpers', function (done) {
+    var app = asyncApp.create(hbs.create(), 'production');
+    makeUserRequest(app, 'jt', function (err, user, results) {
+      if (err) {
+        return done(err);
+      }
+      assert.equal(false, resolver.hasResolvers(results));
+      assert.equal(-1, results.search('This should not show!'));
+      done();
+    });
+  });
+});

package/.claude/worktrees/node-20-26-migration-7de0c3/test/cacheSpecs.js

@@ -0,0 +1,135 @@
+var request = require('supertest');
+var path = require('path');
+var rewire = require('rewire');
+var assert = require('assert');
+var fs = require('fs');
+
+/**
+ * Creates instance of example app using an injected version of express-hbs to track the number of times a
+ * file is read. Additionally, the $NODE_ENV environment variable may be set.
+ *
+ * @param env
+ * @returns {{app: hbs, readCounts: {}}}
+ */
+function createApp(env) {
+  var readCounts = {};
+  var hbs = rewire('../lib/hbs');
+  hbs.__set__('fs', {
+    readFileSync: function (filename, encoding) {
+      if (typeof readCounts[filename] === 'undefined') {
+        readCounts[filename] = 1;
+      } else {
+        readCounts[filename] += 1;
+      }
+
+      return fs.readFileSync(filename, encoding);
+    },
+
+    readFile: function (filename, encoding, cb) {
+      if (typeof readCounts[filename] === 'undefined') {
+        readCounts[filename] = 1;
+      } else {
+        readCounts[filename] += 1;
+      }
+
+      fs.readFile(filename, encoding, cb);
+    },
+    existsSync: function (filename, encoding) {
+      return fs.existsSync(filename, encoding);
+    },
+  });
+
+  // used mocked hbs in example
+  var example = require('../example/app');
+  var app = example.create(hbs, env);
+  return { app: app, readCounts: readCounts };
+}
+
+describe('express-hbs', function () {
+  describe('cache', function () {
+    it('should not cache layout in `development`', function (done) {
+      var mock = createApp('development');
+
+      request(mock.app)
+        .get('/')
+        .end(function (err) {
+          assert.ifError(err);
+
+          request(mock.app)
+            .get('/')
+            .expect(/DEFAULT LAYOUT/)
+            .end(function (err) {
+              assert.ifError(err);
+
+              var filename = path.resolve(__dirname, '../example/views/layout/default.hbs');
+              assert.equal(mock.readCounts[filename], 2);
+              done();
+            });
+        });
+    });
+
+    it('should cache layout in `production` reading file once', function (done) {
+      var mock = createApp('production');
+
+      // reads layout from fs once
+      request(mock.app)
+        .get('/')
+        .end(function (err) {
+          assert.ifError(err);
+
+          request(mock.app)
+            .get('/')
+            .expect(/DEFAULT LAYOUT/)
+            .end(function (err, res) {
+              assert.ifError(err);
+
+              var filename = path.resolve(__dirname, '../example/views/layout/default.hbs');
+              assert.equal(mock.readCounts[filename], 1);
+              done();
+            });
+        });
+    });
+
+    it('should not cache partials in `development`', function (done) {
+      var mock = createApp('development');
+
+      request(mock.app)
+        .get('/veggies')
+        .expect(/just a comment/)
+        .end(function (err) {
+          assert.ifError(err);
+          request(mock.app)
+            .get('/veggies')
+            .expect(/just a comment/)
+            .end(function (err) {
+              assert.ifError(err);
+
+              var filename = path.resolve(__dirname, '../example/views/partials/sub/comment.hbs');
+              assert.equal(mock.readCounts[filename], 2);
+              done();
+            });
+        });
+    });
+
+    it('should cache partials in `production', function (done) {
+      var mock = createApp('production');
+
+      request(mock.app)
+        .get('/veggies')
+        .expect(/just a comment/)
+        .end(function (err) {
+          assert.ifError(err);
+          request(mock.app)
+            .get('/veggies')
+            .expect(/just a comment/)
+            .end(function (err) {
+              assert.ifError(err);
+
+              var filename = path.resolve(__dirname, '../example/views/partials/sub/comment.hbs');
+              assert.equal(mock.readCounts[filename], 1);
+              done();
+            });
+        });
+    });
+  });
+});

package/.claude/worktrees/node-20-26-migration-7de0c3/test/customExtension.js

@@ -0,0 +1,35 @@
+'use strict';
+var assert = require('assert');
+var hbs = require('..');
+var path = require('path');
+var H = require('./helpers');
+
+// MEANJS is using custom extension .server.view.html instead of .hbs
+// https://github.com/meanjs/mean
+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',
+    restrictLayoutsTo: dirname,
+  });
+
+  it('should allow rendering multiple partials with custom extension', function (done) {
+    function check(err, html) {
+      assert.ifError(err);
+      assert.equal(
+        '<html>' +
+          '<subpartial>1</subpartial>' +
+          '<partial>1</partial>' +
+          '<subpartial>2</subpartial>' +
+          '<partial>2</partial>' +
+          '</html>',
+        H.stripWs(html),
+      );
+      done();
+    }
+
+    var options = { cache: true, settings: { views: dirname } };
+    render(dirname + '/template.server.view.html', options, check);
+  });
+});

package/.claude/worktrees/node-20-26-migration-7de0c3/test/handlebarsSpecs.js

@@ -0,0 +1,92 @@
+var request = require('supertest');
+var assert = require('assert');
+var hbs = require('..');
+
+describe('express-hbs', function () {
+  describe('defaults', function () {
+    var app;
+
+    beforeEach(function () {
+      var example = require('../example/app');
+      app = example.create(hbs.create());
+    });
+
+    it('should render using default layout', function (done) {
+      request(app)
+        .get('/')
+        .expect(/DEFAULT LAYOUT/, done);
+    });
+
+    it('should render layout declared in markup', function (done) {
+      request(app)
+        .get('/fruits')
+        .expect(/DECLARATIVE LAYOUT/, done);
+    });
+
+    it('should render nested declarative layouts correctly', function (done) {
+      request(app)
+        .get('/fruits/apple')
+        .expect(/DECLARATIVE LAYOUT/)
+        .expect(/NESTED LAYOUT/, done);
+    });
+
+    it('should render layout specified as locals', function (done) {
+      request(app)
+        .get('/veggies')
+        .expect(/PROGRAMMATIC LAYOUT/, done);
+    });
+
+    it('should render nested layouts correctly when first layout is specified as locals', function (done) {
+      request(app)
+        .get('/veggies/carrot')
+        .expect(/PROGRAMMATIC LAYOUT/)
+        .expect(/NESTED LAYOUT/, done);
+    });
+
+    it('should render partial', function (done) {
+      request(app)
+        .get('/veggies')
+        .expect(/jquery\.js/)
+        .expect(/Other partial/, done);
+    });
+
+    it('should render sub partial', function (done) {
+      request(app)
+        .get('/veggies')
+        .expect(/just a comment/, done);
+    });
+
+    it('should render block', function (done) {
+      request(app)
+        .get('/')
+        .expect(/color: blue/, done);
+    });
+
+    it('should render block default content', function (done) {
+      request(app)
+        .get('/')
+        .expect(/Default block content/, done);
+    });
+
+    it('should render block content instead of default content when contentFor is declared', function (done) {
+      request(app)
+        .get('/replace')
+        .expect(/Non-default block content/, done);
+    });
+
+    it('should replace {{body}}', function (done) {
+      request(app)
+        .get('/')
+        .expect(/Vegetables/, done);
+    });
+  });
+
+  describe('instances', function () {
+    it('should create isolated instances', function () {
+      var hbs2 = hbs.create();
+      var hbs3 = hbs.create();
+
+      assert(hbs !== hbs2 && hbs !== hbs3 && hbs2 !== hbs3);
+    });
+  });
+});

package/.claude/worktrees/node-20-26-migration-7de0c3/test/helperSpecs.js

@@ -0,0 +1,58 @@
+var assert = require('assert');
+var hbs = require('..');
+var H = require('./helpers');
+
+describe('helpers', function () {
+  describe('sync', function () {
+    var dirname = __dirname + '/views/helpers';
+
+    function sync(s, options) {
+      return new hbs.SafeString('-sync-' + s);
+    }
+
+    it('should register functions', function (done) {
+      var hb = hbs.create();
+      hb.registerHelper('sync', sync);
+      var render = hb.express3({
+        viewsDir: dirname,
+        restrictLayoutsTo: dirname,
+      });
+      var locals = H.createLocals('express3', dirname);
+
+      render(dirname + '/home/index.hbs', locals, function (err, html) {
+        assert.equal('<default>index-sync-index</default>', H.stripWs(html));
+        done();
+      });
+    });
+  });
+
+  describe('async', function () {
+    var dirname = __dirname + '/views/helpers';
+    it('should register functions', function (done) {
+      var hb = hbs.create();
+      function async(s, cb) {
+        setTimeout(
+          function () {
+            cb(new hb.SafeString('-async-' + s));
+          },
+          Math.floor(Math.random() * 10 + 1),
+        );
+      }
+      hb.registerAsyncHelper('async', async);
+
+      var render = hb.express3({
+        viewsDir: dirname,
+        restrictLayoutsTo: dirname,
+      });
+      var locals = H.createLocals('express3', dirname);
+
+      render(dirname + '/home/async.hbs', locals, function (err, html) {
+        assert.equal(
+          '<default>asynctemplate-async-foo-async-bar-async-bah-async-baz</default>',
+          H.stripWs(html),
+        );
+        done();
+      });
+    });
+  });
+});

package/.claude/worktrees/node-20-26-migration-7de0c3/test/helpers.js

@@ -0,0 +1,24 @@
+function stripWs(s) {
+  return s.replace(/\s+/g, '');
+}
+
+function createLocals(which, viewsDir, locals) {
+  if (!locals) locals = {};
+  var opts = {};
+  if (which === 'express3' || which === 'express4') {
+    opts.settings = {
+      views: viewsDir,
+    };
+    opts.cache = process.env.NODE_ENV === 'production';
+    for (var k in locals) {
+      if (!locals.hasOwnProperty(k)) continue;
+      opts[k] = locals[k];
+    }
+  }
+  return opts;
+}
+
+module.exports = {
+  createLocals: createLocals,
+  stripWs: stripWs,
+};