[2.x] Remove the group property from the navigation item class

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

@@ -78,7 +78,7 @@ public function getActiveGroup(): ?NavigationGroup
 
         return $this->items->first(function (NavigationGroup $group) use ($currentPage): bool {
             // A group is active when it contains the current page being rendered.
-            return $group->getGroupKey() === NavigationItem::normalizeGroupKey($currentPage->navigationMenuGroup());
+            return $currentPage->navigationMenuGroup() && $group->getGroupKey() === NavigationGroup::normalizeGroupKey($currentPage->navigationMenuGroup());
         });
     }
 }

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

@@ -15,9 +15,4 @@ public function getLabel(): string;
      * Get the priority to determine the order of the navigation item.
      */
     public function getPriority(): int;
-
-    /**
-     * Get the group identifier key of the navigation item, if any.
-     */
-    public function getGroupKey(): ?string;
 }

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

@@ -81,4 +81,10 @@ protected function containsOnlyDocumentationPages(): bool
             return $child->getPage() instanceof DocumentationPage;
         });
     }
+
+    /** @experimental This method is subject to change before its release. */
+    public static function normalizeGroupKey(string $group): string
+    {
+        return Str::slug($group);
+    }
 }

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

@@ -8,7 +8,6 @@
 use Hyde\Foundation\Facades\Routes;
 use Hyde\Hyde;
 use Hyde\Support\Models\Route;
-use Illuminate\Support\Str;
 use Stringable;
 
 use function is_string;
@@ -27,36 +26,29 @@ class NavigationItem implements NavigationElement, Stringable
     protected string $label;
     protected int $priority;
 
-    // TODO: Do we actually need this? We should just care if it's physically stored in a group.
-    protected ?string $group = null;
-
     /**
      * Create a new navigation menu item with your own properties.
      *
      * @param  \Hyde\Support\Models\Route|string  $destination  Route instance, route key, or external URI.
      * @param  string  $label  The label of the navigation item.
      * @param  int  $priority  The priority to determine the order of the navigation item.
-     * @param  string|null  $group  The dropdown/group key of the navigation item, if any.
      */
-    public function __construct(Route|string $destination, string $label, int $priority = NavigationMenu::DEFAULT, ?string $group = null)
+    public function __construct(Route|string $destination, string $label, int $priority = NavigationMenu::DEFAULT)
     {
         $this->destination = $destination;
 
         $this->label = $label;
         $this->priority = $priority;
-
-        $this->group = static::normalizeGroupKey($group);
     }
 
     /**
      * Create a new navigation menu item, automatically filling in the properties from a Route instance if provided.
      *
      * @param  \Hyde\Support\Models\Route|string<\Hyde\Support\Models\RouteKey>|string  $destination  Route instance or route key, or external URI.
-     * @param  int|null  $priority  Leave blank to use the priority of the route's corresponding page, if there is one tied to the route.
      * @param  string|null  $label  Leave blank to use the label of the route's corresponding page, if there is one tied to the route.
-     * @param  string|null  $group  Leave blank to use the group of the route's corresponding page, if there is one tied to the route.
+     * @param  int|null  $priority  Leave blank to use the priority of the route's corresponding page, if there is one tied to the route.
      */
