[2.x] Improved navigation group label generation

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

@@ -4,7 +4,7 @@
 
 namespace Hyde\Framework\Features\Navigation;
 
-use Hyde\Hyde;
+use Illuminate\Support\Str;
 use Hyde\Support\Models\Route;
 use Hyde\Pages\DocumentationPage;
 use Illuminate\Support\Collection;
@@ -58,16 +58,16 @@ protected function generate(): void
                         $group = 'Other';
                     }
 
-                    $groupItem = $this->items->get($group);
+                    $groupItem = $this->items->get(Str::slug($group));
 
                     if ($groupItem === null) {
-                        $groupItem = NavItem::dropdown($this->makeTitleForGroup($group), []);
+                        $groupItem = NavItem::dropdown($group, []);
                     }
 
                     $groupItem->addChild($item);
 
-                    if (! $this->items->has($group)) {
-                        $this->items->put($group, $groupItem);
+                    if (! $this->items->has($groupItem->getIdentifier())) {
+                        $this->items->put($groupItem->getIdentifier(), $groupItem);
                     }
 
                     return;
@@ -93,13 +93,6 @@ protected function usesSidebarGroups(): bool
         }) !== null;
     }
 
-    protected function makeTitleForGroup(string $group): string
-    {
-        // Todo search for other labels in the group before slugifying them
-
-        return Hyde::makeTitle($group);
-    }
-
     protected function canAddRoute(Route $route): bool
     {
         return $route->getPage()->showInNavigation() && ! $route->is(DocumentationPage::homeRouteName());

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

@@ -12,6 +12,9 @@
 use Stringable;
 use Hyde\Support\Models\ExternalRoute;
 
+use function is_string;
+use function strtolower;
+
 /**
  * Abstraction for a navigation menu item. Used by the MainNavigationMenu and DocumentationSidebar classes.
  *
@@ -98,7 +101,7 @@ public static function forRoute(Route|string $route, ?string $label = null, ?int
     public static function dropdown(string $label, array $items, ?int $priority = null): static
     {
         // TODO resolve label from config here instead of view
-        return new static('', static::normalizeGroupLabel($label), $priority ?? static::searchForDropdownPriorityInNavigationConfig($label) ?? 999, null, $items);
+        return new static('', static::normalizeGroupLabel($label), $priority ?? static::searchForDropdownPriorityInNavigationConfig($label) ?? 999, $label, $items);
     }
 
     /**
@@ -130,6 +133,10 @@ public function getLink(): string
      */
     public function getLabel(): string
     {
+        if ($this->hasChildren()) {
+            return $this->makeGroupLabel();
+        }
+
         return $this->label;
     }
 
@@ -192,6 +199,8 @@ public function isCurrent(): bool
      */
     public function addChild(NavItem $item): void
     {
+        // Todo: Ensure that the item has a group identifier by creating it from the label if it doesn't exist?
+
         $this->children[] = $item;
     }
 
@@ -205,27 +214,25 @@ protected static function makeIdentifier(string $label): string
         return Str::slug($label); // Todo: If it's a dropdown based on a subdirectory, we should use the subdirectory as the identifier
     }
 
-    protected static function normalizeGroupLabel(string $label): string
+    // TODO: Consider moving all of these to a dropdown factory
+    protected static function searchForDropdownPriorityInNavigationConfig(string $groupKey): ?int
     {
-        $configLabel = Config::getNullableString('docs.sidebar_group_labels.'.Str::slug($label));
+        return Config::getArray('hyde.navigation.order', [])[$groupKey] ?? null;
+    }
 
-        if ($configLabel) {
-            return $configLabel;
+    protected static function normalizeGroupLabel(string $label): string
+    {
+        // If there is no label, and the group is a slug, we can make a title from it
+        if ($label === strtolower($label)) {
+            return Hyde::makeTitle($label);
         }
 
         return $label;
     }
 
-    // TODO: Consider moving all of these to a dropdown factory
-    protected static function searchForDropdownPriorityInNavigationConfig(string $groupKey): ?int
+    /** Find the best label for the group. */
+    protected function makeGroupLabel(): string
     {
-        /** @var array<string, int> $config */
-        $config = Config::getArray('hyde.navigation.order', [
-            'index' => 0,
-            'posts' => 10,
-            'docs/index' => 100,
-        ]);
-
-        return $config[$groupKey] ?? null;
+        return Config::getArray('docs.sidebar_group_labels', [])[Str::slug($this->identifier)] ?? $this->label;
     }
 }

