Merge pull request #289 from hydephp/replace-documentation-index-path-helper

Replace deprecated documentation indexPath() helper hydephp/develop@2287419

Author: github-actions

resources/views/layouts/docs.blade.php

@@ -18,7 +18,7 @@ class="bg-white dark:bg-gray-900 dark:text-white min-h-screen w-screen relative
 		class="bg-white dark:bg-gray-800 md:hidden flex justify-between w-full h-16 z-40 fixed left-0 top-0 p-4 leading-8 shadow-lg">
 		<strong class="px-2 mr-auto">
 			@if(Route::exists('docs/index'))
-			<a href="{{ Route::get('docs/index') }}">
+			<a href="{{ DocumentationPage::home() }}">
 				{{ config('docs.header_title', 'Documentation') }}
 			</a>
 			@else
@@ -47,7 +47,7 @@ class="bg-gray-100 dark:bg-gray-800 dark:text-gray-200 h-screen w-64 fixed z-30
 			<div id="sidebar-brand" class="flex items-center justify-between h-16 py-4 px-2">
 				<strong class="px-2">
 					@if(Route::exists('docs/index'))
-					<a href="{{ Route::get('docs/index') }}">
+					<a href="{{ DocumentationPage::home() }}">
 						{{ config('docs.header_title', 'Documentation') }}
 					</a>
 					@else

src/Models/Pages/DocumentationPage.php

@@ -4,8 +4,9 @@
 
 use Hyde\Framework\Concerns\HasTableOfContents;
 use Hyde\Framework\Contracts\AbstractMarkdownPage;
-use Hyde\Framework\Hyde;
+use Hyde\Framework\Contracts\RouteContract;
 use Hyde\Framework\Models\Parsers\DocumentationPageParser;
+use Hyde\Framework\Models\Route;
 
 class DocumentationPage extends AbstractMarkdownPage
 {
@@ -31,27 +32,8 @@ public function getOnlineSourcePath(): string|false
         return trim(config('docs.source_file_location_base'), '/').'/'.$this->slug.'.md';
     }
 
-    /**
-     * Get the path to the frontpage for the documentation.
-     *
-     * It is highly recommended to have an index.md file in the _docs directory,
-     * however, this method will fall back to a readme.
-     *
-     * @since 0.46.x (moved from Hyde::docsIndexPath).
-     * @deprecated 0.52.x (use the route instead)
-     *
-     * @return string|false returns false if no suitable frontpage is found
-     */
-    public static function indexPath(): string|false
+    public static function home(): ?RouteContract
     {
-        if (file_exists(Hyde::path(static::getSourceDirectory().'/index.md'))) {
-            return trim(Hyde::pageLink(static::getOutputDirectory().'/index.html'), '/');
-        }
-
-        if (file_exists(Hyde::path(static::getSourceDirectory().'/readme.md'))) {
-            return trim(Hyde::pageLink(static::getOutputDirectory().'/readme.html'), '/');
-        }
-
-        return false;
+        return Route::exists('docs/index') ? Route::get('docs/index') : null;
     }
 }

tests/Unit/DocumentationPageIndexPathTest.php

@@ -2,8 +2,10 @@
 
 namespace Hyde\Framework\Testing\Unit;
 
+use Hyde\Framework\Hyde;
 use Hyde\Framework\HydeServiceProvider;
 use Hyde\Framework\Models\Pages\DocumentationPage;
+use Hyde\Framework\Models\Route;
 use Hyde\Testing\TestCase;
 
 /**
@@ -79,4 +81,17 @@ public function test_can_get_documentation_output_path_with_trailing_slashes()
             $this->assertEquals('foo', DocumentationPage::getOutputDirectory());
         }
     }
+
+    public function test_home_method_returns_null_when_there_is_no_index_page()
+    {
+        $this->assertNull(DocumentationPage::home());
+    }
+
+    public function test_home_method_returns_docs_index_route_when_it_exists()
+    {
+        Hyde::touch('_docs/index.md');
+        $this->assertInstanceOf(Route::class, DocumentationPage::home());
+        $this->assertEquals(Route::get('docs/index'), DocumentationPage::home());
+        Hyde::unlink('_docs/index.md');
+    }
 }