testilo 33.2.0 → 33.2.2

package/README.md

@@ -794,11 +794,15 @@ When a user invokes `summarize` in this example, the `call` module:
 - creates a _summary report_, an object containing three properties: an ID, a description (here `'divisions'`), and the array of summaries.
 - writes the summary report in JSON format to the `summarized` subdirectory of the `REPORTDIR` directory, using the ID as the base of the file name.
 
+#### Summary reports
+
+A summary report serves as a necessary input to the `compare` and `track` modules described below. When a user invokes the `compare` module, a summary report is produced. A module can create a summary report by invoking `compare` multiple times on different scored reports, assembling the resulting summaries into an array, and creating an object like the one the `call` module creates for a user.
+
 ### Comparison
 
 If you use Testilo to perform a battery of tests on multiple targets, you may want a single report that compares the total scores received by the targets. Testilo can produce such a _comparison_.
 
-The `compare` module compares the scores in a summary report. Its `compare()` function takes two arguments:
+The `compare` module compares the scores in a summary report. The `compare()` function of the `compare` module takes two arguments:
 - a comparison function
 - a summary report
 
@@ -866,7 +870,7 @@ const summaryReport = …;
 const [reportID, 'main competitors', trackReport] = track(tracker, summaryReport);
 ```
 
-The `track()` function returns an ID and an HTML tracking report that shows data for all of the results in the summary report and identifies “main competitors” as its subject. The invoking module can further dispose of the tracking report as needed.
+The `track()` function returns, as an array, an ID and an HTML tracking report that shows data for all of the results in the summary report and identifies “main competitors” as its subject. The invoking module can further dispose of the tracking report as needed.
 
 ##### By a user
 
@@ -940,4 +944,4 @@ Work on the functionalities of Testaro and Testilo began in 2017. It was named [
 
 ## Etymology
 
-“Testilo” means “testing tool” in Esperanto.
+“Testilo” means “testing utility” in Esperanto.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "testilo",
-  "version": "33.2.0",
+  "version": "33.2.2",
   "description": "Prepares and processes Testaro reports",
   "main": "call.js",
   "scripts": {

package/procs/track/ttp40/index.html

@@ -22,32 +22,44 @@
       <p>It tracks accessibility scores over time. A perfect score is 0. The tracking was performed by Testilo procedure <code>__tp__</code>.</p>
       <p>The results are presented first as a graph, and then as a table.</p>
       <h2>Results as a graph</h2>
+      <h3>Legend</h3>
+      <ul id="legendItems">
+        __legendItems__
+      </ul>
+      <h3>Line graph</h3>
       <figure id="graph">
         <figcaption>Accessibility scores</figcaption>
       </figure>
       <script src="https://cdn.jsdelivr.net/npm/d3@7"></script>
       <script src="https://cdn.jsdelivr.net/npm/@observablehq/plot@0.6"></script>
-      <script type="module">
+      <script type="module" defer>
         const summaryReportJSON = '__summaryReportJSON__';
         const summaryReport = JSON.parse(summaryReportJSON);
         const graphData = [];
+        const targetIDs = {};
+        Array.from(document.getElementById('legendItems').children).forEach(li => {
+          const targetData = li.textContent.split(': ');
+          targetIDs[targetData[1]] = targetData[0];
+        });
         summaryReport.summaries.forEach(result => {
+          const {what} = result.sources.target;
           graphData.push({
-            targetID: result.sources.target.id,
-            targetWhat: result.sources.target.what,
+            targetID: targetIDs[what],
+            targetWhat: what,
             time: new Date(`20${result.endTime}Z`),
             score: result.score
           });
         });
         const svg = Plot.plot({
           style: 'overflow: visible;',
+          height: 600,
           y: {grid: true},
           marks: [
             Plot.ruleY([0]),
             Plot.lineY(graphData, {
               x: 'time',
               y: 'score',
-              stroke: 'targetWhat'
+              stroke: 'targetID'
             }),
             Plot.dot(graphData, {
               x: 'time',
@@ -83,7 +95,7 @@
         document.getElementById('graph').insertAdjacentElement('beforeend', svg);
       </script>
       <h2>Results as a table</h2>
-      <table class="allBorder secondCellRight thirdCellRight">
+      <table class="allBorder secondCellRight">
         <caption>Accessibility scores</caption>
         <thead>
           <tr>

package/procs/track/ttp40/index.js

@@ -31,18 +31,32 @@ const populateQuery = async (id, what, summaryReport, query) => {
   // JSON of summary report.
   const {summaries} = summaryReport;
   query.summaryReportJSON = JSON.stringify(summaryReport);
-  // For each score:
+  // Legend.
+
+  // Get an array of target descriptions and assign to each an ID.
   const rows = [];
-  const targetWhats = Array.from(new Set(summaries.map(result => result.sources.target.what))).sort();
+  const targets = Array
+  .from(new Set(summaries.map(result => result.sources.target.what)))
+  .sort()
+  .map((targetWhat, index) => [alphaNumOf(index), targetWhat]);
+  const targetIDs = {};
+  targets.forEach(target => {
+    targetIDs[target[1]] = target[0];
+  });
+  // Add legend items to the query.
+  const legendItems = targets.map(target => `<li>${target[0]}: ${target[1]}</li>`);
+  query.legendItems = legendItems.join('\n        ');
+  // For each result:
   summaries.forEach(result => {
-    // Create an HTML table row for it.
+    // Create a date-time cell.
     const timeCell = `<td>${result.endTime}</td>`;
+    // Create a score cell.
     const digestLinkDestination = digestURL.replace('__id__', result.id);
     const scoreCell = `<td><a href=${digestLinkDestination}>${result.score}</a></td>`;
+    // Create a target cell.
     const {target} = result.sources;
-    const targetID = alphaNumOf(targetWhats.indexOf(target.what));
     const targetLink = `<a href="${target.which}">${target.what}</a>`;
-    const targetCell = `<td>${targetID}: ${targetLink}</td>`;
+    const targetCell = `<td>${targetIDs[target.what]}: ${targetLink}</td>`;
     const row = `<tr>${[timeCell, scoreCell, targetCell].join('')}</tr>`;
     // Add the row to the array of rows.
     rows.push(row);

package/track.js

@@ -18,5 +18,6 @@ exports.track = async (tracker, what, summaryReport) => {
   // Use the tracker to create a tracking report.
   const id = getFileID(2);
   const trackingReport = await tracker(id, what, summaryReport);
+  // Return an ID usable for the report and the report.
   return [id, trackingReport];
 };