Add aggregate cloud variables data to analysis results

README.md

@@ -26,7 +26,8 @@ The `scratch-analysis` module will return an object containing high-level summar
 | `scripts`         | `count`                                                  |
 | `blocks`          | `count`, `unique`, `list`, `frequency`                   |
 | `sprites`         | `count`                                                  |
-| `variables`       | `count`                                                  |
+| `variables`       | `count`, `id`                                            |
+| `cloud`           | `count`, `id`                                            |
 | `lists`           | `count`                                                  |
 | `costumes`        | `count`, `list`, `hash`                                  |
 | `sounds`          | `count`, `list`, `hash`                                  |

lib/sb2.js

@@ -154,6 +154,35 @@ const extensions = function (project) {
     return result;
 };
 
+/**
+ * Extracts cloud variable information.
+ * @param  {object} project Project object (SB2 format)
+ * @param  {array}  names   Names of all variables in project
+ * @return {object}         Cloud variable information
+ */
+const cloud = function (project, names) {
+    const obj = [];
+
+    // Extract "isPersistent" parameter from all variables in project
+    const cloudyness = extract(project, 'variables', 'isPersistent').id;
+
+    // Ensure that variable names and isPersistent parameter list are the same
+    // length
+    if (names.length !== cloudyness.length) return -1;
+
+    // Iterate over isPersistent values, and extract names of any that are true
+    for (let i in cloudyness) {
+        if (cloudyness[i]) {
+            obj.push(names[i]);
+        }
+    }
+
+    return {
+        count: obj.length,
+        id: obj
+    };
+};
+
 /**
  * Analyzes a project and returns summary information about the project.
  * @param  {object}   project  Project object (SB2 format)
@@ -171,6 +200,8 @@ module.exports = function (project, callback) {
         costumes: extract(project, 'costumes', 'costumeName', 'baseLayerMD5')
     };
 
+    meta.cloud = cloud(project, meta.variables.id);
+
     // Sprites
     meta.sprites = sprites(project);
 

lib/sb3.js

@@ -21,9 +21,14 @@ const variables = function (targets, attribute) {
     let occurrences = 0;
     let idList = [];
 
+    // Cloud variables are a type of variable
+    const isCloud = (attribute === 'cloud');
+    if (isCloud) attribute = 'variables';
+
     for (let t in targets) {
         for (let a in targets[t][attribute]) {
             const variable = targets[t][attribute][a];
+            if (isCloud && (variable.length !== 3 || !variable[2])) continue;
             occurrences++;
             idList.push(variable[0]);
         }
@@ -97,6 +102,7 @@ module.exports = function (project, callback) {
     const meta = {
         scripts: scripts(project.targets),
         variables: variables(project.targets, 'variables'),
+        cloud: variables(project.targets, 'cloud'),
         lists: variables(project.targets, 'lists'),
         comments: extract(project.targets, 'comments'),
         sounds: extract(project.targets, 'sounds', 'name', 'md5ext'),

test/unit/cloud.js

@@ -0,0 +1,79 @@
+const fs = require('fs');
+const path = require('path');
+const test = require('tap').test;
+const analysis = require('../../lib/index');
+
+const sb2 = fs.readFileSync(
+    path.resolve(__dirname, '../fixtures/sb2/cloud.sb2')
+);
+const sb3 = fs.readFileSync(
+    path.resolve(__dirname, '../fixtures/sb3/cloud.sb3')
+);
+const sb2Complex = fs.readFileSync(
+    path.resolve(__dirname, '../fixtures/sb2/cloud_complex.sb2')
+);
+const sb3Complex = fs.readFileSync(
+    path.resolve(__dirname, '../fixtures/sb3/cloud_complex.sb3')
+);
+
+test('sb2', t => {
+    analysis(sb2, (err, result) => {
+        t.true(typeof err === 'undefined' || err === null);
+        t.type(result, 'object');
+        t.type(result.cloud, 'object');
+        t.equals(result.cloud.count, 1);
+        t.deepEquals(result.cloud.id, ['☁ baz']);
+        t.end();
+    });
+});
+
+test('sb3', t => {
+    analysis(sb3, (err, result) => {
+        t.true(typeof err === 'undefined' || err === null);
+        t.type(result, 'object');
+        t.type(result.cloud, 'object');
+        t.equals(result.cloud.count, 1);
+        t.deepEquals(result.cloud.id, ['☁ baz']);
+        t.end();
+    });
+});
+
+test('sb2 complex', t => {
+    analysis(sb2Complex, (err, result) => {
+        t.true(typeof err === 'undefined' || err === null);
+        t.type(result, 'object');
+        t.type(result.cloud, 'object');
+        t.equals(result.cloud.count, 8);
+        t.deepEquals(result.cloud.id, [
+            '☁ Player_1',
+            '☁ Player_2',
+            '☁ Player_3',
+            '☁ Player_4',
+            '☁ Player_5',
+            '☁ GameData',
+            '☁ Player_6',
+            '☁ SAVE_DATA2'
+        ]);
+        t.end();
+    });
+});
+
+test('sb3 complex', t => {
+    analysis(sb3Complex, (err, result) => {
+        t.true(typeof err === 'undefined' || err === null);
+        t.type(result, 'object');
+        t.type(result.cloud, 'object');
+        t.equals(result.cloud.count, 8);
+        t.deepEquals(result.cloud.id, [
+            '☁ Player_1',
+            '☁ Player_2',
+            '☁ Player_3',
+            '☁ Player_4',
+            '☁ Player_5',
+            '☁ GameData',
+            '☁ Player_6',
+            '☁ SAVE_DATA2'
+        ]);
+        t.end();
+    });
+});