testaro 18.6.0 → 18.7.0

package/package.json

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

package/testaro/autocomplete.js

@@ -5,12 +5,14 @@
 
 // ########## IMPORTS
 
+// Module to perform common operations.
+const {init, report} = require('../procs/testaro');
 // Module to get locator data.
 const {getLocatorData} = require('../procs/getLocatorData');
 
 // ########## FUNCTIONS
 
-// Runs the test and returns the results.
+// Runs the test and returns the result.
 exports.reporter = async (
   page,
   withItems,
@@ -18,23 +20,18 @@ exports.reporter = async (
   familyLabels = ['last name', 'surname', 'family name'],
   emailLabels = ['email']
 ) => {
+  // Initialize the locators and result.
+  const all = await init(page, 'input[type=text], input[type=email], input:not([type])');
+  // For each locator:
   const autoValues = {
     'given-name': givenLabels,
     'family-name': familyLabels,
     'email': emailLabels
   };
-  // Get locators for all input elements of type text or email.
-  const locAll = page.locator('input[type=text], input[type=email], input:not([type])');
-  const locsAll = await locAll.all();
-  // Initialize the result.
-  const data = {};
-  const totals = [0, 0, 0, 0];
-  const standardInstances = [];
-  // For each of the inputs:
-  for (const loc of locsAll) {
-    // If it requires an autocomplete attribute but does not have it:
-    const data = await getLocatorData(loc);
-    const lcText = data.excerpt.toLowerCase();
+  for (const loc of all.allLocs) {
+    // Get which autocomplete value, if any, its element needs.
+    const elData = await getLocatorData(loc);
+    const lcText = elData.excerpt.toLowerCase();
     const neededAutos = Object.keys(autoValues)
     .filter(autoValue => autoValues[autoValue].some(typeLabel => lcText.includes(typeLabel)));
     let neededAuto;
@@ -44,49 +41,21 @@ exports.reporter = async (
     else if (! neededAutos.length && await loc.getAttribute('type') === 'email') {
       neededAuto = 'email';
     }
+    // If it needs one:
     if (neededAuto) {
+      // If it does not have the one it needs:
       const actualAuto = await loc.getAttribute('autocomplete');
-      if (actualAuto !== neededAuto) {
-        // Add to the totals.
-        totals[2]++;
-        // If itemization is required:
-        if (withItems) {
-          // Add a standard instance.
-          standardInstances.push({
-            ruleID: 'autocomplete',
-            what: `Input is missing an autocomplete attribute with value ${neededAuto}`,
-            ordinalSeverity: 2,
-            tagName: 'INPUT',
-            id: data.id,
-            location: data.location,
-            excerpt: data.excerpt
-          });
-        }
+      const isBad = actualAuto !== neededAuto;
+      if (isBad) {
+        // Add the locator to the array of violators.
+        all.locs.push([loc, neededAuto]);
       }
     }
   }
-  // If itemization is not required and there are any instances:
-  if (! withItems && totals[2]) {
-    // Add a summary standard instance.
-    standardInstances.push({
-      ruleID: 'autocomplete',
-      what: 'Inputs are missing applicable autocomplete attributes',
-      ordinalSeverity: 2,
-      count: totals[2],
-      tagName: 'INPUT',
-      id: '',
-      location: {
-        doc: '',
-        type: '',
-        spec: ''
-      },
-      excerpt: ''
-    });
-  }
-  // Return the data.
-  return {
-    data,
-    totals,
-    standardInstances
-  };
+  // Populate and return the result.
+  const whats = [
+    'Input is missing an autocomplete attribute with value __param__',
+    'Inputs are missing applicable autocomplete attributes'
+  ];
+  return await report(withItems, all, 'autocomplete', whats, 2);
 };

package/testaro/buttonMenu.js

@@ -104,6 +104,7 @@ exports.reporter = async (page, withItems, trialKeySpecs = []) => {
   const mbLocAll = page.locator(
     'button[aria-controls][aria-expanded][aria-haspopup=true], button[aria-controls][aria-expanded][aria-haspopup=menu]'
   );
+  // For each menu button:
   const mbLocsAll = await mbLocAll.all();
   for (const mbLoc of mbLocsAll) {
     // Get a locator for its menu.