testaro 60.6.1 → 60.7.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "testaro",
-  "version": "60.6.1",
+  "version": "60.7.1",
   "description": "Run 1000 web accessibility tests from 11 tools and get a standardized report",
   "main": "index.js",
   "scripts": {

package/procs/testaro.js

@@ -90,19 +90,19 @@ const getRuleResult = exports.getRuleResult = async (
     // If itemization is required:
     if (withItems) {
       // Get the bounding box of the element.
-      const {location} = elData;
+      const {tagName,id, location, excerpt} = elData;
       const box = location.type === 'box' ? location.spec : await boxOf(loc);
       // Add a standard instance to the result.
       standardInstances.push({
         ruleID,
         what: whatParam ? whats[0].replace('__param__', whatParam) : whats[0],
         ordinalSeverity,
-        tagName: elData.tagName,
-        id: elData.id,
-        location: elData.location,
-        excerpt: elData.excerpt,
+        tagName,
+        id,
+        location,
+        excerpt,
         boxID: boxToString(box),
-        pathID: await xPath(loc)
+        pathID: tagName === 'HTML' ? '/html' : await xPath(loc)
       });
     }
   }

package/run.js

@@ -383,6 +383,57 @@ const launch = exports.launch = async (
             get: () => ['en-US', 'en']
           });
         });
+        // If the act is a testaro test act:
+        if (act.type === 'test' && act.which === 'testaro') {
+          // Add a script that defines a window method to get the XPath of an element.
+          await page.addInitScript(() => {
+            window.getXPath = element => {
+              if (!element || element.nodeType !== Node.ELEMENT_NODE) {
+                return '';
+              }
+              const segments = [];
+              let el = element;
+              // As long as the current node is an element:
+              while (el && el.nodeType === Node.ELEMENT_NODE) {
+                const tag = el.tagName.toLowerCase();
+                // If it is the html element:
+                if (el === document.documentElement) {
+                  // Prepend it to the segment array
+                  segments.unshift('html');
+                  // Stop traversing.
+                  break;
+                }
+                // Otherwise, get its parent node.
+                const parent = el.parentNode;
+                // If (abnormally) the parent node is not an element:
+                if (!parent || parent.nodeType !== Node.ELEMENT_NODE) {
+                  // Prepend it to the segment array.
+                  segments.unshift(tag);
+                  // Stop traversing, leaving the segment array partial.
+                  break;
+                }
+                let subscript = '';
+                let sameTagCount = 0;
+                // Get the subscript of the element.
+                const cohort = Array
+                .from(parent.childNodes)
+                .filter(
+                  childNode => childNode.nodeType === Node.ELEMENT_NODE
+                  && childNode.tagName === el.tagName
+                );
+                if (cohort.length > 1) {
+                  subscript = `[${cohort.indexOf(el) + 1}]`;
+                }
+                // Prepend the element identifier to the segment array.
+                segments.unshift(`${tag}${subscript}`);
+                // Continue the traversal with the parent of the current element.
+                el = parent;
+              }
+              // Return the XPath.
+              return `/${segments.join('/')}`;
+            };
+          });
+        }
         // Ensure the report has a jobData property.
         report.jobData ??= {};
         const {jobData} = report;

package/testaro/lineHeight-slow.js

@@ -0,0 +1,70 @@
+/*
+  © 2023–2024 CVS Health and/or one of its affiliates. All rights reserved.
+  © 2025 Jonathan Robert Pool. All rights reserved.
+
+  MIT License
+
+  Permission is hereby granted, free of charge, to any person obtaining a copy
+  of this software and associated documentation files (the "Software"), to deal
+  in the Software without restriction, including without limitation the rights
+  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+  copies of the Software, and to permit persons to whom the Software is
+  furnished to do so, subject to the following conditions:
+
+  The above copyright notice and this permission notice shall be included in all
+  copies or substantial portions of the Software.
+
+  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+  SOFTWARE.
+*/
+
+/*
+  lineHeight
+  Related to Tenon rule 144.
+  This test reports elements whose line heights are less than 1.5 times their font sizes. Even
+  such elements with no text create accessibility risk, because any text node added to one of
+  them would have a substandard line height. Nonetheless, elements with no non-spacing text in
+  their subtrees are excluded.
+*/
+
+// IMPORTS
+
+// Module to perform common operations.
+const {init, getRuleResult} = require('../procs/testaro');
+
+// FUNCTIONS
+
+// Runs the test and returns the result.
+exports.reporter = async (page, withItems) => {
+  // Initialize the locators and result.
+  const all = await init(100, page, 'body *', {hasText: /[^\s]/});
+  // For each locator:
+  for (const loc of all.allLocs) {
+    // Get whether its element violates the rule.
+    const data = await loc.evaluate(el => {
+      const styleDec = window.getComputedStyle(el);
+      const {fontSize, lineHeight} = styleDec;
+      return {
+        fontSize: Number.parseFloat(fontSize),
+        lineHeight: Number.parseFloat(lineHeight)
+      };
+    });
+    // If it does, after a grace margin for rounding:
+    const isBad = data.lineHeight < 1.49 * data.fontSize;
+    if (isBad) {
+      // Add the locator to the array of violators.
+      all.locs.push([loc, `font size ${data.fontSize} px, line height ${data.lineHeight} px`]);
+    }
+  }
+  // Populate and return the result.
+  const whats = [
+    'Element line height is less than 1.5 times its font size (__param__)',
+    'Elements have line heights less than 1.5 times their font sizes'
+  ];
+  return await getRuleResult(withItems, all, 'lineHeight', whats, 1);
+};

package/testaro/lineHeight.js

@@ -32,39 +32,119 @@
   their subtrees are excluded.
 */
 
