lib: better assert messages

Author: LinusU

lib/create.js

@@ -52,7 +52,7 @@ module.exports = exports = function (targetPath) {
   var volumePath = findVolume(targetPath, targetStat);
   var volumeStat = fs.statSync(volumePath);
 
-  assert(targetStat.isFile() || targetStat.isDirectory());
+  assert(targetStat.isFile() || targetStat.isDirectory(), 'Target is a file or directory');
 
   info.target = {
     id: targetStat.ino,
@@ -134,7 +134,7 @@ module.exports = exports = function (targetPath) {
   (function addType18() {
 
     var vl = volumePath.length;
-    assert(targetPath.slice(0, vl) === volumePath);
+    assert.equal(targetPath.slice(0, vl), volumePath);
     var lp = targetPath.slice(vl);
     var b = new Buffer(lp, 'utf8');
 

lib/decode.js

@@ -17,29 +17,29 @@ module.exports = exports = function (buf) {
   assert.equal(info.version, 2);
 
   var type = buf.readUInt16BE(8);
-  assert(type === 0 || type === 1);
+  assert(type === 0 || type === 1, 'Type is valid');
   info.target.type = values.type[type];
 
   var volNameLength = buf.readUInt8(10);
-  assert(volNameLength <= 27);
+  assert(volNameLength <= 27, 'Volume name is not longer than 27 chars');
   info.volume.name = buf.toString('utf8', 11, 11 + volNameLength);
 
   var volCreateDate = buf.readUInt32BE(38);
   info.volume.created = appleDate(volCreateDate);
 
   var volSig = buf.toString('ascii', 42, 44);
-  assert(volSig === 'BD' || volSig === 'H+' || volSig === 'HX');
+  assert(volSig === 'BD' || volSig === 'H+' || volSig === 'HX', 'Volume signature is valid');
   info.volume.signature = volSig;
 
   var volType = buf.readUInt16BE(44);
-  assert(volType >= 0 && volType <= 5);
+  assert(volType >= 0 && volType <= 5, 'Volume type is valid');
   info.volume.type = values.volumeType[volType];
 
   var dirId = buf.readUInt32BE(46);
   info.parent.id = dirId;
 
   var fileNameLength = buf.readUInt8(50);
-  assert(fileNameLength <= 63);
+  assert(fileNameLength <= 63, 'File name is not longer than 63 chars');
   info.target.filename = buf.toString('utf8', 51, 51 + fileNameLength);
 
   var fileId = buf.readUInt32BE(114);
@@ -63,11 +63,11 @@ module.exports = exports = function (buf) {
   // I have only encountered 00 00
 
   var reserved = buf.slice(140, 150);
-  assert(reserved[0] === 0 && reserved[1] === 0);
-  assert(reserved[2] === 0 && reserved[3] === 0);
-  assert(reserved[4] === 0 && reserved[5] === 0);
-  assert(reserved[6] === 0 && reserved[7] === 0);
-  assert(reserved[8] === 0 && reserved[9] === 0);
+  assert(reserved[0] === 0 && reserved[1] === 0, 'Reserved is zero-filled');
+  assert(reserved[2] === 0 && reserved[3] === 0, 'Reserved is zero-filled');
+  assert(reserved[4] === 0 && reserved[5] === 0, 'Reserved is zero-filled');
+  assert(reserved[6] === 0 && reserved[7] === 0, 'Reserved is zero-filled');
+  assert(reserved[8] === 0 && reserved[9] === 0, 'Reserved is zero-filled');
 
   var pos = 150;
 

lib/encode.js

@@ -34,11 +34,11 @@ module.exports = exports = function (info) {
   buf.writeUInt16BE(info.version, 6)
 
   var type = values.type.indexOf(info.target.type);
-  assert(type === 0 || type === 1);
+  assert(type === 0 || type === 1, 'Type is valid');
   buf.writeUInt16BE(type, 8);
 
   var volNameLength = info.volume.name.length;
-  assert(volNameLength <= 27);
+  assert(volNameLength <= 27, 'Volume name is not longer than 27 chars');
   buf.writeUInt8(volNameLength, 10);
   buf.fill(0, 11, 11 + 27)
   buf.write(info.volume.name, 11, 'utf8');
@@ -47,17 +47,17 @@ module.exports = exports = function (info) {
   buf.writeUInt32BE(volCreateDate, 38);
 
   var volSig = info.volume.signature;
-  assert(volSig === 'BD' || volSig === 'H+' || volSig === 'HX');
+  assert(volSig === 'BD' || volSig === 'H+' || volSig === 'HX', 'Volume signature is valid');
   buf.write(volSig, 42, 'ascii');
 
   var volType = values.volumeType.indexOf(info.volume.type);
-  assert(volType >= 0 && volType <= 5);
+  assert(volType >= 0 && volType <= 5, 'Volume type is valid');
   buf.writeUInt16BE(volType, 44);
 
   buf.writeUInt32BE(info.parent.id, 46);
 
   var fileNameLength = info.target.filename.length;
-  assert(fileNameLength <= 63);
+  assert(fileNameLength <= 63, 'File name is not longer than 63 chars');
   buf.writeUInt8(fileNameLength, 50);
   buf.fill(0, 51, 51 + 63);
   buf.write(info.target.filename, 51, 'utf8');
@@ -95,7 +95,7 @@ module.exports = exports = function (info) {
   for (var i = 0; i < info.extra.length; i++) {
 
     var e = info.extra[i];
-    assert(e.type >= 0);
+    assert(e.type >= 0, 'Type is valid');
 
     buf.writeInt16BE(e.type, pos);
     buf.writeUInt16BE(e.length, pos + 2);