Sort navigation items on retrieval

Author: emmadesilva

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

@@ -59,7 +59,7 @@ public function getPriority(): int
     /** @return \Illuminate\Support\Collection<\Hyde\Framework\Features\Navigation\NavigationItem> */
     public function getItems(): Collection
     {
-        return $this->items;
+        return $this->items->sortBy(fn (NavigationItem|NavigationGroup $item) => $item->getPriority())->values();
     }
 
     /** @param \Hyde\Framework\Features\Navigation\NavigationItem|\Hyde\Framework\Features\Navigation\NavigationGroup|array<\Hyde\Framework\Features\Navigation\NavigationItem|\Hyde\Framework\Features\Navigation\NavigationGroup> $items */

packages/framework/tests/Unit/NavigationGroupTest.php

@@ -119,6 +119,28 @@ public function testAddChildrenMethodReturnsSelf()
         $this->assertSame($group, $group->add([]));
     }
 
+    public function testItemsOrderingDefaultsToAddOrder()
+    {
+        $group = new NavigationGroup('Group', [
+            new NavigationItem(new Route(new MarkdownPage()), 'Foo'),
+            new NavigationItem(new Route(new MarkdownPage()), 'Bar'),
+            new NavigationItem(new Route(new MarkdownPage()), 'Baz'),
+        ]);
+
+        $this->assertSame(['Foo', 'Bar', 'Baz'], $group->getItems()->map(fn (NavigationItem $item) => $item->getLabel())->all());
+    }
+
+    public function testItemsAreSortedByPriority()
+    {
+        $group = new NavigationGroup('Group', [
+            new NavigationItem(new Route(new MarkdownPage()), 'Foo', 3),
+            new NavigationItem(new Route(new MarkdownPage()), 'Bar', 2),
+            new NavigationItem(new Route(new MarkdownPage()), 'Baz', 1),
+        ]);
+
+        $this->assertSame(['Baz', 'Bar', 'Foo'], $group->getItems()->map(fn (NavigationItem $item) => $item->getLabel())->all());
+    }
+
     public function testGetPriorityUsesDefaultPriority()
     {
         $this->assertSame(999, (new NavigationGroup('Foo'))->getPriority());