Merge pull request #646 from IBMa/ali-deprecating_Rpt_Aria_MultipleGr…

…oupRoles_Implicit Deprecation of rule Rpt_Aria_MultipleGroupRoles_Implicit
IBMa · Feb 3, 2022 · b4034eb · b4034eb
2 parents 3bb5e0d + dac522d
commit b4034eb
Show file tree

Hide file tree

Showing 14 changed files with 97 additions and 79 deletions.
diff --git a/accessibility-checker-engine/src/v2/checker/accessibility/help/index.ts b/accessibility-checker-engine/src/v2/checker/accessibility/help/index.ts
@@ -863,11 +863,11 @@ let a11yHelp = {
         "Fail_1": `${Config.helpRoot}/Rpt_Aria_ArticleRoleLabel_Implicit`
     },
     // JCH - DONE
-    "Rpt_Aria_MultipleGroupRoles_Implicit": {
-        0: `${Config.helpRoot}/Rpt_Aria_MultipleGroupRoles_Implicit`,
-        "Pass_0": `${Config.helpRoot}/Rpt_Aria_MultipleGroupRoles_Implicit`,
-        "Fail_1": `${Config.helpRoot}/Rpt_Aria_MultipleGroupRoles_Implicit`
-    },
+    // "Rpt_Aria_MultipleGroupRoles_Implicit": {
+    //     0: `${Config.helpRoot}/Rpt_Aria_MultipleGroupRoles_Implicit`,
+    //     "Pass_0": `${Config.helpRoot}/Rpt_Aria_MultipleGroupRoles_Implicit`,
+    //     "Fail_1": `${Config.helpRoot}/Rpt_Aria_MultipleGroupRoles_Implicit`
+    // },
     // JCH - DONE
     "Rpt_Aria_GroupRoleLabel_Implicit": {
         0: `${Config.helpRoot}/Rpt_Aria_GroupRoleLabel_Implicit`,

diff --git a/accessibility-checker-engine/src/v2/checker/accessibility/nls/index.ts b/accessibility-checker-engine/src/v2/checker/accessibility/nls/index.ts
@@ -856,11 +856,11 @@ let a11yNls = {
         "Fail_1": "The element with \"article\" role does not have a label"
     },
     // JCH - DONE
-    "Rpt_Aria_MultipleGroupRoles_Implicit": {
-        0: "Each element with \"group\" role must have a unique label that describes its purpose",
-        "Pass_0": "Rule Passed",
-        "Fail_1": "Multiple elements with \"group\" role do not have unique labels"
-    },
+    // "Rpt_Aria_MultipleGroupRoles_Implicit": {
+    //     0: "Each element with \"group\" role must have a unique label that describes its purpose",
+    //     "Pass_0": "Rule Passed",
+    //     "Fail_1": "Multiple elements with \"group\" role do not have unique labels"
+    // },
     // JCH - DONE
     "Rpt_Aria_GroupRoleLabel_Implicit": {
         0: "An element with \"group\" role should have a unique label that describes its purpose",

diff --git a/accessibility-checker-engine/src/v2/checker/accessibility/rules/rpt-ariaLabeling-rules.ts b/accessibility-checker-engine/src/v2/checker/accessibility/rules/rpt-ariaLabeling-rules.ts
@@ -834,40 +834,48 @@ let a11yRulesLabeling: Rule[] = [
         }
     },
 
-    {
-        /**
-         * Description: Triggers if multiple group roles are present and they don't have unique labels
-         * Also, consider <details> element which has implicit 'group' role
-         * Origin:  CI162 Web checklist checkpoint 2.4a
-         */
-        id: "Rpt_Aria_MultipleGroupRoles_Implicit",
-        context: "aria:group",
-        run: (context: RuleContext, options?: {}): RuleResult | RuleResult[] => {
-            const ruleContext = context["dom"].node as Element;
-
-            // Consider the Check Hidden Content setting that is set by the rules
-            // Also, consider Implicit role checking. 
-            let landmarks = RPTUtil.getElementsByRoleHidden(ruleContext.ownerDocument, "group", true, true);
-            if (landmarks.length === 0 || landmarks.length === 1) {
-                return null;
-            }
-
-            let dupes = RPTUtil.getCache(ruleContext.ownerDocument, "Rpt_Aria_MultipleGroupRoles_Implicit", null);
-            if (!dupes) {
-                dupes = RPTUtil.findAriaLabelDupes(landmarks);
-                RPTUtil.setCache(ruleContext.ownerDocument, "Rpt_Aria_MultipleGroupRoles_Implicit", dupes);
-            }
-            let myLabel = RPTUtil.getAriaLabel(ruleContext);
-            let passed = myLabel === "" || !(myLabel in dupes) || dupes[myLabel] <= 1;
-
-            //return new ValidationResult(passed, ruleContext, '', '', [ myLabel ]);
-            if (!passed) {
-                return RuleFail("Fail_1", [myLabel]);
-            } else {
-                return RulePass("Pass_0");
-            }
-        }
-    },
+    /** --------------------------------------------------------------------------------------------
+     * DEPRECATED: This rule is being deprecated and replaced by 2 separate rules that are more 
+     * targeted. 
+     * 1) landmark_name_unique
+     * 2) group_withInputs_hasName
+     * The reasoning for this was we were accidentally catching groups that were valid. Such as 
+     * groups that might have the same name but had structurally ways to reach them. So they were 
+     * disambiguated by structure nested parent hierarchy.
+     * --------------------------------------------------------------------------------------------
+     * Description: Triggers if multiple group roles are present and they don't have unique labels
+     * Also, consider <details> element which has implicit 'group' role
+     * Origin:  CI162 Web checklist checkpoint 2.4a
+     */
+    // {
+    //     id: "Rpt_Aria_MultipleGroupRoles_Implicit",
+    //     context: "aria:group",
+    //     run: (context: RuleContext, options?: {}): RuleResult | RuleResult[] => {
+    //         const ruleContext = context["dom"].node as Element;
+
+    //         // Consider the Check Hidden Content setting that is set by the rules
+    //         // Also, consider Implicit role checking. 
+    //         let landmarks = RPTUtil.getElementsByRoleHidden(ruleContext.ownerDocument, "group", true, true);
+    //         if (landmarks.length === 0 || landmarks.length === 1) {
+    //             return null;
+    //         }
+
+    //         let dupes = RPTUtil.getCache(ruleContext.ownerDocument, "Rpt_Aria_MultipleGroupRoles_Implicit", null);
+    //         if (!dupes) {
+    //             dupes = RPTUtil.findAriaLabelDupes(landmarks);
+    //             RPTUtil.setCache(ruleContext.ownerDocument, "Rpt_Aria_MultipleGroupRoles_Implicit", dupes);
+    //         }
+    //         let myLabel = RPTUtil.getAriaLabel(ruleContext);
+    //         let passed = myLabel === "" || !(myLabel in dupes) || dupes[myLabel] <= 1;
+
+    //         //return new ValidationResult(passed, ruleContext, '', '', [ myLabel ]);
+    //         if (!passed) {
+    //             return RuleFail("Fail_1", [myLabel]);
+    //         } else {
+    //             return RulePass("Pass_0");
+    //         }
+    //     }
+    // },
 
 
     {

diff --git a/accessibility-checker-engine/src/v2/checker/accessibility/rulesets/index.ts b/accessibility-checker-engine/src/v2/checker/accessibility/rulesets/index.ts
@@ -756,11 +756,12 @@ let a11yRulesets: Ruleset[] = [
                     level: eRulePolicy.VIOLATION,
                     toolkitLevel: eToolkitLevel.LEVEL_THREE
                 },
-                {
-                    id: "Rpt_Aria_MultipleGroupRoles_Implicit",
-                    level: eRulePolicy.VIOLATION,
-                    toolkitLevel: eToolkitLevel.LEVEL_THREE
-                },
+                // DEPRECATED
+                // {
+                //     id: "Rpt_Aria_MultipleGroupRoles_Implicit",
+                //     level: eRulePolicy.VIOLATION,
+                //     toolkitLevel: eToolkitLevel.LEVEL_THREE
+                // },
                 {
                     id: "Rpt_Aria_MultipleContentinfoInSiblingSet_Implicit",
                     level: eRulePolicy.VIOLATION,
@@ -1945,11 +1946,12 @@ let a11yRulesets: Ruleset[] = [
                     level: eRulePolicy.VIOLATION,
                     toolkitLevel: eToolkitLevel.LEVEL_THREE
                 },
-                {
-                    id: "Rpt_Aria_MultipleGroupRoles_Implicit",
-                    level: eRulePolicy.VIOLATION,
-                    toolkitLevel: eToolkitLevel.LEVEL_THREE
-                },
+                // DEPRECATED
+                // {
+                //     id: "Rpt_Aria_MultipleGroupRoles_Implicit",
+                //     level: eRulePolicy.VIOLATION,
+                //     toolkitLevel: eToolkitLevel.LEVEL_THREE
+                // },
                 {
                     id: "Rpt_Aria_MultipleContentinfoInSiblingSet_Implicit",
                     level: eRulePolicy.VIOLATION,
@@ -3080,11 +3082,12 @@ let a11yRulesets: Ruleset[] = [
                     level: eRulePolicy.VIOLATION,
                     toolkitLevel: eToolkitLevel.LEVEL_THREE
                 },
-                {
-                    id: "Rpt_Aria_MultipleGroupRoles_Implicit",
-                    level: eRulePolicy.VIOLATION,
-                    toolkitLevel: eToolkitLevel.LEVEL_THREE
-                },
+                // DEPRECATED
+                // {
+                //     id: "Rpt_Aria_MultipleGroupRoles_Implicit",
+                //     level: eRulePolicy.VIOLATION,
+                //     toolkitLevel: eToolkitLevel.LEVEL_THREE
+                // },
                 {
                     id: "Rpt_Aria_MultipleContentinfoInSiblingSet_Implicit",
                     level: eRulePolicy.VIOLATION,

diff --git a/...s/Rpt_Aria_MultipleGroupRoles_Implicit_ruleunit/duplicateLandmarksAriaLabelNotUnique.html b/...s/Rpt_Aria_MultipleGroupRoles_Implicit_ruleunit/duplicateLandmarksAriaLabelNotUnique.html
@@ -37,7 +37,7 @@ <h3>Multiple landmarks of the same type must have unique labels</h3>
 
 <a name="navskip"></a>
 
-<script type="text/javascript">
+<!-- <script type="text/javascript">
 //<![CDATA[
   if (typeof(OpenAjax) == 'undefined') OpenAjax = {}
   if (typeof(OpenAjax.a11y) == 'undefined') OpenAjax.a11y = {}
@@ -53,5 +53,6 @@ <h3>Multiple landmarks of the same type must have unique labels</h3>
     }
   ];
 //]]>
-</script></body>
+</script> -->
+</body>
 </html>
diff --git a/...Aria_MultipleGroupRoles_Implicit_ruleunit/duplicateLandmarksAriaLabelNotUniqueHidden.html b/...Aria_MultipleGroupRoles_Implicit_ruleunit/duplicateLandmarksAriaLabelNotUniqueHidden.html
@@ -37,7 +37,7 @@ <h3>Multiple landmarks of the same type must have unique labels</h3>
 
 <a name="navskip"></a>
 
-<script type="text/javascript">
+<!-- <script type="text/javascript">
 //<![CDATA[
   if (typeof(OpenAjax) == 'undefined') OpenAjax = {}
   if (typeof(OpenAjax.a11y) == 'undefined') OpenAjax.a11y = {}
@@ -51,5 +51,6 @@ <h3>Multiple landmarks of the same type must have unique labels</h3>
     }
   ];
 //]]>
-</script></body>
+</script> -->
+</body>
 </html>
diff --git a/...tipleGroupRoles_Implicit_ruleunit/duplicateLandmarksAriaLabelNotUniqueHiddenImplicit.html b/...tipleGroupRoles_Implicit_ruleunit/duplicateLandmarksAriaLabelNotUniqueHiddenImplicit.html
@@ -37,7 +37,7 @@ <h3>Multiple landmarks of the same type must have unique labels</h3>
 
     <a name="navskip"></a>
 
-    <script type="text/javascript">
+    <!-- <script type="text/javascript">
         //<![CDATA[
         if (typeof(OpenAjax) == 'undefined') OpenAjax = {}
         if (typeof(OpenAjax.a11y) == 'undefined') OpenAjax.a11y = {}
@@ -47,7 +47,7 @@ <h3>Multiple landmarks of the same type must have unique labels</h3>
             failedXpaths: []
         }];
         //]]>
