testaro 18.5.0 → 18.6.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "testaro",
-  "version": "18.5.0",
+  "version": "18.6.0",
   "description": "Run 920 web accessibility tests from 9 tools and get a standardized report",
   "main": "index.js",
   "scripts": {

package/procs/testaro.js

@@ -8,9 +8,9 @@ const {getLocatorData} = require('../procs/getLocatorData');
 // ########## FUNCTIONS
 
 // Initializes locators and a result.
-exports.init = async (page, locAllSelector) => {
+exports.init = async (page, locAllSelector, options = {}) => {
   // Get locators for the specified elements.
-  const locAll = page.locator(locAllSelector);
+  const locAll = page.locator(locAllSelector, options);
   const allLocs = await locAll.all();
   const result = {
     data: {},
@@ -30,8 +30,16 @@ exports.report = async (withItems, all, ruleID, whats, ordinalSeverity, tagName
   const {locs, result} = all;
   const {totals, standardInstances} = result;
   // For each instance locator:
-  for (const loc of locs) {
+  for (const locItem of locs) {
     // Get data on its element.
+    let loc, whatParam;
+    if (Array.isArray(locItem)) {
+      loc = locItem[0];
+      whatParam = locItem[1];
+    }
+    else {
+      loc = locItem;
+    }
     const elData = await getLocatorData(loc);
     // Add to the totals.
     totals[ordinalSeverity]++;
@@ -40,7 +48,7 @@ exports.report = async (withItems, all, ruleID, whats, ordinalSeverity, tagName
       // Add a standard instance to the result.
       standardInstances.push({
         ruleID,
-        what: whats[0],
+        what: whatParam ? whats[0].replace('__param__', whatParam) : whats[0],
         ordinalSeverity,
         tagName: elData.tagName,
         id: elData.id,
@@ -49,8 +57,8 @@ exports.report = async (withItems, all, ruleID, whats, ordinalSeverity, tagName
       });
     }
   }
-  // If itemization is not required:
-  if (! withItems) {
+  // If itemization is not required and any instances exist:
+  if (! withItems && locs.length) {
     // Add a summary standard instance to the result.
     standardInstances.push({
       ruleID,

package/testaro/allCaps.js

@@ -1,96 +1,50 @@
 /*
   allCaps
   Related to Tenon rule 153.
-  This test reports normalized text nodes containing at least one substring of upper-case letters,
-  hyphen-minuses, and spaces at least 8 characters long. Blocks of upper-case text are difficult
-  to read.
+  This test reports elements with native or transformed upper-case text at least 8 characters long.
+  Blocks of upper-case text are difficult to read.
 */
 
 // ########## IMPORTS
 
-// Module to get text nodes.
-const {getTextNodes} = require('../procs/getTextNodes');
+// Module to perform common operations.
+const {init, report} = require('../procs/testaro');
 
 // ########## FUNCTIONS
 
-// Runs the test and returns the results.
+// Runs the test and returns the result.
 exports.reporter = async (page, withItems) => {
-  // Get the text nodes of the page and their parent elements.
-  const textNodesData = await getTextNodes(page);
-  // Get data on the qualifying text nodes.
-  const result = await textNodesData.evaluate((textNodesData, withItems) => {
-    // Initialize the result.
-    const result = {
-      data: {},
-      totals: [0, 0, 0, 0],
-      standardInstances: []
-    };
-    // For each text node:
-    for (const textNodeData of textNodesData) {
-      // If it qualifies:
-      let isCap = false;
-      if (/[- A-Z]{8}/.test(textNodeData[0])) {
-        isCap = true;
+  // Initialize the locators and result.
+  const all = await init(page, 'body *:not(style):not(script):not(svg)');
+  // For each locator:
+  for (const loc of all.allLocs) {
+    // Get whether its element violates the rule.
+    const isBad = await loc.evaluate(el => {
+      const elText = Array
+      .from(el.childNodes)
+      .filter(node => node.nodeType === Node.TEXT_NODE)
+      .map(textNode => textNode.nodeValue)
+      .join(' ');
+      // If the element text includes 8 sequential upper-case letters, spaces, or hyphen-minuses:
+      if (/[- A-Z]{8}/.test(elText)) {
+        // Report this.
+        return true;
       }
-      else if (/[- A-Za-z]{8}/.test(textNodeData[0])) {
-        const styleDec = window.getComputedStyle(textNodeData[1]);
-        if (styleDec.textTransform === 'uppercase') {
-          isCap = true;
-        }
+      // Otherwise:
+      else {
+        // Report whether its text is at least 8 characters long and transformed to upper case.
+        const elStyleDec = window.getComputedStyle(el);
+        const transformStyle = elStyleDec.textTransform;
+        return transformStyle === 'uppercase' && elText.length > 7;
       }
-      if (isCap) {
-        // Add to the totals.
-        result.totals[0]++;
-        // If itemization is required:
-        if (withItems) {
-          // Add a standard instance.
-          const {id} = textNodeData[1];
-          let spec;
-          if (id) {
-            spec = `#${id}`;
-          }
-          else {
-            const domRect = textNodeData[1].getBoundingClientRect();
-            spec = {
-              x: Math.round(domRect.x),
-              y: Math.round(domRect.y),
-              width: Math.round(domRect.width),
-              height: Math.round(domRect.height)
-            };
-          }
-          result.standardInstances.push({
-            ruleID: 'allCaps',
-            what: 'Text is entirely upper-case',
-            ordinalSeverity: 0,
-            tagName: textNodeData[1].tagName,
-            id: id || '',
-            location: {
-              doc: 'dom',
-              type: id ? 'selector' : 'box',
-              spec
-            },
-            excerpt: textNodeData[0]
-          });
-        }
-      }
-    }
-    return result;
-  }, withItems);
-  if (! withItems) {
-    result.standardInstances.push({
-      ruleID: 'allCaps',
-      what: 'Texts are entirely upper-case',
-      ordinalSeverity: 0,
-      count: result.totals[0],
-      tagName: '',
-      id: '',
-      location: {
-        doc: '',
-        type: '',
-        spec: ''
-      },
-      excerpt: ''
     });
+    // If it does:
+    if (isBad) {
+      // Add the locator to the array of violators.
+      all.locs.push(loc);
+    }
   }
-  return result;
+  // Populate and return the result.
+  const whats = ['Element contains all-capital text', 'Elements contain all-capital text'];
+  return await report(withItems, all, 'allCaps', whats, 0);
 };

package/testaro/allSlanted.js

@@ -1,93 +1,39 @@
 /*
   allSlanted
   Related to Tenon rule 154.
-  This test reports normalized text nodes containing at least one substring of italic or
-  oblique characters at least 40 characters long. Blocks of slanted text are difficult
-  to read.
+  This test reports elements with italic or oblique text at least 40 characters long. Blocks of
+  slanted text are difficult to read.
 */
 
 // ########## IMPORTS
 
-// Module to get text nodes.
-const {getTextNodes} = require('../procs/getTextNodes');
+// Module to perform common operations.
+const {init, report} = require('../procs/testaro');
 
 // ########## FUNCTIONS
 
-// Runs the test and returns the results.
+// Runs the test and returns the result.
 exports.reporter = async (page, withItems) => {
-  // Get the text nodes of the page and their parent elements.
-  const textNodesData = await getTextNodes(page);
-  // Get data on the qualifying text nodes.
-  const result = await textNodesData.evaluate((textNodesData, withItems) => {
-    // Initialize the result.
-    const result = {
-      data: {},
-      totals: [0, 0, 0, 0],
-      standardInstances: []
-    };
-    // For each text node:
-    for (const textNodeData of textNodesData) {
-      // If it qualifies:
-      let isSlanted = false;
-      if (/.{40}/.test(textNodeData[0])) {
-        const styleDec = window.getComputedStyle(textNodeData[1]);
-        if (['italic', 'oblique'].includes(styleDec.fontStyle)) {
-          isSlanted = true;
-        }
-      }
-      if (isSlanted) {
-        // Add to the totals.
-        result.totals[0]++;
-        // If itemization is required:
-        if (withItems) {
-          // Add a standard instance.
-          const {id} = textNodeData[1];
-          let spec;
-          if (id) {
-            spec = `#${id}`;
-          }
-          else {
-            const domRect = textNodeData[1].getBoundingClientRect();
-            spec = {
-              x: Math.round(domRect.x),
-              y: Math.round(domRect.y),
-              width: Math.round(domRect.width),
-              height: Math.round(domRect.height)
-            };
-          }
-          result.standardInstances.push({
-            ruleID: 'allSlanted',
-            what: 'Text is entirely italic or oblique',
-            ordinalSeverity: 0,
-            tagName: textNodeData[1].tagName,
-            id: id || '',
-            location: {
-              doc: 'dom',
-              type: id ? 'selector' : 'box',
-              spec
-            },
-            excerpt: textNodeData[0]
-          });
-        }
-      }
-    }
-    return result;
-  }, withItems);
-  if (! withItems) {
-    result.standardInstances.push({
-      ruleID: 'allSlanted',
-      what: 'Texts are entirely italic or oblique',
-      ordinalSeverity: 0,
-      count: result.totals[0],
-      tagName: '',
-      id: '',
-      location: {
-        doc: '',
-        type: '',
-        spec: ''
-      },
-      excerpt: ''
+  // Initialize the locators and result.
+  const all = await init(page, 'body *:not(style):not(script):not(svg)');
+  // For each locator:
+  for (const loc of all.allLocs) {
+    // Get whether its element violates the rule.
+    const isBad = await loc.evaluate(el => {
+      const elStyleDec = window.getComputedStyle(el);
+      const elText = el.textContent;
+      return ['italic', 'oblique'].includes(elStyleDec.fontStyle) && elText.length > 39;
     });
+    // If it does:
+    if (isBad) {
+      // Add the locator to the array of violators.
+      all.locs.push(loc);
+    }
   }
-  return result;
+  // Populate and return the result.
+  const whats = [
+    'Element contains all-italic or all-oblique text',
+    'Elements contain all-italic or all-oblique text'
+  ];
+  return await report(withItems, all, 'allSlanted', whats, 0);
 };

package/testaro/attVal.js

@@ -5,69 +5,30 @@
 
 // ########## IMPORTS
 
-// Module to get locator data.
-const {getLocatorData} = require('../procs/getLocatorData');
+// Module to perform common operations.
+const {init, report} = require('../procs/testaro');
 
 // ########## FUNCTIONS
 
-// Runs the test and returns the results.
+// Runs the test and returns the result.
 exports.reporter = async (page, withItems, attributeName, areLicit, values) => {
-  // Get locators for all elements with the attribute.
-  const locAll = page.locator(`[${attributeName}]`);
-  const locsAll = await locAll.all();
-  const locs = [];
-  // Get those that have illicit values on the attribute.
-  for (const loc of locsAll) {
+  // Initialize the locators and result.
+  const all = await init(page, `[${attributeName}]`);
+  // For each locator:
+  for (const loc of all.allLocs) {
+    // Get whether its element violates the rule.
     const value = await loc.getAttribute(attributeName);
-    if (areLicit !== values.includes(value)) {
-      locs.push(loc);
+    const isBad = areLicit !== values.includes(value);
+    // If it does:
+    if (isBad) {
+      // Add the locator to the array of violators.
+      all.locs.push([loc, value]);
     }
   }
-  // Initialize the results.
-  const data = {};
-  const totals = [0, 0, locs.length, 0];
-  const standardInstances = [];
-  // If itemization is required:
-  if (withItems) {
-    // For each qualifying locator:
-    for (const loc of locs) {
-      // Get data on its element.
-      const elData = await getLocatorData(loc);
-      // Get the illicit value of the attribute.
-      const badValue = await loc.getAttribute(attributeName);
-      // Add a standard instance.
-      standardInstances.push({
-        ruleID: 'attVal',
-        what: `Element has attribute ${attributeName} with illicit value ${badValue}`,
-        ordinalSeverity: 2,
-        tagName: elData.tagName,
-        id: elData.id,
-        location: elData.location,
-        excerpt: elData.excerpt
-      });
-    }
-  }
-  // Otherwise, i.e. if itemization is not required and any instances exist:
-  else if (totals[2]) {
-    // Add a summary standard instance.
-    standardInstances.push({
-      ruleID: 'attVal',
-      what: `Elements have attribute ${attributeName} with illicit values`,
-      ordinalSeverity: 2,
-      count: totals[2],
-      tagName: '',
-      id: '',
-      location: {
-        doc: '',
-        type: '',
-        spec: ''
-      },
-      excerpt: ''
-    });
-  }
-  return {
-    data,
-    totals,
-    standardInstances
-  };
+  // Populate and return the result.
+  const whats = [
+    `Element has attribute ${attributeName} with illicit value “__param__”`,
+    `Elements have attribute ${attributeName} with illicit values`
+  ];
+  return await report(withItems, all, 'attVal', whats, 2);
 };

package/testaro/distortion.js

@@ -12,7 +12,7 @@ const {init, report} = require('../procs/testaro');
 
 // ########## FUNCTIONS
 
-// Runs the test and returns the results.
+// Runs the test and returns the result.
 exports.reporter = async (page, withItems) => {
   // Initialize the locators and result.
   const all = await init(page, 'body *');

package/testaro/template.js

@@ -10,7 +10,7 @@ const {init, report} = require('../procs/testaro');
 
 // ########## FUNCTIONS
 
-// Runs the test and returns the results.
+// Runs the test and returns the result.
 exports.reporter = async (page, withItems) => {
   // Initialize the locators and result.
   const all = await init(page, 'body *');

package/validation/tests/jobs/allCaps.json

@@ -30,6 +30,16 @@
           "=",
           0
         ],
+        [
+          "standardResult.instances.0.ruleID",
+          "=",
+          "allCaps"
+        ],
+        [
+          "standardResult.instances.0.what",
+          "i",
+          "Element contains"
+        ],
         [
           "standardResult.instances.0.tagName",
           "=",
@@ -112,6 +122,11 @@
           "=",
           0
         ],
+        [
+          "standardResult.instances.0.what",
+          "i",
+          "Elements contain"
+        ],
         [
           "standardResult.instances.0.count",
           "=",

package/validation/tests/jobs/allSlanted.json

@@ -30,6 +30,16 @@
           "=",
           0
         ],
+        [
+          "standardResult.instances.0.ruleID",
+          "=",
+          "allSlanted"
+        ],
+        [
+          "standardResult.instances.0.what",
+          "i",
+          "Element contains"
+        ],
         [
           "standardResult.instances.0.tagName",
           "=",
@@ -40,11 +50,6 @@
           "=",
           0
         ],
-        [
-          "standardResult.instances.0.what",
-          "i",
-          "Text is entirely"
-        ],
         [
           "standardResult.instances.0.location.type",
           "=",

package/validation/tests/jobs/attVal.json

@@ -88,7 +88,7 @@
         [
           "standardResult.instances.0.what",
           "i",
-          "illicit value en"
+          "Element has attribute"
         ],
         [
           "standardResult.instances.0.location.doc",