Merge pull request #21 from cidilabs/scottcooper/php-ally-track-number

cidilabs · web-flow · commit 73171a7aee11 · 2021-11-19T14:57:29.000-07:00
Make changes for IssueCount and TestCount
diff --git a/src/PhpAlly.php b/src/PhpAlly.php
@@ -33,8 +33,9 @@ public function checkMany($content, $ruleIds = [], $options = [])
                 }           
 
                 $rule = new $className($document, $options);
-                $rule->check();                
+                $issueCount = $rule->check();                
 
+                $report->setIssueCounts($ruleId, $issueCount, $rule->getTotalTests());
                 $report->setIssues($rule->getIssues());
                 $report->setErrors($rule->getErrors());
             } catch (\Exception $e) {
diff --git a/src/PhpAllyReport.php b/src/PhpAllyReport.php
@@ -6,6 +6,7 @@ class PhpAllyReport implements \JsonSerializable {
     protected $issues = [];
     protected $errors = [];
     protected $html = '';
+    protected $issueCounts = [];
 
     public function __construct()
     {
@@ -16,6 +17,7 @@ public function toArray()
         return [
             'issues' => $this->getIssues(),
             'errors' => $this->getErrors(),
+            'issueCounts' => $this->getIssueCounts(),
         ];
     }
 
@@ -59,4 +61,14 @@ public function setErrors($errors)
         $this->errors = array_merge($this->errors, $errors);
     }
 
+    public function getIssueCounts()
+    {
+        return $this->issueCounts;
+    }
+
+    public function setIssueCounts($ruleId, $issueCount, $total) {
+        $ruleId = str_replace(['CidiLabs\\PhpAlly\\Rule\\','App\\Rule\\'], '', $ruleId);
+        $this->issueCounts[$ruleId] = array('issueCount' => $issueCount, "totalCount" => $total);
+    }
+
 }
diff --git a/src/Rule/AnchorLinksToMultiMediaRequireTranscript.php b/src/Rule/AnchorLinksToMultiMediaRequireTranscript.php
@@ -32,6 +32,7 @@ public function check()
 					$this->setIssue($a);
 				}
 			}
+			$this->totalTests++;
 		}
 
         return count($this->issues);
diff --git a/src/Rule/AnchorLinksToSoundFilesNeedTranscripts.php b/src/Rule/AnchorLinksToSoundFilesNeedTranscripts.php
@@ -34,7 +34,8 @@ public function check()
 					$this->setIssue($a);
 				}
 			}
-		}
+            $this->totalTests++;
+        }
 
         return count($this->issues);
     }
diff --git a/src/Rule/AnchorMustContainText.php b/src/Rule/AnchorMustContainText.php
@@ -25,6 +25,7 @@ public function check()
             if (!$this->elementContainsReadableText($a) && ($a->hasAttribute('href'))) {
                 $this->setIssue($a);
             }
+            $this->totalTests++;
         }
 
         return count($this->issues);
diff --git a/src/Rule/AnchorSuspiciousLinkText.php b/src/Rule/AnchorSuspiciousLinkText.php
@@ -25,6 +25,7 @@ public function check()
         foreach ($this->getAllElements('a') as $a) {
             if (in_array(strtolower(trim($a->nodeValue)), $this->translation()) || $a->nodeValue == $a->getAttribute('href'))
 				$this->setIssue($a);
+            $this->totalTests++;
         }
 
         return count($this->issues);
