fix(core): headings with role doc-subtitle reported empty

- Allow the accessible name of role `doc-subtitle` to be computed from the element’s contents (in axe’s ARIA lookup table) see also w3c/dpub-aria#6 - Fix the case of field `nameFrom` in the DPUB ARIA lookup table - Add a regression test
daisy · May 25, 2018 · 7ad1373 · 7ad1373
1 parent 4a7d88f
commit 7ad1373
Show file tree

Hide file tree

Showing 7 changed files with 87 additions and 31 deletions.
diff --git a/packages/ace-core/src/scripts/axe-patch-arialookuptable.js b/packages/ace-core/src/scripts/axe-patch-arialookuptable.js
@@ -81,7 +81,7 @@
         allowed: ['aria-expanded'],
       },
       owned: null,
-      namefrom: ['author'],
+      nameFrom: ['author'],
       context: null,
     },
     'doc-colophon': {
@@ -90,7 +90,7 @@
         allowed: ['aria-expanded'],
       },
       owned: null,
-      namefrom: ['author'],
+      nameFrom: ['author'],
       context: null,
     },
     'doc-conclusion': {
@@ -99,7 +99,7 @@
         allowed: ['aria-expanded'],
       },
       owned: null,
-      namefrom: ['author'],
+      nameFrom: ['author'],
       context: null,
     },
     'doc-cover': {
@@ -108,7 +108,7 @@
         allowed: ['aria-expanded'],
       },
       owned: null,
-      namefrom: ['author'],
+      nameFrom: ['author'],
       context: null,
     },
     'doc-credit': {
@@ -117,7 +117,7 @@
         allowed: ['aria-expanded'],
       },
       owned: null,
-      namefrom: ['author'],
+      nameFrom: ['author'],
       context: null,
     },
     'doc-credits': {
@@ -126,7 +126,7 @@
         allowed: ['aria-expanded'],
       },
       owned: null,
-      namefrom: ['author'],
+      nameFrom: ['author'],
       context: null,
     },
     'doc-dedication': {
@@ -135,7 +135,7 @@
         allowed: ['aria-expanded'],
       },
       owned: null,
-      namefrom: ['author'],
+      nameFrom: ['author'],
       context: null,
     },
     'doc-endnote': {
@@ -144,7 +144,7 @@
         allowed: ['aria-expanded', 'aria-level', 'aria-posinset', 'aria-setsize'],
       },
       owned: null,
-      namefrom: ['author'],
+      nameFrom: ['author'],
       context: ['doc-endnotes'],
     },
     'doc-endnotes': {
@@ -153,7 +153,7 @@
         allowed: ['aria-expanded'],
       },
       owned: ['doc-endnote'],
-      namefrom: ['author'],
+      nameFrom: ['author'],
       context: null,
     },
     'doc-epigraph': {
@@ -162,7 +162,7 @@
         allowed: ['aria-expanded'],
       },
       owned: null,
-      namefrom: ['author'],
+      nameFrom: ['author'],
       context: null,
     },
     'doc-epilogue': {
@@ -171,7 +171,7 @@
         allowed: ['aria-expanded'],
       },
       owned: null,
-      namefrom: ['author'],
+      nameFrom: ['author'],
       context: null,
     },
     'doc-errata': {
@@ -180,7 +180,7 @@
         allowed: ['aria-expanded'],
       },
       owned: null,
-      namefrom: ['author'],
+      nameFrom: ['author'],
       context: null,
     },
     'doc-example': {
@@ -189,7 +189,7 @@
         allowed: ['aria-expanded'],
       },
       owned: null,
-      namefrom: ['author'],
+      nameFrom: ['author'],
       context: null,
     },
     'doc-footnote': {
@@ -198,7 +198,7 @@
         allowed: ['aria-expanded'],
       },
       owned: null,
-      namefrom: ['author'],
+      nameFrom: ['author'],
       context: null,
     },
     'doc-foreword': {
@@ -207,7 +207,7 @@
         allowed: ['aria-expanded'],
       },
       owned: null,
-      namefrom: ['author'],
+      nameFrom: ['author'],
       context: null,
     },
     'doc-glossary': {
@@ -216,7 +216,7 @@
         allowed: ['aria-expanded'],
       },
       owned: ['term', 'definition'],
-      namefrom: ['author'],
+      nameFrom: ['author'],
       context: null,
     },
     'doc-glossref': {
@@ -225,7 +225,7 @@
         allowed: ['aria-expanded'],
       },
       owned: null,
