Expand nested components

Closes #1

src/Document.php

@@ -1,12 +1,18 @@
 <?php
 namespace Gt\DomTemplate;
 
-use DOMElement;
 use Gt\Dom\Document as BaseDocument;
+use DOMNode;
+use DOMElement;
+use DOMDocumentFragment;
+
 
 class Document extends BaseDocument {
 	public function __construct($document = null) {
 		parent::__construct($document);
-		$this->registerNodeClass(DOMElement::class, Node::class);
+
+		$this->registerNodeClass(DOMNode::class, Node::class);
+		$this->registerNodeClass(DOMElement::class, Element::class);
+		$this->registerNodeClass(DOMDocumentFragment::class, DocumentFragment::class);
 	}
 }

src/DocumentFragment.php

@@ -0,0 +1,8 @@
+<?php
+namespace Gt\DomTemplate;
+
+use Gt\Dom\DocumentFragment as BaseDocumentFragment;
+
+class DocumentFragment extends BaseDocumentFragment {
+	use TemplateParent;
+}

src/DomTemplateException.php

@@ -0,0 +1,7 @@
+<?php
+
+namespace Gt\DomTemplate;
+
+use RuntimeException;
+
+class DomTemplateException extends RuntimeException {}

src/Element.php

@@ -5,4 +5,5 @@
 
 class Element extends BaseElement {
 	use Bindable;
+	use TemplateParent;
 }

src/HTMLDocument.php

@@ -1,21 +1,24 @@
 <?php
 namespace Gt\DomTemplate;
 
-use DOMElement;
-use DOMNode;
-use Gt\Dom\DocumentFragment;
 use Gt\Dom\HTMLDocument as BaseHTMLDocument;
