express-hbs 3.0.0 → 4.0.1

package/example/views/layout/fruit-details.hbs

@@ -1,9 +0,0 @@
-{{!< fruits}}
-
-<h3>NESTED LAYOUT</h3>
-
-<p>This is one of my favorite fruits!</p>
-
-<span class="fruit-details">
-  {{{body}}}
-</span>

package/example/views/layout/fruits.hbs

@@ -1,6 +0,0 @@
-{{!< html-struct}}
-
-<h2>DECLARATIVE LAYOUT</h2>
-
-<!-- Placeholder for page content. -->
-{{{body}}}

package/example/views/layout/html-struct.hbs

@@ -1,21 +0,0 @@
-<!DOCTYPE html>
-<html>
-  <head>
-    <title>{{title}}</title>
-    <link type="text/css" rel="stylesheet" href="/css/style.css"/>
-    {{{block "pageStyles"}}}
-  </head>
-
-  <body>
-
-    <!-- Placeholder for page content. -->
-    {{{body}}}
-
-    <!-- Partials are common snippets to be used 1 or more pages. -->
-    {{> scripts}}
-    {{> other}}
-
-    <!-- A block is placeholder for pieces of content defined in a page. -->
-    {{{block 'pageScripts'}}}
-  </body>
-</html>

package/example/views/layout/veggie-details.hbs

@@ -1,9 +0,0 @@
-{{!< veggie}}
-
-<h3>NESTED LAYOUT</h3>
-
-<p>This is one of my favorite veggies!</p>
-
-<span class="veggie-details">
-  {{{body}}}
-</span>

package/example/views/layout/veggie.hbs

@@ -1,6 +0,0 @@
-{{!< html-struct}}
-
-<h2>PROGRAMMATIC LAYOUT</h2>
-
-<!-- Placeholder for page content. -->
-{{{body}}}

package/example/views/partials/scripts.hbs

@@ -1,5 +0,0 @@
-{{#if production}}
-   <script src="//ajax.googleapis.com/ajax/libs/jquery/1.8.2/jquery.min.js"></script>
-{{else}}
-   <script src="//ajax.googleapis.com/ajax/libs/jquery/1.8.2/jquery.js"></script>
-{{/if}}

package/example/views/partials/sub/comment.hbs

@@ -1 +0,0 @@
-<!-- just a comment -->

package/example/views/partials-other/other.hbs

@@ -1 +0,0 @@
-<!-- Other partial -->

package/example/views/replace.hbs

@@ -1,6 +0,0 @@
-{{#contentFor 'replaced-default-block'}}
-    Non-default block content
-{{/contentFor}}
-
-
-<h1>{{title}}</h1>

package/example/views/tos.txt

@@ -1,3 +0,0 @@
-<h4>Terms of Service</h4>
-
-<div>Async result!</div>

package/example/views/veggies/details.hbs

@@ -1 +0,0 @@
-{{veggie}}

package/example/views/veggies.hbs

@@ -1,17 +0,0 @@
-{{#contentFor 'pageStyles'}}
-<style>
-  li a {
-    color: #800;
-  }
-</style>
-{{/contentFor}}
-
-{{> sub/comment}}
-<h1>{{title}}</h1>
-<ul>
-    {{#each veggies}}
-      <li>
-        <a href="/veggies/{{this.name}}">{{this.name}}</a>
-      </li>
-    {{/each}}
-</ul>

package/renovate.json

@@ -1,13 +0,0 @@
-{
-  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
-  "extends": [
-    "local>TryGhost/renovate-config"
-  ],
-  "packageRules": [
-    {
-      "description": "Keep pnpm on 10.x while this repo supports Node 20; pnpm 11 requires Node 22.13 or newer.",
-      "matchPackageNames": ["pnpm"],
-      "allowedVersions": "<11"
-    }
-  ]
-}

package/test/apps/async/index.js

@@ -1,139 +0,0 @@
-'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/test/apps/async/views/failer.hbs

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

package/test/apps/async/views/index.hbs

@@ -1,16 +0,0 @@
-{{#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/test/apps/async/views/layout.hbs

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

package/test/apps/i18n/index.js

@@ -1,57 +0,0 @@
-/**
- * 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/test/apps/i18n/locales/en.json

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

package/test/apps/i18n/locales/fr.json

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

package/test/apps/i18n/views/index.hbs

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

package/test/asyncSpecs.js

@@ -1,69 +0,0 @@
-'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/test/cacheSpecs.js

@@ -1,135 +0,0 @@
-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/test/customExtension.js

@@ -1,35 +0,0 @@
-'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);
-  });
-});