-      namefrom: ['author', 'contents'],
+      nameFrom: ['author', 'contents'],
       context: null,
     },
     'doc-index': {
@@ -234,7 +234,7 @@
         allowed: ['aria-expanded'],
       },
       owned: null,
-      namefrom: ['author'],
+      nameFrom: ['author'],
       context: null,
     },
     'doc-introduction': {
@@ -243,7 +243,7 @@
         allowed: ['aria-expanded'],
       },
       owned: null,
-      namefrom: ['author'],
+      nameFrom: ['author'],
       context: null,
     },
     'doc-noteref': {
@@ -252,7 +252,7 @@
         allowed: ['aria-expanded'],
       },
       owned: null,
-      namefrom: ['author', 'contents'],
+      nameFrom: ['author', 'contents'],
       context: null,
     },
     'doc-notice': {
@@ -261,7 +261,7 @@
         allowed: ['aria-expanded'],
       },
       owned: null,
-      namefrom: ['author'],
+      nameFrom: ['author'],
       context: null,
     },
     'doc-pagebreak': {
@@ -270,7 +270,7 @@
         allowed: ['aria-expanded'],
       },
       owned: null,
-      namefrom: ['author'],
+      nameFrom: ['author'],
       context: null,
     },
     'doc-pagelist': {
@@ -279,7 +279,7 @@
         allowed: ['aria-expanded'],
       },
       owned: null,
-      namefrom: ['author'],
+      nameFrom: ['author'],
       context: null,
     },
     'doc-part': {
@@ -288,7 +288,7 @@
         allowed: ['aria-expanded'],
       },
       owned: null,
-      namefrom: ['author'],
+      nameFrom: ['author'],
       context: null,
     },
     'doc-preface': {
@@ -297,7 +297,7 @@
         allowed: ['aria-expanded'],
       },
       owned: null,
-      namefrom: ['author'],
+      nameFrom: ['author'],
       context: null,
     },
     'doc-prologue': {
@@ -306,7 +306,7 @@
         allowed: ['aria-expanded'],
       },
       owned: null,
-      namefrom: ['author'],
+      nameFrom: ['author'],
       context: null,
     },
     'doc-pullquote': {
@@ -315,7 +315,7 @@
         allowed: ['aria-expanded'],
       },
       owned: null,
-      namefrom: ['author'],
+      nameFrom: ['author'],
       context: null,
     },
     'doc-qna': {
@@ -324,7 +324,7 @@
         allowed: ['aria-expanded'],
       },
       owned: null,
-      namefrom: ['author'],
+      nameFrom: ['author'],
       context: null,
     },
     'doc-subtitle': {
@@ -333,7 +333,7 @@
         allowed: ['aria-expanded'],
       },
       owned: null,
-      namefrom: ['author'],
+      nameFrom: ['author', 'contents'],
       context: null,
     },
     'doc-tip': {
@@ -342,7 +342,7 @@
         allowed: ['aria-expanded'],
       },
       owned: null,
-      namefrom: ['author'],
+      nameFrom: ['author'],
       context: null,
     },
     'doc-toc': {
@@ -351,7 +351,7 @@
         allowed: ['aria-expanded'],
       },
       owned: null,
-      namefrom: ['author'],
+      nameFrom: ['author'],
       context: null,
     },
   };

diff --git a/tests/__tests__/regression.test.js b/tests/__tests__/regression.test.js
@@ -70,3 +70,8 @@ test('issue #122: Failed to check HTML content with `.xml` extension', async ()
   const report = await ace('../data/issue-122');
   expect(report['earl:result']['earl:outcome']).toEqual('pass');
 });
+
+test('issue #170: heading with `doc-subtitle` role were reported empty', async () => {
+  const report = await ace('../data/issue-170');
+  expect(report['earl:result']['earl:outcome']).toEqual('pass');
+});
diff --git a/tests/data/issue-170/EPUB/content_001.xhtml b/tests/data/issue-170/EPUB/content_001.xhtml
@@ -0,0 +1,9 @@
+<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 epub:type="subtitle" role="doc-subtitle">Loomings</h1>
+<p>Call me Ishmael.</p>
+</body>
+</html>
diff --git a/tests/data/issue-170/EPUB/nav.xhtml b/tests/data/issue-170/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-170/EPUB/package.opf b/tests/data/issue-170/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-170/META-INF/container.xml b/tests/data/issue-170/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-170/mimetype b/tests/data/issue-170/mimetype
@@ -0,0 +1 @@
+application/epub+zip