Merge pull request #108 from kevee/hotfix

Hotfix - add test results per issue #99
quailjs · Jan 12, 2014 · 4fc83b9 · 4fc83b9
2 parents 37b8d80 + e0c5fba
commit 4fc83b9
Show file tree

Hide file tree

Showing 40 changed files with 61 additions and 58 deletions.
diff --git a/README.md b/README.md
@@ -45,4 +45,4 @@ Credits
 Legal
 -----
 
-QUAIL is covered under the MIT License, and is copyright (c) 2013 by Kevin Miller. Current license is at http://quailjs.org/license.
+QUAIL is covered under the MIT License, and is copyright (c) 2013 by Kevin Miller. Current license is at http://quailjs.org/license.
diff --git a/bower.json b/bower.json
@@ -1,7 +1,7 @@
 {
   "name": "quail",
   "version": "2.1.0",
-  "main": "dist/quail.jquery.js",
+  "main": "dist/*",
   "ignore": [
     ".jshintrc",
     "**/*.txt"

diff --git a/dist/quail.jquery.js b/dist/quail.jquery.js
@@ -99,8 +99,7 @@ var quail = {
       var results = {totals : {severe : 0, moderate : 0, suggestion : 0 },
                     results : quail.accessibilityResults };
       $.each(results.results, function(testName, result) {
-        results.totals[quail.testabilityTranslation[quail.accessibilityTests[testName].testability]] += result.length;
-      });
+        results.totals[quail.testabilityTranslation[quail.accessibilityTests[testName].testability]] += result.elements.length;      });
       quail.options.complete(results);
     }
   },
@@ -129,14 +128,15 @@ var quail = {
       }
     }
 
