testilo 12.3.0 → 13.1.1

package/README.md

@@ -181,8 +181,7 @@ The `batch()` function of the `batch` module generates a batch and returns it as
 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 w`
+- In the Testilo project directory, execute the statement `node call batch i w`.
 
 In this statement, replace `i` with the list ID and `w` with a description of the batch.
 
@@ -196,6 +195,8 @@ Testilo classifies issues. The built-in issue classifications are located in the
 
 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.
 
+If you want Testaro to test targets for **all** the rules of all the available tools, without regard to any issue classification, you can use the `script` module to create a script that does not impose any issue restrictions.
+
 #### Invocation
 
 There are two ways to use the `script` module.
@@ -216,6 +217,13 @@ This invocation references `scriptID`, `issueClasses`, and `issueID` variables.
 
 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.
 
+To create a script without issue restrictions, a module can use this invocation:
+
+```javaScript
+const {script} = require('testilo/script');
+const scriptObj = script(scriptID);
+```
+
 ##### 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 …`.
@@ -229,6 +237,8 @@ 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.
 
+To create a script without any issue restrictions, a user can execute the statement `node call script s`.
+
 #### 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.

package/call.js

@@ -58,7 +58,7 @@ const callBatch = async (listID, what) => {
 const callScript = async (scriptID, classificationID = null, ... issueIDs) => {
   // Get any issue classification.
   const issueClasses = classificationID
-  ? require(`${functionDir}/score/${classificationID}`)
+  ? require(`${functionDir}/score/${classificationID}`).issueClasses
   : null;
   // Create a script.
   const scriptObj = script(scriptID, issueClasses, ... issueIDs);

package/digest.js

@@ -2,31 +2,23 @@
   digest.js
   Creates digests from a scored reports.
   Arguments:
-    0. Digest template.
-    1. Digesting function.
-    2. Array of scored reports.
+    0. Digesting function.
+    1. Array of scored reports.
 */
 
 // ########## FUNCTIONS
 
-// Replaces the placeholders in content with eponymous query parameters.
-const replaceHolders = (content, query) => content
-.replace(/__([a-zA-Z]+)__/g, (ph, qp) => query[qp]);
 // Digests the scored reports and returns them, digested.
-exports.digest = (digestTemplate, digester, reports) => {
+exports.digest = (digester, reports) => {
   const digests = {};
-  // Create a query.
-  const query = {};
   // For each report:
-  for (const report of reports) {
-    // Populate the query.
-    digester(report, query);
+  reports.forEach(report => {
     // Use it to create a digest.
-    const digestedReport = replaceHolders(digestTemplate, query);
+    const digestedReport = digester(report);
     // Add the digest to the array of digests.
     digests[report.id] = digestedReport;
     console.log(`Report ${report.id} digested`);
-  };
+  });
   // Return the digests.
   console.log(`Digesting complete. Report count: ${reports.length}`);
   return digests;

package/package.json

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

package/procs/digest/tdp27/index.html

@@ -29,21 +29,29 @@
         </table>
       </header>
       <h2>Introduction</h2>
-      <p>This is a digest of results from a battery of accessibility Tests.</p>
-      <p>The battery includes 1353 automated accessibility tests drawn from ten different packages: Alfa, Axe, Continuum, Equal Access, HTML CodeSniffer, Nu Html Checker, QualWeb, Tenon, Testaro, and WAVE.</p>
+      <p>This is a digest of results from a battery of accessibility tests.</p>
+      <p>The battery includes about 1350 tests drawn from ten different packages: Alfa, Axe, Continuum, Equal Access, HTML CodeSniffer, Nu Html Checker, QualWeb, Tenon, Testaro, and WAVE.</p>
       <p>These tests were run on the web page named above and gave the page a score of __totalScore__, where 0 would be <q>perfect</q>.</p>
       <h2>Score summary</h2>
       <table class="allBorder secondCellRight">
-        <caption>Score components</caption>
+        <caption>Score summary</caption>
+        <thead>
+          <tr><th>Component</th><th>Score</th></tr>
+        </thead>
         <tbody class="headersLeft">
-        __scoreRows__
+          __summaryRows__
+        </tbody>
+      </table>
+      <h2>Issue scores</h2>
+      <table class="allBorder secondCellRight">
+        <caption>Issue scores</caption>
+        <thead>
+          <tr><th>Issue</th><th>Score</th></tr>
+        </thead>
+        <tbody class="headersLeft">
+          __issueRows__
         </tbody>
       </table>
-      <h2>Issue summary</h2>
-      <h3>Special issues</h3>
-      __specialSummary__
-      <h3>Classified issues</h3>
-      __issueSummary__
       <h2>Complete report</h2>
       <pre>__report__</pre>
       <footer>

package/procs/digest/tdp27/index.js

@@ -1,7 +1,4 @@
-/*
-  index: digester for scoring procedure tsp24.
-  Creator of parameters for substitution into index.html.
-*/
+// index: digester for scoring procedure tsp27.
 
 // IMPORTS
 
@@ -21,20 +18,14 @@ const innerJoiner = '\n        ';
 const htmlEscape = textOrNumber => textOrNumber
 .toString()
 .replace(/&/g, '&')
-.replace(/</g, '&lt;');
+.replace(/</g, '&lt;')
+.replace(/"/g, '&quot;');
 // Gets a row of the score-summary table.
 const getScoreRow = (componentName, score) => `<tr><th>${componentName}</th><td>${score}</td></tr>`;
-// Gets the start of a paragraph about a special score.
-const getSpecialPStart = (summary, scoreID) =>
-`<p><span class="componentID">${scoreID}</span>: Score ${summary[scoreID]}.`;
 // Adds parameters to a query for a digest.
-exports.makeQuery = (report, query) => {
-  // Add an HTML-safe copy of the report to the query to be appended to the digest.
-  const {acts, sources, jobData, score} = report;
+const makeQuery = (report, query) => {
+  const {sources, jobData, score} = report;
   const {script, target, requester} = sources;
-  const reportJSON = JSON.stringify(report, null, 2);
-  const reportJSONSafe = htmlEscape(reportJSON);
-  query.report = reportJSONSafe;
   const {scoreProcID, summary, issues} = score;
   const {total} = summary;
   query.ts = script;
@@ -55,20 +46,25 @@ exports.makeQuery = (report, query) => {
     return;
   }
   // Get rows for a score-summary table.
-  const scoreRows = [];
+  const rows = {
+    summaryRows: [],
+    issueRows: []
+  };
   const componentIDs = ['issues', 'tools', 'preventions', 'log', 'latency'];
   ['total'].concat(componentIDs).forEach(itemID => {
     if (summary[itemID]) {
-      scoreRows.push(getScoreRow(itemID, summary[itemID]));
+      rows.summaryRows.push(getScoreRow(itemID, summary[itemID]));
     }
   });
-  // Add the issue rows to them.
+  // Get rows for an issue-score table.
   Object.keys(issues).forEach(issueID => {
-    scoreRows.push(getScoreRow(issueID, issues[issueID]));
+    rows.issueRows.push(getScoreRow(issueID, issues[issueID]));
   });
   // Add the rows to the query.
-  query.scoreRows = scoreRows.join(innerJoiner);
-  // Add paragraphs about them for the issue summary to the query.
+  ['summaryRows', 'issueRows'].forEach(rowType => {
+    query[rowType] = rows[rowType].join(innerJoiner);
+  });
+  // Add paragraphs about the issues to the query.
   const issueSummaryItems = [];
   Object.keys(issues).forEach(issueID => {
     const issueHeading = `<h4>Issue ${issueID}</h4>`;
@@ -96,4 +92,21 @@ exports.makeQuery = (report, query) => {
     issueSummaryItems.push(issueHeading, wcagP, scoreP, issueIntroP, issueList);
   });
   query.issueSummary = issueSummaryItems.join(joiner);
+  // Add an HTML-safe copy of the report to the query to be appended to the digest.
+  const reportJSON = JSON.stringify(report, null, 2);
+  const reportJSONSafe = htmlEscape(reportJSON);
+  query.report = reportJSONSafe;
+};
+// Returns a digested report.
+exports.digester = async report => {
+  // Create a query to replace plateholders.
+  const query = makeQuery(report, {});
+  // Get the template.
+  let template = await fs.readFile(`${__dirname}/index.html`, 'utf8');
+  // Replace its placeholders.
+  Object.keys(query).forEach(param => {
+    template = template.replace(new RegExp(`__${param}__`, 'g'), query[param]);
+  });
+  // Return the digest.
+  return template;
 };

package/procs/score/tic27.js

@@ -2577,13 +2577,6 @@ exports.issueClasses = {
           quality: 1,
           what: 'role attribute has an invalid value'
         }
-      },
-      testaro: {
-        'role-bad': {
-          variable: false,
-          quality: 0.5,
-          what: 'Nonexistent or implicit-overriding role'
-        }
       }
     }
   },
@@ -2621,10 +2614,10 @@ exports.issueClasses = {
         }
       },
       testaro: {
-        'role-redundant': {
+        'role': {
           variable: false,
           quality: 1,
-          what: 'Redundant role'
+          what: 'Invalid, native-replacing, or redundant role'
         }
       }
     }
@@ -4696,13 +4689,6 @@ exports.issueClasses = {
           what: 'Form control has no accessible name'
         }
       },
-      testaro: {
-        'labClash-unlabeled': {
-          variable: false,
-          quality: 1,
-          what: 'Button, input, select, or textarea is unlabeled'
-        }
-      },
       wave: {
         'label_missing': {
           variable: false,
@@ -4967,23 +4953,10 @@ exports.issueClasses = {
         }
       },
       testaro: {
-        'focInd-missing': {
+        'focInd': {
           variable: false,
           quality: 1,
-          what: 'Focused element displays no focus indicator'
-        }
-      }
-    }
-  },
-  focusIndicationBad: {
-    wcag: '2.4.7',
-    weight: 3,
-    tools: {
-      testaro: {
-        'focInd-nonoutline': {
-          variable: false,
-          quality: 1,
-          what: 'Focused element displays a nostandard focus indicator'
+          what: 'Focused element displays a nonstandard or no focus indicator'
         }
       }
     }
@@ -5438,15 +5411,10 @@ exports.issueClasses = {
     weight: 3,
     tools: {
       testaro: {
-        'focOp-focusable-inoperable': {
+        'focOp': {
           variable: false,
           quality: 1,
-          what: 'Tab-focusable elements that are inoperable'
-        },
-        'focOp-operable-nonfocusable': {
-          variable: false,
-          quality: 1,
-          what: 'Operable elements that cannot be Tab-focused'
+          what: 'Tab-focusable elements that are inoperable or operable elements that are not focusable'
         }
       }
     }
@@ -5645,12 +5613,12 @@ exports.issueClasses = {
       }
     }
   },
-  hoverImpact: {
+  hoverSurprise: {
     wcag: '1.4.13',
     weight: 3,
     tools: {
       testaro: {
-        'hover-impactTriggers': {
+        'hover': {
           variable: false,
           quality: 1,
           what: 'Hovering over element has unexpected effects'
@@ -5658,71 +5626,6 @@ exports.issueClasses = {
       }
     }
   },
-  unhoverable: {
-    wcag: '1.4.13',
-    weight: 3,
-    tools: {
-      testaro: {
-        'hover-unhoverables': {
-          variable: false,
-          quality: 1,
-          what: 'Operable element cannot be hovered over'
-        }
-      }
-    }
-  },
-  hoverNoCursor: {
-    wcag: '1.4.13',
-    weight: 3,
-    tools: {
-      testaro: {
-        'hover-noCursors': {
-          variable: false,
-          quality: 1,
-          what: 'Hoverable element hides the mouse cursor'
-        }
-      }
-    }
-  },
-  hoverBadCursor: {
-    wcag: '1.4.13',
-    weight: 2,
-    tools: {
-      testaro: {
-        'hover-badCursors': {
-          variable: false,
-          quality: 1,
-          what: 'Link or button makes the hovering mouse cursor nonstandard'
-        }
-      }
-    }
-  },
-  hoverNoIndicator: {
-    wcag: '1.4.13',
-    weight: 3,
-    tools: {
-      testaro: {
-        'hover-noCursors': {
-          variable: false,
-          quality: 1,
-          what: 'Button shows no indication of being hovered over'
-        }
-      }
-    }
-  },
-  hoverBadIndicator: {
-    wcag: '1.4.13',
-    weight: 2,
-    tools: {
-      testaro: {
-        'hover-noCursors': {
-          variable: false,
-          quality: 1,
-          what: 'List item changes when hovered over'
-        }
-      }
-    }
-  },
   labelClash: {
     wcag: '1.3.1',
     weight: 2,
@@ -5735,7 +5638,7 @@ exports.issueClasses = {
         }
       },
       testaro: {
-        'labClash-mislabeled': {
+        'labClash': {
           variable: false,
           quality: 1,
           what: 'Incompatible label types'

package/procs/score/tsp27.js

@@ -63,18 +63,22 @@ exports.scorer = report => {
         scoreProcID,
         summary: {
           total: 0,
-          issues: 0,
-          tools: 0,
-          preventions: 0,
+          issue: 0,
+          tool: 0,
+          prevention: 0,
           log: 0,
           latency: 0
         },
-        toolTotals: [0, 0, 0, 0],
-        issues: {},
-        tools: {},
-        preventions: {}
+        details: {
+          severity: {
+            total: [0, 0, 0, 0],
+            byTool: {}
+          },
+          prevention: {},
+          issue: {}
+        }
       };
-      const {summary, toolTotals, issues, tools, preventions} = score;
+      const {summary, details} = score;
       // For each test act:
       testActs.forEach(act => {
         // If a successful standard result exists:
@@ -87,16 +91,11 @@ exports.scorer = report => {
         ) {
           // Add the severity totals of the tool to the score.
           const {totals} = standardResult;
-          tools[which] = totals;
-          toolTotals.forEach((total, index) => {
-            toolTotals[index] += totals[index];
-          });
-          // Update the issue totals for the tool.
-          const issueTotals = {};
-          let ruleID;
+          details.severity.byTool[which] = totals;
+          // Add the instance data of the tool to the score.
           standardResult.instances.forEach(instance => {
-            ruleID = issueIndex[which][instance.ruleID];
-            if (! ruleID) {
+            let {ruleID} = instance;
+            if (! issueIndex[which][ruleID]) {
               ruleID = issueMatcher.find(pattern => {
                 const patternRE = new RegExp(pattern);
                 return patternRE.test(instance.ruleID);
@@ -104,22 +103,46 @@ exports.scorer = report => {
             }
             if (ruleID) {
               const issueID = issueIndex[which][ruleID];
-              if (! issueTotals[issueID]) {
-                issueTotals[issueID] = 0;
+              if (! details.issue[issueID]) {
+                details.issue[issueID] = {
+                  weight: issueClasses[issueID].weight,
+                  tools: {}
+                };
+              }
+              if (! details.issue[issueID].tools[which]) {
+                details.issue[issueID].tools[which] = {};
+              }
+              if (! details.issue[issueID].tools[which][ruleID]) {
+                details.issue[issueID].tools[which][ruleID] = {
+                  quality: issueClasses[issueID].tools[which][ruleID].quality,
+                  complaints: {
+                    countTotal: 0,
+                    texts: []
+                  }
+                };
+              }
+              details
+              .issue[issueID]
+              .tools[which][ruleID]
+              .complaints
+              .countTotal += instance.count || 1;
+              if (
+                ! details
+                .issue[issueID]
+                .tools[which][ruleID]
+                .complaints
+                .texts
+                .includes(instance.what)
+              ) {
+                details.issue[issueID].tools[which][ruleID].complaints.texts.push(instance.what);
               }
-              issueTotals[issueID] += instance.count || 1;
             }
             else {
               console.log(`ERROR: ${instance.ruleID} of ${which} not found in issueClasses`);
             }
           });
-          // Update the issue totals in the score.
-          Object.keys(issueTotals).forEach(issueID => {
-            issues[issueID] = Math.max(issues[id] || 0, issueTotals[issueID]);
-          });
-          summary.issues = Object.values(issues).reduce((total, current) => total + current);
         }
-        // Otherwise, i.e. if no no successful result exists:
+        // Otherwise, i.e. if no successful standard result exists:
         else {
           // Add a prevented result to the act if not already there.
           if (! act.result) {
@@ -129,15 +152,35 @@ exports.scorer = report => {
             act.result.prevented = true;
           };
           // Add the tool and the prevention score to the score.
-          preventions[which] = preventionWeight;
-          summary.preventions += preventionWeight;
+          details.prevention[which] = preventionWeight;
         }
       });
-      // Add the weighted tool total to the score.
-      summary.tools = toolWeight * toolTotals.reduce(
-        (total, current, index) => total + current * severityWeights[index], 0
+      // Add the severity detail totals to the score.
+      details.severity.total = Object.keys(details.severity.byTool).reduce((severityTotals, toolID) => {
+        details.severity.byTool[toolID].forEach((severityScore, index) => {
+          severityTotals[index] += severityScore;
+        });
+        return severityTotals;
+      }, details.severity.total);
+      // Add the summary issue total to the score.
+      Object.keys(details.issue).forEach(issueID => {
+        Object.keys(details.issue[issueID].tools).forEach(toolID => {
+          Object.keys(details.issue[issueID].tools[toolID]).forEach(ruleID => {
+            summary.issue += details.issue[issueID].weight
+            * details.issue[issueID].tools[toolID][ruleID].quality
+            * details.issue[issueID].tools[toolID][ruleID].complaints.countTotal;
+          });
+        });
+      });
+      // Add the summary tool total to the score.
+      summary.tool = toolWeight * details.severity.total.reduce(
+        (total, current, index) => total + severityWeights[index] * current, 0
+      );
+      // Add the summary prevention total to the score.
+      summary.prevention = Object.values(details.prevention).reduce(
+        (total, current) => total + current, 0
       );
-      // Add the log score to the score.
+      // Add the summary log score to the score.
       const {jobData} = report;
       summary.log = Math.max(0, Math.round(
         logWeights.logCount * jobData.logCount
@@ -147,21 +190,21 @@ exports.scorer = report => {
         + logWeights.prohibitedCount * jobData.prohibitedCount +
         + logWeights.visitRejectionCount * jobData.visitRejectionCount
       ));
-      // Add the latency score to the score.
+      // Add the summary latency score to the score.
       summary.latency = Math.round(
         latencyWeight * (Math.max(0, jobData.visitLatency - normalLatency))
       );
-      // Round the scores.
+      // Round the unrounded scores.
       Object.keys(summary).forEach(summaryTypeName => {
         summary[summaryTypeName] = Math.round(summary[summaryTypeName]);
       });
-      toolTotals.forEach((severityTotal, index) => {
-        toolTotals[index] = Math.round(toolTotals[index]);
+      details.severity.total.forEach((severityTotal, index) => {
+        details.severity.total[index] = Math.round(severityTotal);
       });
-      // Add the total score to the score.
-      summary.total = summary.issues
-      + summary.tools
-      + summary.preventions
+      // Add the summary total score to the score.
+      summary.total = summary.issue
+      + summary.tool
+      + summary.prevention
       + summary.log
       + summary.latency;
       // Add the score to the report.