fix(aXe): description list item does not have a <dl> parent

aXe v2.x uses an equality check based on the uppercase `tagName` property, but this latter is case-sensitive in XHTML. This change patches aXe until a PR is submitted to fix dequelabs/axe-core#581 Fixes #114
daisy · Dec 13, 2017 · 4c0afdd · 4c0afdd
1 parent 03e3a3e
commit 4c0afdd
Show file tree

Hide file tree

Showing 8 changed files with 75 additions and 0 deletions.
diff --git a/packages/ace-core/src/checker/checker-chromium.js b/packages/ace-core/src/checker/checker-chromium.js
@@ -14,6 +14,7 @@ const scripts = [
   require.resolve('../scripts/vendor/outliner.min.js'),
   require.resolve('../scripts/axe-patch-getselector.js'),
   require.resolve('../scripts/axe-patch-arialookuptable.js'),
+  require.resolve('../scripts/axe-patch-dlitem.js'),
   require.resolve('../scripts/ace-axe.js'),
   require.resolve('../scripts/ace-extraction.js'),
 ];

diff --git a/packages/ace-core/src/scripts/axe-patch-dlitem.js b/packages/ace-core/src/scripts/axe-patch-dlitem.js
@@ -0,0 +1,8 @@
+'use strict';
+
+(function axePatch(window) {
+  const axe = window.axe;
+  axe._audit.checks.dlitem.evaluate = function evaluate(node, options) {
+    return node.parentNode.nodeName.toUpperCase() === 'DL';
+  }
+}(window));
diff --git a/tests/__tests__/regression.test.js b/tests/__tests__/regression.test.js
@@ -61,3 +61,8 @@ test('issue #108: HTML5Outline is not defined (RequireJS conflict)', async () =>
   const report = await ace('../data/issue-108');
   expect(report['earl:result']['earl:outcome']).toEqual('pass');
 });
+
+test('issue #114: Description list item does not have a <dl> parent element', async () => {
+  const report = await ace('../data/issue-114');
+  expect(report['earl:result']['earl:outcome']).toEqual('pass');
+});
diff --git a/tests/data/issue-114/EPUB/content_001.xhtml b/tests/data/issue-114/EPUB/content_001.xhtml
@@ -0,0 +1,19 @@
+<html xmlns="http://www.w3.org/1999/xhtml" xmlns:epub="http://www.idpf.org/2007/ops" xml:lang="en">
+<head>
+<title>Minimal EPUB</title>
+<script src="../../../../node_modules/axe-core/axe.js"></script>
+</head>
+<body>
+<h1>Loomings</h1>
+<p>Call me Ishmael.</p>
+<dl>
+  <dt>term</dt>
+  <dd>def</dd>
+</dl>
+<script>
+  window.axe.run({ runOnly: { type: 'rule', values: ['dlitem'] } }, function (err, results) {
+      console.log(results);
+    });
+</script>
+</body>
+</html>
diff --git a/tests/data/issue-114/EPUB/nav.xhtml b/tests/data/issue-114/EPUB/nav.xhtml
@@ -0,0 +1,12 @@
+<html xmlns="http://www.w3.org/1999/xhtml" xmlns:epub="http://www.idpf.org/2007/ops" xml:lang="en">
+<head>
+<title>Minimal Nav</title>
+</head>
+<body>
+<nav epub:type="toc">
+<ol>
+<li><a href="content_001.xhtml">content 001</a></li>
+</ol>
+</nav>
+</body>
+</html>
diff --git a/tests/data/issue-114/EPUB/package.opf b/tests/data/issue-114/EPUB/package.opf
@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<package xmlns="http://www.idpf.org/2007/opf" version="3.0" xml:lang="en" unique-identifier="uid">
+<metadata xmlns:dc="http://purl.org/dc/elements/1.1/">
+  <dc:title id="title">Minimal EPUB 3.0</dc:title>
+  <dc:language>en</dc:language>
+  <dc:identifier id="uid">NOID</dc:identifier>
+  <meta property="dcterms:modified">2017-01-01T00:00:01Z</meta>
+  <meta property="schema:accessibilityFeature">structuralNavigation</meta>
+  <meta property="schema:accessibilitySummary">everything OK!</meta>
+  <meta property="schema:accessibilityHazard">noFlashingHazard</meta>
+  <meta property="schema:accessibilityHazard">noSoundHazard</meta>
+  <meta property="schema:accessibilityHazard">noMotionSimulationHazard</meta>
+  <meta property="schema:accessMode">textual</meta>
+  <meta property="schema:accessModeSufficient">textual</meta>
+</metadata>
+<manifest>
+  <item id="nav"  href="nav.xhtml" media-type="application/xhtml+xml" properties="nav"/>
+  <item id="content_001"  href="content_001.xhtml" media-type="application/xhtml+xml"/>
+</manifest>
+<spine>
+  <itemref idref="content_001" />
+</spine>
+</package>
diff --git a/tests/data/issue-114/META-INF/container.xml b/tests/data/issue-114/META-INF/container.xml
@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<container version="1.0" xmlns="urn:oasis:names:tc:opendocument:xmlns:container">
+   <rootfiles>
+      <rootfile full-path="EPUB/package.opf" media-type="application/oebps-package+xml"/>
+   </rootfiles>
+</container>
diff --git a/tests/data/issue-114/mimetype b/tests/data/issue-114/mimetype
@@ -0,0 +1 @@
+application/epub+zip