diff --git a/src/Rule/BaseFontIsNotUsed.php b/src/Rule/BaseFontIsNotUsed.php
@@ -20,6 +20,7 @@ public function check()
     {
         foreach ($this->getAllElements('basefont') as $b) {
 			$this->setIssue($b);
+            $this->totalTests++;
 		}
         
         return count($this->issues);
diff --git a/src/Rule/BaseRule.php b/src/Rule/BaseRule.php
@@ -25,6 +25,7 @@ class BaseRule implements PhpAllyRuleInterface {
     protected $altTextLengthLimit;
     protected $minDocLengthForHeaders;
     protected $maxWordCount;
+    protected $totalTests = 0;
 
     public function __construct(DOMDocument $dom, $options = [])
     {
@@ -217,8 +218,6 @@ private function walkUpTreeForInheritance($element, $style) {
 	}
 
 
-
-
     public function elementContainsReadableText($element)
     {
         if (is_a($element, 'DOMText')) {
@@ -266,6 +265,15 @@ public function getIssues()
         return $this->issues;
     }
 
+    public function getTotalTests()
+    {
+        return $this->totalTests;
+    }
+    public function IncrementTotalTests()
+    {
+        return $this->totalTests++;
+    }
+
     public function setError($errorMsg) 
     {
         $this->errors[] = $errorMsg;
@@ -323,4 +331,6 @@ function propertyIsEqual($object, $property, $value, $trim = false, $lower = fal
 		}
 		return ($property_value == $value);
 	}
+
+
 }
diff --git a/src/Rule/BlinkIsNotUsed.php b/src/Rule/BlinkIsNotUsed.php
@@ -21,6 +21,7 @@ public function check()
     {
         foreach ($this->getAllElements('blink') as $b) {
 			$this->setIssue($b);
+            $this->totalTests++;
 		}
         
         return count($this->issues);
diff --git a/src/Rule/BrokenLink.php b/src/Rule/BrokenLink.php
@@ -25,6 +25,7 @@ public function check()
 			if ($href) {
 				$links[$href] = $a;
 			}
+            $this->totalTests++;
 		}
 		$this->checkLink($links);
 
diff --git a/src/Rule/ContentTooLong.php b/src/Rule/ContentTooLong.php
@@ -28,6 +28,7 @@ public function check()
 			if($text != null){
 				$pageText = $pageText . $text;
 			}
+            $this->totalTests++;
 		}
         $wordCount = str_word_count($pageText);
 
diff --git a/src/Rule/CssTextHasContrast.php b/src/Rule/CssTextHasContrast.php
@@ -287,6 +287,7 @@ public function check()
 					}
 				}
 			}
+            $this->totalTests++;
 		}
         
         return count($this->issues);
diff --git a/src/Rule/CssTextStyleEmphasize.php b/src/Rule/CssTextStyleEmphasize.php
@@ -89,6 +89,7 @@ public function check()
 			}
 
 			$this->setIssue($element);
+            $this->totalTests++;
 		}
 
 		return count($this->issues);
diff --git a/src/Rule/DocumentReadingDirection.php b/src/Rule/DocumentReadingDirection.php
@@ -31,6 +31,7 @@ public function check()
 				if ($element->getAttribute('dir') != 'rtl')
 				 	$this->setIssue($element);
 			}
+            $this->totalTests++;
 		}
         
         return count($this->issues);
diff --git a/src/Rule/EmbedHasAssociatedNoEmbed.php b/src/Rule/EmbedHasAssociatedNoEmbed.php
@@ -24,7 +24,7 @@ public function check()
 			   && !$this->propertyIsEqual($embed->nextSibling, 'tagName', 'noembed')) {
 					$this->setIssue($embed);
 			}
-
+            $this->totalTests++;
 		}
         
         return count($this->issues);
diff --git a/src/Rule/EmbedTagDetected.php b/src/Rule/EmbedTagDetected.php
@@ -19,6 +19,7 @@ public function check()
     {
         foreach ($this->getAllElements('embed') as $object) {
             $this->setIssue($object);
+            $this->totalTests++;
         }
 
         return count($this->issues);
diff --git a/src/Rule/FontIsNotUsed.php b/src/Rule/FontIsNotUsed.php
@@ -20,6 +20,7 @@ public function check()
     {
         foreach ($this->getAllElements('font') as $b) {
 			$this->setIssue($b);
+            $this->totalTests++;
 		}
         
         return count($this->issues);
diff --git a/src/Rule/HeadersHaveText.php b/src/Rule/HeadersHaveText.php
@@ -22,6 +22,7 @@ public function check()
 			if (!$this->elementContainsReadableText($header)) {
 				$this->setIssue($header);
 			}
+            $this->totalTests++;
 		}
         
         return count($this->issues);
diff --git a/src/Rule/HeadingsInOrder.php b/src/Rule/HeadingsInOrder.php
@@ -37,8 +37,8 @@ public function check()
             }
 
             $previousLevel = $currentLevel;
