gulp-twig/test/main.js

Twig.js plugin for gulp.js (gulpjs.com)

var fs = require('fs');
var path = require('path');
var should = require('should');
var Vinyl = require('vinyl');
var twig = require('../');

require('mocha');

describe('gulp-twig', function () {

    it('should compile twig templates to html files', function (done) {
        var twg = twig({
            data: {
                title: 'twig'
            }
        });

        var fakeFile = new Vinyl({
            base: 'test/',
            cwd: 'test/',
            path: path.join(__dirname, '/templates/file.twig'),
            contents: fs.readFileSync(__dirname + '/templates/file.twig')
        });

        twg.on('data', function (newFile) {
            should.exist(newFile);
            should.exist(newFile.contents);
            should.exist(newFile.path);
            String(newFile.contents).should.equal(fs.readFileSync(__dirname + '/expected/file.html', 'utf8'));
            done();
        });
        twg.write(fakeFile);
    });

    it('should compile twig templates to html files without options', function (done) {
        var twg = twig();

        var fakeFile = new Vinyl({
            base: 'test/',
            cwd: 'test/',
            path: path.join(__dirname, '/templates/file.twig'),
            contents: fs.readFileSync(__dirname + '/templates/file.twig')
        });

        twg.on('data', function (newFile) {
            should.exist(newFile);
            should.exist(newFile.contents);
            should.exist(newFile.path);
            String(newFile.contents).should.equal(fs.readFileSync(__dirname + '/expected/file-noopts.html', 'utf8'));
            done();
        });
        twg.write(fakeFile);
    });

    it('should return \'null\' file when no file put in', function (done) {
        var twg = twig();

        var fakeFile = new Vinyl({
            base: 'test/',
            cwd: 'test/'
        });

        twg.on('data', function (newFile) {
            should.exist(newFile);
            should.not.exist(newFile.contents);
            should.not.exist(newFile.path);
            String(newFile.contents).should.equal('null');
            done();
        });
        twg.write(fakeFile);
    });

    it('should accept data from file.data', function (done) {
        var twg = twig();

        var fakeFile = new Vinyl({
            base: 'test/',
            cwd: 'test/',
            path: path.join(__dirname, '/templates/file.twig'),
            contents: fs.readFileSync(__dirname + '/templates/file.twig'),
        });

        // simulate data attribute being added by gulp-data plugin
        fakeFile['data'] = {
            title: 'twig'
        };

        twg.on('data', function (newFile) {
            should.exist(newFile);
            should.exist(newFile.contents);
            should.exist(newFile.path);
            String(newFile.contents).should.equal(fs.readFileSync(__dirname + '/expected/file.html', 'utf8'));
            done();
        });
        twg.write(fakeFile);
    });

  it('should consider extname option', function (done) {
    var twg = twig({
      extname: '.md'
    });

    var fakeFile = new Vinyl({
      base: 'test/',
      cwd: 'test/',
      path: path.join(__dirname, '/templates/file.twig'),
      contents: fs.readFileSync(__dirname + '/templates/file.twig')
    });

    twg.on('data', function (newFile) {
      path.extname(newFile.path).should.equal('.md');
      done();
    });
    twg.write(fakeFile);
  });

  it('should drop extname option when passing "falsy"', function (done) {
    var twg = twig({
      extname: false
    });

    var fakeFile = new Vinyl({
      base: 'test/',
      cwd: 'test/',
      path: path.join(__dirname, '/templates/file.twig'),
      contents: fs.readFileSync(__dirname + '/templates/file.twig')
    });

    twg.on('data', function (newFile) {
      path.basename(newFile.path).should.equal('file');
      done();
    });
    twg.write(fakeFile);
  });

  it('should inherit extname option when passing true', function (done) {
    var twg = twig({
      extname: true
    });

    var fakeFile = new Vinyl({
      base: 'test/',
      cwd: 'test/',
      path: path.join(__dirname, '/templates/file.twig'),
      contents: fs.readFileSync(__dirname + '/templates/file.twig')
    });

    twg.on('data', function (newFile) {
      path.basename(newFile.path).should.equal('file.twig');
      done();
    });
    twg.write(fakeFile);
  });

  it('should use file contents if useFileContents option is enabled', function (done) {
    var twg = twig({
      useFileContents: true,
      data: {
        title: 'twig',
      },
    });

    var fakeFile = new Vinyl({
      base: 'test/',
      cwd: 'test/',
      path: path.join(__dirname, '/templates/file.twig'),
      contents: new Buffer('{{ title }}'),
    });

    twg.on('data', function (newFile) {
      String(newFile.contents).should.equal('twig');
      done();
    });
    twg.write(fakeFile);
  });

});