testilo 12.0.3 → 12.1.0

package/README.md

@@ -64,6 +64,7 @@ Targets can be specified in a more complex way, too. That allows you to create j
   targets: [
     {
       id: 'acme',
+      which: 'https://acmeclothes.com/',
       what: 'Acme Clothes',
       acts: {
         public: [
@@ -189,6 +190,49 @@ The `call` module will retrieve the named target list.
 The `batch` module will convert the target list to a batch.
 The `call` module will save the batch as a JSON file in the `batches` subdirectory of the `process.env.SPECDIR` directory.
 
+### Issues to script
+
+Testilo classifies issues. The built-in issue classifications are located in the `procs/score` directory, in files whose names begin with `tic` (for “Testilo issue classification”). You can create additional `tic` files with custom issue classifications.
+
+If you want Testaro to test targets for particular issues, you can name those issues and use the Testilo `script` module to create a script.
+
+#### Invocation
+
+There are two ways to use the `script` module.
+
+##### By a module
+
+A module can invoke `script` in this way:
+
+```javaScript
+const {script} = require('testilo/script');
+const scriptObj = script(scriptID, issueClasses, issueID0, issueID1, …);
+```
+
+This invocation references `scriptID`, `issueClasses`, and `issueID` variables.
+- The `scriptID` variable is an alphanumeric string.
+- The `issueClasses` variable is an object that classifies issues, such as the `issueClasses` object in a `tic` file.
+- The `issueID` variables are strings, such as `'regionNoText'`, that name of properties of the `issueClasses` object.
+
+The `script()` function of the `script` module generates a script and returns it as an object. The invoking module can further dispose of the script as needed.
+
+##### By a user
+
+A user can invoke `script` in this way: In the Testilo project directory, execute the statement `node call script s c i0 i1 i2 i3 …`.
+
+In this statement:
+- Replace `s` with an ID for the script, such as `headings`.
+- Replace `c` with the base name, such as `tic99`, of an issue classification file in the `score` subdirectory of the `process.env.FUNCTIONDIR` directory.
+- Replace the remaining arguments (`i0` etc.) with issue IDs from that classification file.
+
+The `call` module will retrieve the named classification from its directory.
+The `script` module will create a script.
+The `call` module will save the script as a JSON file in the `scripts` subdirectory of the `process.env.SPECDIR` directory.
+
+#### Options
+
+When the `script` module creates a script for you, it does not ask you for all of the options that the script may require. Instead, it chooses options. After you invoke `script`, you can edit the script that it creates to revise options.
+
 ### Merge
 
 Testilo merges batches with scripts, producing jobs, by means of the `merge` module.
@@ -324,49 +368,6 @@ The `call` module will save the jobs as JSON files in the `todo` subdirectory of
 
 To test the `merge` module, in the project directory you can execute the statement `node validation/merge/validate`. If `merge` is valid, all logging statements will begin with “Success” and none will begin with “ERROR”.
 
-### Issues to script
-
-Testilo classifies issues. The built-in issue classifications are located in the `procs/score` directory, in files whose names begin with `tic` (for “Testilo issue classification”). You can create additional `tic` files with custom issue classifications.
-
-If you want Testaro to test targets for particular issues, you can name those issues and use the Testilo `script` module to create a script.
-
-#### Invocation
-
-There are two ways to use the `script` module.
-
-##### By a module
-
-A module can invoke `script` in this way:
-
-```javaScript
-const {script} = require('testilo/script');
-const scriptObj = script(scriptID, issueClasses, issueID0, issueID1, …);
-```
-
-This invocation references `scriptID`, `issueClasses`, and `issueID` variables.
-- The `scriptID` variable is an alphanumeric string.
-- The `issueClasses` variable is an object that classifies issues, such as the `issueClasses` object in a `tic` file.
-- The `issueID` variables are strings, such as `'regionNoText'`, that name of properties of the `issueClasses` object.
-
-The `script()` function of the `script` module generates a script and returns it as an object. The invoking module can further dispose of the script as needed.
-
-##### By a user
-
-A user can invoke `script` in this way: In the Testilo project directory, execute the statement `node call script s c i0 i1 i2 i3 …`.
-
-In this statement:
-- Replace `s` with an ID for the script, such as `headings`.
-- Replace `c` with the base name, such as `tic99`, of an issue classification file in the `score` subdirectory of the `process.env.FUNCTIONDIR` directory.
-- Replace the remaining arguments (`i0` etc.) with issue IDs from that classification file.
-
-The `call` module will retrieve the named classification from its directory.
-The `script` module will create a script.
-The `call` module will save the script as a JSON file in the `scripts` subdirectory of the `process.env.SPECDIR` directory.
-
-#### Options
-
-When the `script` module creates a script for you, it does not ask you for all of the options that the script may require. Instead, it chooses options. After you invoke `script`, you can edit the script that it creates to revise options.
-
 ## Report scoring
 
 ### Introduction

package/batch.js

@@ -33,10 +33,11 @@ exports.batch = (id, what, targetList) => {
     };
     // For each valid target:
     targetList.forEach(target => {
-      if (target.length === 3) {
+      if (target.length === 3 && target.every(item => item.length)) {
         // Add it to the batch.
         batch.targets.push({
           id: target[0],
+          which: target[2],
           what: target[1],
           acts: {
             main: [

package/merge.js

@@ -51,6 +51,7 @@ exports.merge = (script, batch, requester, isolate = false) => {
     batch: batch.id,
     target: {
       id: '',
+      which: '',
       what: ''
     },
     requester
@@ -87,43 +88,51 @@ exports.merge = (script, batch, requester, isolate = false) => {
   // For each target in the batch:
   const {targets} = batch;
   for (const target of targets) {
-    // Initialize a job.
-    const job = JSON.parse(JSON.stringify(protoJob));
-    // Add the target ID to the job ID.
-    job.id += target.id;
-    // Add data on the target to the sources property of the job.
-    job.sources.target.id = target.id;
-    job.sources.target.what = target.what;
-    // Replace each placeholder object in the job with the named replacer array of the target.
-    let {acts} = job;
-    for (const actIndex in acts) {
-      const act = acts[actIndex];
-      if (act.type === 'placeholder') {
-        const replacerName = act.which;
-        if (replacerName && target.acts) {
-          let replacerActs = target.acts[replacerName];
-          if (replacerActs) {
-            // Add a which property to any launch act in the replacer.
-            replacerActs = JSON.parse(JSON.stringify(replacerActs));
-            for (const replacerAct of replacerActs) {
-              if (replacerAct.type === 'launch') {
-                replacerAct.which = act.launch;
+    // If the target has the required identifiers:
+    const {id, which, what} = target;
+    if (id && which && what) {
+      // Initialize a job.
+      const job = JSON.parse(JSON.stringify(protoJob));
+      // Append the target ID to the job ID.
+      job.id += target.id;
+      // Add data on the target to the sources property of the job.
+      job.sources.target.id = target.id;
+      job.sources.target.which = target.which;
+      job.sources.target.what = target.what;
+      // Replace each placeholder object in the job with the named replacer array of the target.
+      let {acts} = job;
+      for (const actIndex in acts) {
+        const act = acts[actIndex];
+        if (act.type === 'placeholder') {
+          const replacerName = act.which;
+          if (replacerName && target.acts) {
+            let replacerActs = target.acts[replacerName];
+            if (replacerActs) {
+              // Add a which property to any launch act in the replacer.
+              replacerActs = JSON.parse(JSON.stringify(replacerActs));
+              for (const replacerAct of replacerActs) {
+                if (replacerAct.type === 'launch') {
+                  replacerAct.which = act.launch;
+                }
               }
+              acts[actIndex] = replacerActs;
+            }
+            else {
+              console.log(`ERROR: Target ${target.id} has no ${replacerName} replacer`);
             }
-            acts[actIndex] = replacerActs;
           }
           else {
-            console.log(`ERROR: Target ${target.id} has no ${replacerName} replacer`);
+            console.log(`ERROR: Placeholder for target ${target.id} not replaceable`);
           }
         }
-        else {
-          console.log(`ERROR: Placeholder for target ${target.id} not replaceable`);
-        }
       }
+      job.acts = acts.flat();
+      // Append the job to the array of jobs.
+      jobs.push(job);
+    }
+    else {
+      console.log('ERROR: Target in batch missing id, which, or what property');
     }
-    job.acts = acts.flat();
-    // Append the job to the array of jobs.
-    jobs.push(job);
   };
   return jobs;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "testilo",
-  "version": "12.0.3",
+  "version": "12.1.0",
   "description": "Client that scores and digests Testaro reports",
   "main": "aim.js",
   "scripts": {

package/script.js

@@ -88,6 +88,11 @@ exports.script = (id, issueClasses, ... issueIDs) => {
         which: toolID,
         rules: neededTools[toolID]
       };
+      // If the tool is Testaro:
+      if (toolID === 'testaro') {
+        // Prepend the inclusion option to the rule array.
+        toolAct.rules.unshift('y');
+      }
       // Add option specifications if necessary.
       if (toolID === 'axe') {
         toolAct.detailLevel = 2;