Merge pull request #1579 from hydephp/merge-menu-generator-actions-into-single-class

[2.x] Merge menu generator actions into single class

Author: emmadesilva

packages/framework/src/Foundation/Providers/NavigationServiceProvider.php

@@ -6,9 +6,10 @@
 
 use Hyde\Foundation\HydeKernel;
 use Illuminate\Support\ServiceProvider;
+use Hyde\Framework\Features\Navigation\NavigationMenu;
 use Hyde\Framework\Features\Navigation\NavigationManager;
-use Hyde\Framework\Features\Navigation\GeneratesMainNavigationMenu;
-use Hyde\Framework\Features\Navigation\GeneratesDocumentationSidebarMenu;
+use Hyde\Framework\Features\Navigation\DocumentationSidebar;
+use Hyde\Framework\Features\Navigation\NavigationMenuGenerator;
 
 class NavigationServiceProvider extends ServiceProvider
 {
@@ -21,8 +22,8 @@ public function register(): void
         $this->app->alias(NavigationManager::class, 'navigation');
 
         $this->app->make(HydeKernel::class)->booted(function () {
-            $this->app->make(NavigationManager::class)->registerMenu('main', GeneratesMainNavigationMenu::handle());
-            $this->app->make(NavigationManager::class)->registerMenu('sidebar', GeneratesDocumentationSidebarMenu::handle());
+            $this->app->make(NavigationManager::class)->registerMenu('main', NavigationMenuGenerator::handle(NavigationMenu::class));
+            $this->app->make(NavigationManager::class)->registerMenu('sidebar', NavigationMenuGenerator::handle(DocumentationSidebar::class));
         });
     }
 }

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

@@ -18,7 +18,7 @@ class DocumentationSidebar extends NavigationMenu
     /** @deprecated Will be moved to an action */
     public static function create(): static
     {
-        return GeneratesDocumentationSidebarMenu::handle();
+        return NavigationMenuGenerator::handle(DocumentationSidebar::class);
     }
 
     public function hasGroups(): bool

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

@@ -11,6 +11,7 @@
 use Stringable;
 use Hyde\Support\Models\ExternalRoute;
 
+use function collect;
 use function is_string;
 
 /**
@@ -135,9 +136,15 @@ public function getLabel(): string
 
     /**
      * Get the priority to determine the order of the navigation item.
+     *
+     * For dropdowns, this is the priority of the lowest priority child, unless the dropdown has a lower priority.
      */
     public function getPriority(): int
     {
+        if ($this->hasChildren()) {
+            return min($this->priority, collect($this->getChildren())->min(fn (NavItem $child): int => $child->getPriority()));
+        }
+
         return $this->priority;
     }
 

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

@@ -14,27 +14,38 @@
 use Hyde\Foundation\Kernel\RouteCollection;
 
 use function filled;
+use function assert;
+use function collect;
+use function in_array;
 use function strtolower;
 
 /**
  * @experimental This class may change significantly before its release.
  */
-abstract class BaseMenuGenerator
+class NavigationMenuGenerator
 {
     /** @var \Illuminate\Support\Collection<string, \Hyde\Framework\Features\Navigation\NavItem> */
     protected Collection $items;
 
     /** @var \Hyde\Foundation\Kernel\RouteCollection<string, \Hyde\Support\Models\Route> */
     protected RouteCollection $routes;
 
+    /** @var class-string<\Hyde\Framework\Features\Navigation\NavigationMenu> */
+    protected string $menuType;
+
     protected bool $generatesSidebar;
     protected bool $usesGroups;
 
-    protected function __construct()
+    /** @param class-string<\Hyde\Framework\Features\Navigation\NavigationMenu> $menuType */
+    protected function __construct(string $menuType)
     {
+        assert(in_array($menuType, [NavigationMenu::class, DocumentationSidebar::class]));
+
+        $this->menuType = $menuType;
+
         $this->items = new Collection();
 
-        $this->generatesSidebar = $this instanceof GeneratesDocumentationSidebarMenu;
+        $this->generatesSidebar = $menuType === DocumentationSidebar::class;
 
         $this->routes = $this->generatesSidebar
             ? Routes::getRoutes(DocumentationPage::class)
@@ -43,13 +54,14 @@ protected function __construct()
         $this->usesGroups = $this->usesGroups();
     }
 
-    public static function handle(): NavigationMenu
+    /** @param class-string<\Hyde\Framework\Features\Navigation\NavigationMenu> $menuType */
+    public static function handle(string $menuType): NavigationMenu|DocumentationSidebar
     {
-        $menu = new static();
+        $menu = new static($menuType);
 
         $menu->generate();
 
-        return new NavigationMenu($menu->items);
+        return new $menuType($menu->items);
     }
 
     protected function generate(): void
@@ -63,6 +75,18 @@ protected function generate(): void
                 }
             }
         });
+
+        if ($this->generatesSidebar) {
+            // If there are no pages other than the index page, we add it to the sidebar so that it's not empty
+            if ($this->items->count() === 0 && DocumentationPage::home() !== null) {
+                $this->items->push(NavItem::fromRoute(DocumentationPage::home()));
+            }
+        } else {
+            collect(Config::getArray('hyde.navigation.custom', []))->each(function (NavItem $item): void {
+                // Since these were added explicitly by the user, we can assume they should always be shown
+                $this->items->push($item);
+            });
+        }
     }
 
     protected function usesGroups(): bool
