Add a Hyde::route() helper method

RELEASE_NOTES.md

@@ -11,6 +11,7 @@ This serves two purposes:
 
 ### Added
 - Added a `@head` stack to the `head.blade.php` component in https://github.com/hydephp/develop/pull/1567
+- Added a `Hyde::route()` helper to the `Hyde` facade in https://github.com/hydephp/develop/pull/1591
 
 ### Changed
 - for changes in existing functionality.

docs/_data/partials/hyde-pages-api/hyde-kernel-hyperlink-methods.md

@@ -1,7 +1,7 @@
 <section id="hyde-kernel-hyperlink-methods">
 
 <!-- Start generated docs for Hyde\Foundation\Concerns\ForwardsHyperlinks -->
-<!-- Generated by HydePHP DocGen script at 2023-03-11 11:17:34 in 0.09ms -->
+<!-- Generated by HydePHP DocGen script at 2024-02-25 19:02:29 in 0.09ms -->
 
 #### `formatLink()`
 
@@ -48,6 +48,15 @@ No description provided.
 Hyde::url(string $path): string
 ```
 
+#### `route()`
+
+No description provided.
+
+```php
+// torchlight! {"lineNumbers": false}
+Hyde::route(string $key): Hyde\Support\Models\Route
+```
+
 #### `hasSiteUrl()`
 
 No description provided.

packages/framework/src/Foundation/Concerns/ForwardsHyperlinks.php

@@ -4,6 +4,8 @@
 
 namespace Hyde\Foundation\Concerns;
 
+use Hyde\Support\Models\Route;
+
 /**
  * @internal Single-use trait for the HydeKernel class.
  *
@@ -36,6 +38,11 @@ public function url(string $path = ''): string
         return $this->hyperlinks->url($path);
     }
 
+    public function route(string $key): ?Route
+    {
+        return $this->hyperlinks->route($key);
+    }
+
     public function hasSiteUrl(): bool
     {
         return $this->hyperlinks->hasSiteUrl();

packages/framework/src/Foundation/Kernel/Hyperlinks.php

@@ -5,6 +5,7 @@
 namespace Hyde\Foundation\Kernel;
 
 use Hyde\Facades\Config;
+use Hyde\Support\Models\Route;
 use Hyde\Foundation\HydeKernel;
 use Hyde\Framework\Exceptions\BaseUrlNotSetException;
 use Hyde\Framework\Exceptions\FileNotFoundException;
@@ -148,4 +149,12 @@ public function url(string $path = ''): string
 
         throw new BaseUrlNotSetException();
     }
+
+    /**
+     * Get a route instance by its key from the kernel's route collection.
+     */
+    public function route(string $key): ?Route
+    {
+        return $this->kernel->routes()->get($key);
+    }
 }

packages/framework/src/Hyde.php

@@ -38,6 +38,7 @@
  * @method static string mediaLink(string $destination, bool $validate = false)
  * @method static string asset(string $name, bool $preferQualifiedUrl = false)
  * @method static string url(string $path = '')
+ * @method static Route|null route(string $key)
  * @method static string makeTitle(string $value)
  * @method static string normalizeNewlines(string $string)
  * @method static string stripNewlines(string $string)

packages/framework/tests/Feature/Foundation/HyperlinksTest.php

@@ -5,6 +5,7 @@
 namespace Hyde\Framework\Testing\Feature\Foundation;
 
 use Hyde\Foundation\HydeKernel;
+use Hyde\Foundation\Facades\Routes;
 use Hyde\Foundation\Kernel\Hyperlinks;
 use Hyde\Framework\Exceptions\FileNotFoundException;
 use Hyde\Hyde;
@@ -103,4 +104,15 @@ public function testMediaLinkHelperWithValidationAndNonExistingFile()
         $this->expectException(FileNotFoundException::class);
         $this->class->mediaLink('foo', true);
     }
+
+    public function testRouteHelper()
+    {
+        $this->assertNotNull($this->class->route('index'));
+        $this->assertSame(Routes::get('index'), $this->class->route('index'));
+    }
+
+    public function testRouteHelperWithInvalidRoute()
+    {
+        $this->assertNull($this->class->route('foo'));
+    }
 }

packages/framework/tests/Feature/HydeKernelTest.php

@@ -198,6 +198,17 @@ public function testImageHelperSupportsCustomMediaDirectories()
         $this->assertSame('assets/foo.jpg', Hyde::asset('foo.jpg'));
     }
 
+    public function testRouteHelper()
+    {
+        $this->assertNotNull(Hyde::route('index'));
+        $this->assertSame(Routes::get('index'), Hyde::route('index'));
+    }
+
+    public function testRouteHelperWithInvalidRoute()
+    {
+        $this->assertNull(Hyde::route('foo'));
+    }
+
     public function testHasSiteUrlHelperReturnsBooleanValueForWhenConfigSettingIsSet()
     {
         Config::set('hyde.url', 'https://example.com');