-    </script>
+    </script> -->
 </body>
 
 </html>
diff --git a/...ules/Rpt_Aria_MultipleGroupRoles_Implicit_ruleunit/duplicateLandmarksAriaLabelUnique.html b/...ules/Rpt_Aria_MultipleGroupRoles_Implicit_ruleunit/duplicateLandmarksAriaLabelUnique.html
@@ -37,7 +37,7 @@ <h3>Multiple landmarks of the same type must have unique labels</h3>
 
 <a name="navskip"></a>
 
-<script type="text/javascript">
+<!-- <script type="text/javascript">
 //<![CDATA[
   if (typeof(OpenAjax) == 'undefined') OpenAjax = {}
   if (typeof(OpenAjax.a11y) == 'undefined') OpenAjax.a11y = {}
@@ -51,5 +51,6 @@ <h3>Multiple landmarks of the same type must have unique labels</h3>
     }
   ];
 //]]>
-</script></body>
+</script> -->
+</body>
 </html>
diff --git a/...ltipleGroupRoles_Implicit_ruleunit/duplicateLandmarksAriaLabelledbyNotUniqueImplicit.html b/...ltipleGroupRoles_Implicit_ruleunit/duplicateLandmarksAriaLabelledbyNotUniqueImplicit.html
@@ -38,7 +38,7 @@ <h2 id="hd1">Another heading to be used as landmark label</h2>
 
     <a name="navskip"></a>
 