+            $this->totalTests++;
         }
-
         return count($this->issues);
     }
 }
diff --git a/src/Rule/ImageAltIsDifferent.php b/src/Rule/ImageAltIsDifferent.php
@@ -25,7 +25,9 @@ public function check()
 				$this->setIssue($img);
 			else if ( preg_match("/\.jpg|\.JPG|\.png|\.PNG|\.gif|\.GIF|\.jpeg|\.JPEG$/", trim($img->getAttribute('alt'))) )
 				$this->setIssue($img);
-		}
+            $this->totalTests++;
+
+        }
         
         return count($this->issues);
     }
diff --git a/src/Rule/ImageAltIsTooLong.php b/src/Rule/ImageAltIsTooLong.php
@@ -24,7 +24,8 @@ public function check()
 			if ($img->hasAttribute('alt') && (strlen($img->getAttribute('alt')) > $this->altTextLengthLimit)) {
                 $this->setIssue($img);
             }
-		}
+            $this->totalTests++;
+        }
         
         return count($this->issues);
     }
diff --git a/src/Rule/ImageAltNotEmptyInAnchor.php b/src/Rule/ImageAltNotEmptyInAnchor.php
@@ -28,7 +28,8 @@ public function check()
 							$this->setIssue($child);
 				}
 			}
-		}
+            $this->totalTests++;
+        }
         
         return count($this->issues);
     }
diff --git a/src/Rule/ImageAltNotPlaceholder.php b/src/Rule/ImageAltNotPlaceholder.php
@@ -34,7 +34,8 @@ public function check()
 					}
 				}
 			}
-		}
+            $this->totalTests++;
+        }
         
         return count($this->issues);
     }
diff --git a/src/Rule/ImageHasAlt.php b/src/Rule/ImageHasAlt.php
@@ -26,6 +26,7 @@ public function check()
 					$this->setIssue($img);
 				}
 			}
+			$this->totalTests++;
         }
 
         return count($this->issues);
diff --git a/src/Rule/ImageHasAltDecorative.php b/src/Rule/ImageHasAltDecorative.php
@@ -32,7 +32,8 @@ public function check()
 				&& trim($img->getAttribute('alt') != '')) {
 				$this->setIssue($img);
 			}
-		}
+            $this->totalTests++;
+        }
         
         return count($this->issues);
     }
diff --git a/src/Rule/ImageHasLongDescription.php b/src/Rule/ImageHasLongDescription.php
@@ -27,7 +27,9 @@ public function check()
 						$this->setIssue($img);
 				}
 			}
-		}
+			$this->totalTests++;
+
+        }
         
         return count($this->issues);
     }
diff --git a/src/Rule/InputImageNotDecorative.php b/src/Rule/InputImageNotDecorative.php
@@ -23,7 +23,9 @@ public function check()
         foreach ($this->getAllElements('input') as $input) {
 			if ($input->getAttribute('type') == 'image')
 				$this->setIssue($input);
-		}
+            $this->totalTests++;
+
+        }
         
         return count($this->issues);
     }
diff --git a/src/Rule/MarqueeIsNotUsed.php b/src/Rule/MarqueeIsNotUsed.php
@@ -21,7 +21,9 @@ public function check()
     {
         foreach ($this->getAllElements('marquee') as $m) {
 			$this->setIssue($m);
-		}
+            $this->totalTests++;
+
+        }
         
         return count($this->issues);
     }
