Add module statistics to Statistics class

Enhanced the Statistics class to handle module statistics, including adding the ModuleStatisticsInterface and implementing getModules and getModuleStatistics methods. Updated related tests and bumped the version in composer.json to 0.9.0.

Author: Pavlusha311245

composer.json

@@ -1,6 +1,6 @@
 {
   "name": "pavlusha/unit-php-sdk",
-  "version": "0.8.0",
+  "version": "0.9.0",
   "type": "sdk",
   "description": "This project allows developers to interact with the Nginx Unit web server through PHP classes",
   "license": "Apache-2.0",

src/Contracts/ModuleStatisticsInterface.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace UnitPhpSdk\Contracts;
+
+interface ModuleStatisticsInterface
+{
+    /**
+     * Language module version. If multiple versions are loaded, the list contains multiple items.
+     *
+     * @return string
+     */
+    public function getVersion(): string;
+
+    /**
+     * Path to the language module file
+     *
+     * @return string
+     */
+    public function getLibPath(): string;
+}

src/Contracts/StatisticsInterface.php

@@ -3,9 +3,25 @@
 namespace UnitPhpSdk\Contracts;
 
 use UnitPhpSdk\Abstract\AbstractApplication;
+use UnitPhpSdk\Statistics\ModuleStatistics;
 
 interface StatisticsInterface extends Arrayable, Jsonable
 {
+    /**
+     * Get modules
+     *
+     * @return array
+     */
+    public function getModules(): array;
+
+    /**
+     * Get module statistics
+     *
+     * @param string $module
+     * @return ModuleStatistics
+     */
+    public function getModuleStatistics(string $module): ModuleStatisticsInterface;
+
     /**
      * Get connections
      *

src/Statistics/ModuleStatistics.php

@@ -0,0 +1,65 @@
+<?php
+
+namespace UnitPhpSdk\Statistics;
+
+use UnitPhpSdk\Contracts\Arrayable;
+use UnitPhpSdk\Contracts\ModuleStatisticsInterface;
+
+class ModuleStatistics implements ModuleStatisticsInterface, Arrayable
+{
+    /**
+     * @var string Language module version. If multiple versions are loaded, the list contains multiple items.
+     */
+    private string $version;
+
+    /**
+     * @var string Path to the language module file
+     */
+    private string $libPath;
+
+    public function __construct(array $data)
+    {
+        $this->parseFromArray($data);
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getVersion(): string
+    {
+        return $this->version;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getLibPath(): string
+    {
+        return $this->libPath;
+    }
+
+    public function parseFromArray(array $data)
+    {
+        if (!isset($data['version'])) {
+            throw new \InvalidArgumentException('Version is required');
+        }
+
+        if (!isset($data['lib'])) {
+            throw new \InvalidArgumentException('Lib is required');
+        }
+
+        $this->version = $data['version'];
+        $this->libPath = $data['lib'];
+    }
+
+    /**
+     * @inheritDoc
+     */
+    #[\Override] public function toArray(): array
+    {
+        return [
+            'version' => $this->getVersion(),
+            'lib' => $this->getLibPath()
+        ];
+    }
+}

src/Statistics/Statistics.php

@@ -9,9 +9,9 @@
 use UnitPhpSdk\Contracts\{ApplicationStatisticsInterface,
     Arrayable,
     ConnectionsStatisticsInterface,
+    ModuleStatisticsInterface,
     RequestsStatisticsInterface,
-    StatisticsInterface
-};
+    StatisticsInterface};
 use UnitPhpSdk\Exceptions\UnitParseException;
 
 /**
@@ -22,6 +22,13 @@
  */
 final readonly class Statistics implements StatisticsInterface
 {
+    /**
+     * Modules statistics
+     *
+     * @var array
+     */
+    private array $modules;
+
     /**
      * Connections statistics
      *
@@ -48,7 +55,7 @@
      */
     public function __construct(array $data)
     {
-        //        $this->unitInformation = new UnitStatistics($data['unit']);
+        $this->modules = array_map(fn ($item) => new ModuleStatistics($item), $data['modules']);
         $this->connections = new ConnectionsStatistics($data['connections']);
         $this->requests = new RequestsStatistics($data['requests']);
         $this->applications = array_map(fn ($item) => new ApplicationStatistics($item), $data['applications']);
@@ -94,12 +101,33 @@ public function getApplicationStatistics(AbstractApplication|string $application
         return $this->applications[$application->getName()];
     }
 
+    /**
+     * @return array
+     */
+    public function getModules(): array
+    {
+        return $this->modules;
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function getModuleStatistics(string $module): ModuleStatisticsInterface
+    {
+        if (!array_key_exists($module, $this->modules)) {
+            throw new InvalidArgumentException('Module with name ' . $module . ' not found');
+        }
+
+        return $this->modules[$module];
+    }
+
     /**
      * @inheritDoc
      */
     #[Override] public function toArray(): array
     {
         return [
+            'modules' => array_map(fn ($item) => $item->toArray(), $this->modules),
             'connections' => $this->connections->toArray(),
             'requests' => $this->requests->toArray(),
             'applications' => array_map(fn ($item) => $item->toArray(), $this->applications),

src/helpers.php

@@ -30,7 +30,7 @@ function parse_listener_pass(string $string): array
 
             return $data;
         } else {
-            throw new ParseError('Error when try to parse listenerPass');
+            throw new ParseError('Invalid format. The string must start with applications, routes, or upstreams, followed by up to three optional segments separated by slashes, where each segment can contain letters, digits, underscores, or hyphens.');
         }
     }
 }

tests/Unit/Helpers/ListenerParseTest.php

@@ -47,7 +47,7 @@
 
     foreach ($invalidStrings as $string) {
         $this->expectException(ParseError::class);
-        $this->expectExceptionMessage('Error when try to parse listenerPass');
+        $this->expectExceptionMessage('Invalid format. The string must start with applications, routes, or upstreams, followed by up to three optional segments separated by slashes, where each segment can contain letters, digits, underscores, or hyphens.');
 
         parse_listener_pass($string);
     }

tests/Unit/Statistics/ModuleStatisticsTest.php

@@ -0,0 +1,56 @@
+<?php
+
+namespace Tests\Unit\Statistics;
+
+use InvalidArgumentException;
+use UnitPhpSdk\Statistics\ModuleStatistics;
+
+it('creates ModuleStatistics instance correctly', function () {
+    $data = [
+        'version' => '1.0.0',
+        'lib' => '/path/to/libfile.so'
+    ];
+
+    $moduleStats = new ModuleStatistics($data);
+
+    expect($moduleStats->getVersion())->toBe('1.0.0')
+        ->and($moduleStats->getLibPath())->toBe('/path/to/libfile.so')
+        ->and($moduleStats->toArray())->toBe([
+            'version' => '1.0.0',
+            'lib' => '/path/to/libfile.so'
+        ]);
+});
+
+it(
+/**
+ * @throws InvalidArgumentException
+ */
+    'throws InvalidArgumentException when version is missing',
+    function () {
+        $data = [
+            'lib' => '/path/to/libfile.so'
+        ];
+
+        $this->expectException(InvalidArgumentException::class);
+        $this->expectExceptionMessage('Version is required');
+
+        new ModuleStatistics($data);
+    }
+);
+
+it(
+/**
+ * @throws InvalidArgumentException
+ */
+    'throws InvalidArgumentException when lib is missing',
+    function () {
+        $data = [
+            'version' => '1.0.0',
+        ];
+
+        $this->expectException(InvalidArgumentException::class);
+        $this->expectExceptionMessage('Lib is required');
+
+        new ModuleStatistics($data);
+    }
+);