fix #233 - Made comments self-closing

Author: paquettg

CHANGELOG.md

@@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Changed
 - Fixed issue with numbers in comments.
 - Updated minimume php version to correct version.
+- Comment tags are now self-closing when cleanup input is set to false.
 
 ## 3.1.0
 

src/PHPHtmlParser/Content.php

@@ -72,6 +72,22 @@ public function char(?int $char = null): string
         return $this->content[$char ?? $this->pos] ?? '';
     }
 
+    /**
+     * Gets a string from the current character position.
+     *
+     * @param int $length
+     * @return string
+     */
+    public function string(int $length = 1): string
+    {
+        $string = '';
+        $position = $this->pos;
+        do {
+            $string .= $this->char($position++);
+        } while ($position < $this->pos + $length);
+        return $string;
+    }
+
     /**
      * Moves the current position forward.
      *

src/PHPHtmlParser/Dom/Parser.php

@@ -183,6 +183,14 @@ private function parseTag(Options $options, Content $content, int $size): TagDTO
                 ->setOpening('<?')
                 ->setClosing(' ?>')
                 ->selfClosing();
+        } elseif($content->string(3) == '!--') {
+            // comment tag
+            $tag = $content->fastForward(3)
+                ->copyByToken(StringToken::CLOSECOMMENT(), true);
+            $tag = (new Tag($tag))
+                ->setOpening('<!--')
+                ->setClosing('-->')
+                ->selfClosing();
         } else {
             $tag = \strtolower($content->copyByToken(StringToken::SLASH(), true));
             if (\trim($tag) == '') {

src/PHPHtmlParser/Enum/StringToken.php

@@ -11,11 +11,13 @@
  * @method static StringToken EQUAL()
  * @method static StringToken SLASH()
  * @method static StringToken ATTR()
+ * @method static StringToken CLOSECOMMENT()
  */
 class StringToken extends Enum
 {
     private const BLANK = " \t\r\n";
     private const EQUAL = ' =/>';
     private const SLASH = " />\r\n\t";
     private const ATTR = ' >';
+    private const CLOSECOMMENT = '-->';
 }

tests/Dom/CommentTest.php

@@ -0,0 +1,34 @@
+<?php
+
+declare(strict_types=1);
+
+use PHPHtmlParser\Dom;
+use PHPHtmlParser\Options;
+use PHPUnit\Framework\TestCase;
+
+class CommentTest extends TestCase
+{
+    /**
+     * @var Dom
+     */
+    private $dom;
+
+    public function setUp()
+    {
+        $dom = new Dom();
+        $options = new Options();
+        $options->setCleanupInput(false);
+        $dom->loadStr('<!-- test comment with number 2 -->', $options);
+        $this->dom = $dom;
+    }
+
+    public function tearDown()
+    {
+        Mockery::close();
+    }
+
+    public function testLoadCommentInnerHtml()
+    {
+        $this->assertEquals('<!-- test comment with number 2 -->', $this->dom->innerHtml);
+    }
+}

tests/Node/TextTest.php

@@ -75,14 +75,4 @@ public function testSetTextEncoded()
         $node->setText('biz baz');
         $this->assertEquals('biz baz', $node->text());
     }
-
-    public function testCommentWithNumbers() {
-      $dom = new Dom;
-      $options = new Options();
-      $options->setCleanupInput(false);
-      $dom->setOptions($options);
-      $dom->loadStr('<!-- test comment with number 2 -->');
-      $output = $dom->outerHtml;
-      $this->assertContains('<!-- test comment with number 2 -->', $output);
-    }
 }