Implement ApplicationBuilder and CanUpload trait

This commit implements ApplicationBuilder class and CanUpload trait. It also refactors AbstractApplication, Route, Config, Listener and other classes to adapt the CanUpload trait. The ApplicationBuilder class includes the creation logic of different application types. The CanUpload trait provides generic methods for the data upload and removal to Nginx Unit.

Author: Pavlusha311245

CHANGELOG.md

@@ -1,5 +1,11 @@
 # CHANGELOG
 
+## v0.8.0 - [2024/04/26]
+
+- Updated application classes
+- Removed doc folder
+- Updated tests
+
 ## v0.7.0 - [2024/04/07]
 
 - Now SDK support connection via only address.

composer.json

@@ -1,6 +1,6 @@
 {
   "name": "pavlusha/unit-php-sdk",
-  "version": "0.7.0",
+  "version": "0.8.0",
   "type": "sdk",
   "description": "This project allows developers to interact with the Nginx Unit web server through PHP classes",
   "license": "Apache-2.0",
@@ -29,13 +29,14 @@
   },
   "require": {
     "php": "^8.3",
-    "friendsofphp/php-cs-fixer": "^3.46",
+    "friendsofphp/php-cs-fixer": "^3.54",
     "guzzlehttp/guzzle": "^7.8.1",
-    "ext-curl": "*",
-    "nesbot/carbon": "^2.72"
+    "nesbot/carbon": "^2.72",
+    "doctrine/inflector": "^2.0",
+    "ext-curl": "*"
   },
   "require-dev": {
-    "pestphp/pest": "^2.26",
+    "pestphp/pest": "^2.34",
     "phpstan/phpstan": "^1.10",
     "mockery/mockery": "^1.6"
   },
@@ -57,6 +58,6 @@
       "pestphp/pest-plugin": true
     }
   },
-  "minimum-stability": "beta",
+  "minimum-stability": "stable",
   "prefer-stable": true
 }

src/Abstract/AbstractApplication.php

@@ -6,22 +6,21 @@
     ProcessManagement\ProcessIsolation,
     ProcessManagement\RequestLimit
 };
+use UnitPhpSdk\Builders\EndpointBuilder;
 use UnitPhpSdk\Exceptions\UnitException;
-use UnitPhpSdk\Http\UnitRequest;
-use UnitPhpSdk\Contracts\{ApplicationControlInterface, ApplicationInterface, Arrayable, Uploadable};
+use UnitPhpSdk\Contracts\{ApplicationInterface, Arrayable, Uploadable};
+use UnitPhpSdk\Traits\CanUpload;
 use UnitPhpSdk\Traits\HasListeners;
 
 /**
- * @implements ApplicationInterface, ApplicationControlInterface, Arrayable
+ * @implements ApplicationInterface
+ * @implements Arrayable
+ * @implements Uploadable
  */
