feat(view): support relative view paths (#953)

Author: brendt

src/Tempest/Framework/Testing/IntegrationTest.php

@@ -87,12 +87,19 @@ protected function tearDown(): void
     {
         parent::tearDown();
 
+        /** @phpstan-ignore-next-line */
         unset($this->root);
+        /** @phpstan-ignore-next-line */
         unset($this->discoveryLocations);
+        /** @phpstan-ignore-next-line */
         unset($this->appConfig);
+        /** @phpstan-ignore-next-line */
         unset($this->kernel);
+        /** @phpstan-ignore-next-line */
         unset($this->container);
+        /** @phpstan-ignore-next-line */
         unset($this->console);
+        /** @phpstan-ignore-next-line */
         unset($this->http);
     }
 }

src/Tempest/Mapper/src/Exceptions/ViewNotFound.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace Tempest\Mapper\Exceptions;
+
+use Exception;
+
+final class ViewNotFound extends Exception
+{
+    public function __construct(string $path)
+    {
+        parent::__construct("View {$path} not found");
+    }
+}

src/Tempest/View/src/IsView.php

@@ -4,11 +4,15 @@
 
 namespace Tempest\View;
 
+use function Tempest\path;
+
 /** @phpstan-require-implements \Tempest\View\View */
 trait IsView
 {
     public string $path;
 
+    public ?string $relativeRootPath = null;
+
     public array $data = [];
 
     public function __construct(
@@ -17,6 +21,14 @@ public function __construct(
     ) {
         $this->path = $path;
         $this->data = $data;
+
+        $trace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS);
+
+        if (str_ends_with($trace[0]['file'], 'Tempest/View/src/functions.php')) {
+            $this->relativeRootPath = path($trace[1]['file'])->dirname();
+        } else {
+            $this->relativeRootPath = path($trace[0]['file'])->dirname();
+        }
     }
 
     public function get(string $key): mixed

src/Tempest/View/src/Renderers/TempestViewCompiler.php

@@ -8,10 +8,14 @@
 use Dom\NodeList;
 use Exception;
 use Tempest\Core\Kernel;
+use Tempest\Discovery\DiscoveryLocation;
+use Tempest\Mapper\Exceptions\ViewNotFound;
 use Tempest\View\Attributes\AttributeFactory;
 use Tempest\View\Element;
 use Tempest\View\Elements\ElementFactory;
+use Tempest\View\View;
 use function Tempest\path;
+use function Tempest\Support\arr;
 use function Tempest\Support\str;
 use const Dom\HTML_NO_DEFAULT_NS;
 
@@ -35,12 +39,12 @@ public function __construct(
         private Kernel $kernel,
     ) {}
 
-    public function compile(string $path): string
+    public function compile(string|View $view): string
     {
         $this->elementFactory->setViewCompiler($this);
 
         // 1. Retrieve template
-        $template = $this->retrieveTemplate($path);
+        $template = $this->retrieveTemplate($view);
 
         // 2. Parse as DOM
         $dom = $this->parseDom($template);
@@ -57,23 +61,38 @@ public function compile(string $path): string
         return $compiled;
     }
 
-    private function retrieveTemplate(string $path): string
+    private function retrieveTemplate(string|View $view): string
     {
+        $path = $view instanceof View ? $view->path : $view;
+
         if (! str_ends_with($path, '.php')) {
             return $path;
         }
 
-        $discoveryLocations = $this->kernel->discoveryLocations;
+        $searchPathOptions = [
+            $path
+        ];
 
-        $searchPath = $path;
+        if ($view instanceof View && $view->relativeRootPath !== null) {
+            $searchPathOptions[] = path($view->relativeRootPath, $path)->toString();
+        }
 
-        while (! file_exists($searchPath) && $location = current($discoveryLocations)) {
-            $searchPath = path($location->path, $path)->toString();
-            next($discoveryLocations);
+        $searchPathOptions = [
+            ...$searchPathOptions,
+            ...arr($this->kernel->discoveryLocations)
+                ->map(fn (DiscoveryLocation $discoveryLocation) => path($discoveryLocation->path, $path)->toString())
+                ->toArray()
+        ];
+
+        foreach ($searchPathOptions as $searchPath)
+        {
+            if (file_exists($searchPath)) {
+                break;
+            }
         }
 
         if (! file_exists($searchPath)) {
-            throw new Exception("View {$searchPath} not found");
+            throw new ViewNotFound($path);
         }
 
         return file_get_contents($searchPath);

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

@@ -43,7 +43,7 @@ public function render(string|View $view): string
 
         $path = $this->viewCache->getCachedViewPath(
             path: $view->path,
-            compiledView: fn () => $this->cleanupCompiled($this->compiler->compile($view->path)),
+            compiledView: fn () => $this->cleanupCompiled($this->compiler->compile($view)),
         );
 
         return $this->renderCompiled($view, $path);

src/Tempest/View/src/View.php

@@ -10,6 +10,10 @@ interface View
         get;
     }
 
+    public ?string $relativeRootPath {
+        get;
+    }
+
     public array $data {
         get;
     }

tests/Fixtures/Controllers/RelativeViewController.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace Tests\Tempest\Fixtures\Controllers;
+
+use Tempest\Router\Get;
+use Tempest\View\GenericView;
+use Tempest\View\View;
+use function Tempest\view;
+
+final class RelativeViewController
+{
+    #[Get('/relative-view-controller-with-view-function')]
+    public function asFunction(): View
+    {
+        return view('./relative-view.view.php');
+    }
+
+    #[Get('/relative-view-controller-with-view-object')]
+    public function asObject(): View
+    {
+        return new GenericView('./relative-view.view.php');
+    }
+}

tests/Fixtures/Controllers/relative-view.view.php

@@ -0,0 +1 @@
+Yes!

tests/Integration/View/TempestViewRendererTest.php

@@ -7,7 +7,9 @@
 use Tempest\Support\HtmlString;
 use Tempest\View\Exceptions\InvalidElement;
 use Tempest\View\ViewCache;
+use Tests\Tempest\Fixtures\Controllers\RelativeViewController;
 use Tests\Tempest\Integration\FrameworkIntegrationTestCase;
+use function Tempest\uri;
 use function Tempest\view;
 
 /**
@@ -45,6 +47,21 @@ public function test_view_renderer(): void
         );
     }
 
+    public function test_relative_view_path_rendering(): void
+    {
+        if (PHP_OS_FAMILY === 'Windows') {
+            $this->markTestSkipped('Relative paths not supported on Windows');
+        }
+
+        $this->http->get(uri([RelativeViewController::class, 'asFunction']))
+            ->assertOk()
+            ->assertSee('Yes!');
+
+        $this->http->get(uri([RelativeViewController::class, 'asObject']))
+            ->assertOk()
+            ->assertSee('Yes!');
+    }
+
     public function test_if_attribute(): void
     {
         $this->assertSame(
@@ -496,4 +513,4 @@ public function test_html_tags(): void
         $this->assertStringContainsString('<body', $html);
         $this->assertStringContainsString('<!-- test comment -->', $html);
     }
-}
+}