Allow using a directory index page

mobizel · Mar 29, 2021 · b54e978 · b54e978
1 parent 374ac1e
commit b54e978
Show file tree

Hide file tree

Showing 6 changed files with 62 additions and 1 deletion.
diff --git a/src/Controller/PageAction.php b/src/Controller/PageAction.php
@@ -31,12 +31,20 @@ public function __construct(
 
     public function __invoke(string $slug): Response
     {
+        // redirect a suffixed page ("foo/bar.md" should be redirected to "foo/bar")
         if (false !== strpos($slug, '.md')) {
             $slug = preg_replace('/\.md$/', '', $slug);
 
             return $this->redirectToRoute('mobizel_markdown_docs_page_show', ['slug' => $slug]);
         }
 
+        // redirect a directory homepage ("foo/bar/index" should be redirected to "foo/bar")
+        if (false !== strpos($slug, '/index')) {
+            $slug = preg_replace('/\/index$/', '', $slug);
+
+            return $this->redirectToRoute('mobizel_markdown_docs_page_show', ['slug' => $slug]);
+        }
+
         $page = $this->pageItemDataProvider->getPage($slug);
 
         if (null === $page) {

diff --git a/src/DataProvider/PageCollectionDataProvider.php b/src/DataProvider/PageCollectionDataProvider.php
@@ -38,6 +38,7 @@ public function getRootPages(): iterable
             ->in($this->docsDir)
             ->notName('index.md')
             ->depth(0)
+            ->append($this->createDirectoryIndexFinder($this->docsDir))
             ->sort(PageSorter::sortByTitle());
 
         $pages = [];
@@ -47,9 +48,10 @@ public function getRootPages(): iterable
 
             /** @var string $slug */
             $slug = preg_replace('/\.md$/', '', $pageInfo->getRelativePathName());
+            $slug = preg_replace('/\/index$/', '', $slug);
 
             $pages[] = $this->createPage(
-                $slug,
+                (string) $slug,
                 $pageInfo->getTitle(),
                 $pageInfo->getContentWithoutTitle()
             );
@@ -68,6 +70,7 @@ public function getChildrenPages(string $parentSlug): iterable
                 ->in($this->docsDir.'/'.$parentSlug)
                 ->notName('index.md')
                 ->depth(0)
+                ->append($this->createDirectoryIndexFinder($this->docsDir.'/'.$parentSlug))
                 ->sort(PageSorter::sortByTitle());
         } catch (DirectoryNotFoundException $exception) {
             return [];
@@ -127,6 +130,7 @@ private function getRootPagesMap(): array
             ->files()
             ->in($this->docsDir)
             ->depth(0)
+            ->append($this->createDirectoryIndexFinder($this->docsDir))
             ->sort(PageSorter::sortByTitle())
         ;
 
@@ -137,6 +141,7 @@ private function getRootPagesMap(): array
 
             /** @var string $slug */
             $slug = preg_replace('/\.md$/', '', $pageInfo->getRelativePathName());
+            $slug = preg_replace('/\/index$/', '', $slug);
 
             $pages[] = ['slug' => $slug, 'title' => $pageInfo->getTitle()];
         }
@@ -153,7 +158,9 @@ private function getChildrenPagesMap(array $row, array $pages, int &$currentPosi
             $finder
                 ->files()
                 ->in($this->docsDir.'/'.$parentSlug)
+                ->notName('index.md')
                 ->depth(0)
+                ->append($this->createDirectoryIndexFinder($this->docsDir.'/'.$parentSlug))
                 ->sort(PageSorter::sortByTitle())
             ;
         } catch (DirectoryNotFoundException $exception) {
@@ -163,6 +170,7 @@ private function getChildrenPagesMap(array $row, array $pages, int &$currentPosi
         foreach ($finder as $file) {
             $pageInfo = new PageInfo($file->getPathname(), $file->getRelativePath(), $file->getRelativePathname());
             $slug = $parentSlug.'/'.preg_replace('/\.md$/', '', $pageInfo->getRelativePathName());
+            $slug = preg_replace('/\/index$/', '', $slug);
 
             $pageToAdd = ['slug' => $slug, 'title' => $pageInfo->getTitle()];
 
@@ -174,4 +182,13 @@ private function getChildrenPagesMap(array $row, array $pages, int &$currentPosi
 
         return $pages;
     }
+
+    private function createDirectoryIndexFinder(string $dir): Finder
+    {
+        return (new Finder())
+            ->files()
+            ->name('index.md')
+            ->in($dir)
+            ->depth(1);
+    }
 }
diff --git a/src/DataProvider/PageItemDataProvider.php b/src/DataProvider/PageItemDataProvider.php
@@ -31,6 +31,10 @@ public function getPage(string $slug): ?PageOutput
     {
         $templateAbsolutePath = $this->templateHandler->getTemplateAbsolutePath($slug);
 
+        if (!is_file($templateAbsolutePath)) {
+            $templateAbsolutePath = $this->templateHandler->getTemplateAbsolutePath($slug.'/index');
+        }
+
         if (!is_file($templateAbsolutePath)) {
             return null;
         }

diff --git a/tests/Controller/PageActionTest.php b/tests/Controller/PageActionTest.php
@@ -27,6 +27,16 @@ public function testRedirection()
         $this->assertEquals('/bdd', $client->getResponse()->getTargetUrl());
     }
 
+    public function testDirectoryIndexPageRedirection()
+    {
+        $client = static::createClient();
+
+        $client->request('GET', 'book/index');
+
+        $this->assertEquals(302, $client->getResponse()->getStatusCode());
+        $this->assertEquals('/book', $client->getResponse()->getTargetUrl());
+    }
+
     public function testShowPage()
     {
         $client = static::createClient();
@@ -37,6 +47,26 @@ public function testShowPage()
         $this->assertSelectorTextSame('html h1', 'Documentation');
     }
 
+    public function testDirectoryIndexPage()
+    {
+        $client = static::createClient();
+
+        $client->request('GET', 'book');
+
+        $this->assertEquals(200, $client->getResponse()->getStatusCode());
+        $this->assertSelectorTextSame('html h1', 'Book homepage');
+    }
+
+    public function testSubDirectoryIndexPage()
+    {
+        $client = static::createClient();
+
+        $client->request('GET', 'book/stephen-king');
+
+        $this->assertEquals(200, $client->getResponse()->getStatusCode());
+        $this->assertSelectorTextSame('html h1', 'Stephen King Books');
+    }
+
     public function testNotFoundPage()
     {
         $client = static::createClient();

diff --git a/tests/docs/book/index.md b/tests/docs/book/index.md
@@ -0,0 +1 @@
+# Book homepage
diff --git a/tests/docs/book/stephen-king/index.md b/tests/docs/book/stephen-king/index.md
@@ -0,0 +1 @@
+# Stephen King Books