Make method more generic

Author: lachiebol

API.php

@@ -38,15 +38,15 @@ public function getAllowedPlugins(): array
     }
 
     /**
-     * Returns API class descriptions for the plugins used by OpenApiDocs spec generation.
+     * Returns metadata for the plugins used by OpenApiDocs spec generation.
      *
-     * @return array<string, string>
+     * @return array<string, array{description: string}>
      */
-    public function getAllowedPluginDescriptions(): array
+    public function getAllowedPluginMetadata(): array
     {
         Piwik::checkUserHasSomeViewAccess();
 
-        return $this->getPluginListProvider()->getAllowedPluginDescriptions();
+        return $this->getPluginListProvider()->getAllowedPluginMetadata();
     }
 
     /**

Generation/PluginListProvider.php

@@ -45,21 +45,25 @@ public function getAllowedPlugins(): array
     }
 
     /**
-     * @return array<string, string>
+     * @return array<string, array{description: string}>
      */
-    public function getAllowedPluginDescriptions(): array
+    public function getAllowedPluginMetadata(): array
     {
-        $descriptions = [];
+        $metadata = [];
 
         foreach ($this->getAllowedPlugins() as $pluginName) {
             try {
-                $descriptions[$pluginName] = $this->getPluginDescription($pluginName);
+                $description = $this->getPluginDescription($pluginName);
             } catch (\Throwable $e) {
-                $descriptions[$pluginName] = '';
+                $description = '';
             }
+
+            $metadata[$pluginName] = [
+                'description' => $description,
+            ];
         }
 
-        return $descriptions;
+        return $metadata;
     }
 
     private function shouldIncludeEventProvidedPlugin(string $pluginName): bool

tests/Unit/APITest.php

@@ -77,14 +77,14 @@ public function testGetAllowedPluginsReturnsProviderValues(): void
         $this->assertSame(['Login', 'ActivityLog'], $api->getAllowedPlugins());
     }
 
-    public function testGetAllowedPluginDescriptionsReturnsProviderValues(): void
+    public function testGetAllowedPluginMetadataReturnsProviderValues(): void
     {
         $provider = $this->createMock(PluginListProvider::class);
         $provider->expects($this->once())
-            ->method('getAllowedPluginDescriptions')
+            ->method('getAllowedPluginMetadata')
             ->willReturn([
-                'Login' => 'Login API description',
-                'ActivityLog' => '',
+                'Login' => ['description' => 'Login API description'],
+                'ActivityLog' => ['description' => ''],
             ]);
 
         $api = $this->getMockBuilder(API::class)
@@ -93,9 +93,9 @@ public function testGetAllowedPluginDescriptionsReturnsProviderValues(): void
         $api->method('getPluginListProvider')->willReturn($provider);
 
         $this->assertSame([
-            'Login' => 'Login API description',
-            'ActivityLog' => '',
-        ], $api->getAllowedPluginDescriptions());
+            'Login' => ['description' => 'Login API description'],
+            'ActivityLog' => ['description' => ''],
+        ], $api->getAllowedPluginMetadata());
     }
 
     public function testGetOpenApiSpecThrowsExceptionWhenFileMissing()

tests/Unit/Generation/PluginListProviderTest.php

@@ -107,7 +107,7 @@ static function (string $eventName, array $params): void {
         $this->assertSame(['HasApi', 'Login', 'InactivePlugin'], $provider->getAllowedPlugins());
     }
 
-    public function testGetAllowedPluginDescriptionsReturnsDescriptionPerAllowedPlugin(): void
+    public function testGetAllowedPluginMetadataReturnsDescriptionPerAllowedPlugin(): void
     {
         $provider = $this->getMockBuilder(PluginListProvider::class)
             ->disableOriginalConstructor()
@@ -123,12 +123,12 @@ public function testGetAllowedPluginDescriptionsReturnsDescriptionPerAllowedPlug
             ]);
 
         $this->assertSame([
-            'Login' => 'Login API description',
-            'ActivityLog' => 'Activity log API description',
-        ], $provider->getAllowedPluginDescriptions());
+            'Login' => ['description' => 'Login API description'],
+            'ActivityLog' => ['description' => 'Activity log API description'],
+        ], $provider->getAllowedPluginMetadata());
     }
 
-    public function testGetAllowedPluginDescriptionsReturnsEmptyStringWhenDescriptionMissing(): void
+    public function testGetAllowedPluginMetadataReturnsEmptyStringWhenDescriptionMissing(): void
     {
         $provider = $this->getMockBuilder(PluginListProvider::class)
             ->disableOriginalConstructor()
@@ -140,10 +140,10 @@ public function testGetAllowedPluginDescriptionsReturnsEmptyStringWhenDescriptio
         $provider->method('getPluginDescription')
             ->willReturn('');
 
-        $this->assertSame(['Login' => ''], $provider->getAllowedPluginDescriptions());
+        $this->assertSame(['Login' => ['description' => '']], $provider->getAllowedPluginMetadata());
     }
 
-    public function testGetAllowedPluginDescriptionsContinuesWhenOnePluginDescriptionFails(): void
+    public function testGetAllowedPluginMetadataContinuesWhenOnePluginDescriptionFails(): void
     {
         $provider = $this->getMockBuilder(PluginListProvider::class)
             ->disableOriginalConstructor()
@@ -162,10 +162,10 @@ public function testGetAllowedPluginDescriptionsContinuesWhenOnePluginDescriptio
             });
 
         $this->assertSame([
-            'Login' => 'Login API description',
-            'BrokenPlugin' => '',
-            'ActivityLog' => 'Activity log API description',
-        ], $provider->getAllowedPluginDescriptions());
+            'Login' => ['description' => 'Login API description'],
+            'BrokenPlugin' => ['description' => ''],
+            'ActivityLog' => ['description' => 'Activity log API description'],
+        ], $provider->getAllowedPluginMetadata());
     }
 
     /**