Extract internal route key helper

Reduces the amount of times and places we call the exact same logic
hydephp · Dec 18, 2023 · 9b00817 · 9b00817
1 parent 0f8fe02
commit 9b00817
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 3 deletions.
diff --git a/packages/framework/resources/views/components/docs/search-scripts.blade.php b/packages/framework/resources/views/components/docs/search-scripts.blade.php
@@ -1,7 +1,7 @@
 <script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/HydeSearch.min.js" defer></script>
 <script>
     window.addEventListener('load', function () {
-        const searchIndexLocation = '{{ Hyde::relativeLink(ltrim(DocumentationPage::outputDirectory().'/search.json', '/')) }}';
+        const searchIndexLocation = '{{ Hyde::relativeLink(\Hyde\Framework\Features\Documentation\DocumentationSearchIndex::routeKey()) }}';
         const Search = new HydeSearch(searchIndexLocation);
 
         Search.init();

diff --git a/packages/framework/src/Framework/Actions/GeneratesDocumentationSearchIndex.php b/packages/framework/src/Framework/Actions/GeneratesDocumentationSearchIndex.php
@@ -11,6 +11,7 @@
 use Hyde\Pages\DocumentationPage;
 use Illuminate\Support\Collection;
 
+use Hyde\Framework\Features\Documentation\DocumentationSearchIndex;
 use function basename;
 use function in_array;
 use function trim;
@@ -101,7 +102,7 @@ protected function formatDestination(string $slug): string
 
     protected function getPath(): string
     {
-        return Hyde::sitePath(DocumentationPage::outputDirectory().'/search.json');
+        return Hyde::sitePath(DocumentationSearchIndex::routeKey());
     }
 
     protected function getPagesToExcludeFromSearch(): array

diff --git a/packages/framework/src/Framework/Features/Documentation/DocumentationSearchIndex.php b/packages/framework/src/Framework/Features/Documentation/DocumentationSearchIndex.php
@@ -8,6 +8,8 @@
 use Hyde\Pages\DocumentationPage;
 use Hyde\Framework\Actions\GeneratesDocumentationSearchIndex;
 
+use function ltrim;
+
 /**
  * @internal This page is used to render the search index for the documentation.
  */
@@ -18,7 +20,7 @@ class DocumentationSearchIndex extends InMemoryPage
      */
     public function __construct()
     {
-        parent::__construct(ltrim(DocumentationPage::outputDirectory().'/search.json', '/'), [
+        parent::__construct(static::routeKey(), [
             'navigation' => ['hidden' => true],
         ]);
     }
@@ -29,6 +31,11 @@ public function compile(): string
     }
 
     public function getOutputPath(): string
+    {
+        return static::routeKey();
+    }
+
+    public static function routeKey(): string
     {
         return ltrim(DocumentationPage::outputDirectory().'/search.json', '/');
     }

diff --git a/packages/framework/tests/Feature/DocumentationSearchIndexTest.php b/packages/framework/tests/Feature/DocumentationSearchIndexTest.php
@@ -33,4 +33,21 @@ public function testRouteKeyIsSetToConfiguredDocumentationOutputDirectory()
         $page = new DocumentationSearchIndex();
         $this->assertSame('foo/search.json', $page->routeKey);
     }
+
+    public function testStaticRouteKeyHelper()
+    {
+        $this->assertSame('docs/search.json', DocumentationSearchIndex::routeKey());
+    }
+
+    public function testStaticRouteKeyHelperWithCustomOutputDirectory()
+    {
+        DocumentationPage::setOutputDirectory('foo');
+        $this->assertSame('foo/search.json', DocumentationSearchIndex::routeKey());
+    }
+
+    public function testStaticRouteKeyHelperWithRootOutputDirectory()
+    {
+        DocumentationPage::setOutputDirectory('');
+        $this->assertSame('search.json', DocumentationSearchIndex::routeKey());
+    }
 }