Merged in audio-video-incomplete (pull request #122)

feat: change audio/video rule to report incomplete

Closes #285

Approved-by: Wilco Fiers <wilco.fiers@deque.com>

lib/checks/media/caption.js

@@ -1 +1,13 @@
-return !(node.querySelector('track[kind=captions]'));
+var tracks = node.querySelectorAll('track');
+if (tracks.length) {
+	for (var i=0; i<tracks.length; i++) {
+		var kind = tracks[i].getAttribute('kind');
+		if (kind && kind === 'captions') {
+			// only return for matching track, in case there are multiple
+			return false;
+		}
+	}
+	return true;
+}
+// for multiple track elements, return the first one that matches
+return undefined;

lib/checks/media/caption.json

@@ -5,7 +5,8 @@
     "impact": "critical",
     "messages": {
       "pass": "The multimedia element has a captions track",
-      "fail": "The multimedia element does not have a captions track"
+      "fail": "The multimedia element does not have a captions track",
+      "incomplete": "A captions track for this element could not be found"
     }
   }
 }

lib/checks/media/description.js

@@ -1 +1,12 @@
-return !(node.querySelector('track[kind=descriptions]'));
+var tracks = node.querySelectorAll('track');
+if (tracks.length) {
+	for (var i=0; i<tracks.length; i++) {
+		var kind = tracks[i].getAttribute('kind');
+		if (kind && kind === 'descriptions') {
+			// only return for matching track, in case there are multiple
+			return false;
+		}
+	}
+	return true;
+}
+return undefined;

lib/checks/media/description.json

@@ -5,7 +5,8 @@
     "impact": "serious",
     "messages": {
       "pass": "The multimedia element has an audio description track",
-      "fail": "The multimedia element does not have an audio description track"
+      "fail": "The multimedia element does not have an audio description track",
+      "incomplete": "An audio description track for this element could not be found"
     }
   }
 }

test/checks/media/caption.js

@@ -7,11 +7,11 @@ describe('caption', function () {
 		fixture.innerHTML = '';
 	});
 
-	it('should fail if there is no track element', function () {
+	it('should return undefined if there is no track element', function () {
 		fixture.innerHTML = '<audio></audio>';
 		var node = fixture.querySelector('audio');
 
-		assert.isTrue(checks.caption.evaluate(node));
+		assert.isUndefined(checks.caption.evaluate(node));
 	});
 
 	it('should fail if there is no kind=captions attribute', function () {

test/checks/media/description.js

@@ -7,11 +7,11 @@ describe('description', function () {
 		fixture.innerHTML = '';
 	});
 
-	it('should fail if there is no track element', function () {
+	it('should return undefined if there is no track element', function () {
 		fixture.innerHTML = '<video></video>';
 		var node = fixture.querySelector('video');
 
-		assert.isTrue(checks.description.evaluate(node));
+		assert.isUndefined(checks.description.evaluate(node));
 	});
 
 	it('should fail if there is no kind=descriptions attribute', function () {

test/integration/rules/audio-caption/audio-caption.json

@@ -1,6 +1,6 @@
 {
 	"description": "audio-caption test",
 	"rule": "audio-caption",
-	"violations": [["#empty"]],
+	"incomplete": [["#empty"]],
 	"passes": [["#caption"]]
 }

test/integration/rules/video-caption/video-caption.html

@@ -1,5 +1,4 @@
-
-<video id="fail1"></video>
-<video id="fail2"><track kind="descriptions"></video>
+<video id="incomplete1"></video>
+<video id="fail1"><track kind="descriptions"></video>
 <video id="pass1"><track kind="captions"></video>
 <video id="pass2"><track kind="descriptions"><track kind="captions"></video>

test/integration/rules/video-caption/video-caption.json

@@ -1,6 +1,7 @@
 {
 	"description": "video-caption test",
 	"rule": "video-caption",
-	"violations": [["#fail1"], ["#fail2"]],
+	"incomplete": [["#incomplete1"]],
+	"violations": [["#fail1"]],
 	"passes": [["#pass1"], ["#pass2"]]
 }

test/integration/rules/video-description/video-description.html

@@ -1,5 +1,5 @@
 
-<video id="fail1"></video>
-<video id="fail2"><track kind="captions"></video>
+<video id="incomplete1"></video>
+<video id="fail1"><track kind="captions"></video>
 <video id="pass1"><track kind="descriptions"></video>
 <video id="pass2"><track kind="descriptions"><track kind="captions"></video>

test/integration/rules/video-description/video-description.json

@@ -1,6 +1,7 @@
 {
 	"description": "video-description test",
 	"rule": "video-description",
-	"violations": [["#fail1"], ["#fail2"]],
+	"incomplete": [["#incomplete1"]],
+	"violations": [["#fail1"]],
 	"passes": [["#pass1"], ["#pass2"]]
 }