refactor(view): attach tokens to relevant elements for raw slot content support (#1428)

Author: brendt

packages/view/src/Elements/ElementFactory.php

@@ -63,7 +63,7 @@ private function makeElement(Token $token, ?Element $parent): ?Element
         }
 
         if (! $token->tag || $token->type === TokenType::COMMENT || $token->type === TokenType::PHP) {
-            return new RawElement(tag: null, content: $token->compile());
+            return new RawElement(token: $token, tag: null, content: $token->compile());
         }
 
         $attributes = $token->htmlAttributes;
@@ -74,6 +74,7 @@ private function makeElement(Token $token, ?Element $parent): ?Element
 
         if ($token->tag === 'code' || $token->tag === 'pre') {
             return new RawElement(
+                token: $token,
                 tag: $token->tag,
                 content: $token->compileChildren(),
                 attributes: $attributes,
@@ -91,22 +92,26 @@ private function makeElement(Token $token, ?Element $parent): ?Element
             }
 
             $element = new ViewComponentElement(
+                token: $token,
                 environment: $this->appConfig->environment,
                 compiler: $this->compiler,
                 viewComponent: $viewComponentClass,
                 attributes: $attributes,
             );
         } elseif ($token->tag === 'x-template') {
             $element = new TemplateElement(
+                token: $token,
                 attributes: $attributes,
             );
         } elseif ($token->tag === 'x-slot') {
             $element = new SlotElement(
+                token: $token,
                 name: $token->getAttribute('name') ?? Slot::DEFAULT,
                 attributes: $attributes,
             );
         } else {
             $element = new GenericElement(
+                token: $token,
                 tag: $token->tag,
                 attributes: $attributes,
             );

packages/view/src/Elements/GenericElement.php

@@ -5,15 +5,17 @@
 namespace Tempest\View\Elements;
 
 use Tempest\View\Element;
+use Tempest\View\Parser\Token;
+use Tempest\View\WithToken;
 
 use function Tempest\Support\Html\is_void_tag;
-use function Tempest\Support\str;
 
-final class GenericElement implements Element
+final class GenericElement implements Element, WithToken
 {
     use IsElement;
 
     public function __construct(
+        public readonly Token $token,
         private readonly string $tag,
         array $attributes,
     ) {

packages/view/src/Elements/RawElement.php

@@ -5,14 +5,17 @@
 namespace Tempest\View\Elements;
 
 use Tempest\View\Element;
+use Tempest\View\Parser\Token;
+use Tempest\View\WithToken;
 
 use function Tempest\Support\str;
 
-final class RawElement implements Element
+final class RawElement implements Element, WithToken
 {
     use IsElement;
 
     public function __construct(
+        public readonly Token $token,
         private readonly ?string $tag,
         private readonly string $content,
         array $attributes = [],

packages/view/src/Elements/SlotElement.php

@@ -5,12 +5,15 @@
 namespace Tempest\View\Elements;
 
 use Tempest\View\Element;
+use Tempest\View\Parser\Token;
+use Tempest\View\WithToken;
 
-final class SlotElement implements Element
+final class SlotElement implements Element, WithToken
 {
     use IsElement;
 
     public function __construct(
+        public readonly Token $token,
         public readonly string $name,
         array $attributes = [],
     ) {

packages/view/src/Elements/TemplateElement.php

@@ -5,13 +5,17 @@
 namespace Tempest\View\Elements;
 
 use Tempest\View\Element;
+use Tempest\View\Parser\Token;
+use Tempest\View\WithToken;
 
-final class TemplateElement implements Element
+final class TemplateElement implements Element, WithToken
 {
     use IsElement;
 
-    public function __construct(array $attributes = [])
-    {
+    public function __construct(
+        public readonly Token $token,
+        array $attributes = [],
+    ) {
         $this->attributes = $attributes;
     }
 

packages/view/src/Elements/ViewComponentElement.php

@@ -11,19 +11,22 @@
 use Tempest\View\Element;
 use Tempest\View\Parser\TempestViewCompiler;
 use Tempest\View\Parser\TempestViewParser;
+use Tempest\View\Parser\Token;
 use Tempest\View\Slot;
 use Tempest\View\ViewComponent;
+use Tempest\View\WithToken;
 
 use function Tempest\Support\arr;
 use function Tempest\Support\str;
 
-final class ViewComponentElement implements Element
+final class ViewComponentElement implements Element, WithToken
 {
     use IsElement;
 
     private array $dataAttributes;
 
     public function __construct(
+        public readonly Token $token,
         private readonly Environment $environment,
         private readonly TempestViewCompiler $compiler,
         private readonly ViewComponent $viewComponent,
@@ -47,19 +50,19 @@ public function getSlots(): ImmutableArray
     {
         $slots = arr();
 
-        $default = [];
+        $defaultTokens = [];
 
-        foreach ($this->getChildren() as $child) {
-            if ($child instanceof SlotElement) {
-                $slot = Slot::fromElement($child);
+        foreach ($this->token->children as $child) {
+            if ($child->tag === 'x-slot') {
+                $slot = Slot::named($child);
 
                 $slots[$slot->name] = $slot;
             } else {
-                $default[] = $child;
+                $defaultTokens[] = $child;
             }
         }
 
-        $slots[Slot::DEFAULT] = Slot::fromElement(new CollectionElement($default));
+        $slots[Slot::DEFAULT] = Slot::default(...$defaultTokens);
 
         return $slots;
     }
@@ -154,7 +157,9 @@ public function compile(): string
                     return $this->environment->isProduction() ? '' : ('<!--' . $matches[0] . '-->');
                 }
 
-                $compiled = $slot->content;
+                $slotElement = $this->getSlotElement($slot->name);
+
+                $compiled = $slotElement?->compile() ?? '';
 
                 // There's no default slot content, but there's a default value in the view component
                 if (trim($compiled) === '') {
@@ -167,4 +172,25 @@ public function compile(): string
 
         return $this->compiler->compile($compiled->toString());
     }
+
+    private function getSlotElement(string $name): SlotElement|CollectionElement|null
+    {
+        $defaultElements = [];
+
+        foreach ($this->getChildren() as $childElement) {
+            if ($childElement instanceof SlotElement && $childElement->name === $name) {
+                return $childElement;
+            }
+
+            if (! ($childElement instanceof SlotElement)) {
+                $defaultElements[] = $childElement;
+            }
+        }
+
+        if ($name === Slot::DEFAULT) {
+            return new CollectionElement($defaultElements);
+        }
+
+        return null;
+    }
 }

packages/view/src/Parser/Token.php

@@ -8,6 +8,7 @@
 
 final class Token
 {
+    /** @var \Tempest\View\Parser\Token[] */
     private(set) array $children = [];
 
     private(set) ?Token $parent = null;

packages/view/src/Slot.php

@@ -4,8 +4,7 @@
 
 namespace Tempest\View;
 
-use Tempest\View\Elements\CollectionElement;
-use Tempest\View\Elements\SlotElement;
+use Tempest\View\Parser\Token;
 
 final class Slot
 {
@@ -22,12 +21,33 @@ public function __get(string $name): mixed
         return $this->attributes[$name] ?? null;
     }
 
-    public static function fromElement(SlotElement|CollectionElement $element): self
+    public static function named(Token $token): self
     {
+        $name = $token->getAttribute('name');
+        $attributes = $token->htmlAttributes;
+        $content = $token->compileChildren();
+
+        return new self(
+            name: $name,
+            attributes: $attributes,
+            content: $content,
+        );
+    }
+
+    public static function default(Token ...$tokens): self
+    {
+        $name = Slot::DEFAULT;
+        $attributes = [];
+        $content = '';
+
+        foreach ($tokens as $token) {
+            $content .= $token->compile();
+        }
+
         return new self(
-            name: $element->name ?? self::DEFAULT,
-            attributes: $element->getAttributes(),
-            content: $element->compile(),
+            name: $name,
+            attributes: $attributes,
+            content: $content,
         );
     }
 

packages/view/src/WithToken.php

@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tempest\View;
+
+use Tempest\View\Parser\Token;
+
+interface WithToken
+{
+    public Token $token {
+        get;
+    }
+}