Merge pull request #974 from hydephp/create-helper-to-get-the-documentation-page-home-route-name

emmadesilva · web-flow · commit 6dd3cd71aaa8 · 2023-02-11T19:11:04.000+01:00
Create helper to get the documentation page home route name
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());

Original file line number	Diff line number	Diff line change
`@@ -131,7 +131,7 @@ private function searchForLabelInConfig(): ?string`
`131`	`131`	`{`
`132`	`132`	`return Arr::get(config('hyde.navigation.labels', [`
`133`	`133`	`'index' => 'Home',`
`134`		`- 'docs/index' => 'Docs',`
	`134`	`+ DocumentationPage::homeRouteName() => 'Docs',`
`135`	`135`	`]), $this->routeKey);`
`136`	`136`	`}`
`137`	`137`
Original file line number	Diff line number	Diff line change
`@@ -46,6 +46,6 @@ public function getItemsInGroup(?string $group): Collection`
`46`	`46`
`47`	`47`	`protected static function shouldItemBeHidden(NavItem $item): bool`
`48`	`48`	`{`
`49`		`- return parent::shouldItemBeHidden($item) \|\| $item->getRoute()?->is('docs/index');`
	`49`	`+ return parent::shouldItemBeHidden($item) \|\| $item->getRoute()?->is(DocumentationPage::homeRouteName());`
`50`	`50`	`}`
`51`	`51`	`}`
Original file line number	Diff line number	Diff line change
`@@ -81,6 +81,6 @@ protected static function dropdownsEnabled(): bool`
`81`	`81`	`protected static function shouldItemBeHidden(NavItem $item): bool`
`82`	`82`	`{`
`83`	`83`	`return parent::shouldItemBeHidden($item) \|\|`
`84`		`- $item->getRoute()?->getPage() instanceof DocumentationPage && ! $item->getRoute()->is('docs/index');`
	`84`	`+ $item->getRoute()?->getPage() instanceof DocumentationPage && ! $item->getRoute()->is(DocumentationPage::homeRouteName());`
`85`	`85`	`}`
`86`	`86`	`}`
Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,12 @@ class DocumentationPage extends BaseMarkdownPage`
`26`	`26`
`27`	`27`	`public static function home(): ?Route`
`28`	`28`	`{`
`29`		`- return Route::get(static::$outputDirectory.'/index');`
	`29`	`+ return Route::get(static::homeRouteName());`
	`30`	`+ }`
	`31`	`+`
	`32`	`+ public static function homeRouteName(): string`
	`33`	`+ {`
	`34`	`+ return static::baseRouteKey().'/index';`
`30`	`35`	`}`
`31`	`36`
`32`	`37`	`/** @see https://hydephp.com/docs/master/documentation-pages#automatic-edit-page-button */`