-    quail.accessibilityResults[testName].push($element);
+    quail.accessibilityResults[testName].elements.push($element);
     if(typeof quail.options.testFailed !== 'undefined') {
       var testability = (typeof quail.accessibilityTests[testName].testability !== 'undefined') ?
                      quail.accessibilityTests[testName].testability :
                      'unknown';
       var severity = 
       quail.options.testFailed({element  : $element,
                              testName    : testName,
+                             test        : quail.accessibilityTests[testName],
                              testability : testability,
                              severity    : quail.testabilityTranslation[testability],
                              options     : options
@@ -157,7 +157,7 @@ var quail = {
       }
       var testType = quail.accessibilityTests[testName].type;
       if(typeof quail.accessibilityResults[testName] === 'undefined') {
-        quail.accessibilityResults[testName] = [ ];
+        quail.accessibilityResults[testName] = { test : quail.accessibilityTests[testName], elements : [ ] };
       }
       if(testType === 'selector') {
         quail.html.find(quail.accessibilityTests[testName].selector).each(function() {

diff --git a/dist/quail.jquery.min.js b/dist/quail.jquery.min.js
diff --git a/docs/tests/imgAltNotPlaceHolder.rst b/docs/tests/imgAltNotPlaceHolder.rst
@@ -9,10 +9,13 @@ Images should not have a simple placeholder text as an "alt" attribute
 
 Any image that is not used decorativey or which is purely for layout purposes cannot have an "alt" attribute that consists solely of placeholders. Placeholders include:
 
+* nbsp
+* &nbsp;
+* spacer
+* image
+* img
+* photo
 
-
-<ul><li>nbsp</li><li>&amp;nbsp;</li><li>spacer</li><li>image</li><li>img</li><li>photo</li></ul>Example
--------
 Wrong
 -----
 

diff --git a/package.json b/package.json
@@ -2,7 +2,7 @@
   "name": "quail",
   "description": "A javascript content accessibility checker.",
   "homepage": "http://quailjs.org",
-  "version": "2.1.0",
+  "version": "2.1.1",
   "engines": {
     "node": ">= 0.10.20"
   },

diff --git a/quail.jquery.json b/quail.jquery.json
@@ -6,7 +6,7 @@
 	"homepage": "http://quailjs.org",
 	"docs": "http://quail.readthedocs.org/en/latest/",
 	"demo": "http://quailjs.org/examples/",
-	"version": "2.1.0",
+	"version": "2.1.1",
 	"author": {
  		"name": "Kevin Miller",
 		"email": "[email protected]",

diff --git a/quail.json b/quail.json
@@ -2,7 +2,7 @@
   "name": "quail",
   "title": "Quail",
   "description": "QUAIL Accessibility Information Library.",
-  "version": "2.1.0",
+  "version": "2.1.1",
   "homepage": "https://github.com/kevee/quail",
   "author": {
     "name": "Kevin Miller",

diff --git a/src/js/core.js b/src/js/core.js
@@ -97,8 +97,7 @@ var quail = {
       var results = {totals : {severe : 0, moderate : 0, suggestion : 0 },
                     results : quail.accessibilityResults };
       $.each(results.results, function(testName, result) {
-        results.totals[quail.testabilityTranslation[quail.accessibilityTests[testName].testability]] += result.length;
-      });
+        results.totals[quail.testabilityTranslation[quail.accessibilityTests[testName].testability]] += result.elements.length;      });
       quail.options.complete(results);
     }
   },
@@ -127,14 +126,15 @@ var quail = {
       }
     }
 
-    quail.accessibilityResults[testName].push($element);
+    quail.accessibilityResults[testName].elements.push($element);
     if(typeof quail.options.testFailed !== 'undefined') {
       var testability = (typeof quail.accessibilityTests[testName].testability !== 'undefined') ?
                      quail.accessibilityTests[testName].testability :
                      'unknown';
       var severity = 
       quail.options.testFailed({element  : $element,
                              testName    : testName,
+                             test        : quail.accessibilityTests[testName],
                              testability : testability,
                              severity    : quail.testabilityTranslation[testability],
                              options     : options
@@ -155,7 +155,7 @@ var quail = {
       }
       var testType = quail.accessibilityTests[testName].type;
       if(typeof quail.accessibilityResults[testName] === 'undefined') {
-        quail.accessibilityResults[testName] = [ ];
+        quail.accessibilityResults[testName] = { test : quail.accessibilityTests[testName], elements : [ ] };
       }
       if(testType === 'selector') {
         quail.html.find(quail.accessibilityTests[testName].selector).each(function() {

diff --git a/test/composite.js b/test/composite.js
@@ -27,36 +27,36 @@ var quailTest = {
                       reset : true,
                       accessibilityTests : accessibilityTests,
                       complete : function(results) {
-                        $.each(results.results[testName], function(index, item) {
+                        $.each(results.results[testName].elements, function(index, item) {
                           if(typeof item === 'undefined' ||
                              (item && item.attr('id') && item.attr('id').indexOf('qunit-') !== -1) ||
                              item.parents('#qunit-wrapper').length) {
-                            results.results[testName].splice(index, 1);
+                            results.results[testName].elements.splice(index, 1);
                           }
                         });
                         quailTest.results = results.results;
                       }});
   },
 
   confirmIsEmpty : function() {
-    $.each(quailTest.results[quailTest.testName], function(index, item) {
+    $.each(quailTest.results[quailTest.testName].elements, function(index, item) {
       if(typeof item === 'undefined' ||
          (item && item.attr('id') && item.attr('id').indexOf('qunit-') !== -1) ||
          item.parents('#qunit-wrapper').length) {
-        quailTest.results[quailTest.testName].splice(index, 1);
+        quailTest.results[quailTest.testName].elements.splice(index, 1);
       }
     });
-    if(quailTest.results[quailTest.testName].length) {
+    if(quailTest.results[quailTest.testName].elements.length) {
       return false;
     }
     return true;
   },
 
   confirmIsTag : function(tag) {
-    if(typeof quailTest.results[quailTest.testName][0] === 'undefined') {
+    if(typeof quailTest.results[quailTest.testName].elements[0] === 'undefined') {
       return false;
     }
-    return quailTest.results[quailTest.testName][0].is(tag);
+    return quailTest.results[quailTest.testName].elements[0].is(tag);
   },
 
   insertElements : function(callback) {

diff --git a/test/testfiles/common/aLinksToMultiMediaRequireTranscript-fail-2.html b/test/testfiles/common/aLinksToMultiMediaRequireTranscript-fail-2.html
@@ -16,7 +16,7 @@
         <script id="qunit-script">
             test('aLinksToMultiMediaRequireTranscript', function() {
               quailTest.runTest( 'aLinksToMultiMediaRequireTranscript', '20-3.html');
-              equal(quailTest.results[quailTest.testName][0].attr('href'), 'movie.mpg', 'Item attribute check');
+              equal(quailTest.results[quailTest.testName].elements[0].attr('href'), 'movie.mpg', 'Item attribute check');
             });
         </script>
     </body>

diff --git a/test/testfiles/common/aLinksToMultiMediaRequireTranscript-fail-3.html b/test/testfiles/common/aLinksToMultiMediaRequireTranscript-fail-3.html
@@ -16,7 +16,7 @@
         <script id="qunit-script">
             test('aLinksToMultiMediaRequireTranscript', function() {
               quailTest.runTest( 'aLinksToMultiMediaRequireTranscript', '20-4.html');
-              equal(quailTest.results[quailTest.testName][0].attr('href'), 'movie.mov', 'Item attribute check');
+              equal(quailTest.results[quailTest.testName].elements[0].attr('href'), 'movie.mov', 'Item attribute check');
             });
         </script>
     </body>

diff --git a/test/testfiles/common/aLinksToMultiMediaRequireTranscript-fail-4.html b/test/testfiles/common/aLinksToMultiMediaRequireTranscript-fail-4.html
@@ -16,7 +16,7 @@
         <script id="qunit-script">
             test('aLinksToMultiMediaRequireTranscript', function() {
               quailTest.runTest( 'aLinksToMultiMediaRequireTranscript', '20-5.html');
-              equal(quailTest.results[quailTest.testName][0].attr('href'), 'movie.ram', 'Item attribute check');
+              equal(quailTest.results[quailTest.testName].elements[0].attr('href'), 'movie.ram', 'Item attribute check');
             });
         </script>
     </body>

diff --git a/test/testfiles/common/aLinksToMultiMediaRequireTranscript-fail-5.html b/test/testfiles/common/aLinksToMultiMediaRequireTranscript-fail-5.html
@@ -16,7 +16,7 @@
         <script id="qunit-script">
             test('aLinksToMultiMediaRequireTranscript', function() {
               quailTest.runTest( 'aLinksToMultiMediaRequireTranscript', '20-6.html');
-              equal(quailTest.results[quailTest.testName][0].attr('href'), 'movie.aif', 'Item attribute check');
+              equal(quailTest.results[quailTest.testName].elements[0].attr('href'), 'movie.aif', 'Item attribute check');
             });
         </script>
     </body>

diff --git a/test/testfiles/common/aLinksToMultiMediaRequireTranscript-fail.html b/test/testfiles/common/aLinksToMultiMediaRequireTranscript-fail.html
@@ -16,7 +16,7 @@
         <script id="qunit-script">
             test('aLinksToMultiMediaRequireTranscript', function() {
               quailTest.runTest( 'aLinksToMultiMediaRequireTranscript', '20-1.html');
-              equal(quailTest.results[quailTest.testName][0].attr('href'), 'movie.wmv', 'Item attribute check');
+              equal(quailTest.results[quailTest.testName].elements[0].attr('href'), 'movie.wmv', 'Item attribute check');
             });
         </script>
     </body>

diff --git a/test/testfiles/common/aLinksToSoundFilesNeedTranscripts-fail.html b/test/testfiles/common/aLinksToSoundFilesNeedTranscripts-fail.html
@@ -17,7 +17,7 @@
             <script id="qunit-script">
                 test('aLinksToSoundFilesNeedTranscripts', function() {
                   quailTest.runTest( 'aLinksToSoundFilesNeedTranscripts', '17-1.html');
-                  equal(quailTest.results[quailTest.testName][0].attr('href'), 'carol-talking.wav', 'Item attribute check');
+                  equal(quailTest.results[quailTest.testName].elements[0].attr('href'), 'carol-talking.wav', 'Item attribute check');
                 });
             </script>
     </body>

diff --git a/test/testfiles/common/cssDocumentMakesSenseStyleTurnedOff-pass.html b/test/testfiles/common/cssDocumentMakesSenseStyleTurnedOff-pass.html
@@ -16,9 +16,9 @@
         <script id="qunit-script">
             test('cssDocumentMakesSenseStyleTurnedOff', function() {
               quailTest.runTest( 'cssDocumentMakesSenseStyleTurnedOff', '97-2.html');
-              $.each(quailTest.results['cssDocumentMakesSenseStyleTurnedOff'], function(index, item) {
+              $.each(quailTest.results['cssDocumentMakesSenseStyleTurnedOff'].elements, function(index, item) {
               	if(item.is('body')) {
-              		quailTest.results['cssDocumentMakesSenseStyleTurnedOff'].splice(index, 1);
+              		quailTest.results['cssDocumentMakesSenseStyleTurnedOff'].elements.splice(index, 1);
               	}
               });
               equal(true, quailTest.confirmIsEmpty(), 'Results are empty');

diff --git a/test/testfiles/common/documentAbbrIsUsed-fail.html b/test/testfiles/common/documentAbbrIsUsed-fail.html
@@ -17,7 +17,7 @@
             test('documentAbbrIsUsed', function() {
               quailTest.runTest( 'documentAbbrIsUsed', '98-1.html');
               var pass = false;
-              $.each(quailTest.results.documentAbbrIsUsed, function(index, abbr) {
+              $.each(quailTest.results.documentAbbrIsUsed.elements, function(index, abbr) {
                 if(abbr.hasClass('fail')) {
                   pass = true;
                 }

diff --git a/test/testfiles/common/documentAcronymsHaveElement-fail.html b/test/testfiles/common/documentAcronymsHaveElement-fail.html
@@ -17,7 +17,7 @@
             test('documentAcronymsHaveElement', function() {
               quailTest.runTest( 'documentAcronymsHaveElement', '99-1.html');
               var pass = false;
-              $.each(quailTest.results.documentAcronymsHaveElement, function(index, abbr) {
+              $.each(quailTest.results.documentAcronymsHaveElement.elements, function(index, abbr) {
                 if(abbr.hasClass('fail')) {
                   pass = true;
                 }

diff --git a/test/testfiles/common/imgAltEmptyForDecorativeImages-fail-2.html b/test/testfiles/common/imgAltEmptyForDecorativeImages-fail-2.html
@@ -18,7 +18,7 @@
         <script id="qunit-script">
             test('imgAltEmptyForDecorativeImages', function() {
               quailTest.runTest( 'imgAltEmptyForDecorativeImages', '16-2.html');
-              equal(quailTest.results[quailTest.testName][0].attr('src'), 'resources/10pttab.gif', 'Item attribute check');
+              equal(quailTest.results[quailTest.testName].elements[0].attr('src'), 'resources/10pttab.gif', 'Item attribute check');
             });
         </script>
     </body>

diff --git a/test/testfiles/common/imgAltEmptyForDecorativeImages-fail-3.html b/test/testfiles/common/imgAltEmptyForDecorativeImages-fail-3.html
@@ -17,7 +17,7 @@
         <script id="qunit-script">
             test('imgAltEmptyForDecorativeImages', function() {
               quailTest.runTest( 'imgAltEmptyForDecorativeImages', '16-3.html');
-              equal(quailTest.results[quailTest.testName][0].attr('src'), 'resources/star.gif', 'Item attribute check');
+              equal(quailTest.results[quailTest.testName].elements[0].attr('src'), 'resources/star.gif', 'Item attribute check');
             });
         </script>
     </body>

diff --git a/test/testfiles/common/imgAltEmptyForDecorativeImages-fail-4.html b/test/testfiles/common/imgAltEmptyForDecorativeImages-fail-4.html
@@ -17,7 +17,7 @@
         <script id="qunit-script">
             test('imgAltEmptyForDecorativeImages', function() {
               quailTest.runTest( 'imgAltEmptyForDecorativeImages', '16-4.html');
-              equal(quailTest.results[quailTest.testName][0].attr('src'), 'resources/star.gif', 'Item attribute check');
+              equal(quailTest.results[quailTest.testName].elements[0].attr('src'), 'resources/star.gif', 'Item attribute check');
             });
         </script>
     </body>

diff --git a/test/testfiles/common/imgAltEmptyForDecorativeImages-fail.html b/test/testfiles/common/imgAltEmptyForDecorativeImages-fail.html
@@ -18,7 +18,7 @@
         <script>
             test('imgAltEmptyForDecorativeImages', function() {
               quailTest.runTest( 'imgAltEmptyForDecorativeImages', '16-1.html');
-              equal(quailTest.results[quailTest.testName][0].attr('src'), 'resources/10pttab.gif', 'Item attribute check');
+              equal(quailTest.results[quailTest.testName].elements[0].attr('src'), 'resources/10pttab.gif', 'Item attribute check');
             });
         </script>
     </body>

diff --git a/test/testfiles/common/imgAltIdentifiesLinkDestination-fail.html b/test/testfiles/common/imgAltIdentifiesLinkDestination-fail.html
@@ -17,7 +17,7 @@
         <script id="qunit-script">
             test('imgAltIdentifiesLinkDestination', function() {
               quailTest.runTest( 'imgAltIdentifiesLinkDestination', '15-2.html');
-              equal(quailTest.results[quailTest.testName][0].attr('src'), 'resources/topo.gif', 'Item attribute check');
+              equal(quailTest.results[quailTest.testName].elements[0].attr('src'), 'resources/topo.gif', 'Item attribute check');
             });
         </script>
     </body>

diff --git a/test/testfiles/common/imgAltIsSameInText-fail.html b/test/testfiles/common/imgAltIsSameInText-fail.html
@@ -18,7 +18,7 @@
         <script id="qunit-script">
             test('imgAltIsSameInText', function() {
               quailTest.runTest( 'imgAltIsSameInText', '11-1.html');
-              equal(quailTest.results[quailTest.testName][0].attr('alt'), 'logo', 'Item attribute check');
+              equal(quailTest.results[quailTest.testName].elements[0].attr('alt'), 'logo', 'Item attribute check');
             });
         </script>
     </body>

diff --git a/test/testfiles/common/imgAltIsSameInText-pass.html b/test/testfiles/common/imgAltIsSameInText-pass.html
@@ -19,7 +19,7 @@
         <script id="qunit-script">
             test('imgAltIsSameInText', function() {
               quailTest.runTest( 'imgAltIsSameInText', '11-2.html');
-              equal(quailTest.results[quailTest.testName][0].attr('alt'), 'W3C Working Draft logo', 'Item attribute check');
+              equal(quailTest.results[quailTest.testName].elements[0].attr('alt'), 'W3C Working Draft logo', 'Item attribute check');
             });
         </script>
     </body>

diff --git a/test/testfiles/common/imgHasLongDesc-fail-2.html b/test/testfiles/common/imgHasLongDesc-fail-2.html
@@ -20,7 +20,7 @@
         <script id="qunit-script">
             test('imgHasLongDesc', function() {
               quailTest.runTest( 'imgHasLongDesc', '8-3.html');
-              equal(quailTest.results[quailTest.testName][0].attr('src'), 'resources/chart.gif', 'Image is chart.gif');
+              equal(quailTest.results[quailTest.testName].elements[0].attr('src'), 'resources/chart.gif', 'Image is chart.gif');
             });
         </script>
     </body>

diff --git a/test/testfiles/common/imgHasLongDesc-fail.html b/test/testfiles/common/imgHasLongDesc-fail.html
@@ -20,7 +20,7 @@
         <script id="qunit-script">
             test('imgHasLongDesc', function() {
               quailTest.runTest( 'imgHasLongDesc', '8-1.html');
-              equal(quailTest.results[quailTest.testName][0].attr('src'), 'resources/chart.gif', 'Image is chart.gif');
+              equal(quailTest.results[quailTest.testName].elements[0].attr('src'), 'resources/chart.gif', 'Image is chart.gif');
             });
         </script>
     </body>

diff --git a/test/testfiles/common/imgMapAreasHaveDuplicateLink-fail-2.html b/test/testfiles/common/imgMapAreasHaveDuplicateLink-fail-2.html
@@ -31,7 +31,7 @@
         <script id="qunit-script">
             test('imgMapAreasHaveDuplicateLink', function() {
               quailTest.runTest( 'imgMapAreasHaveDuplicateLink', '13-3.html');
-              equal(quailTest.results[quailTest.testName][0].attr('src'), 'resources/navigation.gif', 'Item attribute check');
+              equal(quailTest.results[quailTest.testName].elements[0].attr('src'), 'resources/navigation.gif', 'Item attribute check');
             });
         </script>
     </body>

diff --git a/test/testfiles/common/imgMapAreasHaveDuplicateLink-fail.html b/test/testfiles/common/imgMapAreasHaveDuplicateLink-fail.html
@@ -29,7 +29,7 @@
         <script id="qunit-script">
             test('imgMapAreasHaveDuplicateLink', function() {
               quailTest.runTest( 'imgMapAreasHaveDuplicateLink', '13-1.html');
-              equal(quailTest.results[quailTest.testName][0].attr('src'), 'resources/navigation.gif', 'Item attribute check');
+              equal(quailTest.results[quailTest.testName].elements[0].attr('src'), 'resources/navigation.gif', 'Item attribute check');
             });
         </script>
     </body>

diff --git a/test/testfiles/common/imgNotReferredToByColorAlone-fail-2.html b/test/testfiles/common/imgNotReferredToByColorAlone-fail-2.html
@@ -23,7 +23,7 @@ <h1>Clayton's Class</h1>
         <script id="qunit-script">
             test('imgNotReferredToByColorAlone', function() {
               quailTest.runTest( 'imgNotReferredToByColorAlone', '14-2.html');
-              equal(quailTest.results[quailTest.testName][0].attr('src'), 'resources/kids.jpg', 'Item attribute check');
+              equal(quailTest.results[quailTest.testName].elements[0].attr('src'), 'resources/kids.jpg', 'Item attribute check');
             });
         </script>
     </body>

diff --git a/test/testfiles/common/imgNotReferredToByColorAlone-fail-3.html b/test/testfiles/common/imgNotReferredToByColorAlone-fail-3.html
@@ -23,7 +23,7 @@ <h1>Clayton's Class</h1>
         <script id="qunit-script">
             test('imgNotReferredToByColorAlone', function() {
               quailTest.runTest( 'imgNotReferredToByColorAlone', '14-3.html');
-              equal(quailTest.results[quailTest.testName][0].attr('src'), 'resources/kids.jpg', 'Item attribute check');
+              equal(quailTest.results[quailTest.testName].elements[0].attr('src'), 'resources/kids.jpg', 'Item attribute check');
             });
         </script>
     </body>

diff --git a/test/testfiles/common/imgNotReferredToByColorAlone-fail.html b/test/testfiles/common/imgNotReferredToByColorAlone-fail.html
@@ -23,7 +23,7 @@ <h1>Clayton's Class</h1>
         <script id="qunit-script">
             test('imgNotReferredToByColorAlone', function() {
               quailTest.runTest( 'imgNotReferredToByColorAlone', '14-1.html');
-              equal(quailTest.results[quailTest.testName][0].attr('src'), 'resources/kids.jpg', 'Item attribute check');
+              equal(quailTest.results[quailTest.testName].elements[0].attr('src'), 'resources/kids.jpg', 'Item attribute check');
             });
         </script>
     </body>

diff --git a/test/testfiles/common/imgWithMapHasUseMap-fail.html b/test/testfiles/common/imgWithMapHasUseMap-fail.html
@@ -19,7 +19,7 @@
         <script id="qunit-script">
             test('imgWithMapHasUseMap', function() {
               quailTest.runTest( 'imgWithMapHasUseMap', '12-1.html');
-              equal(quailTest.results[quailTest.testName][0].attr('src'), 'resources/image.gif', 'Item attribute check');
+              equal(quailTest.results[quailTest.testName].elements[0].attr('src'), 'resources/image.gif', 'Item attribute check');
             });
         </script>
     </body>
-Original file line number
+Diff line change
@@ Expand Up / @@ -45,4 +45,4 @@ Credits @@
     Legal
     -----
-    QUAIL is covered under the MIT License, and is copyright (c) 2013 by Kevin Miller. Current license is at http://quailjs.org/license.
+    QUAIL is covered under the MIT License, and is copyright (c) 2013 by Kevin Miller. Current license is at http://quailjs.org/license.