packages/framework/tests/Feature/AutomaticNavigationConfigurationsTest.php

@@ -448,8 +448,7 @@ public function testPagesInSubdirectoriesAreAddedAsDropdownsWhenNavigationSubdir
         config(['hyde.navigation.subdirectories' => 'dropdown']);
 
         $this->assertMenuEquals([
-            ['label' => 'about', 'children' => ['Foo', 'Bar', 'Baz']],
-            // TODO: Label should be About
+            ['label' => 'About', 'children' => ['Foo', 'Bar', 'Baz']],
         ], [
             new MarkdownPage('about/foo'),
             new MarkdownPage('about/bar'),
@@ -496,9 +495,8 @@ public function testMainNavigationMenuDropdownItemsWithSameLabelButDifferentGrou
         config(['hyde.navigation.subdirectories' => 'dropdown']);
 
         $this->assertMenuEquals([
-            // Todo: Should use proper group name
-            ['label' => 'group-1', 'children' => ['Foo']],
-            ['label' => 'group-2', 'children' => ['Foo']],
+            ['label' => 'Group 1', 'children' => ['Foo']],
+            ['label' => 'Group 2', 'children' => ['Foo']],
         ], [
             new MarkdownPage('one/foo', ['navigation.group' => 'Group 1']),
             new MarkdownPage('two/foo', ['navigation.group' => 'Group 2']),
@@ -510,9 +508,8 @@ public function testMainNavigationMenuAutomaticDropdownItemsWithSameLabelButDiff
         config(['hyde.navigation.subdirectories' => 'dropdown']);
 
         $this->assertMenuEquals([
-            // Todo: Should use proper group name
-            ['label' => 'one', 'children' => ['Foo']],
-            ['label' => 'two', 'children' => ['Foo']],
+            ['label' => 'One', 'children' => ['Foo']],
+            ['label' => 'Two', 'children' => ['Foo']],
         ], [
             new MarkdownPage('one/foo'),
             new MarkdownPage('two/foo'),
@@ -986,6 +983,11 @@ public function testSidebarLabelsRetainBestFormatting()
             new DocumentationPage('foo', ['navigation.group' => 'GitHub']),
             new DocumentationPage('bar', ['navigation.group' => 'github']),
         ]);
+
+        $this->assertSidebarEquals(['GitHub'], [
+            new DocumentationPage('foo', ['navigation.group' => 'github']),
+            new DocumentationPage('bar', ['navigation.group' => 'GitHub']),
+        ]);
     }
 
     public function testSidebarLabelsCanBeSetInConfig()
@@ -1036,6 +1038,92 @@ public function testAllSidebarItemsArePlacedInGroupsWhenAtLeastOneItemIsGrouped(
         ]);
     }
 
+    // Label casing tests
+
+    public function testMainMenuNavigationItemCasing()
+    {
+        // These labels are based on the page titles, which are made from the file names, so we try to format them
+
+        $this->assertMenuEquals(['Hello World'], [new MarkdownPage('Hello World')]);
+        $this->assertMenuEquals(['Hello World'], [new MarkdownPage('hello-world')]);
+        $this->assertMenuEquals(['Hello World'], [new MarkdownPage('hello world')]);
+    }
+
+    public function testMainMenuNavigationItemCasingUsingFrontMatter()
+    {
+        // If the user explicitly sets the label, we should respect that and assume it's already formatted correctly
+
+        $this->assertMenuEquals(['Hello World'], [new MarkdownPage('foo', ['title' => 'Hello World'])]);
+        $this->assertMenuEquals(['hello-world'], [new MarkdownPage('foo', ['title' => 'hello-world'])]);
+        $this->assertMenuEquals(['hello world'], [new MarkdownPage('foo', ['title' => 'hello world'])]);
+
+        $this->assertMenuEquals(['Hello World'], [new MarkdownPage('foo', ['navigation.label' => 'Hello World'])]);
+        $this->assertMenuEquals(['hello-world'], [new MarkdownPage('foo', ['navigation.label' => 'hello-world'])]);
+        $this->assertMenuEquals(['hello world'], [new MarkdownPage('foo', ['navigation.label' => 'hello world'])]);
+    }
+
+    public function testMainMenuNavigationGroupCasing()
+    {
+        config(['hyde.navigation.subdirectories' => 'dropdown']);
+
+        // When using subdirectory groupings, we try to format them the same way as the page titles
+
+        $this->assertMenuEquals(['Hello World'], [new MarkdownPage('Hello World/foo')]);
+        $this->assertMenuEquals(['Hello World'], [new MarkdownPage('hello-world/foo')]);
+        $this->assertMenuEquals(['Hello World'], [new MarkdownPage('hello world/foo')]);
+    }
+
+    public function testMainMenuNavigationGroupCasingUsingFrontMatter()
+    {
+        config(['hyde.navigation.subdirectories' => 'dropdown']); // TODO This should NOT be necessary when using front matter
+
+        // If the user explicitly sets the group, we should respect that and assume it's already formatted correctly
+
+        $this->assertMenuEquals(['Hello World'], [new MarkdownPage('foo', ['navigation.group' => 'Hello World'])]);
+        $this->assertMenuEquals(['Hello World'], [new MarkdownPage('foo', ['navigation.group' => 'hello-world'])]);
+        $this->assertMenuEquals(['Hello World'], [new MarkdownPage('foo', ['navigation.group' => 'hello world'])]);
+    }
+
+    public function testSidebarItemCasing()
+    {
+        // These labels are based on the page titles, which are made from the file names, so we try to format them
+
+        $this->assertSidebarEquals(['Hello World'], [new DocumentationPage('Hello World')]);
+        $this->assertSidebarEquals(['Hello World'], [new DocumentationPage('hello-world')]);
+        $this->assertSidebarEquals(['Hello World'], [new DocumentationPage('hello world')]);
+    }
+
+    public function testSidebarItemCasingUsingFrontMatter()
+    {
+        // If the user explicitly sets the label, we should respect that and assume it's already formatted correctly
+
+        $this->assertSidebarEquals(['Hello World'], [new DocumentationPage('foo', ['title' => 'Hello World'])]);
+        $this->assertSidebarEquals(['hello-world'], [new DocumentationPage('foo', ['title' => 'hello-world'])]);
+        $this->assertSidebarEquals(['hello world'], [new DocumentationPage('foo', ['title' => 'hello world'])]);
+
+        $this->assertSidebarEquals(['Hello World'], [new DocumentationPage('foo', ['navigation.label' => 'Hello World'])]);
+        $this->assertSidebarEquals(['hello-world'], [new DocumentationPage('foo', ['navigation.label' => 'hello-world'])]);
+        $this->assertSidebarEquals(['hello world'], [new DocumentationPage('foo', ['navigation.label' => 'hello world'])]);
+    }
+
+    public function testSidebarGroupCasing()
+    {
+        // When using subdirectory groupings, we try to format them the same way as the page titles
+
+        $this->assertSidebarEquals(['Hello World'], [new DocumentationPage('Hello World/foo')]);
+        $this->assertSidebarEquals(['Hello World'], [new DocumentationPage('hello-world/foo')]);
+        $this->assertSidebarEquals(['Hello World'], [new DocumentationPage('hello world/foo')]);
+    }
+
+    public function testSidebarGroupCasingUsingFrontMatter()
+    {
+        // If the user explicitly sets the group, we should respect that and assume it's already formatted correctly
+
+        $this->assertSidebarEquals(['Hello World'], [new DocumentationPage('foo', ['navigation.group' => 'Hello World'])]);
+        $this->assertSidebarEquals(['Hello World'], [new DocumentationPage('foo', ['navigation.group' => 'hello-world'])]);
+        $this->assertSidebarEquals(['Hello World'], [new DocumentationPage('foo', ['navigation.group' => 'hello world'])]);
+    }
+
     // Testing helpers
 
     protected function assertSidebarEquals(array $expected, array $menuPages): void

packages/framework/tests/Unit/NavItemTest.php

@@ -265,7 +265,7 @@ public function testDropdownFacade()
     {
         $item = NavItem::dropdown('foo', []);
 
-        $this->assertSame('foo', $item->getLabel());
+        $this->assertSame('Foo', $item->getLabel());
         $this->assertSame([], $item->getChildren());
         $this->assertSame(999, $item->getPriority());
     }