testilo 3.2.0 → 3.3.0

package/README.md

@@ -56,11 +56,11 @@ When Testilo digests a report, Testilo saves the digest in the directory whose r
 
 ### Comparing
 
-You can use Testilo to publish comparisons of accessibility scores. To do this, execute the statement `node compare abc xyz`, replacing `abc` with the prefix of the names of the reports and `xyz` with the name of a subdirectory of the `procs/compare` directory.
+You can use Testilo to publish comparisons of accessibility scores. To do this, execute the statement `node compare abc xyz`, replacing `abc` with a filename base for the comparison and `xyz` with the name of a subdirectory of the `procs/compare` directory.
 
-Testilo will use the comparison proc you name to compile the scores into a table and construct a web page containing that table. It will save the page in the `reports/comparative` directory. The name of the file will be `abc.html`.
+Testilo will examine all of the scored reports in the `REPORTDIR_SCORED` directory. The comparison proc in the `xyz` directory will construct a web page. Testilo will save the page in the `COMPARISONDIR` directory. The name of the file will be `abc.html`.
 
-In the table, the first column will contain descriptions of the pages (the `what` property of the hosts in the batch), such as “Wikipedia English”. Each such description will be a link to the page on the web. The second column will contain the scores of the pages. Each score will be a link to the digest for its page. The link will be `
+Comparison procs can design various pages on the basis of a set of scored reports. As an example, the `cp0` comparison proc creates a page that contains a table of scores, shown both numerically and with a bar graph. In the table, the first column contains descriptions of the pages (the `what` property of the hosts in the batch), such as “Wikipedia English”. Each such description is a link to the page on the web. The second column contains the scores of the pages. Each score is a link to the digest for its page. The link points to a digest located in a `digests` directory adjacent to the page itself. Thus, to use the `cp0` comparison proc, you would copy its output file to a web server, create a `digests` directory on the server as a sibling of that file, and copy the digest files into the `digests` directory.
 
 This procedure has some preconditions:
 - The comparison proc is compatible with the score proc that scored the report.

package/compare.js

@@ -13,9 +13,9 @@ const fs = require('fs/promises');
 
 // ########## CONSTANTS
 
-const tableDir = process.env.COMPARISONDIR || 'reports/comparative';
-const reportTimeStamp = process.argv[2];
-const tableProcID = process.argv[3];
+const comparisonDir = process.env.COMPARISONDIR || 'reports/comparative';
+const comparisonNameBase = process.argv[2];
+const compareProcID = process.argv[3];
 
 // ########## FUNCTIONS
 
@@ -24,13 +24,13 @@ const replaceHolders = (content, query) => content
 .replace(/__([a-zA-Z]+)__/g, (ph, qp) => query[qp]);
 // Creates and saves a web page containing a comparative table.
 const compare = async () => {
-  const tableDirAbs = `${__dirname}/${tableDir}`;
-  const {getQuery} = require(`./procs/compare/${tableProcID}/index`);
+  const comparisonDirAbs = `${__dirname}/${comparisonDir}`;
+  const {getQuery} = require(`./procs/compare/${compareProcID}/index`);
   const query = await getQuery();
-  const pageRaw = await fs.readFile(`${__dirname}/procs/compare/${tableProcID}/index.html`, 'utf8');
+  const pageRaw = await fs.readFile(`${__dirname}/procs/compare/${compareProcID}/index.html`, 'utf8');
   const page = replaceHolders(pageRaw, query);
-  await fs.writeFile(`${tableDirAbs}/${reportTimeStamp}.html`, page);
-  console.log(`Page comparing ${reportTimeStamp} reports created and saved`);
+  await fs.writeFile(`${comparisonDirAbs}/${comparisonNameBase}.html`, page);
+  console.log(`Page ${comparisonNameBase}.html created and saved`);
 };
 
 // ########## OPERATION

package/package.json

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

package/procs/compare/cp0/index.html

@@ -18,11 +18,16 @@
         <h1>Accessibility score comparison</h1>
       </header>
       <h2>Introduction</h2>
-      <p>The <code>tp10</code> <a href="https://www.w3.org/WAI/fundamentals/accessibility-intro/">accessibility</a> testing procedure was executed by <a href="https://www.npmjs.com/package/testaro">Testaro</a> on __pageCount__ web pages. The procedure performed 808 tests on each page. Of these, 16 tests are custom tests defined by Testaro, and the others belong to packages of tests created by others. Testaro produced reports enumerating the test results.</p>
-      <p>Given the reports produced by Testaro, another application, <a href="https://www.npmjs.com/package/testilo">Testilo</a>, used its <code>sp10a</code> procedure to assigned weights to the tests and compute a total score for each page (where 0 is the best possible score), adding a section on scoring to each report.</p>
-      <p>Testilo used a third procedure, <code>dp10a</code>, to create a digest from each report, summarizing the tests and how the score was computed. The report for each page is included, as an appendix, in the page&rsquo;s digest.</p>
-      <p>Testilo produced this comparison page with a fourth procedure, <code>cp0</code>, listing the tested web pages in order of their scores (best to worst) and showing their scores in a table. The table includes links to the pages and to the digests.</p>
-      <p>Tests and scoring formulae are fallible and subjective. The reported faults merit investigation as potential opportunities for improved accessibility. But some may not actually harm accessibility, and some other accessibility faults may have escaped detection by any of the tests. Different reasonable procedures could yield different test results and different scores. Both Testaro and Testilo can be customized to fit different definitions and weightings of types of accessibility.</p>
+      <p>The table below compares __pageCount__ web pages on <a href="https://www.w3.org/WAI/fundamentals/accessibility-intro/">accessibility</a>. The page names link to the pages on the web. The scores link to digests that explain in detail how the scores were computed.</p>
+      <p>The pages were:</p>
+      <div id="summary">
+        <p>Tested by <a href="https://www.npmjs.com/package/testaro">Testaro</a> with procedure <code>tp10</code></p>
+        <p>Scored by <a href="https://www.npmjs.com/package/testilo">Testilo</a> with procedure <code>sp10a</code></p>
+        <p>Digested by Testilo with procedure <code>dp10a</code></p>
+        <p>Compared by Testilo with procedure <code>cp0</code></p>
+      </div>
+      <p>The <code>tp10</code> procedure performs 808 tests on each page. Of these, 16 tests are custom tests defined by Testaro, and the others belong to packages of tests created by others.</p>
+      <p>Tests and scoring formulae are fallible and subjective. The reported faults merit investigation as potential opportunities for improved accessibility. But some may not actually harm accessibility, and some other accessibility faults may have escaped detection. Different reasonable procedures could yield different test results and different scores. Testaro and Testilo can be customized to fit different definitions and weightings of types of accessibility.</p>
       <h2>Comparison</h2>
       <table class="allBorder">
         <caption>Accessibility scores of web pages</caption>

package/procs/compare/cp0/index.js

@@ -13,7 +13,6 @@ const fs = require('fs/promises');
 // ########## CONSTANTS
 
 const reportDirScored = process.env.REPORTDIR_SCORED || 'reports/scored';
-const reportIDStart = process.argv[2];
 const query = {};
 
 // ########## FUNCTIONS
@@ -22,8 +21,7 @@ const query = {};
 const getData = async () => {
   const reportDirAbs = `${__dirname}/../../../${reportDirScored}`;
   const reportFileNamesAll = await fs.readdir(reportDirAbs);
-  const reportFileNamesSource = reportFileNamesAll
-  .filter(fileName => fileName.startsWith(reportIDStart) && fileName.endsWith('.json'));
+  const reportFileNamesSource = reportFileNamesAll.filter(fileName => fileName.endsWith('.json'));
   const pageCount = reportFileNamesSource.length;
   const bodyData = [];
   for (const fileName of reportFileNamesSource) {
@@ -51,7 +49,7 @@ const getTableBody = async bodyData => {
   .map(item => {
     const {id, host, score} = item;
     const pageCell = `<th scope="row"><a href="${host.which}">${host.what}</a></th>`;
-    const numCell = `<td><a href="reports/${id}.html">${score}</a></td>`;
+    const numCell = `<td><a href="digests/${id}.html">${score}</a></td>`;
     const barWidth = 100 * score / maxScore;
     const bar = `<rect height="100%" width="${barWidth}%" fill="red"></rect>`;
     const barCell = `<td aria-hidden="true"><svg width="100%" height="0.7em">${bar}</svg></td>`;

package/procs/digest/dp10a/index.html

@@ -24,7 +24,7 @@
           <p>Tested by: Testaro, <code>tp10</code></p>
           <p>Scored by: Testilo, <code>sp10a</code></p>
           <p>Digested by: Testilo, <code>dp10a</code></p>
-        </dl>
+        </div>
       </header>
       <h2>Introduction</h2>
       <p>The <code>tp10</code> <a href="https://www.w3.org/WAI/fundamentals/accessibility-intro/">accessibility</a> testing procedure was executed by <a href="https://www.npmjs.com/package/testaro">Testaro</a> on the web page at <a href="__url__">__url__</a>, belonging to __org__, on __dateSlash__. The procedure performed 808 tests. Of these, 16 tests are custom tests defined by Testaro, and the others belong to packages of tests created by others. Testaro produced a report enumerating the test results. The report is appended, below, to this page.</p>

package/reports/comparative/{35k1r-.html → comparison.html}

@@ -18,11 +18,16 @@
         <h1>Accessibility score comparison</h1>
       </header>
       <h2>Introduction</h2>
-      <p>The <code>tp10</code> <a href="https://www.w3.org/WAI/fundamentals/accessibility-intro/">accessibility</a> testing procedure was executed by <a href="https://www.npmjs.com/package/testaro">Testaro</a> on 1 web pages. The procedure performed 808 tests on each page. Of these, 16 tests are custom tests defined by Testaro, and the others belong to packages of tests created by others. Testaro produced reports enumerating the test results.</p>
-      <p>Given the reports produced by Testaro, another application, <a href="https://www.npmjs.com/package/testilo">Testilo</a>, used its <code>sp10a</code> procedure to assigned weights to the tests and compute a total score for each page (where 0 is the best possible score), adding a section on scoring to each report.</p>
-      <p>Testilo used a third procedure, <code>dp10a</code>, to create a digest from each report, summarizing the tests and how the score was computed. The report for each page is included, as an appendix, in the page&rsquo;s digest.</p>
-      <p>Testilo produced this comparison page with a fourth procedure, <code>cp0</code>, listing the tested web pages in order of their scores (best to worst) and showing their scores in a table. The table includes links to the pages and to the digests.</p>
-      <p>Tests and scoring formulae are fallible and subjective. The reported faults merit investigation as potential opportunities for improved accessibility. But some may not actually harm accessibility, and some other accessibility faults may have escaped detection by any of the tests. Different reasonable procedures could yield different test results and different scores. Both Testaro and Testilo can be customized to fit different definitions and weightings of types of accessibility.</p>
+      <p>The table below compares 1 web pages on <a href="https://www.w3.org/WAI/fundamentals/accessibility-intro/">accessibility</a>. The page names link to the pages on the web. The scores link to digests that explain in detail how the scores were computed.</p>
+      <p>The pages were:</p>
+      <div id="summary">
+        <p>Tested by <a href="https://www.npmjs.com/package/testaro">Testaro</a> with procedure <code>tp10</code></p>
+        <p>Scored by <a href="https://www.npmjs.com/package/testilo">Testilo</a> with procedure <code>sp10a</code></p>
+        <p>Digested by Testilo with procedure <code>dp10a</code></p>
+        <p>Compared by Testilo with procedure <code>cp0</code></p>
+      </div>
+      <p>The <code>tp10</code> procedure performs 808 tests on each page. Of these, 16 tests are custom tests defined by Testaro, and the others belong to packages of tests created by others.</p>
+      <p>Tests and scoring formulae are fallible and subjective. The reported faults merit investigation as potential opportunities for improved accessibility. But some may not actually harm accessibility, and some other accessibility faults may have escaped detection. Different reasonable procedures could yield different test results and different scores. Testaro and Testilo can be customized to fit different definitions and weightings of types of accessibility.</p>
       <h2>Comparison</h2>
       <table class="allBorder">
         <caption>Accessibility scores of web pages</caption>
@@ -30,7 +35,7 @@
           <tr><th scope="col">Page</th><th scope="col" colspan="2">Score (lower is better)</tr>
         </thead>
         <tbody class="linkSmaller secondCellRight">
-          <tr><th scope="row"><a href="https://www.railpass.com/">Railpass</a></th><td><a href="reports/35k1r-railpass.html">1589</a></td><td aria-hidden="true"><svg width="100%" height="0.7em"><rect height="100%" width="100%" fill="red"></rect></svg></td></tr>
+          <tr><th scope="row"><a href="https://www.railpass.com/">Railpass</a></th><td><a href="digests/35k1r-railpass.html">1589</a></td><td aria-hidden="true"><svg width="100%" height="0.7em"><rect height="100%" width="100%" fill="red"></rect></svg></td></tr>
         </tbody>
       </table>
       <footer>

package/reports/comparative/style.css

@@ -64,6 +64,10 @@ legend {
 section:not(.wide) {
   max-width: 36rem;
 }
+#summary > p {
+  margin: 0;
+  padding: 0;
+}
 table {
   border-collapse: collapse;
 }

package/reports/digested/35k1r-railpass.html

@@ -24,7 +24,7 @@
           <p>Tested by: Testaro, <code>tp10</code></p>
           <p>Scored by: Testilo, <code>sp10a</code></p>
           <p>Digested by: Testilo, <code>dp10a</code></p>
-        </dl>
+        </div>
       </header>
       <h2>Introduction</h2>
       <p>The <code>tp10</code> <a href="https://www.w3.org/WAI/fundamentals/accessibility-intro/">accessibility</a> testing procedure was executed by <a href="https://www.npmjs.com/package/testaro">Testaro</a> on the web page at <a href="https://www.railpass.com/">https://www.railpass.com/</a>, belonging to Railpass, on 2022/06/03. The procedure performed 808 tests. Of these, 16 tests are custom tests defined by Testaro, and the others belong to packages of tests created by others. Testaro produced a report enumerating the test results. The report is appended, below, to this page.</p>