-abstract class AbstractApplication implements ApplicationInterface, ApplicationControlInterface, Arrayable, Uploadable
+abstract class AbstractApplication implements ApplicationInterface, Arrayable, Uploadable
 {
     use HasListeners;
-
-    /**
-     * @var UnitRequest
-     */
-    private UnitRequest $unitRequest;
+    use CanUpload;
 
     /**
      * Environment variables to be passed to the app
@@ -89,24 +88,18 @@ abstract class AbstractApplication implements ApplicationInterface, ApplicationC
     private ?ProcessIsolation $isolation = null;
 
     /**
-     * @throws UnitException
+     * @param string $name
+     * @param array|null $data
      */
-    public function __construct($data = null)
+    public function __construct(string $name, ?array $data = [])
     {
+        $this->setName($name);
+
         if (!empty($data)) {
             $this->parseFromArray($data);
         }
-    }
-
-    /**
-     * @param UnitRequest $unitRequest
-     * @return AbstractApplication
-     */
-    public function setUnitRequest(UnitRequest $unitRequest): self
-    {
-        $this->unitRequest = $unitRequest;
 
-        return $this;
+        $this->setApiEndpoint(EndpointBuilder::create("config/applications/")->get() . $this->getName());
     }
 
     /**
@@ -348,61 +341,33 @@ public function setName(string $name): self
      *
      * @param array $data
      * @return void
-     * @throws UnitException
      */
     public function parseFromArray(array $data): void
     {
         $data = array_filter($data, fn ($item) => !empty($item), ARRAY_FILTER_USE_BOTH);
 
-        if (array_key_exists('working_directory', $data)) {
-            $this->setWorkingDirectory($data['working_directory']);
-        }
-
-        if (array_key_exists('user', $data)) {
-            $this->setUser($data['user']);
-        }
-
-        if (array_key_exists('group', $data)) {
-            $this->setGroup($data['group']);
-        }
-
-        if (array_key_exists('environment', $data)) {
-            $this->setEnvironment($data['environment']);
-        }
-
-        if (array_key_exists('stderr', $data)) {
-            $this->setStdErr($data['stderr']);
-        }
-
-        if (array_key_exists('stdout', $data)) {
-            $this->setStdOut($data['stdout']);
-        }
+        $attributes = ['working_directory', 'user', 'group', 'environment', 'stderr', 'stdout', 'isolation', 'processes', 'limits',];
 
-        if (array_key_exists('isolation', $data)) {
-            $this->setIsolation($data['isolation']);
-        }
-
-        if (array_key_exists('processes', $data)) {
-            $this->setProcesses($data['processes']);
-        }
+        foreach ($attributes as $attribute) {
+            $camelCase = str_replace(' ', '', ucwords(str_replace('_', ' ', $attribute)));
+            $method = "set" . $camelCase;
 
-        if (array_key_exists('limits', $data)) {
-            $this->setLimits($data['limits']);
+            $this->setDataAttributeIfExists($data, $attribute, $method);
         }
     }
 
     /**
-     * @inheritDoc
+     * If the given key exists in the data array, call the corresponding setter method.
+     *
+     * @param array $data
+     * @param string $key
+     * @param string $method
      */
-    public function restartApplication(): bool
+    protected function setDataAttributeIfExists(array $data, string $key, string $method): void
     {
-        try {
-            $this->unitRequest->send("/control/applications/{$this->getName()}/restart");
-        } catch (UnitException) {
-            return false;
+        if (array_key_exists($key, $data)) {
+            $this->$method($data[$key]);
         }
-
-        return true;
     }
 
     /**
@@ -430,25 +395,4 @@ public function toJson(): string|false
     {
         return json_encode(array_filter(static::toArray(), fn ($item) => !empty($item)), JSON_UNESCAPED_SLASHES);
     }
-
-    /**
-     * @param UnitRequest $request
-     * @return void
-     * @throws UnitException
-     */
-    #[\Override] public function upload(UnitRequest $request): void
-    {
-        $request->setMethod('PUT')
-            ->send($this->getApiEndpoint(), true, ['json' => array_filter($this->toArray(), fn ($item) => !empty($item))]);
-    }
-
-    #[\Override] public function remove(UnitRequest $request): void
-    {
-        $request->setMethod('DELETE')->send($this->getApiEndpoint());
-    }
-
-    public function getApiEndpoint(): string
-    {
-        return "/config/applications/{$this->getName()}";
-    }
 }

src/Builders/ApplicationBuilder.php

@@ -0,0 +1,60 @@
+<?php
+
+namespace UnitPhpSdk\Builders;
+
+use UnitPhpSdk\Config\Application\{GoExternalApplication,
+    JavaApplication,
+    NodeJsExternalApplication,
+    PerlApplication,
+    PhpApplication,
+    PythonApplication,
+    RubyApplication,
+    WebAssemblyApplication,
+    WebAssemblyComponentApplication
+};
+use UnitPhpSdk\Exceptions\UnitException;
+
+class ApplicationBuilder
+{
+    /**
+     * @throws UnitException
+     *
+     * TODO: add ApplicationTypeEnum as possible type
+     */
+    public static function create($appName, $appData, string $type = '')
+    {
+        $application = match ($type) {
+            'php' => new PhpApplication($appName, $appData),
+            'java' => new JavaApplication($appName, $appData),
+            'perl' => new PerlApplication($appName, $appData),
+            'python' => new PythonApplication($appName, $appData),
+            'wasm' => new WebAssemblyApplication($appName, $appData),
+            'ruby' => new RubyApplication($appName, $appData),
+            'wasm-wasi-component' => new WebAssemblyComponentApplication($appName, $appData),
+            'external' => self::isNodeJsApplication($appData) ?
+                new NodeJsExternalApplication($appName, $appData) :
+                new GoExternalApplication($appName, $appData),
+        };
+
+        return $application;
+    }
+
+    /**
+     * Detect if NodeJsExternalApplication
+     *
+     * @param $appData
+     * @return bool
+     */
+    private static function isNodeJsApplication($appData): bool
+    {
+        if (str_contains($appData['executable'], '.js')) {
+            return true;
+        }
+
+        if (array_key_exists('arguments', $appData)) {
+            return str_contains(implode(';', $appData['arguments']), '.js');
+        }
+
+        return false;
+    }
+}

src/Builders/EndpointBuilder.php

@@ -0,0 +1,66 @@
+<?php
+
+namespace UnitPhpSdk\Builders;
+
+use UnitPhpSdk\Contracts\Uploadable;
+use UnitPhpSdk\Support\Pluralizer;
+
+/**
+ * Class EndpointBuilder
+ *
+ * A class to build the endpoint for a given object.
+ *
+ * TODO: review
+ */
+class EndpointBuilder
+{
+    protected string $endpoint = '';
+
+    public function __construct(
+        // TODO: change with http extension
+        array|string $url = null
+    ) {
+        $this->endpoint = '/' . (is_array($url) ? implode('/', $url) : $url);
+    }
+
+    /**
+     * @param object $object
+     * @return array
+     */
+    private static function convertNamespace(object $object): array
+    {
+        $fullClassName = get_class($object);
+        $namespaceParts = array_map('strtolower', explode('\\', $fullClassName));
+        array_shift($namespaceParts);
+
+        return $namespaceParts;
+    }
+
+    /**
+     * @param mixed|null $value
+     * @return EndpointBuilder
+     */
+    public static function create(mixed $value = null): EndpointBuilder
+    {
+        $result = $value;
+
+        if (is_a($value, Uploadable::class)) {
+            $result = self::convertNamespace($value);
+            $entity = Pluralizer::plural(end($result));
+            array_pop($result);
+            $result[] = $entity;
+        }
+
+        return new EndpointBuilder($result);
+    }
+
+    /**
+     * Gets the endpoint value.
+     *
+     * @return string The endpoint value.
+     */
+    public function get(): string
+    {
+        return $this->endpoint;
+    }
+}