+use Gt\Dom\DocumentFragment as BaseDocumentFragment;
+use DOMNode;
+use DOMElement;
+use DOMDocumentFragment;
 
 class HTMLDocument extends BaseHTMLDocument {
 	use TemplateParent;
 
 	public function __construct($document = "") {
 		parent::__construct($document);
+
 		$this->registerNodeClass(DOMNode::class, Node::class);
 		$this->registerNodeClass(DOMElement::class, Element::class);
+		$this->registerNodeClass(DOMDocumentFragment::class, DocumentFragment::class);
 	}
 
-	protected function createTemplateFragment(DOMElement $templateElement):DocumentFragment {
+	protected function createTemplateFragment(DOMElement $templateElement):BaseDocumentFragment {
 		$fragment = $this->createDocumentFragment();
 
 		if($templateElement->tagName === "template") {

src/TemplateComponentNotFoundException.php

@@ -0,0 +1,5 @@
+<?php
+
+namespace Gt\DomTemplate;
+
+class TemplateComponentNotFoundException extends DomTemplateException {}

src/TemplateParent.php

@@ -2,9 +2,9 @@
 namespace Gt\DomTemplate;
 
 use DirectoryIterator;
-use Gt\Dom\DocumentFragment;
 use Gt\Dom\HTMLCollection;
 use Gt\Dom\Element as BaseElement;
+use Gt\Dom\DocumentFragment as BaseDocumentFragment;
 
 trait TemplateParent {
 	protected $templateFragmentMap = [];
@@ -33,10 +33,6 @@ public function extractTemplates():int {
 		return $i + 1;
 	}
 
-	public function setTemplateFilePath(string $path):void {
-		$this->templateFilePath = $path;
-	}
-
 	public function getTemplate(string $name):?DocumentFragment {
 		if(isset($this->templateFragmentMap[$name])) {
 			return $this->templateFragmentMap[$name];
@@ -61,47 +57,67 @@ public function getTemplate(string $name):?DocumentFragment {
 		return null;
 	}
 
-	public function expandComponents():int {
-		$count = 0;
-
-		/** @var HTMLCollection $componentList*/
-		$componentList = $this->xPath("//*[contains(local-name(), '-')]");
+	public function expandComponents(string $templateFilePath):int {
+// Any HTML element is considered a "custom element" if it contains a hyphen in its name:
+// @see https://www.w3.org/TR/custom-elements/#valid-custom-element-name
+		/** @var HTMLCollection $componentList */
+		$componentList = $this->xPath(
+			"descendant-or-self::*[contains(local-name(), '-')]"
+		);
 
+		$count = 0;
 		foreach($componentList as $component) {
 			$name = $component->tagName;
 
 			if(!isset($this->templateFragmentMap[$name])) {
-				$this->templateFragmentMap[$name] = $this->loadComponent($name);
+				try {
+					$this->templateFragmentMap[$name] = $this->loadComponent(
+						$name,
+						$templateFilePath
+					);
+				}
+				catch(TemplateComponentNotFoundException $exception) {}
 			}
 
+			/** @var DocumentFragment $fragment */
 			$fragment = $this->templateFragmentMap[$name];
+
 			if(is_null($fragment)) {
 				continue;
 			}
 
+			$fragment->expandComponents($templateFilePath);
 			$component->replaceWith($fragment);
 			$count++;
 		}
 
 		return $count;
 	}
 
-	protected function loadComponent(string $name):?DocumentFragment {
-		$filePath = $this->getTemplateFilePath($name);
+	protected function loadComponent(string $name, string $path):BaseDocumentFragment {
+		$filePath = $this->getTemplateFilePath($name, $path);
 
 		if(is_null($filePath)) {
-			return null;
+			throw new TemplateComponentNotFoundException($filePath);
 		}
 
 		$html = file_get_contents($filePath);
 		/** @var DocumentFragment $fragment */
-		$fragment = $this->createDocumentFragment();
+		if(method_exists($this, "createDocumentFragment")) {
+			$fragment = $this->createDocumentFragment();
+		}
+		else {
+			/** @var HTMLDocument $ownerDocument */
+			$ownerDocument = $this->ownerDocument;
+			$fragment = $ownerDocument->createDocumentFragment();
+		}
+
 		$fragment->appendXML($html);
 		return $fragment;
 	}
 
-	protected function getTemplateFilePath(string $name):?string {
-		foreach(new DirectoryIterator($this->templateFilePath) as $fileInfo) {
+	protected function getTemplateFilePath(string $name, string $path):?string {
+		foreach(new DirectoryIterator($path) as $fileInfo) {
 			if(!$fileInfo->isFile()) {
 				continue;
 			}

test/unit/TemplateParentTest.php

@@ -62,8 +62,9 @@ public function testGetTemplate() {
 	}
 
 	public function testExpandComponentsNoComponents() {
+		$templateDir = self::TEST_DIR . "/" . self::TEMPLATE_PATH;
 		$document = new HTMLDocument(Helper::HTML_TEMPLATES);
-		$count = $document->expandComponents();
+		$count = $document->expandComponents($templateDir);
 		self::assertEquals(0, $count);
 	}
 
@@ -88,12 +89,33 @@ public function testExpandComponents() {
 
 		$elementBeforeOrderedList = $document->querySelector("ordered-list")->previousElementSibling;
 
-		$document->setTemplateFilePath($templateDir);
-		$count = $document->expandComponents();
+		$count = $document->expandComponents($templateDir);
 		self::assertEquals(2, $count);
 		self::assertNull($document->querySelector("title-definition-list"));
 		self::assertNull($document->querySelector("ordered-list"));
 
 		self::assertEquals("ol", $elementBeforeOrderedList->nextElementSibling->tagName);
 	}
+
+	public function testNestedComponentsExpand() {
+		// While the count of the expandCompnents > 0, do it again on the expanded component...
+		$templateDir = self::TEST_DIR . "/" . self::TEMPLATE_PATH;
+		file_put_contents(
+			"$templateDir/title-definition-list.html",
+			Helper::COMPONENT_TITLE_DEFINITION_LIST
+		);
+		file_put_contents(
+			"$templateDir/title-definition.html",
+			Helper::COMPONENT_TITLE_DEFINITION
+		);
+		$document = new HTMLDocument(Helper::HTML_COMPONENTS);
+		$document->expandComponents($templateDir);
+
+		$expandedComponent = $document->querySelector("dl");
+		self::assertInstanceOf(Element::class, $expandedComponent);
+		self::assertInstanceOf(Element::class, $expandedComponent->firstElementChild);
+		self::assertInstanceOf(Element::class, $expandedComponent->lastElementChild);
+		self::assertEquals("dt", $expandedComponent->firstElementChild->tagName);
+		self::assertEquals("dd", $expandedComponent->lastElementChild->tagName);
+	}
 }