-// IMPORTS
-
-// Module to perform common operations.
-const {init, getRuleResult} = require('../procs/testaro');
-
 // FUNCTIONS
 
 // Runs the test and returns the result.
 exports.reporter = async (page, withItems) => {
-  // Initialize the locators and result.
-  const all = await init(100, page, 'body *', {hasText: /[^\s]/});
-  // For each locator:
-  for (const loc of all.allLocs) {
-    // Get whether its element violates the rule.
-    const data = await loc.evaluate(el => {
+  // Get data on violations of the rule.
+  const violationData = await page.evaluate(withItems => {
+    // Get all elements.
+    const elements = document.body.querySelectorAll('*');
+    // Get all elements that have non-empty child text nodes.
+    const elementsWithText = Array.from(elements).filter(el =>
+      Array.from(el.childNodes).some(child =>
+        child.nodeType === Node.TEXT_NODE &&
+        child.textContent.trim().length
+      )
+    );
+    // Initialize a violation count and an array of violation items.
+    let violationCount = 0;
+    const violationItems = [];
+    // For each such element:
+    elementsWithText.forEach(el => {
+      // Get its relevant style properties.
       const styleDec = window.getComputedStyle(el);
       const {fontSize, lineHeight} = styleDec;
-      return {
-        fontSize: Number.parseFloat(fontSize),
-        lineHeight: Number.parseFloat(lineHeight)
-      };
+      const fontSizeNum = Number.parseFloat(fontSize);
+      const lineHeightNum = Number.parseFloat(lineHeight);
+      // If it violates the rule:
+      if (lineHeightNum < 1.495 * fontSizeNum) {
+        // Increment the violation count.
+        violationCount++;
+        // If itemization is required:
+        if (withItems) {
+          // Get its bounding box.
+          const boxData = el.getBoundingClientRect();
+          ['x', 'y', 'width', 'height'].forEach(dimension => {
+            boxData[dimension] = Math.round(boxData[dimension]);
+          });
+          const {x, y, width, height} = boxData;
+          const fontSizeTrunc = fontSizeNum.toFixed(1);
+          const lineHeightTrunc = lineHeightNum.toFixed(1);
+          // Add data on the element to the violation items.
+          violationItems.push({
+            tagName: el.tagName,
+            id: el.id,
+            location: {
+              doc: 'dom',
+              type: 'box',
+              spec: {
+                x,
+                y,
+                width,
+                height
+              }
+            },
+            excerpt: el.textContent.trim(),
+            boxID: [x, y, width, height].join(':'),
+            pathID: window.getXPath(el),
+            fontSize: fontSizeTrunc,
+            lineHeight: lineHeightTrunc
+          });
+        }
+      }
+    });
+    return {
+      violationCount,
+      violationItems
+    };
+  }, withItems);
+  const {violationCount, violationItems} = violationData;
+  // Initialize the standard instances.
+  const standardInstances = [];
+  // If itemization is required:
+  if (withItems) {
+    // For each violation item:
+    violationItems.forEach(violationItem => {
+      // Add a standard instance.
+      const {tagName, id, location, excerpt, boxID, pathID, fontSize, lineHeight} = violationItem;
+      standardInstances.push({
+        ruleID: 'lineHeight',
+        what: `Element line height (${lineHeight}px) is less than 1.5 times its font size (${fontSize}px)`,
+        ordinalSeverity: 1,
+        tagName,
+        id,
+        location,
+        excerpt,
+        boxID,
+        pathID
+      });
+    });
+  }
+  // Otherwise, i.e. if itemization is not required:
+  else {
+    const {violationCount} = violationData;
+    // Summarize the violations.
+    standardInstances.push({
+      ruleID: 'lineHeight',
+      what: `Element line heights are less than 1.5 times their font sizes`,
+      ordinalSeverity: 1,
+      count: violationCount,
+      tagName: '',
+      id: '',
+      location: {
+        doc: '',
+        type: '',
+        spec: ''
+      },
+      excerpt: '',
+      boxID: '',
+      pathID: ''
     });
-    // If it does, after a grace margin for rounding:
-    const isBad = data.lineHeight < 1.49 * data.fontSize;
-    if (isBad) {
-      // Add the locator to the array of violators.
-      all.locs.push([loc, `font size ${data.fontSize} px, line height ${data.lineHeight} px`]);
-    }
   }
-  // Populate and return the result.
-  const whats = [
-    'Element line height is less than 1.5 times its font size (__param__)',
-    'Elements have line heights less than 1.5 times their font sizes'
-  ];
-  return await getRuleResult(withItems, all, 'lineHeight', whats, 1);
+  return {
+    data: {},
+    totals: [0, violationCount, 0, 0],
+    standardInstances
+  };
 };

package/validation/jobs/todo/README.md

@@ -2,7 +2,7 @@
 
 Directory containing jobs for validation.
 
-# License
+## License
 
 © 2022–2023 CVS Health and/or one of its affiliates. All rights reserved.
 

package/validation/watch/done/README.md

@@ -1,3 +1,7 @@
+# done
+
+Directory watched by executor `watchDir`.
+
 /*
   © 2023 CVS Health and/or one of its affiliates. All rights reserved.
 
@@ -21,7 +25,3 @@
   OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
   SOFTWARE.
 */
-
-# done
-
-Directory watched by executor `watchDir`.

package/validation/watch/todo/README.md

@@ -1,3 +1,7 @@
+# todo
+
+Directory watched by executor `watchDir`.
+
 /*
   © 2023 CVS Health and/or one of its affiliates. All rights reserved.
 
@@ -21,7 +25,3 @@
   OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
   SOFTWARE.
 */
-
-# todo
-
-Directory watched by executor `watchDir`.