fix: aria-describedby can be a list of IDs

- Do not fail when `aria-describedby` has a list of ID references. - Only the first ID is used to extract the description in the report Fixes #209
daisy · Jul 4, 2019 · f0aef4c · f0aef4c
1 parent a5452c3
commit f0aef4c
Show file tree

Hide file tree

Showing 9 changed files with 72 additions and 3 deletions.
diff --git a/packages/ace-core/src/scripts/ace-extraction.js b/packages/ace-core/src/scripts/ace-extraction.js
@@ -178,8 +178,9 @@ ace.getImages = function() {
     }
     let describedby = img.getAttribute('aria-describedby')
     if (describedby) {
-      let elem = document.getElementById(describedby);
-      imageObj.describedby = elem.innerText || elem.textContent;
+      var describedbyID = describedby.trim().replace(/\s{2,}/g, ' ').split(' ').shift();
+      let elem = document.getElementById(describedbyID);
+      if (elem) imageObj.describedby = elem.innerText || elem.textContent;
     }
     let figure = findFigure(img);
     if (figure) {

diff --git a/tests/__tests__/axe-rules.test.js b/tests/__tests__/axe-rules.test.js
@@ -186,7 +186,7 @@ test('Checks that `epub:type` have matching ARIA roles', async() => {
     })
   ]));
 });
-test('Checks that `epub:type` `cover` isn’t reported has missing a matching ARIA role', async() => {
+test.only('Checks that `epub:type` `cover` isn’t reported has missing a matching ARIA role', async() => {
   const report = await ace('../data/axerule-matching-dpub-role-cover');
   expect(report['earl:result']['earl:outcome']).toEqual('pass');
 });
diff --git a/tests/__tests__/regression.test.js b/tests/__tests__/regression.test.js
@@ -89,3 +89,15 @@ test('issue #182: named character references are parsed', async () => {
     })
   ]));
 });
+
+test('issue #209: `aria-describedby` can be a list of IDs', async () => {
+  const report = await ace('../data/issue-209');
+  expect(report.data).toEqual(expect.objectContaining({
+    "images": expect.arrayContaining([
+      expect.objectContaining({
+        "src": "EPUB/image_001.jpg",
+        "describedby": "description 1",
+      })
+    ])
+  }));
+});
diff --git a/tests/data/issue-209/EPUB/content_001.xhtml b/tests/data/issue-209/EPUB/content_001.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 EPUB</title>
+</head>
+<body>
+<h1>Loomings</h1>
+<p>Call me Ishmael.</p>
+<img id="img" src="image_001.jpg" alt="a fake image" aria-describedby="desc1 desc2"/>
+<p id="desc1">description 1</p>
+<p id="desc2">description 2</p>
+</body>
+</html>
diff --git a/tests/data/issue-209/EPUB/image_001.jpg b/tests/data/issue-209/EPUB/image_001.jpg
diff --git a/tests/data/issue-209/EPUB/nav.xhtml b/tests/data/issue-209/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-209/EPUB/package.opf b/tests/data/issue-209/EPUB/package.opf
@@ -0,0 +1,24 @@
+<?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"/>
+  <item id="image_001"  href="image_001.jpg" media-type="image/jpeg"/>
+</manifest>
+<spine>
+  <itemref idref="content_001" />
+</spine>
+</package>
diff --git a/tests/data/issue-209/META-INF/container.xml b/tests/data/issue-209/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-209/mimetype b/tests/data/issue-209/mimetype
@@ -0,0 +1 @@
+application/epub+zip