-    <script type="text/javascript">
+    <!-- <script type="text/javascript">
         //<![CDATA[
         if (typeof(OpenAjax) == 'undefined') OpenAjax = {}
         if (typeof(OpenAjax.a11y) == 'undefined') OpenAjax.a11y = {}
@@ -51,7 +51,7 @@ <h2 id="hd1">Another heading to be used as landmark label</h2>
             ]
         }];
         //]]>
-    </script>
+    </script> -->
 </body>
 
 </html>
diff --git a/...Rpt_Aria_MultipleGroupRoles_Implicit_ruleunit/duplicateLandmarksAriaLabelledbyUnique.html b/...Rpt_Aria_MultipleGroupRoles_Implicit_ruleunit/duplicateLandmarksAriaLabelledbyUnique.html
@@ -45,7 +45,7 @@ <h2 id="hd4">Another heading to be used as landmark label - hd4</h2>
 
     <a name="navskip"></a>
 
-    <script type="text/javascript">
+    <!-- <script type="text/javascript">
         //<![CDATA[
         if (typeof(OpenAjax) == 'undefined') OpenAjax = {}
         if (typeof(OpenAjax.a11y) == 'undefined') OpenAjax.a11y = {}
@@ -55,7 +55,7 @@ <h2 id="hd4">Another heading to be used as landmark label - hd4</h2>
             failedXpaths: []
         }];
         //]]>