diff --git a/src/Rule/NoHeadings.php b/src/Rule/NoHeadings.php
@@ -32,7 +32,9 @@ public function check()
 				$this->setIssue($this->dom->documentElement);
 			}
 		}
-        
+        $this->totalTests++;
+
+
         return count($this->issues);
     }
 
diff --git a/src/Rule/ObjectInterfaceIsAccessible.php b/src/Rule/ObjectInterfaceIsAccessible.php
@@ -21,7 +21,10 @@ public function check()
     {
         foreach ($this->getAllElements('object') as $object) {
 			$this->setIssue($object);
-		}
+
+            $this->totalTests++;
+
+        }
         
         return count($this->issues);
     }
diff --git a/src/Rule/ObjectMustContainText.php b/src/Rule/ObjectMustContainText.php
@@ -32,6 +32,7 @@ function check()
                 && (!$object->hasAttribute('alt') || trim($object->getAttribute('alt')) == '')){
 					$this->setIssue($object);
 			}
+            $this->totalTests++;
 
             return count($this->issues);
 		}   
diff --git a/src/Rule/ObjectShouldHaveLongDescription.php b/src/Rule/ObjectShouldHaveLongDescription.php
@@ -21,7 +21,8 @@ public function check()
     {
         foreach ($this->getAllElements('object') as $object) {
 			$this->setIssue($object);
-		}
+            $this->totalTests++;
+        }
         
         return count($this->issues);
     }
diff --git a/src/Rule/ObjectTagDetected.php b/src/Rule/ObjectTagDetected.php
@@ -21,7 +21,9 @@ public function check()
     {
         foreach ($this->getAllElements('object') as $object) {
 			$this->setIssue($object);
-		}
+            $this->totalTests++;
+
+        }
         
         return count($this->issues);
     }
diff --git a/src/Rule/ParagraphNotUsedAsHeader.php b/src/Rule/ParagraphNotUsedAsHeader.php
@@ -44,7 +44,9 @@ public function check()
 					}
 				}
 			}
-		}
+            $this->totalTests++;
+
+        }
 
 		return count($this->issues);
 	}
diff --git a/src/Rule/PreShouldNotBeUsedForTabularValues.php b/src/Rule/PreShouldNotBeUsedForTabularValues.php
@@ -23,7 +23,8 @@ public function check()
 			$rows = preg_split('/[\n\r]+/', $pre->nodeValue);
 			if (count($rows) > 1)
 				$this->setIssue($pre);
-		}
+            $this->totalTests++;
+        }
         
         return count($this->issues);
     }
diff --git a/src/Rule/RedirectedLink.php b/src/Rule/RedirectedLink.php
@@ -25,7 +25,9 @@ public function check()
 			if ($href) {
 				$links[$href] = $a;
 			}
-		}
+            $this->totalTests++;
+
+        }
 		$this->checkLink($links);
 
 		return count($this->issues);
diff --git a/src/Rule/TableDataShouldHaveTableHeader.php b/src/Rule/TableDataShouldHaveTableHeader.php
diff --git a/src/Rule/TableHeaderShouldHaveScope.php b/src/Rule/TableHeaderShouldHaveScope.php
diff --git a/src/Rule/VideoEmbedCheck.php b/src/Rule/VideoEmbedCheck.php
diff --git a/src/Rule/VideoProvidesCaptions.php b/src/Rule/VideoProvidesCaptions.php
diff --git a/src/Rule/VideoScan.php b/src/Rule/VideoScan.php

Original file line number	Diff line number	Diff line change
`@@ -33,8 +33,9 @@ public function checkMany($content, $ruleIds = [], $options = [])`
`33`	`33`	`}`
`34`	`34`
`35`	`35`	`$rule = new $className($document, $options);`
`36`		`- $rule->check();`
	`36`	`+ $issueCount = $rule->check();`
`37`	`37`
	`38`	`+ $report->setIssueCounts($ruleId, $issueCount, $rule->getTotalTests());`
