Merge pull request #974 from hydephp/create-helper-to-get-the-documen…

…tation-page-home-route-name Create helper to get the documentation page home route name
hydephp · Feb 11, 2023 · 6dd3cd7 · 6dd3cd7
2 parents c3febd1 + 392c900
commit 6dd3cd7
Show file tree

Hide file tree

Showing 5 changed files with 22 additions and 4 deletions.
diff --git a/packages/framework/src/Framework/Factories/NavigationDataFactory.php b/packages/framework/src/Framework/Factories/NavigationDataFactory.php
@@ -131,7 +131,7 @@ private function searchForLabelInConfig(): ?string
     {
         return Arr::get(config('hyde.navigation.labels', [
             'index' => 'Home',
-            'docs/index' => 'Docs',
+            DocumentationPage::homeRouteName() => 'Docs',
         ]), $this->routeKey);
     }
 

diff --git a/packages/framework/src/Framework/Features/Navigation/DocumentationSidebar.php b/packages/framework/src/Framework/Features/Navigation/DocumentationSidebar.php
@@ -46,6 +46,6 @@ public function getItemsInGroup(?string $group): Collection
 
     protected static function shouldItemBeHidden(NavItem $item): bool
     {
-        return parent::shouldItemBeHidden($item) || $item->getRoute()?->is('docs/index');
+        return parent::shouldItemBeHidden($item) || $item->getRoute()?->is(DocumentationPage::homeRouteName());
     }
 }
diff --git a/packages/framework/src/Framework/Features/Navigation/NavigationMenu.php b/packages/framework/src/Framework/Features/Navigation/NavigationMenu.php
@@ -81,6 +81,6 @@ protected static function dropdownsEnabled(): bool
     protected static function shouldItemBeHidden(NavItem $item): bool
     {
         return parent::shouldItemBeHidden($item) ||
-            $item->getRoute()?->getPage() instanceof DocumentationPage && ! $item->getRoute()->is('docs/index');
+            $item->getRoute()?->getPage() instanceof DocumentationPage && ! $item->getRoute()->is(DocumentationPage::homeRouteName());
     }
 }
diff --git a/packages/framework/src/Pages/DocumentationPage.php b/packages/framework/src/Pages/DocumentationPage.php
@@ -26,7 +26,12 @@ class DocumentationPage extends BaseMarkdownPage
 
     public static function home(): ?Route
     {
-        return Route::get(static::$outputDirectory.'/index');
+        return Route::get(static::homeRouteName());
+    }
+
+    public static function homeRouteName(): string
+    {
+        return static::baseRouteKey().'/index';
     }
 
     /** @see https://hydephp.com/docs/master/documentation-pages#automatic-edit-page-button */

diff --git a/packages/framework/tests/Unit/DocumentationPageTest.php b/packages/framework/tests/Unit/DocumentationPageTest.php
@@ -144,6 +144,19 @@ public function test_home_method_finds_docs_index_for_custom_nested_output_direc
         File::deleteDirectory(Hyde::path('foo'));
     }
 
+    public function test_home_route_name_method_returns_output_directory_slash_index()
+    {
+        $this->assertSame('docs/index', DocumentationPage::homeRouteName());
+    }
+
+    public function test_home_route_name_method_returns_customized_output_directory_slash_index()
+    {
+        config(['docs.output_directory' => 'foo/bar']);
+        (new HydeServiceProvider($this->app))->register();
+
+        $this->assertSame('foo/bar/index', DocumentationPage::homeRouteName());
+    }
+
     public function test_has_table_of_contents()
     {
         $this->assertIsBool(DocumentationPage::hasTableOfContents());