Merge pull request #1703 from hydephp/enable-dropdowns-when-set-in-front-matter-regardless-of-subdirectory-configuration

Honour front matter navigation groups set in front matter regardless of subdirectory setting

Author: caendesilva

RELEASE_NOTES.md

@@ -15,7 +15,7 @@ This serves two purposes:
 - You can now specify which path to open when using the `--open` option in the serve command in https://github.com/hydephp/develop/pull/1694
 
 ### Changed
-- for changes in existing functionality.
+- When a navigation group is set in front matter, it will now be used regardless of the subdirectory configuration in https://github.com/hydephp/develop/pull/1703 (fixes https://github.com/hydephp/develop/issues/1515)
 
 ### Deprecated
 - for soon-to-be removed features.
@@ -24,7 +24,7 @@ This serves two purposes:
 - for now removed features.
 
 ### Fixed
-- for any bug fixes.
+- Fixed explicitly set front matter navigation group behavior being dependent on subdirectory configuration, fixing https://github.com/hydephp/develop/issues/1515 in https://github.com/hydephp/develop/pull/1703
 
 ### Security
 - in case of vulnerabilities.

packages/framework/src/Framework/Features/Navigation/NavigationMenu.php

@@ -11,6 +11,8 @@
 
 class NavigationMenu extends BaseNavigationMenu
 {
+    private bool $hasDropdowns;
+
     protected function generate(): void
     {
         parent::generate();
@@ -69,6 +71,13 @@ protected function canAddItemToDropdown(NavItem $item): bool
 
     protected function dropdownsEnabled(): bool
     {
-        return Config::getString('hyde.navigation.subdirectories', 'hidden') === 'dropdown';
+        return (Config::getString('hyde.navigation.subdirectories', 'hidden') === 'dropdown') || $this->hasGroupExplicitlySetInFrontMatter();
+    }
+
+    private function hasGroupExplicitlySetInFrontMatter(): bool
+    {
+        return $this->hasDropdowns ??= $this->items->contains(function (NavItem $item): bool {
+            return ($item->getGroup() !== null) && ($item->destination !== (string) DocumentationPage::home());
+        });
     }
 }

packages/framework/tests/Feature/NavigationMenuTest.php

@@ -383,4 +383,38 @@ public function testDropdownMenuItemsAreSortedByPriority()
 
         $this->assertSame(['Foo', 'Bar', 'Baz'], $dropdowns[0]->getItems()->pluck('label')->toArray());
     }
+
+    public function testHasDropdownsReturnsTrueWhenGroupIsExplicitlySetInFrontMatter()
+    {
+        config(['hyde.navigation.subdirectories' => 'hidden']);
+
+        Routes::addRoute((new MarkdownPage('foo', matter: ['navigation.group' => 'test-group']))->getRoute());
+
+        $this->assertTrue(NavigationMenu::create()->hasDropdowns());
+    }
+
+    public function testGetDropdownsReturnsCorrectArrayWhenGroupIsExplicitlySetInFrontMatter()
+    {
+        config(['hyde.navigation.subdirectories' => 'hidden']);
+
+        Routes::addRoute((new MarkdownPage('foo', matter: ['navigation.group' => 'test-group']))->getRoute());
+
+        $menu = NavigationMenu::create();
+        $this->assertCount(1, $menu->getDropdowns());
+
+        $this->assertEquals([
+            DropdownNavItem::fromArray('test-group', [
+                NavItem::fromRoute((new MarkdownPage('foo'))->getRoute()),
+            ]),
+        ], $menu->getDropdowns());
+    }
+
+    public function testHasDropdownsReturnsFalseWhenGroupIsNotExplicitlySetInFrontMatter()
+    {
+        config(['hyde.navigation.subdirectories' => 'hidden']);
+
+        Routes::addRoute((new MarkdownPage('foo'))->getRoute());
+        $menu = NavigationMenu::create();
+        $this->assertFalse($menu->hasDropdowns());
+    }
 }

packages/framework/tests/Unit/NavigationDataFactoryUnitTest.php

@@ -146,6 +146,36 @@ public function testRouteKeysCanBeUsedForDocumentationSidebarPriorities()
         $this->assertSame(502, $factory->makePriority());
     }
 
+    public function testMakeGroupUsesFrontMatterGroupIfSet()
+    {
+        $frontMatter = new FrontMatter(['navigation.group' => 'Test Group']);
+        $coreDataObject = new CoreDataObject($frontMatter, new Markdown(), MarkdownPage::class, 'test.md', '', '', '');
+        $factory = new NavigationConfigTestClass($coreDataObject);
+
+        $this->assertSame('Test Group', $factory->makeGroup());
+    }
+
+    public function testMakeGroupUsesFrontMatterGroupIfSetRegardlessOfSubdirectoryConfiguration()
+    {
+        self::mockConfig(['hyde.navigation.subdirectories' => 'hidden']);
+
+        $frontMatter = new FrontMatter(['navigation.group' => 'Test Group']);
+        $coreDataObject = new CoreDataObject($frontMatter, new Markdown(), MarkdownPage::class, 'test.md', '', '', '');
+        $factory = new NavigationConfigTestClass($coreDataObject);
+
+        $this->assertSame('Test Group', $factory->makeGroup());
+    }
+
+    public function testMakeGroupDefaultsToNullIfFrontMatterGroupNotSetAndSubdirectoriesNotUsed()
+    {
+        self::mockConfig(['hyde.navigation.subdirectories' => 'hidden']);
+
+        $coreDataObject = new CoreDataObject(new FrontMatter(), new Markdown(), MarkdownPage::class, 'test.md', '', '', '');
+        $factory = new NavigationConfigTestClass($coreDataObject);
+
+        $this->assertNull($factory->makeGroup());
+    }
+
     protected function makeCoreDataObject(string $identifier = '', string $routeKey = '', string $pageClass = MarkdownPage::class): CoreDataObject
     {
         return new CoreDataObject(new FrontMatter(), new Markdown(), $pageClass, $identifier, '', '', $routeKey);
@@ -163,4 +193,9 @@ public function makePriority(): int
     {
         return parent::makePriority();
     }
+
+    public function makeGroup(): ?string
+    {
+        return parent::makeGroup();
+    }
 }