Merge pull request #50 from cidilabs/chuck/document-element-issues

Updates ContentTooLong and NoHeadings rules to return empty string rather than all HTML
cidilabs · Jan 26, 2023 · 9a176d9 · 9a176d9
2 parents f7bf9f6 + 9144bf4
commit 9a176d9
Show file tree

Hide file tree

Showing 7 changed files with 82 additions and 37 deletions.
diff --git a/composer.json b/composer.json
@@ -14,12 +14,12 @@
         }
     ],
     "require": {
-        "php": ">=8.0",
+        "php": ">=7.4",
         "guzzlehttp/guzzle": "^7.5.0",
         "kaltura/api-client-library": "^17.2"
     },
     "scripts": {
-        "test": "./vendor/bin/phpunit tests"
+        "test": "./vendor/bin/phpunit tests --verbose"
     },
     "autoload": {
         "classmap": [

diff --git a/composer.lock b/composer.lock
diff --git a/src/PhpAllyIssue.php b/src/PhpAllyIssue.php
@@ -9,6 +9,7 @@ class PhpAllyIssue implements \JsonSerializable
     protected $ruleId;
     protected $element;
     protected $previewElement;
+    protected $metadata;
 
     public function __construct($ruleId, DOMElement $element = null, DOMElement $previewElement = null, $metadata = null)
     {
@@ -56,6 +57,14 @@ public function getHtml()
             return '';
         }
 
+        $metaStr = $this->getMetadata();
+        if ($metaStr) {
+            $metadata = \json_decode($metaStr, true);
+            if (!empty($metadata['isDocumentElement'])) {
+                return '';
+            }
+        }
+
         return $this->element->ownerDocument->saveHTML($this->element);
     }
 
@@ -64,8 +73,18 @@ public function getPreview()
         if (!$this->previewElement) {
             return '';
         }
+
+        $metaStr = $this->getMetadata();
+        if ($metaStr) {
+            $metadata = \json_decode($metaStr, true);
+            if (!empty($metadata['isDocumentElement'])) {
+                return '';
+            }
+        }
+
+        $preview = $this->element->ownerDocument->saveHTML($this->previewElement);
 
-        return $this->element->ownerDocument->saveHTML($this->previewElement);
+        return str_replace('<?xml encoding="utf-8" ?>', '', $preview);
     }
 
     public function toArray(): array

diff --git a/src/Rule/BaseRule.php b/src/Rule/BaseRule.php
@@ -17,6 +17,7 @@ class BaseRule implements PhpAllyRuleInterface {
     protected $errors = [];
     protected $lang;
     protected $strings = array('en' => '');
+	protected $options;
 
     const ALT_TEXT_LENGTH_LIMIT = 150;
     const DOC_LENGTH = 1500;
@@ -272,7 +273,6 @@ public function setIssue($element, $ruleId = null, $metadata = null)
 
 		$ruleId = str_replace(['CidiLabs\\PhpAlly\\Rule\\','App\\Rule\\'], '', $ruleId);
 		$previewElement = $this->previewElement;
-		$isDocumentElement = false;
 
         if ($element) {
             $elementClasses = $element->getAttribute('class');

diff --git a/src/Rule/DocumentReadingDirection.php b/src/Rule/DocumentReadingDirection.php
@@ -31,8 +31,9 @@ public function check()
 				if ($element->getAttribute('dir') != 'rtl')
 				 	$this->setIssue($element);
 			}
-            $this->totalTests++;
 		}
+
+        $this->totalTests++;
 
         return count($this->issues);
     }

diff --git a/src/Rule/NoHeadings.php b/src/Rule/NoHeadings.php
@@ -45,5 +45,10 @@ public function check()
             return count($this->issues);
         }
     }
+
+    public function getPreviewElement(DOMElement $a = null)
+    {
+        return $a;
+    }
 
 }
diff --git a/tests/ContentTooLongTest.php b/tests/ContentTooLongTest.php
@@ -52,4 +52,20 @@ public function testCheckSkipScriptTags()
 
         $this->assertEquals(0, $rule->check(), 'Content Too Long should have no issues.');
     }
+
+    public function testCheckMetadata()
+    {
+        $html = file_get_contents(__DIR__ . '/../tests/testFiles/ContentTooLong.html');
+        $dom = new \DOMDocument('1.0', 'utf-8');
+        $dom->loadHTML($html);
+        $rule = new ContentTooLong($dom);
+
+        $this->assertEquals(1, $rule->check(), 'Content Too Long should have issues.');
+
+        $issues = $rule->getIssues();
+        $issue = reset($issues);
+
+        $this->assertEquals('', $issue->getHtml(), 'Content Too Long getHtml() returns an empty string.');
+        $this->assertEquals('', $issue->getPreview(), 'Content Too Long getHtml() returns an empty string.');
+    }
 }