-    </script>
+    </script> -->
 </body>
 
 </html>
diff --git a/...ility/rules/Rpt_Aria_MultipleGroupRoles_Implicit_ruleunit/duplicateLandmarksNoLabels.html b/...ility/rules/Rpt_Aria_MultipleGroupRoles_Implicit_ruleunit/duplicateLandmarksNoLabels.html
@@ -37,7 +37,7 @@ <h3>Multiple landmarks of the same type must have unique labels</h3>
 
 <a name="navskip"></a>
 
-<script type="text/javascript">
+<!-- <script type="text/javascript">
 //<![CDATA[
   if (typeof(OpenAjax) == 'undefined') OpenAjax = {}
   if (typeof(OpenAjax.a11y) == 'undefined') OpenAjax.a11y = {}
@@ -51,5 +51,6 @@ <h3>Multiple landmarks of the same type must have unique labels</h3>
     }
   ];
 //]]>
-</script></body>
+</script> -->
+</body>
 </html>
diff --git a/...y/rules/Rpt_Aria_MultipleGroupRoles_Implicit_ruleunit/duplicateLandmarksOneAriaLabel.html b/...y/rules/Rpt_Aria_MultipleGroupRoles_Implicit_ruleunit/duplicateLandmarksOneAriaLabel.html
@@ -37,7 +37,7 @@ <h3>Multiple landmarks of the same type must have unique labels</h3>
 
 <a name="navskip"></a>
 
