DefinitelyTyped/vinyl/vinyl-tests.ts

/// <reference path="../mocha/mocha.d.ts" />
/// <reference path="../should/should.d.ts" />

/// <reference path="./vinyl.d.ts" />

import File = require('vinyl');
import Stream = require('stream');
import fs = require('fs');

import should = require('should');

describe('File', function() {

	describe('constructor()', function() {
		it('should default cwd to process.cwd', function(done) {
			var file = new File();
			file.cwd.should.equal(process.cwd());
			done();
		});

		it('should default base to cwd', function(done) {
			var cwd = "/";
			var file = new File({cwd: cwd});
			file.base.should.equal(cwd);
			done();
		});

		it('should default base to cwd even when none is given', function(done) {
			var file = new File();
			file.base.should.equal(process.cwd());
			done();
		});

		it('should default path to null', function(done) {
			var file = new File();
			should.not.exist(file.path);
			done();
		});

		it('should default stat to null', function(done) {
			var file = new File();
			should.not.exist(file.stat);
			done();
		});

		it('should default contents to null', function(done) {
			var file = new File();
			should.not.exist(file.contents);
			done();
		});

		it('should set base to given value', function(done) {
			var val = "/";
			var file = new File({base: val});
			file.base.should.equal(val);
			done();
		});

		it('should set cwd to given value', function(done) {
			var val = "/";
			var file = new File({cwd: val});
			file.cwd.should.equal(val);
			done();
		});

		it('should set path to given value', function(done) {
			var val = "/test.coffee";
			var file = new File({path: val});
			file.path.should.equal(val);
			done();
		});

		it('should set stat to given value', function(done) {
			var val = {};
			var file = new File({stat: val});
			file.stat.should.equal(val);
			done();
		});

		it('should set contents to given value', function(done) {
			var val = new Buffer("test");
			var file = new File({contents: val});
			file.contents.should.equal(val);
			done();
		});
	});

	describe('isBuffer()', function() {
		it('should return true when the contents are a Buffer', function(done) {
			var val = new Buffer("test");
			var file = new File({contents: val});
			file.isBuffer().should.equal(true);
			done();
		});

		it('should return false when the contents are a Stream', function(done) {
			var val: NodeJS.ReadWriteStream; // = new Stream();
			var file = new File({contents: val});
			file.isBuffer().should.equal(false);
			done();
		});

		it('should return false when the contents are a null', function(done) {
			var file = new File({contents: null});
			file.isBuffer().should.equal(false);
			done();
		});
	});

	describe('isStream()', function() {
		it('should return false when the contents are a Buffer', function(done) {
			var val = new Buffer("test");
			var file = new File({contents: val});
			file.isStream().should.equal(false);
			done();
		});

		it('should return true when the contents are a Stream', function(done) {
			var val: NodeJS.ReadWriteStream; // = new Stream();
			var file = new File({contents: val});
			file.isStream().should.equal(true);
			done();
		});

		it('should return false when the contents are a null', function(done) {
			var file = new File({contents: null});
			file.isStream().should.equal(false);
			done();
		});
	});

	describe('isNull()', function() {
		it('should return false when the contents are a Buffer', function(done) {
			var val = new Buffer("test");
			var file = new File({contents: val});
			file.isNull().should.equal(false);
			done();
		});

		it('should return false when the contents are a Stream', function(done) {
			var val: NodeJS.ReadWriteStream; // = new Stream();
			var file = new File({contents: val});
			file.isNull().should.equal(false);
			done();
		});

		it('should return true when the contents are a null', function(done) {
			var file = new File({contents: null});
			file.isNull().should.equal(true);
			done();
		});
	});

	describe('isDirectory()', function() {
		var fakeStat = {
			isDirectory: function() {
				return true;
			}
		};

		it('should return false when the contents are a Buffer', function(done) {
			var val = new Buffer("test");
			var file = new File({contents: val, stat: fakeStat});
			file.isDirectory().should.equal(false);
			done();
		});

		it('should return false when the contents are a Stream', function(done) {
			var val: NodeJS.ReadWriteStream; // = new Stream();
			var file = new File({contents: val, stat: fakeStat});
			file.isDirectory().should.equal(false);
			done();
		});

		it('should return true when the contents are a null', function(done) {
			var file = new File({contents: null, stat: fakeStat});
			file.isDirectory().should.equal(true);
			done();
		});
	});

	describe('clone()', function() {
		it('should copy all attributes over with Buffer', function(done) {
			var options = {
				cwd: "/",
				base: "/test/",
				path: "/test/test.coffee",
				contents: new Buffer("test")
			};
			var file = new File(options);
			var file2 = file.clone();

			file2.should.not.equal(file, 'refs should be different');
			file2.cwd.should.equal(file.cwd);
			file2.base.should.equal(file.base);
			file2.path.should.equal(file.path);
			file2.contents.should.not.equal(file.contents, 'buffer ref should be different');
			file2.contents.toString('utf8').should.equal(file.contents.toString('utf8'));
			done();
		});

		it('should copy all attributes over with Stream', function(done) {
			var options = {
				cwd: "/",
				base: "/test/",
				path: "/test/test.coffee",
				contents: <NodeJS.ReadWriteStream>null // new Stream()
			};
			var file = new File(options);
			var file2 = file.clone();

			file2.should.not.equal(file, 'refs should be different');
			file2.cwd.should.equal(file.cwd);
			file2.base.should.equal(file.base);
			file2.path.should.equal(file.path);
			file2.contents.should.equal(file.contents, 'stream ref should be the same');
			done();
		});

		it('should copy all attributes over with null', function(done) {
			var options = {
				cwd: "/",
				base: "/test/",
				path: "/test/test.coffee",
				contents: <any>null
			};
			var file = new File(options);
			var file2 = file.clone();

			file2.should.not.equal(file, 'refs should be different');
			file2.cwd.should.equal(file.cwd);
			file2.base.should.equal(file.base);
			file2.path.should.equal(file.path);
			should.not.exist(file2.contents);
			done();
		});

		it('should properly clone the `stat` property', function(done) {
			var options = {
				cwd: "/",
				base: "/test/",
				path: "/test/test.js",
				contents: new Buffer("test"),
				stat: fs.statSync(__filename)
			};

			var file = new File(options);
			var copy = file.clone();

			copy.stat.isFile().should.be.true;
			copy.stat.isDirectory().should.be.false;
			// should(file.stat instanceof fs.Stats).be.true;
			// should(copy.stat instanceof fs.Stats).be.true;

			done();
		});
	});

	describe('pipe()', function() {
		it('should write to stream with Buffer', function(done) {
			var options = {
				cwd: "/",
				base: "/test/",
				path: "/test/test.coffee",
				contents: new Buffer("test")
			};
			var file = new File(options);
			var stream = new Stream.PassThrough();
			stream.on('data', function(chunk:any) {
				should.exist(chunk);
				(chunk instanceof Buffer).should.equal(true, 'should write as a buffer');
				chunk.toString('utf8').should.equal(options.contents.toString('utf8'));
			});
			stream.on('end', function(chunk:any) {
				done();
			});
			var ret = file.pipe(stream);
			ret.should.equal(stream, 'should return the stream');
		});

		it('should pipe to stream with Stream', function(done) {
			var testChunk = new Buffer("test");
			var options = {
				cwd: "/",
				base: "/test/",
				path: "/test/test.coffee",
				contents: new Stream.PassThrough()
			};
			var file = new File(options);
			var stream = new Stream.PassThrough();
			stream.on('data', function(chunk:any) {
				should.exist(chunk);
				(chunk instanceof Buffer).should.equal(true, 'should write as a buffer');
				chunk.toString('utf8').should.equal(testChunk.toString('utf8'));
				done();
			});
			var ret = file.pipe(stream);
			ret.should.equal(stream, 'should return the stream');

			file.contents.write(testChunk);
		});

		it('should do nothing with null', function(done) {
			var options = {
				cwd: "/",
				base: "/test/",
				path: "/test/test.coffee",
				contents: <any>null
			};
			var file = new File(options);
			var stream = new Stream.PassThrough();
			stream.on('data', function(chunk:any) {
				throw new Error("should not write");
			});
			stream.on('end', function() {
				done();
			});
			var ret = file.pipe(stream);
			ret.should.equal(stream, 'should return the stream');
		});

		it('should write to stream with Buffer', function(done) {
			var options = {
				cwd: "/",
				base: "/test/",
				path: "/test/test.coffee",
				contents: new Buffer("test")
			};
			var file = new File(options);
			var stream = new Stream.PassThrough();
			stream.on('data', function(chunk:any) {
				should.exist(chunk);
				(chunk instanceof Buffer).should.equal(true, 'should write as a buffer');
				chunk.toString('utf8').should.equal(options.contents.toString('utf8'));
				done();
			});
			stream.on('end', function(chunk:any) {
				throw new Error("should not end");
			});
			var ret = file.pipe(stream, {end: false});
			ret.should.equal(stream, 'should return the stream');
		});

		it('should pipe to stream with Stream', function(done) {
			var testChunk = new Buffer("test");
			var options = {
				cwd: "/",
				base: "/test/",
				path: "/test/test.coffee",
				contents: new Stream.PassThrough()
			};
			var file = new File(options);
			var stream = new Stream.PassThrough();
			stream.on('data', function(chunk:any) {
				should.exist(chunk);
				(chunk instanceof Buffer).should.equal(true, 'should write as a buffer');
				chunk.toString('utf8').should.equal(testChunk.toString('utf8'));
				done();
			});
			stream.on('end', function(chunk:any) {
				throw new Error("should not end");
			});
			var ret = file.pipe(stream, {end: false});
			ret.should.equal(stream, 'should return the stream');

			file.contents.write(testChunk);
		});

		it('should do nothing with null', function(done) {
			var options = {
				cwd: "/",
				base: "/test/",
				path: "/test/test.coffee",
				contents: <any>null
			};
			var file = new File(options);
			var stream = new Stream.PassThrough();
			stream.on('data', function(chunk:any) {
				throw new Error("should not write");
			});
			stream.on('end', function(chunk:any) {
				throw new Error("should not end");
			});
			var ret = file.pipe(stream, {end: false});
			ret.should.equal(stream, 'should return the stream');
			process.nextTick(done);
		});
	});

	describe('inspect()', function() {
		it('should return correct format when no contents and no path', function(done) {
			var file = new File();
			file.inspect().should.equal('<File >');
			done();
		});

		it('should return correct format when Buffer and no path', function(done) {
			var val = new Buffer("test");
			var file = new File({
				contents: val
			});
			file.inspect().should.equal('<File <Buffer 74 65 73 74>>');
			done();
		});

		it('should return correct format when Buffer and relative path', function(done) {
			var val = new Buffer("test");
			var file = new File({
				cwd: "/",
				base: "/test/",
				path: "/test/test.coffee",
				contents: val
			});
			file.inspect().should.equal('<File "test.coffee" <Buffer 74 65 73 74>>');
			done();
		});

		it('should return correct format when Buffer and only path and no base', function(done) {
			var val = new Buffer("test");
			var file = new File({
				cwd: "/",
				path: "/test/test.coffee",
				contents: val
			});
			delete file.base;
			file.inspect().should.equal('<File "/test/test.coffee" <Buffer 74 65 73 74>>');
			done();
		});

		it('should return correct format when Stream and relative path', function(done) {
			var file = new File({
				cwd: "/",
				base: "/test/",
				path: "/test/test.coffee",
				contents: new Stream.PassThrough()
			});
			file.inspect().should.equal('<File "test.coffee" <PassThroughStream>>');
			done();
		});

		it('should return correct format when null and relative path', function(done) {
			var file = new File({
				cwd: "/",
				base: "/test/",
				path: "/test/test.coffee",
				contents: null
			});
			file.inspect().should.equal('<File "test.coffee">');
			done();
		});
	});

	describe('contents get/set', function() {
		it('should work with Buffer', function(done) {
			var val = new Buffer("test");
			var file = new File();
			file.contents = val;
			file.contents.should.equal(val);
			done();
		});

		it('should work with Stream', function(done) {
			var val = new Stream.PassThrough();
			var file = new File();
			file.contents = val;
			file.contents.should.equal(val);
			done();
		});

		it('should work with null', function(done) {
			var val:any = null;
			var file = new File();
			file.contents = val;
			(file.contents === null).should.equal(true);
			done();
		});

		it('should not work with string', function(done) {
			var val = "test";
			var file = new File();
			try {
				file.contents = val;
			} catch (err) {
				should.exist(err);
				done();
			}
		});
	});

	describe('relative get/set', function() {
		it('should error on set', function(done) {
			var file = new File();
			try {
				file.relative = "test";
			} catch (err) {
				should.exist(err);
				done();
			}
		});

		it('should error on get when no base', function(done) {
			var a:any;
			var file = new File();
			delete file.base;
			try {
				a = file.relative;
			} catch (err) {
				should.exist(err);
				done();
			}
		});

		it('should error on get when no path', function(done) {
			var a:any;
			var file = new File();
			try {
				a = file.relative;
			} catch (err) {
				should.exist(err);
				done();
			}
		});

		it('should return a relative path from base', function(done) {
			var file = new File({
				cwd: "/",
				base: "/test/",
				path: "/test/test.coffee"
			});
			file.relative.should.equal("test.coffee");
			done();
		});

		it('should return a relative path from cwd', function(done) {
			var file = new File({
				cwd: "/",
				path: "/test/test.coffee"
			});
			file.relative.should.equal("test/test.coffee");
			done();
		});
	});

});