feat(view): support dynamic $slots and x-template (#911)

Author: brendt

src/Tempest/View/src/Components/AnonymousViewComponent.php

@@ -10,10 +10,9 @@
 final readonly class AnonymousViewComponent implements ViewComponent
 {
     public function __construct(
-        private string $contents,
-        private string $file,
-    ) {
-    }
+        public string $contents,
+        public string $file,
+    ) {}
 
     public static function getName(): string
     {
@@ -24,9 +23,4 @@ public function compile(ViewComponentElement $element): string
     {
         return $this->contents;
     }
-
-    public function getPath(): string
-    {
-        return $this->file;
-    }
-}
+}

src/Tempest/View/src/Elements/ElementFactory.php

@@ -101,9 +101,14 @@ private function makeElement(Node $node, ?Element $parent): ?Element
                 $viewComponentClass,
                 $attributes,
             );
+        } elseif ($tagName === 'x-template') {
+            $element = new TemplateElement(
+                attributes: $attributes,
+            );
         } elseif ($tagName === 'x-slot') {
             $element = new SlotElement(
                 name: $node->getAttribute('name') ?: 'slot',
+                attributes: $attributes,
             );
         } else {
             $element = new GenericElement(

src/Tempest/View/src/Elements/SlotElement.php

@@ -11,8 +11,10 @@ final class SlotElement implements Element
     use IsElement;
 
     public function __construct(
-        private readonly string $name,
+        public readonly string $name,
+        array $attributes = [],
     ) {
+        $this->attributes = $attributes;
     }
 
     public function matches(string $name): bool

src/Tempest/View/src/Elements/TemplateElement.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace Tempest\View\Elements;
+
+use Tempest\View\Element;
+
+final class TemplateElement implements Element
+{
+    use IsElement;
+
+    public function __construct(
+        array $attributes = [],
+    )
+    {
+        $this->attributes = $attributes;
+    }
+
+    public function compile(): string
+    {
+        $content = [];
+
+        foreach ($this->getChildren() as $child) {
+            $content[] = $child->compile();
+        }
+
+        return implode('', $content);
+    }
+}

src/Tempest/View/src/Elements/ViewComponentElement.php

@@ -6,7 +6,9 @@
 
 use Tempest\View\Element;
 use Tempest\View\Renderers\TempestViewCompiler;
+use Tempest\View\Slot;
 use Tempest\View\ViewComponent;
+use function Tempest\Support\arr;
 use function Tempest\Support\str;
 
 final class ViewComponentElement implements Element
@@ -17,7 +19,8 @@ public function __construct(
         private readonly TempestViewCompiler $compiler,
         private readonly ViewComponent $viewComponent,
         array $attributes,
-    ) {
+    )
+    {
         $this->attributes = $attributes;
     }
 
@@ -26,6 +29,22 @@ public function getViewComponent(): ViewComponent
         return $this->viewComponent;
     }
 
+    /** @return Element[] */
+    public function getSlots(): array
+    {
+        $slots = [];
+
+        foreach ($this->getChildren() as $child) {
+            if (! $child instanceof SlotElement) {
+                continue;
+            }
+
+            $slots[] = $child;
+        }
+
+        return $slots;
+    }
+
     public function getSlot(string $name = 'slot'): ?Element
     {
         foreach ($this->getChildren() as $child) {
@@ -57,7 +76,25 @@ public function getSlot(string $name = 'slot'): ?Element
 
     public function compile(): string
     {
+        /** @var Slot[] $slots */
+        $slots = arr($this->getSlots())
+            ->mapWithKeys(fn (SlotElement $element) => yield $element->name => Slot::fromElement($element))
+            ->toArray();
+
         $compiled = str($this->viewComponent->compile($this))
+            // Add dynamic slots to the current scope
+            ->prepend(
+                '<?php $_previousSlots = $slots ?? null; ?>', // Store previous slots in temporary variable to keep scope
+                sprintf('<?php $slots = %s; ?>', var_export($slots, true)), // Set the new value of $slots for this view component
+            )
+
+            // Cleanup slots after the view component and restore slots from previous scope
+            ->append(
+                '<?php unset($slots); ?>', // Unset current $slots
+                '<?php $slots = $_previousSlots ?? null; ?>', // Restore previous $slots
+                '<?php unset($_previousSlots); ?>', // Cleanup temporary $_previousSlots
+            )
+
             // Compile slots
             ->replaceRegex(
                 regex: '/<x-slot\s*(name="(?<name>\w+)")?((\s*\/>)|><\/x-slot>)/',

src/Tempest/View/src/Exceptions/DuplicateViewComponent.php

@@ -17,8 +17,8 @@ public function __construct(
     ) {
         $message = sprintf(
             "Could not register view component `{$name}` from `%s`, because a component with the same name already exists in `%s`",
-            $pending instanceof AnonymousViewComponent ? $pending->getPath() : $pending->getName(),
-            $existing instanceof AnonymousViewComponent ? $existing->getPath() : $existing,
+            $pending instanceof AnonymousViewComponent ? $pending->file : $pending->getName(),
+            $existing instanceof AnonymousViewComponent ? $existing->file : $existing,
         );
 
         parent::__construct($message);

src/Tempest/View/src/Exceptions/ViewVariableIsReserved.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace Tempest\View\Exceptions;
+
+use Exception;
+
+final class ViewVariableIsReserved extends Exception
+{
+    public function __construct(string $name)
+    {
+        parent::__construct('Cannot use reserved variable name `' . $name . '`');
+    }
+}

src/Tempest/View/src/IsView.php

@@ -19,16 +19,6 @@ public function __construct(
         $this->data = $data;
     }
 
-    public function getPath(): string
-    {
-        return $this->path;
-    }
-
-    public function getData(): array
-    {
-        return $this->data;
-    }
-
     public function get(string $key): mixed
     {
         return $this->{$key} ?? $this->data[$key] ?? null;

src/Tempest/View/src/Renderers/BladeViewRenderer.php

@@ -16,6 +16,6 @@ public function __construct(private Blade $blade)
 
     public function render(View|string|null $view): string
     {
-        return $this->blade->render($view->getPath(), $view->getData());
+        return $this->blade->render($view->path, $view->data);
     }
 }

src/Tempest/View/src/Renderers/TempestViewRenderer.php

@@ -7,6 +7,7 @@
 use Stringable;
 use Tempest\Support\HtmlString;
 use Tempest\View\Exceptions\ViewCompilationError;
+use Tempest\View\Exceptions\ViewVariableIsReserved;
 use Tempest\View\GenericView;
 use Tempest\View\View;
 use Tempest\View\ViewCache;
@@ -38,9 +39,11 @@ public function render(string|View $view): string
     {
         $view = is_string($view) ? new GenericView($view) : $view;
 
+        $this->validateView($view);
+
         $path = $this->viewCache->getCachedViewPath(
-            path: $view->getPath(),
-            compiledView: fn () => $this->cleanupCompiled($this->compiler->compile($view->getPath())),
+            path: $view->path,
+            compiledView: fn () => $this->cleanupCompiled($this->compiler->compile($view->path)),
         );
 
         return $this->renderCompiled($view, $path);
@@ -82,7 +85,7 @@ private function renderCompiled(View $_view, string $_path): string
         ob_start();
 
         // Extract data from view into local variables so that they can be accessed directly
-        $_data = $_view->getData();
+        $_data = $_view->data;
 
         extract($_data, flags: EXTR_SKIP);
 
@@ -105,4 +108,13 @@ public function escape(null|string|HtmlString|Stringable $value): string
 
         return htmlentities((string)$value);
     }
+
+    private function validateView(View $view): void
+    {
+        $data = $view->data;
+
+        if (array_key_exists('slots', $data)) {
+            throw new ViewVariableIsReserved('slots');
+        }
+    }
 }