testilo 30.0.0 → 31.0.0

package/README.md

@@ -745,24 +745,25 @@ const {track} = require('testilo/track');
 const trackerDir = `${process.env.FUNCTIONDIR}/track/ttp99a`;
 const {tracker} = require(`${trackerDir}/index`);
 const summaryReport = …;
-const [reportID, trackReport] = track(tracker, 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. The invoking module can further dispose of the tracking report as needed.
+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.
 
 ##### By a user
 
 A user can invoke `track()` in one of these ways:
 
 ```javaScript
-node call track ttp99a 241016
-node call track ttp99a 241016 'ABC Foundation'
+node call track ttp99a 'main competitors'
+node call track ttp99a 'main competitors' 241016
+node call track ttp99a 'main competitors' 241016 'ABC Foundation'
 ```
 
 When a user invokes `track()` in this example, the `call` module:
-- gets the summary report from the first file in the `summarized` subdirectory of the `REPORTDIR` directory whose name begins with `'241016'`.
+- gets the summary report from the last file in the `summarized` subdirectory of the `REPORTDIR` directory, or if the third argument to `call()` exists the last one whose name begins with `'241016'`.
 - selects the summarized data for all results in the summary report, or if the fourth argument to `call()` exists from all results whose `target.what` property has the value `'ABC Foundation'`.
-- uses tracker `ttp99a` to create a tracking report.
+- uses tracker `ttp99a` to create a tracking report that identifies “main competitors” as its subject.
 - assigns an ID to the tracking report.
 - writes the tracking report to the `tracking` subdirectory of the `REPORTDIR` directory, with the ID as the base of its file name.
 

package/call.js

@@ -52,11 +52,17 @@ const fnArgs = process.argv.slice(3);
 
 // ########## FUNCTIONS
 
-// Gets a summary report.
+// Gets the last matching summary report.
 const getSummaryReport = async selector => {
   const summaryDir = `${reportDir}/summarized`;
   const summaryReportNames = await fs.readdir(summaryDir);
-  const summaryReportName = summaryReportNames.find(reportName => reportName.startsWith(selector));
+  let summaryReportName;
+  if (summaryReportNames && summaryReportNames.length) {
+    summaryReportName = summaryReportNames.findLast(reportName => reportName.startsWith(selector));
+  }
+  else {
+    summaryReportName = summaryReportNames.pop();
+  }
   if (summaryReportName) {
     const summaryReportJSON = await fs.readFile(`${summaryDir}/${summaryReportName}`, 'utf8');
     const summaryReport = JSON.parse(summaryReportJSON);
@@ -255,7 +261,7 @@ const callSummarize = async (what, selector = '') => {
     const summaryReport = {
       id: getFileID(2),
       what,
-      data: []
+      summaries: []
     };
     // For each report to be summarized:
     for (const reportID of reportIDs) {
@@ -263,7 +269,7 @@ const callSummarize = async (what, selector = '') => {
       const report = await getReport('scored', reportID);
       // Add a summary of it to the summary report.
       const summary = summarize(report);
-      summaryReport.data.push(summary);
+      summaryReport.summaries.push(summary);
     };
     // Save the summary report.
     const summaryDir = `${reportDir}/summarized`;
@@ -302,6 +308,40 @@ const callCompare = async (what, compareProcID, selector) => {
     }
   }
 };
+// Fulfills a tracking request.
+const callTrack = async (trackerID, what, selector, targetWhat) => {
+  // Get the summary report.
+  try {
+    const summaryReport = await getSummaryReport(selector);
+    // Remove unwanted results, if any, from it.
+    if (targetWhat) {
+      summaryReport.summaries = summaryReport.summaries.filter(
+        result => result.sources
+        && result.sources.target
+        && result.sources.target.what === targetWhat
+      );
+    }
+    // If any results remain:
+    if (summaryReport.summaries.length) {
+      // Get the tracker.
+      const {tracker} = require(`${functionDir}/track/${trackerID}/index`);
+      // Track the results.
+      const [reportID, trackingReport] = await track(tracker, what, summaryReport);
+      // Save the tracking report.
+      await fs.mkdir(`${reportDir}/tracking`, {recursive: true});
+      const reportPath = `${reportDir}/tracking/${reportID}.html`;
+      await fs.writeFile(reportPath, trackingReport);
+      console.log(`Tracking report saved in ${reportPath}`);
+    }
+    // Otherwise, i.e. if no results remain:
+    else {
+      console.log('ERROR: No results match the request');
+    }
+  }
+  catch(error) {
+    console.log(`ERROR: Tracking request invalid (${error.message})`);
+  }
+};
 // Fulfills a credit request.
 const callCredit = async (what, selector = '') => {
   // Get the IDs of the scored reports to be credited.
@@ -331,40 +371,6 @@ const callCredit = async (what, selector = '') => {
     console.log('ERROR: No scored reports to be credited');
   }
 };
-// Fulfills a tracking request.
-const callTrack = async (trackerID, selector, targetWhat) => {
-  // Get the summary report.
-  try {
-    const summaryReport = await getSummaryReport(selector);
-    // Remove unwanted results from it.
-    summaryReport.data = summaryReport.data.filter(
-      result => targetWhat
-      ? result.sources
-      && result.sources.target
-      && result.sources.target.what !== targetWhat
-      : true
-    );
-    // If any results remain:
-    if (summaryReport.data.length) {
-      // Get the tracker.
-      const {tracker} = require(`${functionDir}/track/${trackerID}/index`);
-      // Track the results.
-      const [reportID, trackingReport] = await track(tracker, summaryReport);
-      // Save the tracking report.
-      await fs.mkdir(`${reportDir}/tracking`, {recursive: true});
-      const reportPath = `${reportDir}/tracking/${reportID}.html`;
-      await fs.writeFile(reportPath, trackingReport);
-      console.log(`Tracking report saved in ${reportPath}`);
-    }
-    // Otherwise, i.e. if no results remain:
-    else {
-      console.log('ERROR: No results match the request');
-    }
-  }
-  catch(error) {
-    console.log(`ERROR: Tracking request invalid (${error.message})`);
-  }
-};
 
 // ########## OPERATION
 
@@ -423,14 +429,14 @@ else if (fn === 'compare' && fnArgs.length === 3) {
     console.log('Execution completed');
   });
 }
-else if (fn === 'credit' && fnArgs.length > 0 && fnArgs.length < 3) {
-  callCredit(... fnArgs)
+else if (fn === 'track' && fnArgs.length > 2 && fnArgs.length < 6) {
+  callTrack(... fnArgs)
   .then(() => {
     console.log('Execution completed');
   });
 }
-else if (fn === 'track' && fnArgs.length > 1 && fnArgs.length < 5) {
-  callTrack(... fnArgs)
+else if (fn === 'credit' && fnArgs.length > 0 && fnArgs.length < 3) {
+  callCredit(... fnArgs)
   .then(() => {
     console.log('Execution completed');
   });

package/compare.js

@@ -11,6 +11,6 @@
 // Compares the summarized reports and returns a comparison.
 exports.compare = async (id, what, comparer, summaryReport) => {
   // Return the comparison.
-  console.log(`Comparison complete. Report count: ${summaryReport.data.length}`);
+  console.log(`Comparison complete. Report count: ${summaryReport.summaries.length}`);
   return comparer(id, what, summaryReport);
 };

package/package.json

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

package/procs/compare/tcp40/index.js

@@ -17,13 +17,13 @@ const innestJoiner = '\n          ';
 // ########## FUNCTIONS
 
 // Returns the maximum score.
-const getMaxScore = summaryReport => summaryReport.data.reduce(
+const getMaxScore = summaryReport => summaryReport.summaries.reduce(
   (max, result) => Math.max(max, result.score), 0
 );
 // Converts summary report data to a table body.
 const getTableBody = async summaryReport => {
   const maxScore = getMaxScore(summaryReport);
-  const rows = summaryReport.data
+  const rows = summaryReport.summaries
   .sort((a, b) => a.score - b.score)
   .map(result => {
     const {id, sources, score} = result;
@@ -42,7 +42,7 @@ const getTableBody = async summaryReport => {
 const populateQuery = async (id, what, summaryReport, query) => {
   query.id = id;
   query.what = what;
-  query.pageCount = summaryReport.data.length;
+  query.pageCount = summaryReport.summaries.length;
   query.tableBody = await getTableBody(summaryReport);
   query.dateISO = getNowDate();
   query.dateSlash = getNowDateSlash();

package/procs/track/ttp40/index.html

@@ -18,7 +18,7 @@
         <h1>Accessibility tracking report</h1>
       </header>
       <h2>Introduction</h2>
-      <p>This is tracking report <code>__id__</code>.</p>
+      <p>This is tracking report <code>__id__</code>, for __what__.</p>
       <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>
@@ -31,7 +31,7 @@
         const summaryReportJSON = '__summaryReportJSON__';
         const summaryReport = JSON.parse(summaryReportJSON);
         const graphData = [];
-        summaryReport.data.forEach(result => {
+        summaryReport.summaries.forEach(result => {
           graphData.push({
             target: result.sources.target.what,
             time: new Date(`20${result.endTime}Z`),
@@ -67,7 +67,6 @@
           <tr>
             <th>Date and time</th>
             <th>Score</th>
-            <th>Order</th>
             <th>Target</th>
           </tr>
         </thead>

package/procs/track/ttp40/index.js

@@ -21,32 +21,32 @@ const digestURL = process.env.DIGEST_URL;
 // FUNCTIONS
 
 // Adds parameters to a query for a tracking report.
-const populateQuery = async (id, summaryReport, query) => {
+const populateQuery = async (id, what, summaryReport, query) => {
   // General parameters.
   query.id = id;
+  query.what = what;
   query.tp = trackerID;
   query.dateISO = getNowDate();
   query.dateSlash = getNowDateSlash();
   // JSON of pruned summary report.
-  summaryReport.data.forEach(result => {
+  const {summaries} = summaryReport;
+  summaries.forEach(result => {
     delete result.sources.target.id;
   });
   query.summaryReportJSON = JSON.stringify(summaryReport);
   // For each score:
   const rows = [];
-  const results = summaryReport.data;
-  const targetWhats = Array.from(new Set(results.map(result => result.sources.target.what))).sort();
-  summaryReport.data.forEach(result => {
+  const targetWhats = Array.from(new Set(summaries.map(result => result.sources.target.what))).sort();
+  summaries.forEach(result => {
     // Create an HTML table row for it.
     const timeCell = `<td>${result.endTime}</td>`;
     const digestLinkDestination = digestURL.replace('__id__', result.id);
     const scoreCell = `<td><a href=${digestLinkDestination}>${result.score}</a></td>`;
-    const orderCell = `<td class="center">${result.order}</td>`;
     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 row = `<tr>${[timeCell, scoreCell, orderCell, targetCell].join('')}</tr>`;
+    const row = `<tr>${[timeCell, scoreCell, targetCell].join('')}</tr>`;
     // Add the row to the array of rows.
     rows.push(row);
   });
@@ -54,10 +54,10 @@ const populateQuery = async (id, summaryReport, query) => {
   query.scoreRows = rows.join(innerJoiner);
 };
 // Returns a tracking report.
-exports.tracker = async (id, summaryReport) => {
+exports.tracker = async (id, what, summaryReport) => {
   // Create a query to replace placeholders.
   const query = {};
-  await populateQuery(id, summaryReport, query);
+  await populateQuery(id, what, summaryReport, query);
   // Get the template.
   let template = await fs.readFile(`${__dirname}/index.html`, 'utf8');
   // Replace its placeholders.

package/track.js

@@ -14,10 +14,9 @@ const {getFileID} = require('./procs/util');
 // ########## FUNCTIONS
 
 // Creates and returns a tracking report from a summary.
-exports.track = async (tracker, summaryReport) => {
+exports.track = async (tracker, what, summaryReport) => {
   // Use the tracker to create a tracking report.
   const id = getFileID(2);
-  const trackingReport = await tracker(id, summaryReport);
-  console.log(`Tracking report ${id} created`);
+  const trackingReport = await tracker(id, what, summaryReport);
   return [id, trackingReport];
 };