`38`	`39`	`$report->setIssues($rule->getIssues());`
`39`	`40`	`$report->setErrors($rule->getErrors());`
`40`	`41`	`} catch (\Exception $e) {`
Original file line number	Diff line number	Diff line change
`@@ -32,6 +32,7 @@ public function check()`
`32`	`32`	`$this->setIssue($a);`
`33`	`33`	`}`
`34`	`34`	`}`
	`35`	`+ $this->totalTests++;`
`35`	`36`	`}`
`36`	`37`
`37`	`38`	`return count($this->issues);`
Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,8 @@ public function check()`
`34`	`34`	`$this->setIssue($a);`
`35`	`35`	`}`
`36`	`36`	`}`
`37`		`- }`
	`37`	`+ $this->totalTests++;`
	`38`	`+ }`
`38`	`39`
`39`	`40`	`return count($this->issues);`
`40`	`41`	`}`
Original file line number	Diff line number	Diff line change
`@@ -25,6 +25,7 @@ public function check()`
`25`	`25`	`if (!$this->elementContainsReadableText($a) && ($a->hasAttribute('href'))) {`
`26`	`26`	`$this->setIssue($a);`
`27`	`27`	`}`
	`28`	`+ $this->totalTests++;`
`28`	`29`	`}`
`29`	`30`
`30`	`31`	`return count($this->issues);`
Original file line number	Diff line number	Diff line change
`@@ -20,6 +20,7 @@ public function check()`
`20`	`20`	`{`
`21`	`21`	`foreach ($this->getAllElements('basefont') as $b) {`
`22`	`22`	`$this->setIssue($b);`
	`23`	`+ $this->totalTests++;`
`23`	`24`	`}`
`24`	`25`
`25`	`26`	`return count($this->issues);`
Original file line number	Diff line number	Diff line change
`@@ -25,6 +25,7 @@ class BaseRule implements PhpAllyRuleInterface {`
`25`	`25`	`protected $altTextLengthLimit;`
`26`	`26`	`protected $minDocLengthForHeaders;`
`27`	`27`	`protected $maxWordCount;`
	`28`	`+ protected $totalTests = 0;`
`28`	`29`
`29`	`30`	`public function __construct(DOMDocument $dom, $options = [])`
`30`	`31`	`{`
`@@ -217,8 +218,6 @@ private function walkUpTreeForInheritance($element, $style) {`
`217`	`218`	`}`
`218`	`219`
`219`	`220`
`220`		`-`
`221`		`-`
`222`	`221`	`public function elementContainsReadableText($element)`
`223`	`222`	`{`
`224`	`223`	`if (is_a($element, 'DOMText')) {`
`@@ -266,6 +265,15 @@ public function getIssues()`
`266`	`265`	`return $this->issues;`
`267`	`266`	`}`
`268`	`267`
	`268`	`+ public function getTotalTests()`
	`269`	`+ {`
	`270`	`+ return $this->totalTests;`
	`271`	`+ }`
	`272`	`+ public function IncrementTotalTests()`
	`273`	`+ {`
	`274`	`+ return $this->totalTests++;`
	`275`	`+ }`
	`276`	`+`
`269`	`277`	`public function setError($errorMsg)`
`270`	`278`	`{`
`271`	`279`	`$this->errors[] = $errorMsg;`
`@@ -323,4 +331,6 @@ function propertyIsEqual($object, $property, $value, $trim = false, $lower = fal`
`323`	`331`	`}`
`324`	`332`	`return ($property_value == $value);`
`325`	`333`	`}`
	`334`	`+`
	`335`	`+`
`326`	`336`	`}`
Original file line number	Diff line number	Diff line change
`@@ -21,6 +21,7 @@ public function check()`
`21`	`21`	`{`
`22`	`22`	`foreach ($this->getAllElements('blink') as $b) {`
`23`	`23`	`$this->setIssue($b);`
	`24`	`+ $this->totalTests++;`
`24`	`25`	`}`
`25`	`26`
`26`	`27`	`return count($this->issues);`