gulp-messenger/spec/MessengerSpec.js

Console/Gulp and File Logger

'use strict';

var msg    = require('../index');
var expect = require('chai').expect;
var should = require('chai').should();
var chalk  = require('chalk');
var pkgInfo = require('../package');


var kids = ['Joelle', 'Brady', 'Bailey', 'Trevor'];
var user = {fname: 'Mike', lname: 'Erickson', kids: kids.join(', ')};

describe ('Messenger (Console / Logger) for Browser and Server, including `gulp` pipeline support', function () {

  beforeEach (function () {
    msg.init({
      timestamp: false,
      boldVariables: true
    });
  });

  it ('should return version', function (done) {
    msg.header(chalk.red(' *** Gulp-messenger version: ', msg.version()))
    var version = msg.version();
    var pkgVers = pkgInfo.version;
    version.should.equal(pkgVers)
    done();
  });

  it('should return module name', function (done){
    var name = msg.name;
    name.should.equal('gulp-messenger');
    done();
  });

  it('should interpolate string', function (done) {
    msg.Info(user);
    msg.Success('Hello there <%= fname %> <%= lname %>:', user);
    msg.Success('These are our kids <%= kids %>', user);

    done();
  });

  it('should test all messenger routines', function (done) {

    msg.Log('log');
    msg.Info('info');
    msg.Error('error');
    msg.Success('success');
    msg.Warning('warning');
    msg.Warn('using `warn` shorthand');
    msg.Note(chalk.gray('note, color supplied by `Chalk` instance'));
    msg.Time('time');
    msg.Debug('debug');
    msg.Header('This should be underline');
    msg.Log(chalk.red.bold.italic('You can perform any text customization with simple log and `chalk` library'));
    msg.Info('*', 'Bordered Output', '=');
    msg.Warning('Testing interpolation by <%=fname %> <%=lname %>', {fname: 'Mike', lname: 'Erickson'});
    msg.Info({fname: 'Mike', lname: 'Erickson'});

    msg.Line();
    expect(true).to.be.equal(true);

    done();
  });

  it('should test all logging routines', function (done) {
    expect(true).to.be.equal(true);
    done();
  });

  it('should test `gulp` methods', function (done) {
    expect(true).to.be.equal(true);
    done();
  });

  it('should support all optional params', function (done) {

    msg.Info(chalk.magenta('Note:  These are not working correctly yet...'));
    msg.Line('#');
    msg.Line('-', 40);
    done();

  });

});

describe('Messenger Line Test', function () {

  it('should print lines before and after', function (done) {
    msg.Warn('=', 'Testing `Warn` message', '*');
    msg.Warning('=', 'This is from `Warning` routine', '*');
    expect(true).to.be.equal(true);
    done();
  });

  it('should print lines before and after', function (done) {
    msg.Error('=', 'Now trying `Error containing `=` ');
    expect(true).to.be.equal(true);
    done();
  });

  it('should print lines before and after', function (done) {
    msg.Success('', 'A `Success` line after this message containing `x` ', 'x');
    expect(true).to.be.equal(true);
    done();
  });

});

describe('Test Using Console Override', function (done) {

  it('should work with all messenger methods', function (done) {

    msg.header(msg.orange('Header'));

    msg.log(msg.orange('This text should be orange'));

    msg.log('log');
    msg.info('info');
    msg.error('error');
    msg.success('success');
    msg.note('note');
    msg.warning('warning');
    msg.warn('using `warn` shorthand');
    msg.note(chalk.gray('note, color supplied by `Chalk` instance'));
    msg.time('time');
    msg.debug('debug');
    msg.header('This should be underline');
    msg.log(chalk.red.underline('You can perform any text customization with simple log and `chalk` library'));
    msg.info('*', 'Bordered Output', '=');
    msg.warning('Testing interpolation by <%=fname %> <%=lname %>', {fname: 'Mike', lname: 'Erickson'});
    msg.info({fname: 'Mike', lname: 'Erickson'});

    expect(true).to.be.equal(true);

    done();
msg
  });

  it('should display dump', function (done) {
    var family = {
      fname: 'Mike',
      middle: 'Steven',
      lname: 'Erickson'
    };

    msg.Dump(family, {plain: true});
    msg.Dump(family);

    done();
  });

});