-<script type="text/javascript">
+<!-- <script type="text/javascript">
 //<![CDATA[
   if (typeof(OpenAjax) == 'undefined') OpenAjax = {}
   if (typeof(OpenAjax.a11y) == 'undefined') OpenAjax.a11y = {}
@@ -51,5 +51,6 @@ <h3>Multiple landmarks of the same type must have unique labels</h3>
     }
   ];
 //]]>
-</script></body>
+</script> -->
+</body>
 </html>
diff --git a/...es/Rpt_Aria_MultipleGroupRoles_Implicit_ruleunit/duplicateLandmarksOneAriaLabelledby.html b/...es/Rpt_Aria_MultipleGroupRoles_Implicit_ruleunit/duplicateLandmarksOneAriaLabelledby.html
@@ -37,7 +37,7 @@ <h3 id="hd1">Multiple landmarks of the same type must have unique labels</h3>
 
 <a name="navskip"></a>
 
-<script type="text/javascript">
+<!-- <script type="text/javascript">
 //<![CDATA[
   if (typeof(OpenAjax) == 'undefined') OpenAjax = {}
   if (typeof(OpenAjax.a11y) == 'undefined') OpenAjax.a11y = {}
@@ -51,5 +51,6 @@ <h3 id="hd1">Multiple landmarks of the same type must have unique labels</h3>
     }
   ];
 //]]>
-</script></body>
+</script> -->
+</body>
 </html>
diff --git a/...cessibility/rules/Rpt_Aria_MultipleGroupRoles_Implicit_ruleunit/noDuplicateLandmarks.html b/...cessibility/rules/Rpt_Aria_MultipleGroupRoles_Implicit_ruleunit/noDuplicateLandmarks.html
@@ -36,7 +36,7 @@ <h3>Multiple landmarks of the same type must have unique labels</h3>
 
 <a name="navskip"></a>
 
-<script type="text/javascript">
+<!-- <script type="text/javascript">
 //<![CDATA[
   if (typeof(OpenAjax) == 'undefined') OpenAjax = {}
   if (typeof(OpenAjax.a11y) == 'undefined') OpenAjax.a11y = {}
@@ -50,5 +50,6 @@ <h3>Multiple landmarks of the same type must have unique labels</h3>
     }
   ];
 //]]>
-</script></body>
+</script> -->
+</body>
 </html>