Merge pull request #96 from hydephp/94-bug-hydedocsindexpath-checks-the-hard-coded-source-directory

Fix bug #94: Hyde::docsIndexPath() checks the hard-coded source directory

Author: caendesilva

packages/framework/src/Concerns/Internal/FileHelpers.php

@@ -2,6 +2,8 @@
 
 namespace Hyde\Framework\Concerns\Internal;
 
+use Hyde\Framework\Models\DocumentationPage;
+
 /**
  * Offloads file helper methods for the Hyde Facade.
  *
@@ -31,11 +33,11 @@ public static function getDocumentationOutputDirectory(): string
      */
     public static function docsIndexPath(): string|false
     {
-        if (file_exists(static::path('_docs/index.md'))) {
+        if (file_exists(static::path(DocumentationPage::$sourceDirectory.'/index.md'))) {
             return trim(static::pageLink(static::getDocumentationOutputDirectory().'/index.html'), '/');
         }
 
-        if (file_exists(static::path('_docs/readme.md'))) {
+        if (file_exists(static::path(DocumentationPage::$sourceDirectory.'/readme.md'))) {
             return trim(static::pageLink(static::getDocumentationOutputDirectory().'/readme.html'), '/');
         }
 

packages/framework/tests/Feature/HydeDocsIndexPathTest.php

@@ -3,6 +3,7 @@
 namespace Hyde\Framework\Testing\Feature;
 
 use Hyde\Framework\Hyde;
+use Hyde\Framework\Models\DocumentationPage;
 use Hyde\Testing\TestCase;
 
 class HydeDocsIndexPathTest extends TestCase
@@ -45,6 +46,18 @@ public function test_returns_index_if_only_index_exist()
         $this->assertEquals('docs/index.html', Hyde::docsIndexPath());
     }
 
+    public function test_helper_can_find_index_path_when_custom_docs_directory_is_used()
+    {
+        mkdir(Hyde::path('foo'));
+        file_put_contents(Hyde::path('foo/index.md'), '');
+
+        DocumentationPage::$sourceDirectory = 'foo';
+        $this->assertEquals('docs/index.html', Hyde::docsIndexPath());
+
+        unlink(Hyde::path('foo/index.md'));
+        rmdir(Hyde::path('foo'));
+    }
+
     private function setReadme()
     {
         file_put_contents(Hyde::path('_docs/readme.md'), '');