test(tests): fix up tests to accommodate new apis

Author: kchadha

index.js

@@ -7,20 +7,22 @@ var validate = require('./lib/validate');
 /**
   * Unpacks, parses, validates, and analyzes Scratch projects. If successful,
   * will return a valid Scratch project object with appended metadata.
-  * @param {boolean}         isSprite Whether this is a sprite (true) or whole project (false)
   * @param {Buffer | string} input    Buffer or string representing project
+  * @param {boolean}         isSprite Whether this is a sprite (true) or whole project (false)
   * @param {Function}        callback Returns error or project data
   */
-module.exports = function (isSprite, input, callback) {
+module.exports = function (input, isSprite, callback) {
     // First unpack the input (need this outside of the async waterfall so that
     // unpackedProject can be refered to again)
-    unpack(isSprite, input, function (err, unpackedProject) {
+    unpack(input, isSprite, function (err, unpackedProject) {
         if (err) return callback(err);
 
         async.waterfall([
             function (cb) {
                 parse(unpackedProject[0], cb);
             },
+            // TODO is there a better way to pass this arg
+            // than partially applying this funciton?
             validate.bind(null, isSprite)
         ], function (error, validatedInput) {
             // One more callback wrapper so that we can re-package everything

lib/sb2_definitions.json

@@ -108,6 +108,10 @@
                 "currentCostumeIndex"
             ]
         },
+        "stage_child": {
+            "type": "object",
+            "description": "A child of the stage, can be a sprite or a monitor"
+        },
         "stage_object" : {
             "type": "object",
             "properties": {
@@ -175,7 +179,7 @@
                 },
                 "children": {
                     "type": "array",
-                    "items": {"$ref": "#/definitions/sprite_object"}
+                    "items": {"$ref": "#/definitions/stage_child"}
                 }
             },
             "required": [

lib/unpack.js

@@ -4,13 +4,13 @@ var unzip = require('./unzip');
  * If input a buffer, transforms buffer into a UTF-8 string.
  * If input is encoded in zip or gzip format, the input will be extracted and decoded.
  * If input is a string, passes that string along to the given callback.
+ * @param {Buffer | string} input    Project data
  * @param {boolean}         isSprite Whether the input should be treated as
  * a sprite (true) or a whole project (false)
- * @param {Buffer | string} input    Project data
  * @param {Function}        callback Error or stringified project data
  * @return {void}
  */
-module.exports = function (isSprite, input, callback) {
+module.exports = function (input, isSprite, callback) {
     if (typeof input === 'string') {
         // Pass string to callback
         return callback(null, [input, null]);
@@ -48,5 +48,5 @@ module.exports = function (isSprite, input, callback) {
     // Return error if legacy encoding detected
     if (isLegacy) return callback('Parser only supports Scratch 2.X and above');
 
-    unzip(isSprite, input, isGZip, callback);
+    unzip(input, isGZip, isSprite, callback);
 };

lib/unzip.js

@@ -3,14 +3,14 @@ var GZip = require('gzip-js');
 
 /**
  * Unpacks a zip or gzip file.
- * @param {boolean} isSprite Whether the input should be treated as
- * a sprite (true) or whole project (false)
  * @param {string} input    Zip file provided as a string
  * @param {boolean} isGZip Whether the input is a GZip file, otherwise treat as zip
+ * @param {boolean} isSprite Whether the input should be treated as
+ * a sprite (true) or whole project (false)
  * @param {array}  callback Array including both the project and zip archive
  * @return {void}
  */
-module.exports = function (isSprite, input, isGZip, callback) {
+module.exports = function (input, isGZip, isSprite, callback) {
     var msg = 'Failed to unzip and extract project.json, with error: ';
     if (isGZip) {
         var unpackedProject = null;

test/integration/empty.js

@@ -4,15 +4,15 @@ var data = require('../fixtures/data');
 var parser = require('../../index');
 
 test('sb', function (t) {
-    parser(data.empty.sb, function (err, res) {
+    parser(data.empty.sb, false, function (err, res) {
         t.type(err, 'string');
         t.type(res, 'undefined');
         t.end();
     });
 });
 
 test('sb2', function (t) {
-    parser(data.empty.sb2, function (err, result) {
+    parser(data.empty.sb2, false, function (err, result) {
         t.equal(err, null);
         t.equal(Array.isArray(result), true);
         var res = result[0];
@@ -25,7 +25,7 @@ test('sb2', function (t) {
 });
 
 test('json', function (t) {
-    parser(data.empty.json, function (err, result) {
+    parser(data.empty.json, false, function (err, result) {
         t.equal(err, null);
         t.equal(Array.isArray(result), true);
         var res = result[0];
@@ -38,7 +38,7 @@ test('json', function (t) {
 });
 
 test('json string', function (t) {
-    parser(data.empty.json.toString('utf-8'), function (err, result) {
+    parser(data.empty.json.toString('utf-8'), false, function (err, result) {
         t.equal(err, null);
         t.equal(Array.isArray(result), true);
         var res = result[0];
@@ -51,7 +51,7 @@ test('json string', function (t) {
 });
 
 test('gzipped json', function (t) {
-    parser(data.empty.gzipJson, function (err, result) {
+    parser(data.empty.gzipJson, false, function (err, result) {
         t.equal(err, null);
         t.equal(Array.isArray(result), true);
         var res = result[0];

test/integration/example.js

@@ -4,15 +4,15 @@ var data = require('../fixtures/data');
 var parser = require('../../index');
 
 test('sb', function (t) {
-    parser(data.example.sb, function (err, res) {
+    parser(data.example.sb, false, function (err, res) {
         t.type(err, 'string');
         t.type(res, 'undefined');
         t.end();
     });
 });
 
 test('sb2', function (t) {
-    parser(data.example.sb2, function (err, result) {
+    parser(data.example.sb2, false, function (err, result) {
         t.equal(err, null);
         t.equal(Array.isArray(result), true);
         var res = result[0];
@@ -25,7 +25,7 @@ test('sb2', function (t) {
 });
 
 test('json', function (t) {
-    parser(data.example.json, function (err, result) {
+    parser(data.example.json, false, function (err, result) {
         t.equal(err, null);
         t.equal(Array.isArray(result), true);
         var res = result[0];
@@ -38,7 +38,7 @@ test('json', function (t) {
 });
 
 test('json string', function (t) {
-    parser(data.example.json.toString('utf-8'), function (err, result) {
+    parser(data.example.json.toString('utf-8'), false, function (err, result) {
         t.equal(err, null);
         t.equal(Array.isArray(result), true);
         var res = result[0];
@@ -51,7 +51,7 @@ test('json string', function (t) {
 });
 
 test('gzipped json', function (t) {
-    parser(data.example.gzipJson, function (err, result) {
+    parser(data.example.gzipJson, false, function (err, result) {
         t.equal(err, null);
         t.equal(Array.isArray(result), true);
         var res = result[0];

test/integration/stress.js

@@ -7,7 +7,7 @@ test('sb', function (t) {
     var set = data.sb;
     t.plan(set.length * 2);
     for (var i in data.sb) {
-        parser(data.sb[i], function (err, res) {
+        parser(data.sb[i], false, function (err, res) {
             t.type(err, 'string');
             t.type(res, 'undefined');
         });
@@ -18,7 +18,7 @@ test('sb2', function (t) {
     var set = data.sb2;
     t.plan(set.length * 5);
     for (var i in data.sb2) {
-        parser(data.sb2[i], function (err, result) {
+        parser(data.sb2[i], false, function (err, result) {
             t.equal(err, null);
             t.equal(Array.isArray(result), true);
             var res = result[0];
@@ -34,7 +34,7 @@ test('json', function (t) {
     var set = data.json;
     t.plan(set.length * 5);
     for (var i in data.json) {
-        parser(data.json[i], function (err, result) {
+        parser(data.json[i], false, function (err, result) {
             t.equal(err, null);
             t.equal(Array.isArray(result), true);
             var res = result[0];
@@ -50,7 +50,7 @@ test('json string', function (t) {
     var set = data.json;
     t.plan(set.length * 5);
     for (var i in data.json) {
-        parser(data.json[i].toString('utf-8'), function (err, result) {
+        parser(data.json[i].toString('utf-8'), false, function (err, result) {
             t.equal(err, null);
             t.equal(Array.isArray(result), true);
             var res = result[0];

test/unit/unpack.js

@@ -21,7 +21,7 @@ test('spec', function (t) {
 
 test('sb', function (t) {
     var buffer = new Buffer(fixtures.sb);
-    unpack(buffer, function (err, res) {
+    unpack(buffer, false, function (err, res) {
         t.type(err, 'string');
         t.type(res, 'undefined');
         t.end();
@@ -30,7 +30,7 @@ test('sb', function (t) {
 
 test('sb2', function (t) {
     var buffer = new Buffer(fixtures.sb2);
-    unpack(buffer, function (err, res) {
+    unpack(buffer, false, function (err, res) {
         t.equal(err, null);
         t.equal(Array.isArray(res), true);
         t.type(res[0], 'string');
@@ -42,9 +42,18 @@ test('sb2', function (t) {
     });
 });
 
+test('sb2 does not validate as sprite', function (t) {
+    var buffer = new Buffer(fixtures.sb2);
+    unpack(buffer, true, function (err, res) {
+        t.type(err, 'string');
+        t.type(res, 'undefined');
+        t.end();
+    });
+});
+
 test('json', function (t) {
     var buffer = new Buffer(fixtures.json);
-    unpack(buffer, function (err, res) {
+    unpack(buffer, false, function (err, res) {
         t.equal(err, null);
         t.equal(Array.isArray(res), true);
         t.type(res[0], 'string');
@@ -58,7 +67,7 @@ test('json', function (t) {
 
 test('json utf-8 string', function (t) {
     var buffer = new Buffer(fixtures.json);
-    unpack(buffer.toString('utf-8'), function (err, res) {
+    unpack(buffer.toString('utf-8'), false, function (err, res) {
         t.equal(err, null);
         t.equal(Array.isArray(res), true);
         t.type(res[0], 'string');
@@ -71,7 +80,16 @@ test('json utf-8 string', function (t) {
 });
 
 test('invalid string', function (t) {
-    unpack('this is not json', function (err, res) {
+    unpack('this is not json', false, function (err, res) {
+        t.equal(err, null);
+        t.equal(Array.isArray(res), true);
+        t.type(res[0], 'string');
+        t.throws(function () {
+            JSON.parse(res[0]);
+        });
+        t.equal(res[1], null);
+    });
+    unpack('this is not json', true, function (err, res) {
         t.equal(err, null);
         t.equal(Array.isArray(res), true);
         t.type(res[0], 'string');
@@ -85,23 +103,23 @@ test('invalid string', function (t) {
 
 test('undefined', function (t) {
     var foo;
-    unpack(foo, function (err, res) {
+    unpack(false, foo, function (err, res) {
         t.type(err, 'string');
         t.type(res, 'undefined');
         t.end();
     });
 });
 
 test('null', function (t) {
-    unpack(null, function (err, obj) {
+    unpack(false, null, function (err, obj) {
         t.type(err, 'string');
         t.type(obj, 'undefined');
         t.end();
     });
 });
 
 test('object', function (t) {
-    unpack({}, function (err, obj) {
+    unpack(false, {}, function (err, obj) {
         t.type(err, 'string');
         t.type(obj, 'undefined');
         t.end();