@@ -79,12 +103,32 @@ protected function usesGroups(): bool
 
     protected function canAddRoute(Route $route): bool
     {
-        return $route->getPage()->showInNavigation();
+        if (! $route->getPage()->showInNavigation()) {
+            return false;
+        }
+
+        if ($this->generatesSidebar) {
+            // Since the index page is linked in the header, we don't want it in the sidebar
+            return ! $route->is(DocumentationPage::homeRouteName());
+        } else {
+            // While we for the most part can rely on the navigation visibility state provided by the navigation data factory,
+            // we need to make an exception for documentation pages, which generally have a visible state, as the data is
+            // also used in the sidebar. But we only want the documentation index page to be in the main navigation.
+            return ! $route->getPage() instanceof DocumentationPage || $route->is(DocumentationPage::homeRouteName());
+        }
     }
 
     protected function canGroupRoute(Route $route): bool
     {
-        return $this->usesGroups;
+        if (! $this->usesGroups) {
+            return false;
+        }
+
+        if (! $this->generatesSidebar) {
+            return $route->getPage()->navigationMenuGroup() !== null;
+        }
+
+        return true;
     }
 
     protected function addRouteToGroup(Route $route): void

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

@@ -18,17 +18,17 @@
 use Illuminate\Support\Collection;
 use Hyde\Foundation\Kernel\RouteCollection;
 use Hyde\Framework\Features\Navigation\NavItem;
-use Hyde\Framework\Features\Navigation\GeneratesMainNavigationMenu;
-use Hyde\Framework\Features\Navigation\GeneratesDocumentationSidebarMenu;
+use Hyde\Framework\Features\Navigation\NavigationMenu;
+use Hyde\Framework\Features\Navigation\DocumentationSidebar;
+use Hyde\Framework\Features\Navigation\NavigationMenuGenerator;
 
 /**
  * High-level broad-spectrum tests for the automatic navigation configurations, testing various setups.
  *
  * @covers \Hyde\Framework\Factories\NavigationDataFactory
- * @covers \Hyde\Framework\Features\Navigation\BaseMenuGenerator
+ * @covers \Hyde\Framework\Features\Navigation\NavigationMenuGenerator
  * @covers \Hyde\Framework\Features\Navigation\DocumentationSidebar
- * @covers \Hyde\Framework\Features\Navigation\GeneratesDocumentationSidebarMenu
- * @covers \Hyde\Framework\Features\Navigation\GeneratesMainNavigationMenu
+ * @covers \Hyde\Framework\Features\Navigation\NavigationMenu
  * @covers \Hyde\Framework\Features\Navigation\NavItem
  */
 class AutomaticNavigationConfigurationsTest extends TestCase
@@ -1246,8 +1246,8 @@ class AssertableNavigationMenu
     public function __construct(TestCase $test, $sidebar = false)
     {
         $this->items = $sidebar
-            ? GeneratesDocumentationSidebarMenu::handle()->getItems()
-            : GeneratesMainNavigationMenu::handle()->getItems();
+            ? NavigationMenuGenerator::handle(DocumentationSidebar::class)->getItems()
+            : NavigationMenuGenerator::handle(NavigationMenu::class)->getItems();
 
         $this->test = $test;
     }

packages/framework/src/Framework/Features/Navigation/BaseMenuGenerator.php renamed to packages/framework/src/Framework/Features/Navigation/NavigationMenuGenerator.php

@@ -12,11 +12,11 @@
 use Hyde\Pages\MarkdownPage;
 use Hyde\Testing\TestCase;
 use Illuminate\Support\Collection;
-use Hyde\Framework\Features\Navigation\GeneratesMainNavigationMenu;
+use Hyde\Framework\Features\Navigation\NavigationMenuGenerator;
 
 /**
- * @covers \Hyde\Framework\Features\Navigation\GeneratesMainNavigationMenu
  * @covers \Hyde\Framework\Features\Navigation\NavigationMenu
+ * @covers \Hyde\Framework\Features\Navigation\NavigationMenuGenerator
  *
  * @see \Hyde\Framework\Testing\Unit\NavigationMenuUnitTest
  */
@@ -271,6 +271,6 @@ public function testCanAddItemsToMainNavigationMenuResolvedFromContainer()
 
     protected function createNavigationMenu(): NavigationMenu
     {
-        return GeneratesMainNavigationMenu::handle();
+        return NavigationMenuGenerator::handle(NavigationMenu::class);
     }
 }

packages/framework/tests/Feature/AutomaticNavigationConfigurationsTest.php

@@ -18,6 +18,7 @@
 
 /**
  * @covers \Hyde\Framework\Features\Navigation\DocumentationSidebar
+ * @covers \Hyde\Framework\Features\Navigation\NavigationMenuGenerator
  * @covers \Hyde\Framework\Factories\Concerns\HasFactory
  * @covers \Hyde\Framework\Factories\NavigationDataFactory
  * @covers \Hyde\Framework\Features\Navigation\NavItem

packages/framework/tests/Feature/NavigationMenuTest.php

@@ -278,7 +278,7 @@ public function testDropdownFacadeWithChildren()
 
         $item = NavItem::dropdown('foo', $children);
         $this->assertSame($children, $item->getChildren());
-        $this->assertSame(999, $item->getPriority());
+        $this->assertSame(500, $item->getPriority());
     }
 
     public function testDropdownFacadeWithCustomPriority()