-    public static function create(Route|string $destination, ?string $label = null, ?int $priority = null, ?string $group = null): static
+    public static function create(Route|string $destination, ?string $label = null, ?int $priority = null): static
     {
         if (is_string($destination) && Routes::has($destination)) {
             $destination = Routes::get($destination);
@@ -65,10 +57,9 @@ public static function create(Route|string $destination, ?string $label = null,
         if ($destination instanceof Route) {
             $label ??= $destination->getPage()->navigationMenuLabel();
             $priority ??= $destination->getPage()->navigationMenuPriority();
-            $group ??= $destination->getPage()->navigationMenuGroup();
         }
 
-        return new static($destination, $label ?? $destination, $priority ?? NavigationMenu::DEFAULT, $group);
+        return new static($destination, $label ?? $destination, $priority ?? NavigationMenu::DEFAULT);
     }
 
     /**
@@ -103,19 +94,6 @@ public function getPriority(): int
         return $this->priority;
     }
 
-    /**
-     * Get the group identifier key of the navigation item, if any.
-     *
-     *  For sidebars this is the category key, for navigation menus this is the dropdown key.
-     *
-     *  When using automatic subdirectory based groups, the subdirectory name is the group key.
-     *  Otherwise, the group key is a 'slugified' version of the group's label.
-     */
-    public function getGroupKey(): ?string
-    {
-        return $this->group;
-    }
-
     /**
      * If the navigation item is a link to a routed page, get the corresponding page instance.
      */
@@ -131,10 +109,4 @@ public function isActive(): bool
     {
         return Hyde::currentRoute()->getLink() === $this->getLink();
     }
-
-    /** @return ($group is null ? null : string) */
-    public static function normalizeGroupKey(?string $group): ?string
-    {
-        return $group ? Str::slug($group) : null;
-    }
 }

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

@@ -6,7 +6,6 @@
 
 use Hyde\Hyde;
 use Hyde\Facades\Config;
-use Illuminate\Support\Str;
 use Hyde\Support\Models\Route;
 use Hyde\Pages\DocumentationPage;
 use Illuminate\Support\Collection;
@@ -135,7 +134,8 @@ protected function addRouteToGroup(Route $route): void
     {
         $item = NavigationItem::create($route);
 
-        $groupName = $this->generatesSidebar ? ($item->getGroupKey() ?? 'Other') : $item->getGroupKey();
+        $groupKey = $item->getPage()->navigationMenuGroup();
+        $groupName = $this->generatesSidebar ? ($groupKey ?? 'Other') : $groupKey;
 
         $groupItem = $this->getOrCreateGroupItem($groupName);
 
@@ -148,7 +148,7 @@ protected function addRouteToGroup(Route $route): void
 
     protected function getOrCreateGroupItem(string $groupName): NavigationGroup
     {
-        $groupKey = Str::slug($groupName);
+        $groupKey = NavigationGroup::normalizeGroupKey($groupName);
         $group = $this->items->get($groupKey);
 
         if ($group instanceof NavigationGroup) {

packages/framework/tests/Feature/AutomaticNavigationConfigurationsTest.php

@@ -1284,21 +1284,19 @@ protected function sidebar(?array $withPages = null): AssertableNavigationMenu
 class TestNavigationItem
 {
     public readonly string $label;
-    public readonly ?string $group;
     public readonly int $priority;
     public readonly array $children;
 
-    public function __construct(string $label, ?string $group, int $priority, array $children)
+    public function __construct(string $label, int $priority, array $children)
     {
         $this->label = $label;
-        $this->group = $group;
         $this->priority = $priority;
         $this->children = collect($children)->map(fn (NavigationItem|NavigationGroup $child) => $child->getLabel())->toArray();
     }
 
     public static function properties(): array
     {
-        return ['label', 'group', 'priority', 'children'];
+        return ['label', 'priority', 'children'];
     }
 }
 
@@ -1320,7 +1318,7 @@ public function __construct(TestCase $test, $sidebar = false)
     public function state(): array
     {
         return $this->items->map(function (NavigationItem|NavigationGroup $item): TestNavigationItem {
-            return new TestNavigationItem($item->getLabel(), $item->getGroupKey(), $item->getPriority(), $item instanceof NavigationGroup ? $item->getItems() : []);
+            return new TestNavigationItem($item->getLabel(), $item->getPriority(), $item instanceof NavigationGroup ? $item->getItems() : []);
         })->toArray();
     }
 

packages/framework/tests/Feature/Services/DocumentationSidebarTest.php

@@ -159,7 +159,10 @@ public function testSidebarPrioritiesCanBeSetInBothFrontMatterAndConfig()
     public function testGroupCanBeSetInFrontMatter()
     {
         $this->makePage('foo', ['navigation.group' => 'bar']);
-        $this->assertEquals('bar', collect(NavigationMenuGenerator::handle(DocumentationSidebar::class)->getItems()->first()->getItems())->first()->getGroupKey());
+
+        /** @var NavigationItem $item */
+        $item = collect(NavigationMenuGenerator::handle(DocumentationSidebar::class)->getItems()->first()->getItems())->first();
+        $this->assertSame('bar', $item->getPage()->navigationMenuGroup());
     }
 
     public function testHasGroupsReturnsFalseWhenThereAreNoGroups()
@@ -222,23 +225,23 @@ public function testIsGroupActiveReturnsFalseWhenSuppliedGroupIsNotActive()
     {
         Render::setPage(new DocumentationPage(matter: ['navigation.group' => 'foo']));
         $mainNavigationMenu = NavigationMenuGenerator::handle(DocumentationSidebar::class);
-        $this->assertFalse('bar' === $mainNavigationMenu->getActiveGroup()?->getGroupKey());
+        $this->assertFalse('bar' === $this->getGroupKey($mainNavigationMenu));
     }
 
     public function testIsGroupActiveReturnsTrueWhenSuppliedGroupIsActive()
     {
         $this->makePage('foo', ['navigation.group' => 'foo']);
         Render::setPage(new DocumentationPage(matter: ['navigation.group' => 'foo']));
         $mainNavigationMenu = NavigationMenuGenerator::handle(DocumentationSidebar::class);
-        $this->assertTrue('foo' === $mainNavigationMenu->getActiveGroup()?->getGroupKey());
+        $this->assertTrue('foo' === $this->getGroupKey($mainNavigationMenu));
     }
 
     public function testIsGroupActiveReturnsTrueForDifferingCasing()
     {
         $this->makePage('foo', ['navigation.group' => 'Foo Bar']);
         Render::setPage(new DocumentationPage(matter: ['navigation.group' => 'Foo Bar']));
         $mainNavigationMenu = NavigationMenuGenerator::handle(DocumentationSidebar::class);
-        $this->assertTrue('foo-bar' === $mainNavigationMenu->getActiveGroup()?->getGroupKey());
+        $this->assertTrue('foo-bar' === $this->getGroupKey($mainNavigationMenu));
     }
 
     public function testIsGroupActiveReturnsTrueFirstGroupOfIndexPage()
@@ -250,11 +253,11 @@ public function testIsGroupActiveReturnsTrueFirstGroupOfIndexPage()
 
         Render::setPage(DocumentationPage::get('index'));
         $mainNavigationMenu2 = NavigationMenuGenerator::handle(DocumentationSidebar::class);
-        $this->assertTrue('bar' === $mainNavigationMenu2->getActiveGroup()?->getGroupKey());
+        $this->assertTrue('bar' === $this->getGroupKey($mainNavigationMenu2));
         $mainNavigationMenu1 = NavigationMenuGenerator::handle(DocumentationSidebar::class);
-        $this->assertFalse('foo' === $mainNavigationMenu1->getActiveGroup()?->getGroupKey());
+        $this->assertFalse('foo' === $this->getGroupKey($mainNavigationMenu1));
         $mainNavigationMenu = NavigationMenuGenerator::handle(DocumentationSidebar::class);
-        $this->assertFalse('baz' === $mainNavigationMenu->getActiveGroup()?->getGroupKey());
+        $this->assertFalse('baz' === $this->getGroupKey($mainNavigationMenu));
     }
 
     public function testIsGroupActiveReturnsTrueFirstSortedGroupOfIndexPage()
@@ -266,11 +269,11 @@ public function testIsGroupActiveReturnsTrueFirstSortedGroupOfIndexPage()
 
         Render::setPage(DocumentationPage::get('index'));
         $mainNavigationMenu2 = NavigationMenuGenerator::handle(DocumentationSidebar::class);
-        $this->assertTrue('foo' === $mainNavigationMenu2->getActiveGroup()?->getGroupKey());
+        $this->assertTrue('foo' === $this->getGroupKey($mainNavigationMenu2));
         $mainNavigationMenu1 = NavigationMenuGenerator::handle(DocumentationSidebar::class);
-        $this->assertFalse('bar' === $mainNavigationMenu1->getActiveGroup()?->getGroupKey());
+        $this->assertFalse('bar' === $this->getGroupKey($mainNavigationMenu1));
         $mainNavigationMenu = NavigationMenuGenerator::handle(DocumentationSidebar::class);
-        $this->assertFalse('baz' === $mainNavigationMenu->getActiveGroup()?->getGroupKey());
+        $this->assertFalse('baz' === $this->getGroupKey($mainNavigationMenu));
     }
 
     public function testAutomaticIndexPageGroupExpansionRespectsCustomNavigationMenuSettings()
@@ -282,11 +285,11 @@ public function testAutomaticIndexPageGroupExpansionRespectsCustomNavigationMenu
 
         Render::setPage(DocumentationPage::get('index'));
         $mainNavigationMenu2 = NavigationMenuGenerator::handle(DocumentationSidebar::class);
-        $this->assertFalse('foo' === $mainNavigationMenu2->getActiveGroup()?->getGroupKey());
+        $this->assertFalse('foo' === $this->getGroupKey($mainNavigationMenu2));
         $mainNavigationMenu1 = NavigationMenuGenerator::handle(DocumentationSidebar::class);
-        $this->assertFalse('bar' === $mainNavigationMenu1->getActiveGroup()?->getGroupKey());
+        $this->assertFalse('bar' === $this->getGroupKey($mainNavigationMenu1));
         $mainNavigationMenu = NavigationMenuGenerator::handle(DocumentationSidebar::class);
-        $this->assertTrue('baz' === $mainNavigationMenu->getActiveGroup()?->getGroupKey());
+        $this->assertTrue('baz' === $this->getGroupKey($mainNavigationMenu));
     }
 
     public function testCanHaveMultipleGroupedPagesWithTheSameNameLabels()
@@ -335,7 +338,7 @@ public function testIsGroupActiveForIndexPageWithNoGroups()
 
         Render::setPage(DocumentationPage::get('index'));
         $mainNavigationMenu = NavigationMenuGenerator::handle(DocumentationSidebar::class);
-        $this->assertFalse('foo' === $mainNavigationMenu->getActiveGroup()?->getGroupKey());
+        $this->assertFalse('foo' === $this->getGroupKey($mainNavigationMenu));
     }
 
     public function testIndexPageAddedToSidebarWhenItIsTheOnlyPage()
@@ -377,4 +380,9 @@ protected function makePage(string $name, ?array $matter = null): void
             (new ConvertsArrayToFrontMatter)->execute($matter ?? [])
         );
     }
+
+    protected function getGroupKey(DocumentationSidebar $menu): ?string
+    {
+        return $menu->getActiveGroup()?->getGroupKey();
+    }
 }