Breadcrumb for OpenAPI node

Author: phdhiren

apigee_api_catalog.services.yml

@@ -17,3 +17,8 @@ services:
   apigee_api_catalog.updates:
     class: Drupal\apigee_api_catalog\UpdateService
     arguments: ['@uuid', '@config.factory', '@module_handler', '@entity_type.manager', '@entity_field.manager', '@entity.last_installed_schema.repository']
+
+  apigee_api_catalog.breadcrumb:
+    class: Drupal\apigee_api_catalog\ApigeeApiCatalogBreadcrumbBuilder
+    tags:
+      - { name: breadcrumb_builder, priority: 1000 }

src/ApigeeApiCatalogBreadcrumbBuilder.php

@@ -0,0 +1,62 @@
+<?php
+
+/**
+ * @file
+ * Copyright 2022 Google Inc.
+ *
+ * This program is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License version 2 as published by the
+ * Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+ * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public
+ * License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc., 51
+ * Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ */
+
+namespace Drupal\apigee_api_catalog;
+
+use Drupal\Core\Breadcrumb\Breadcrumb;
+use Drupal\Core\Breadcrumb\BreadcrumbBuilderInterface;
+use Drupal\Core\Link;
+use Drupal\Core\Routing\RouteMatchInterface;
+use Drupal\Core\StringTranslation\StringTranslationTrait;
+use Drupal\node\NodeInterface;
+
+/**
+ * Provides a breadcrumb builder for apidoc.
+ */
+class ApigeeApiCatalogBreadcrumbBuilder implements BreadcrumbBuilderInterface {
+
+  use StringTranslationTrait;
+
+  /**
+   * {@inheritdoc}
+   */
+  public function applies(RouteMatchInterface $route_match) {
+    $node = $route_match->getParameter('node');
+    return $node instanceof NodeInterface && $node->getType() === 'apidoc';
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function build(RouteMatchInterface $route_match) {
+    $breadcrumb = new Breadcrumb();
+
+    $links[] = Link::createFromRoute($this->t('Home'), '<front>');
+
+    // API Catalog is a view.
+    $links[] = Link::createFromRoute($this->t('API Catalog'), 'view.apigee_api_catalog.page_1');
+
+    $breadcrumb->setLinks($links);
+    $breadcrumb->addCacheContexts(['route']);
+
+    return $breadcrumb;
+  }
+
+}

tests/src/Functional/ApiDocsBreadcrumbTest.php

@@ -0,0 +1,102 @@
+<?php
+
+/**
+ * Copyright 2022 Google Inc.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * version 2 as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+ * MA 02110-1301, USA.
+ */
+
+namespace Drupal\Tests\apigee_api_catalog\Functional;
+
+use Drupal\Core\Url;
+use Drupal\Tests\BrowserTestBase;
+
+/**
+ * Tests apidoc breadcrumb.
+ *
+ * @group apigee_api_catalog
+ */
+class ApiDocsBreadcrumbTest extends BrowserTestBase {
+
+  /**
+   * {@inheritdoc}
+   */
+  protected $defaultTheme = 'classy';
+
+  /**
+   * {@inheritdoc}
+   */
+  protected static $modules = [
+    'node',
+    'path_alias',
+    'apigee_api_catalog',
+    'views',
+    'block',
+  ];
+
+  /**
+   * A test doc.
+   *
+   * @var \Drupal\node\NodeInterface
+   */
+  protected $apidoc;
+
+  /**
+   * {@inheritdoc}
+   */
+  protected function setUp(): void {
+    parent::setUp();
+    $this->drupalPlaceBlock('system_breadcrumb_block');
+    $this->drupalPlaceBlock('page_title_block');
+
+    $this->apidoc = $this->container->get('entity_type.manager')
+      ->getStorage('node')
+      ->create([
+        'type' => 'apidoc',
+        'title' => 'API 1',
+        'body' => [
+          'value' => 'Test API 1',
+          'format' => 'basic_html',
+        ],
+        'field_apidoc_spec' => NULL,
+      ]);
+
+    $this->apidoc->save();
+
+    $user = $this->drupalCreateUser(['access content']);
+    $this->drupalLogin($user);
+  }
+
+  /**
+   * Tests the route subscriber will redirect from smartdoc routes.
+   */
+  public function testApiDocBreadcrumb() {
+    // Tests the normal response.
+    $url = Url::fromRoute('entity.node.canonical', ['node' => $this->apidoc->id()]);
+    $this->drupalGet($url);
+
+    // Fetch each node title in the current breadcrumb.
+    $links = $this->xpath('//nav[@class="breadcrumb"]/ol/li/a');
+    $got_breadcrumb = [];
+    foreach ($links as $link) {
+      $got_breadcrumb[] = $link->getText();
+    }
+    // print_r($got_breadcrumb);
+    $this->assertEquals($got_breadcrumb[0], 'Home');
+    $this->assertEquals($got_breadcrumb[1], 'API Catalog');
+
+  }
+
+}