express-dot-engine/test/main.js

Node.js engine using the ultra fast doT templating with support for layouts, partials and friendly for front-end web libraries (Angular, Ember, Backbone...)

var engine = require('../');
var mock = require('mock-fs');
var path = require('path');
var should = require('should');

var expressOptions = {};

describe('express-dot-engine', function() {

  afterEach(function() {
    mock.restore();
  });

  //////////////////////////////////////////////////////////////////////////////
  // SERVER MODEL
  //////////////////////////////////////////////////////////////////////////////
  describe('server model', function() {

    it('should have access to server model', function(done) {
      // prepare
      mock({
        'path/views': {
          'child.dot': 'test-view [[= model.test ]]',
        },
      });

      // run
      engine.__express(
        'path/views/child.dot',
        { test: 'test-model', },
        function(err, result) {
          should(err).not.be.ok;
          should(result).equal('test-view test-model');
          done();
        });
    });

    it('should have access to server model in a layout', function(done) {
      // prepare
      mock({
        'path/views': {
          'master.dot': 'test-master [[= model.test ]]',
          'child.dot': '---\nlayout: master.dot\n---\n',
        },
      });

      // run
      engine.__express(
        'path/views/child.dot',
        { test: 'test-model', },
        function(err, result) {
          should(err).not.be.ok;
          should(result).equal('test-master test-model');
          done();
        });
    });

    it('should have access to server model in a partial', function(done) {
      // prepare
      mock({
        'path/views': {
          'partial.dot': 'test-partial [[= model.test ]]',
          'child.dot': 'test-child [[=partial(\'partial.dot\')]]',
        },
      });

      // run
      engine.__express(
        'path/views/child.dot',
        { test: 'test-model', },
        function(err, result) {
          should(err).not.be.ok;
          should(result).equal('test-child test-partial test-model');
          done();
        });
    });

  });

  //////////////////////////////////////////////////////////////////////////////
  // LAYOUT
  //////////////////////////////////////////////////////////////////////////////
  describe('layout', function() {

    it('should support 2 levels', function(done) {
      // prepare
      mock({
        'path/views': {
          'master.dot': 'test-master [[= layout.section ]]',
          'child.dot': '---\nlayout: master.dot\n---\n[[##section:test-child#]]',
        },
      });

      // run
      engine.__express(
        'path/views/child.dot', {},
        function(err, result) {
          should(err).not.be.ok;
          should(result).equal('test-master test-child');
          done();
        });
    });

    it('should support 3 levels', function(done) {
      // prepare
      mock({
        'path/views': {
          'master.dot': 'test-master [[= layout.section ]]',
          'middle.dot': '---\nlayout: master.dot\n---\n[[##section:test-middle [[= layout.section ]]#]]',
          'child.dot': '---\nlayout: middle.dot\n---\n[[##section:test-child#]]',
        },
      });

      // run
      engine.__express(
        'path/views/child.dot', {},
        function(err, result) {
          should(err).not.be.ok;
          should(result).equal('test-master test-middle test-child');
          done();
        });
    });

  });

  //////////////////////////////////////////////////////////////////////////////
  // PARTIAL
  //////////////////////////////////////////////////////////////////////////////
  describe('partial', function() {

    it('should work', function(done) {
      // prepare
      mock({
        'path/views': {
          'partial.dot': 'test-partial',
          'child.dot': 'test-child [[=partial(\'partial.dot\')]]',
        },
      });

      // run
      engine.__express(
        'path/views/child.dot',
        { test: 'test-model', },
        function(err, result) {
          should(err).not.be.ok;
          should(result).equal('test-child test-partial');
          done();
        });
    });

    it('should allow to pass additional data to the partial', function(done) {
      // prepare
      mock({
        'path/views': {
          'partial.dot': 'test-partial [[=model.media]]',
          'child.dot': 'test-child [[=partial(\'partial.dot\', { media: model.test, })]]',
        },
      });

      // run
      engine.__express(
        'path/views/child.dot',
        { test: 'test-model', },
        function(err, result) {
          should(err).not.be.ok;
          should(result).equal('test-child test-partial test-model');
          done();
        });
    });

  });

  //////////////////////////////////////////////////////////////////////////////
  // TEMPLATE
  //////////////////////////////////////////////////////////////////////////////
  describe('render', function() {

    it('should work async', function(done) {
      // prepare
      mock({
        'path/views': {
          'child.dot': 'test-template [[= model.test ]]',
        },
      });

      // run
      engine.render(
        'path/views/child.dot',
        { test: 'test-model', },
        function(err, result) {
          should(err).not.be.ok;
          should(result).equal('test-template test-model');
          done();
        });
    });

    it('should work sync', function() {
      // prepare
      mock({
        'path/views': {
          'child.dot': 'test-template [[= model.test ]]',
        },
      });

      // run
      var result = engine.render(
        'path/views/child.dot',
        { test: 'test-model', });

      // result
      should(result).equal('test-template test-model');
    });

  });

  //////////////////////////////////////////////////////////////////////////////
  // TEMPLATE STRING
  //////////////////////////////////////////////////////////////////////////////
  describe('renderString', function() {

    it('should work async', function(done) {

      // run
      engine.renderString(
        'test-template [[= model.test ]]',
        { test: 'test-model', },
        function(err, result) {
          should(err).not.be.ok;
          should(result).equal('test-template test-model');
          done();
        });
    });

    it('should work sync', function() {

      // run
      var result = engine.renderString(
        'test-template [[= model.test ]]',
        { test: 'test-model', });

      // result
      should(result).equal('test-template test-model');
    });

  });

  //////////////////////////////////////////////////////////////////////////////
  // TEMPLATE PROVIDER
  //////////////////////////////////////////////////////////////////////////////
  describe('render with template provider', function() {

    var templatename = 'render.with.template.provider',
        template = 'test-template [[= model.test ]]',
        getTemplate = function(name, options, callback) {
            var isAsync = callback && typeof callback === 'function';
            if (name === templatename) {
              if(!isAsync){
                return template;
              }
              callback(null, template);
            }
        };

    it('should work async', function(done) {
      // run
      engine.render(
          templatename,
          { getTemplate: getTemplate, test: 'test-model', },
          function(err, result) {
            should(err).not.be.ok;
            should(result).equal('test-template test-model');
            done();
          });
    });

    it('should work sync', function() {
      // run
      var result = engine.render(
          templatename,
          { getTemplate: getTemplate, test: 'test-model', });

      // result
      should(result).equal('test-template test-model');
    });

  });

  //////////////////////////////////////////////////////////////////////////////
  // CACHE
  //////////////////////////////////////////////////////////////////////////////
  describe('cache', function() {

    it('should work', function(done) {
      // prepare
      mock({
        'path/views': {
          'child.dot': 'test-child [[= model.test ]]',
        },
      });

      // run
      function test(data, cb) {
        engine.__express(
          'path/views/child.dot',
          {
            cache: true,
            test: data,
          },
          function(err, result) {
            should(err).not.be.ok;
            should(result).equal('test-child ' + data);
            cb();
          }
        );
      }

      test('test-model1',
        function() { test('test-model2', done); }
      );
    });

  });

});