feature: trim whitespace when there are only template children

closes #363
PhpGt · Jan 17, 2023 · 3dbda21 · 3dbda21
1 parent 3def753
commit 3dbda21
Show file tree

Hide file tree

Showing 4 changed files with 52 additions and 0 deletions.
diff --git a/src/TemplateCollection.php b/src/TemplateCollection.php
@@ -60,6 +60,7 @@ private function extractTemplates(Document $document):void {
 
 	private function findMatch(Element $context):TemplateElement {
 		$contextPath = (string)(new NodePathCalculator($context));
+		/** @noinspection RegExpRedundantEscape */
 		$contextPath = preg_replace(
 			"/(\[\d+\])/",
 			"",

diff --git a/src/TemplateElement.php b/src/TemplateElement.php
@@ -4,6 +4,7 @@
 use Gt\Dom\Element;
 use Gt\Dom\Node;
 use Gt\Dom\Text;
+use Throwable;
 
 class TemplateElement {
 	private string $templateParentPath;
@@ -36,6 +37,20 @@ public function __construct(
 
 	public function removeOriginalElement():void {
 		$this->originalElement->remove();
+		try {
+			$parent = $this->getTemplateParent();
+			if(count($parent->children) === 0) {
+				if($firstNode = $parent->childNodes[0] ?? null) {
+					if(trim($firstNode->wholeText) === "") {
+						$parent->innerHTML = "";
+					}
+				}
+			}
+		}
+// In nested lists, there may not be an actual element attached to the document
+// yet, but the parent still has a path - this outcome is expected and
+// completely fine in this case.
+		catch(Throwable) {}
 	}
 
 	public function getClone():Node|Element {

diff --git a/test/phpunit/TemplateCollectionTest.php b/test/phpunit/TemplateCollectionTest.php
@@ -116,4 +116,30 @@ public function testBindListData_nestedList_manual():void {
 			}
 		}
 	}
+
+	public function testConstructor_removesWhitespace():void {
+		$document = new HTMLDocument(DocumentTestFactory::HTML_LIST_TEMPLATE);
+		new TemplateCollection($document);
+		self::assertSame("", $document->querySelector("ul")->innerHTML);
+	}
+
+	public function testConstructor_nonTemplateChildrenArePreserved():void {
+		$document = new HTMLDocument(DocumentTestFactory::HTML_LIST_WITH_TEXTNODE);
+		new TemplateCollection($document);
+		$ulChildren = $document->querySelector("ul")->children;
+		self::assertCount(1, $ulChildren);
+		self::assertSame("This list item will always show at the end", $ulChildren[0]->textContent);
+	}
+
+	public function testConstructor_nonTemplateChildrenArePreservedInOrder():void {
+		$document = new HTMLDocument(DocumentTestFactory::HTML_LIST_WITH_TEXTNODE);
+		$sut = new TemplateCollection($document);
+		$ulChildren = $document->querySelector("ul")->children;
+		$template = $sut->get($document);
+		$template->insertTemplate();
+		$template->insertTemplate();
+		$template->insertTemplate();
+		self::assertCount(4, $ulChildren);
+		self::assertSame("This list item will always show at the end", $ulChildren[3]->textContent);
+	}
 }
diff --git a/test/phpunit/TestFactory/DocumentTestFactory.php b/test/phpunit/TestFactory/DocumentTestFactory.php
@@ -244,6 +244,16 @@ class DocumentTestFactory {
 </ol>
 HTML;
 
+	const HTML_LIST_WITH_TEXTNODE = <<<HTML
+<!doctype html>
+<!doctype html>
+<ul>
+	<li data-template data-bind:text>Template item!</li>
+	<li>This list item will always show at the end</li>
+</ul>
+HTML;
+
+
 	const HTML_TWO_LISTS = <<<HTML
 <!doctype html>
 <div id="favourites">