partials.js

'use strict';

require('mocha');
require('should');
var assert = require('assert');
var support = require('./support');
var App = support.resolve();
var app, pages;

describe('partials', function() {
  beforeEach(function() {
    app = new App();
    app.engine('tmpl', require('engine-base'));
    app.engine('hbs', require('engine-handlebars'));

    app.create('partials', { viewType: 'partial' });
    app.create('include', { viewType: 'partial' });
    app.create('layouts', { viewType: 'layout' });
    pages = app.create('page');
  });

  it('should inject a partial with a helper:', function(cb) {
    app.include('base', {path: 'base.tmpl', content: 'xyz'});
    app.pages('a.tmpl', {path: 'a.tmpl', content: 'a <%= include("base") %> c'});
    var page = app.pages.getView('a.tmpl');

    app.render(page, function(err, view) {
      if (err) return cb(err);
      assert.equal(typeof view.content, 'string');
      assert.equal(view.content, 'a xyz c');
      cb();
    });
  });

  it('should inject a partial with a helper on a collection:', function(cb) {
    app.include('base', {path: 'base.tmpl', content: 'xyz'});
    pages.engine('.tmpl', require('engine-handlebars'));
    pages.helpers(app._.helpers.sync);
    pages.asyncHelpers(app._.helpers.async);
    pages.addView('a.tmpl', {path: 'a.tmpl', content: 'a {{include "base" }} c'});
    var page = pages.getView('a.tmpl');

    pages.render(page, function(err, view) {
      if (err) return cb(err);
      assert.equal(typeof view.content, 'string');
      assert.equal(view.content, 'a xyz c');
      cb();
    });
  });

  it('should use handlebars partial with a helper on a collection:', function(cb) {
    app.include('base', {path: 'base.tmpl', content: 'xyz'});
    pages.engine('.tmpl', require('engine-handlebars'));
    pages.helpers(app._.helpers.sync);
    pages.asyncHelpers(app._.helpers.async);
    pages.addView('a.tmpl', {path: 'a.tmpl', content: 'a {{> base }} c'});

    var page = pages.getView('a.tmpl');
    var locals = app.mergePartials(this.options);

    pages.render(page, locals, function(err, view) {
      if (err) return cb(err);
      assert.equal(typeof view.content, 'string');
      assert.equal(view.content, 'a xyz c');
      cb();
    });
  });

  it('should use layouts with partials:', function(cb) {
    app.layout('default', {path: 'a.tmpl', content: 'a {% body %} c'});
    app.include('b', {path: 'b.tmpl', content: 'b', layout: 'default'});
    app.pages('a.tmpl', {path: 'c.tmpl', content: '<%= include("b") %>'});
    var page = app.pages.getView('a.tmpl');

    app.render(page, function(err, view) {
      if (err) return cb(err);
      assert.equal(typeof view.content, 'string');
      assert.equal(view.content, 'a b c');
      cb();
    });
  });

  it('should add `layoutApplied` after layout is applied:', function(cb) {
    app.layout('default', {path: 'a.tmpl', content: 'a {% body %} c'});
    app.include('b', {path: 'b.tmpl', content: 'b', layout: 'default'});
    app.pages('a.tmpl', {path: 'c.tmpl', content: '<%= include("b") %>'});
    var page = app.pages.getView('a.tmpl');

    app.render(page, function(err, view) {
      if (err) return cb(err);
      assert.equal(typeof view.content, 'string');
      assert.equal(app.layouts.getView('default').options.layoutApplied);
      assert.equal(view.content, 'a b c');
      cb();
    });
  });

  it('should pass partials to handlebars:', function(cb) {
    app.onMerge(/\.hbs$/, function(view, next) {
      app.applyLayout(view);
      next();
    });

    app.layout('default', {path: 'a.hbs', content: 'a {% body %} c'});
    app.include('foo', {path: 'foo.hbs', content: 'foo', layout: 'default'});
    app.pages('a.hbs', {path: 'c.hbs', content: '{{> foo }}'});
    var page = app.pages.getView('a.hbs');

    app.render(page, function(err, view) {
      if (err) return cb(err);
      assert.equal(typeof view.content, 'string');
      assert.equal(view.content, 'a foo c');
      cb();
    });
  });

  it('should only merge in the specified viewTypes:', function(cb) {
    app.onMerge(/\.hbs$/, function(view, next) {
      app.applyLayout(view);
      next();
    });

    app.layout('default', {path: 'a.hbs', content: 'a {% body %} c'});
    app.option('mergeTypes', ['includes']);

    app.partial('foo', {path: 'bar.hbs', content: 'bar', layout: 'default'});
    app.include('foo', {path: 'foo.hbs', content: 'foo', layout: 'default'});

    app.pages('a.hbs', {path: 'c.hbs', content: '{{> foo }}'});
    app.pages.getView('a.hbs')
      .render(function(err, view) {
        if (err) return cb(err);
        assert.equal(typeof view.content, 'string');
        assert.equal(view.content, 'a foo c');
        cb();
      });

  });

  it('should merge the specified viewTypes in the order defined:', function(cb) {
    app.onMerge(/\.hbs$/, function(view, next) {
      app.applyLayout(view);
      next();
    });

    app.layout('default', {path: 'a.hbs', content: 'a {% body %} c'});
    app.option('mergeTypes', ['includes', 'partials']);

    app.partial('foo', {path: 'bar.hbs', content: 'bar', layout: 'default'});
    app.include('foo', {path: 'foo.hbs', content: 'foo', layout: 'default'});

    app.pages('a.hbs', {path: 'c.hbs', content: '{{> foo }}'});
    app.pages.getView('a.hbs')
      .render(function(err, view) {
        if (err) return cb(err);
        assert.equal(typeof view.content, 'string');
        assert.equal(view.content, 'a bar c');
        cb();
      });
  });

  it('should not merge in partials with `options.nomerge` defined:', function(cb) {
    app.onMerge(/\.hbs$/, function(view, next) {
      app.applyLayout(view);
      next();
    });

    app.layout('default', {path: 'a.hbs', content: 'a {% body %} c'});
    app.option('mergeTypes', ['includes', 'partials']);

    app.partial('foo', {path: 'bar.hbs', content: 'bar', layout: 'default', options: {nomerge: true}});
    app.include('foo', {path: 'foo.hbs', content: 'foo', layout: 'default'});

    app.pages('a.hbs', {path: 'c.hbs', content: '{{> foo }}'});
    app.pages.getView('a.hbs')
      .render(function(err, view) {
        if (err) return cb(err);
        assert.equal(typeof view.content, 'string');
        assert.equal(view.content, 'a foo c');
        cb();
      });
  });

  it('should emit an `onMerge` event:', function(cb) {
    app.on('onMerge', function(view) {
      app.applyLayout(view);
    });

    app.layout('default', {path: 'a.hbs', content: 'a {% body %} c'});
    app.option('mergeTypes', ['includes', 'partials']);

    app.partial('foo', {path: 'bar.hbs', content: 'bar', layout: 'default'});
    app.include('foo', {path: 'foo.hbs', content: 'foo', layout: 'default'});

    app.pages('a.hbs', {path: 'c.hbs', content: '{{> foo }}'});
    app.pages.getView('a.hbs')
      .render(function(err, view) {
        if (err) return cb(err);
        assert.equal(typeof view.content, 'string');
        assert.equal(view.content, 'a bar c');
        cb();
      });
  });
});