Merge pull request #177 from ock-php/use-hooks-for-links-from-routes

Use hooks for links from routes

Author: donquixote

.github/workflows/ci-per-module.yaml

@@ -20,7 +20,7 @@ jobs:
           - themekit
         php: [8.3]
         composer-flags: ['', '--prefer-lowest']
-        drupal-constraint: ['^11.0.5']
+        drupal-constraint: ['^11.1.8']
 
     defaults:
       run:

composer.json

@@ -41,9 +41,9 @@
         "donquixote/nicetrace": "^0.0.4",
         "drupal/admin_toolbar": "^3.4",
         "drupal/controller_attributes": "self.version",
-        "drupal/core-composer-scaffold": "^11.0.5",
-        "drupal/core-project-message": "^11.0.5",
-        "drupal/core-recommended": "^11.0.5",
+        "drupal/core-composer-scaffold": "^11.1.8",
+        "drupal/core-project-message": "^11.1.8",
+        "drupal/core-recommended": "^11.1.8",
         "drupal/devel": "^5.2",
         "drupal/ock": "self.version",
         "drupal/renderkit": "self.version",
@@ -57,7 +57,7 @@
     "require-dev": {
         "ext-dom": "*",
         "ext-libxml": "*",
-        "drupal/core-dev": "^11.0.5",
+        "drupal/core-dev": "^11.1.8",
         "league/container": "^4.2.2",
         "ock/drupal-testing": "self.version",
         "phpspec/prophecy-phpunit": "^2.2.0",

modules/controller_attributes/composer.json

@@ -5,10 +5,11 @@
     "license": "GPL-2.0-or-later",
     "require": {
         "php": ">=8.3",
-        "drupal/core": "^11.0.5"
+        "drupal/core": "^11.1.8"
     },
     "require-dev": {
-        "ock/drupal-testing": "self.version"
+        "ock/drupal-testing": "self.version",
+        "phpunit/phpunit": "^10.5.38"
     },
     "minimum-stability": "dev",
     "prefer-stable": true

modules/controller_attributes/controller_attributes.links.action.yml

@@ -5,6 +5,7 @@
          bootstrap="web/core/tests/bootstrap.php"
          displayDetailsOnIncompleteTests="true"
          displayDetailsOnSkippedTests="true"
+         displayDetailsOnPhpunitDeprecations="true"
          displayDetailsOnTestsThatTriggerDeprecations="true"
          displayDetailsOnTestsThatTriggerErrors="true"
          displayDetailsOnTestsThatTriggerNotices="true"
@@ -13,9 +14,11 @@
          failOnIncomplete="true"
          failOnNotice="true"
          failOnSkipped="true"
+         failOnPhpunitDeprecation="true"
          failOnDeprecation="true"
          failOnRisky="true"
          failOnWarning="true"
+         requireCoverageMetadata="true"
 >
   <php>
     <!-- See https://gist.github.com/davidjguru/2d59eed50818f74710ae3b0f87fb947d -->
@@ -47,9 +50,19 @@
     <!-- Example for changing the driver args to webdriver tests MINK_DRIVER_ARGS_WEBDRIVER value: '["chrome", { "chromeOptions": { "w3c": false } }, "http://localhost:4444/wd/hub"]' For using the Firefox browser, replace "chrome" with "firefox" -->
     <env name="MINK_DRIVER_ARGS_WEBDRIVER" value=''/>
   </php>
+  <coverage>
+    <report>
+      <clover outputFile="build/logs/clover.xml"/>
+    </report>
+  </coverage>
   <testsuites>
     <testsuite name="default">
       <directory>./tests/src</directory>
     </testsuite>
   </testsuites>
+  <source>
+    <include>
+      <directory>./src/</directory>
+    </include>
+  </source>
 </phpunit>

modules/controller_attributes/controller_attributes.links.menu.yml

@@ -0,0 +1,141 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace Drupal\controller_attributes\Hook;
+
+use Drupal\Core\Hook\Attribute\Hook;
+use Drupal\Core\Menu\LocalActionManagerInterface;
+use Drupal\Core\Menu\LocalTaskManagerInterface;
+use Drupal\Core\Plugin\DefaultPluginManager;
+use Drupal\Core\Routing\RouteProviderInterface;
+use Symfony\Component\Routing\Route;
+
+class LinksFromRoutes {
+
+  public function __construct(
+    protected RouteProviderInterface $provider,
+    protected LocalActionManagerInterface $localActionManager,
+    protected LocalTaskManagerInterface $localTaskManager,
+  ) {}
+
+  #[Hook('menu_links_discovered_alter')]
+  public function menuLinksDiscoveredAlter(&$links): void {
+    $definitions = [];
+    foreach ($this->provider->getAllRoutes() as $k => $route) {
+      if (NULL === $link = $route->getOption('_menu_link')) {
+        continue;
+      }
+      if (!\is_array($link)) {
+        // @todo Skip invalid values like this.
+        $link = [];
+      }
+      $link += [
+        'title' => $route->getDefault('_title'),
+        'route_name' => $k,
+      ];
+      if (!isset($link['parent'])) {
+        $link['parent'] = $this->routeGetParentName($route);
+      }
+      $definitions[$k] = $link;
+    }
+
+    foreach ($definitions as $k => $link) {
+      if (isset($definitions[$link['parent']])) {
+        $link['parent'] = 'routelink:' . $link['parent'];
+      }
+      $links['routelink:' . $k] = $link;
+    }
+  }
+
+  #[Hook('menu_local_actions_alter')]
+  public function menuLocalActionsAlter(array &$local_actions): void {
+    foreach ($this->provider->getAllRoutes() as $k => $route) {
+      if (!is_array($link = $route->getOption('_action_link'))) {
+        continue;
+      }
+      $link += [
+        'title' => $route->getDefault('_title'),
+        'route_name' => $k,
+      ];
+      if (!isset($link['appears_on'])) {
+        if (NULL === $parentRouteName = $this->routeGetParentName($route)) {
+          continue;
+        }
+        $link['appears_on'] = [$parentRouteName];
+      }
+      elseif (!\is_array($link['appears_on'])) {
+        continue;
+      }
+      if ($this->localActionManager instanceof DefaultPluginManager) {
+        $this->localActionManager->processDefinition($link, 'routelink:' . $k);
+      }
+      $local_actions['routelink:' . $k] = $link;
+    }
+  }
+
+  /**
+   * Implements hook_local_tasks_alter().
+   */
+  #[Hook('local_tasks_alter')]
+  public function localTasksAlter(array &$local_tasks): void {
+    foreach ($this->provider->getAllRoutes() as $k => $route) {
+      if (is_array($link = $route->getOption('_task_link'))) {
+        $is_default_task = FALSE;
+      }
+      elseif (is_array($link = $route->getOption('_task_link_default'))) {
+        $is_default_task = TRUE;
+      }
+      else {
+        continue;
+      }
+      if (!$is_default_task) {
+        $is_default_task = !empty($link['is_default_task']);
+      }
+      $link += [
+        'title' => $route->getDefault('_title'),
+        'route_name' => $k,
+      ];
+      if (!isset($link['base_route'])) {
+        if ($is_default_task) {
+          $link['base_route'] = $k;
+        }
+        else {
+          $link['base_route'] = $this->routeGetParentName($route);
+        }
+      }
+      if ($this->localTaskManager instanceof DefaultPluginManager) {
+        $this->localTaskManager->processDefinition($link, 'routelink:' . $k);
+      }
+      $local_tasks['routelink:' . $k] = $link;
+    }
+  }
+
+  /**
+   * Attempts to find a parent route for a given route, based on the path.
+   *
+   * @param \Symfony\Component\Routing\Route $route
+   *   The route for which to find a parent.
+   *
+   * @return string|null
+   *   A parent route name, or NULL if none found.
+   */
+  protected function routeGetParentName(Route $route): ?string {
+
+    $path = $route->getPath();
+    $parent_path = \dirname($path);
+    if ($parent_path === '/' || $parent_path === '') {
+      return NULL;
+    }
+
+    $candidate_routes = $this->provider->getRoutesByPattern($parent_path);
+    foreach ($candidate_routes as $candidate_name => $candidate_route) {
+      if ($candidate_route->getPath() === $parent_path) {
+        return $candidate_name;
+      }
+    }
+
+    return NULL;
+  }
+
+}