testilo 11.0.0 → 11.0.3

package/README.md

@@ -158,7 +158,36 @@ As shown in this example, when a browser is launched by placeholder substitution
 
 ### Target list to batch
 
-If you have a target list, Testilo can convert it to a batch. The batch will contain, for each target, one array of acts named `main`, containing a `launch` act (depending on the script to specify the browser type) and a `url` act.
+If you have a target list, the `batch` module of Testilo can convert it to a batch. The batch will contain, for each target, one array of acts named `main`, containing a `launch` act (depending on the script to specify the browser type) and a `url` act.
+
+#### Invocation
+
+There are two ways to use the `batch` module.
+
+##### By a module
+
+A module can invoke `batch` in this way:
+
+```javaScript
+const {batch} = require('testilo/batch');
+const batchObj = batch(listID, what, targetList);
+```
+
+This invocation references `listID`, `what`, and `targetList` variables that the module must have already defined. They are all strings. `listID` is a unique identifier for the target list. `what` describes the target list. `targetList` is the target list. The `batch()` function of the `batch` module generates a batch and returns it as an object. The invoking module can further dispose of the batch as needed.
+
+##### By a user
+
+A user can invoke `batch` in this way:
+
+- Create a target list and save it as a text file (with tab-delimited items in newline-delimited lines) in the `targetLists` subdirectory of the `process.env.SPECDIR` directory. Name the file `x.tsv`, where `x` is the list ID.
+- In the Testilo project directory, execute this statement:
+    - `node call batch i`
+
+In this statement, replace `i` with the list ID.
+
+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.
 
 ### Merge
 

package/batch.js

@@ -20,8 +20,10 @@ exports.batch = (id, what, targetList) => {
     && Array.isArray(targetList)
     && targetList.length
     && targetList.every(
-      target => Array.isArray(target) && target.every(item => typeof item === string && item.length)
+      target => Array.isArray(target)
+      && target.every(item => typeof item === 'string')
     )
+    && targetList.some(target => target.length === 3)
   ) {
     // Initialize the batch.
     const batch = {
@@ -29,25 +31,27 @@ exports.batch = (id, what, targetList) => {
       what,
       targets: []
     };
-    // For each target:
+    // For each valid target:
     targetList.forEach(target => {
-      // Add it to the batch.
-      batch.targets.push({
-        id: target[0],
-        what: target[1],
-        acts: {
-          main: [
-            {
-              type: 'launch'
-            },
-            {
-              type: 'url',
-              which: target[2],
-              what: target[1]
-            }
-          ]
-        }
-      });
+      if (target.length === 3) {
+        // Add it to the batch.
+        batch.targets.push({
+          id: target[0],
+          what: target[1],
+          acts: {
+            main: [
+              {
+                type: 'launch'
+              },
+              {
+                type: 'url',
+                which: target[2],
+                what: target[1]
+              }
+            ]
+          }
+        });
+      }
     });
     // Return the batch.
     return batch;

package/call.js

@@ -18,6 +18,8 @@
 require('dotenv').config();
 // Function to process files.
 const fs = require('fs/promises');
+// Function to process a list-to-batch conversion.
+const {batch} = require('./batch');
 // Function to process a merger.
 const {merge} = require('./merge');
 // Function to score reports.
@@ -38,6 +40,18 @@ const fnArgs = process.argv.slice(3);
 
 // ########## FUNCTIONS
 
+// Converts a target list to a batch.
+const callBatch = async (listID, what) => {
+  // Get the target list.
+  const listString = await fs.readFile(`${specDir}/targetLists/${listID}.tsv`, 'utf8');
+  const list = listString.split('\n').map(target => target.split('\t'));
+  // Convert it to a batch.
+  const batchObj = batch(listID, what, list);
+  // Save the batch.
+  const batchJSON = JSON.stringify(batchObj, null, 2);
+  await fs.writeFile(`${specDir}/batches/${listID}.json`, `${batchJSON}\n`);
+  console.log(`Target list ${listID} converted to a batch and saved in ${specDir}/batches`);
+};
 // Fulfills a merging request.
 const callMerge = async (scriptID, batchID, requester, withIsolation = false) => {
   // Get the script and the batch.
@@ -145,6 +159,12 @@ if (fn === 'aim' && fnArgs.length === 5) {
     console.log('Execution completed');
   });
 }
+else if (fn === 'batch' && fnArgs.length === 2) {
+  callBatch(... fnArgs)
+  .then(() => {
+    console.log('Execution completed');
+  });
+}
 else if (fn === 'merge' && fnArgs.length > 2 && fnArgs.length < 5) {
   callMerge(... fnArgs)
   .then(() => {

package/merge.js

@@ -38,7 +38,7 @@ exports.merge = (script, batch, requester, isolate = false) => {
   // If the requester is unspecified, make it the standard requester.
   requester ||= stdRequester;
   // Create a timestamp.
-  const timeStamp = Math.floor((Date.now() - Date.UTC(2022, 1)) / 2000).toString(36);
+  const timeStamp = Math.floor((Date.now() - Date.UTC(2023, 4)) / 2000).toString(36);
   // Create a time description.
   const creationTime = (new Date()).toISOString().slice(0, 19);
   // Initialize a target-independent job.

package/package.json

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

package/procs/score/tic25.js

@@ -48,7 +48,7 @@ exports.issues = {
       }
     }
   },
-  duplicateAttribute:{
+  duplicateAttribute: {
     wcag: '4.1.1',
     weight: 2,
     tools: {

package/procs/score/tic26.js

@@ -1,6 +1,6 @@
 /*
-  tic24
-  Testilo issue classification 24
+  tic26
+  Testilo issue classification 26
 
   Classifies tests of Testaro and its dependent tools into issues.
 
@@ -5398,10 +5398,15 @@ exports.issues = {
     weight: 3,
     tools: {
       testaro: {
-        focOp: {
+        'focOp-focusable-inoperable': {
           variable: false,
           quality: 1,
-          what: 'Operable elements that cannot be Tab-focused and vice versa'
+          what: 'Tab-focusable elements that are inoperable'
+        },
+        'focOp-operable-nonfocusable': {
+          variable: false,
+          quality: 1,
+          what: 'Operable elements that cannot be Tab-focused'
         }
       }
     }

package/procs/score/tsp24.js

@@ -489,7 +489,7 @@ exports.scorer = async report => {
               changeFrequency
             } = data;
             const score = 2 * (meanLocalRatio - 1)
-            + (maxLocalRatio - 1)
+            + maxLocalRatio - 1
             + globalRatio - 1
             + meanPixelChange / 10000
             + maxPixelChange / 25000