implement rector (#17)

* implement rector * fix rector parallel process error and strict types declaration
mattvb91 · Feb 4, 2024 · 40a4eb4 · 40a4eb4
1 parent 91fe021
commit 40a4eb4
Show file tree

Hide file tree

Showing 63 changed files with 203 additions and 62 deletions.
diff --git a/.github/workflows/ci_cd.yml b/.github/workflows/ci_cd.yml
@@ -93,6 +93,7 @@ jobs:
           docker run -v $(pwd):/app docker.pkg.github.com/mattvb91/${{ env.REPO_NAME }}/composer:head composer install
           docker run -v $(pwd):/app docker.pkg.github.com/mattvb91/${{ env.REPO_NAME }}/composer:head composer phpstan
           docker run -v $(pwd):/app docker.pkg.github.com/mattvb91/${{ env.REPO_NAME }}/composer:head composer codesniffer
+          docker run -v $(pwd):/app docker.pkg.github.com/mattvb91/${{ env.REPO_NAME }}/composer:head composer rector
           docker run --network="caddy-network" -e XDEBUG_MODE=coverage -v $(pwd):/app docker.pkg.github.com/mattvb91/${{ env.REPO_NAME }}/composer:head composer phpunit
         env:
           REPO_NAME: ${{ github.event.repository.name }}

diff --git a/composer.json b/composer.json
@@ -7,7 +7,9 @@
     "phpunit": "phpunit --testdox --coverage-clover=coverage.xml",
     "phpstan": "phpstan analyse",
     "codesniffer": "phpcs ./src ./tests/**/*.php --standard=./codesniffer.xml -p",
-    "codefixer": "phpcbf ./src ./tests/**/*.php --standard=./codesniffer.xml"
+    "codefixer": "phpcbf ./src ./tests/**/*.php --standard=./codesniffer.xml",
+    "rector": "rector process --dry-run",
+    "rector-fix": "rector process"
   },
   "autoload": {
     "psr-4": {
@@ -30,6 +32,7 @@
     "phpunit/phpunit": "^9.5",
     "dms/phpunit-arraysubset-asserts": "^0.4.0",
     "phpstan/phpstan": "^1.10",
-    "squizlabs/php_codesniffer": "^3.7"
+    "squizlabs/php_codesniffer": "^3.7",
+    "rector/rector": "^0.17"
   }
 }
diff --git a/docker/composer/Dockerfile b/docker/composer/Dockerfile
@@ -1,7 +1,7 @@
-FROM composer:2.6.5
+FROM composer:2.6.6
 
 RUN apk --update --no-cache add autoconf g++ make linux-headers \
-    && pecl install -f xdebug-3.2.2 \
+    && pecl install -f xdebug-3.3 \
     && docker-php-ext-enable xdebug \
     && apk del --purge autoconf g++ make linux-headers
 

diff --git a/rector.php b/rector.php
@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\CodeQuality\Rector\Class_\InlineConstructorDefaultToPropertyRector;
+use Rector\Config\RectorConfig;
+use Rector\TypeDeclaration\Rector\StmtsAwareInterface\DeclareStrictTypesRector;
+
+return static function (RectorConfig $rectorConfig): void {
+    $rectorConfig->paths([
+        __DIR__ . '/src',
+    ]);
+
+    // register a single rule
+    $rectorConfig->rules([
+        InlineConstructorDefaultToPropertyRector::class,
+        DeclareStrictTypesRector::class,
+    ]);
+
+    // define sets of rules
+    $rectorConfig->sets([
+        \Rector\Set\ValueObject\SetList::DEAD_CODE,
+        \Rector\Set\ValueObject\SetList::CODE_QUALITY,
+        \Rector\Set\ValueObject\SetList::TYPE_DECLARATION,
+    ]);
+};
diff --git a/src/Caddy.php b/src/Caddy.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace mattvb91\CaddyPhp;
 
 use GuzzleHttp\Client;
@@ -72,7 +74,12 @@ public function syncHosts(string $hostIdentifier): void
         $this->buildHostsCache($hostIdentifier);
 
         /** @var string[] $hosts */
-        $hosts = json_decode($this->client->get($this->hostsCache[$hostIdentifier]['path'])->getBody(), true);
+        $hosts = json_decode(
+            $this->client->get($this->hostsCache[$hostIdentifier]['path'])
+                ->getBody()
+                ->getContents(),
+            true
+        );
 
         $this->hostsCache[$hostIdentifier]['host']->setHosts($hosts);
     }
@@ -129,7 +136,12 @@ public function removeHostname(string $hostIdentifier, string $hostname): bool
     public function getRemoteConfig(): object
     {
         /** @var object */
-        return json_decode($this->client->get('/config')->getBody(), false, 512, JSON_THROW_ON_ERROR);
+        return json_decode(
+            $this->client->get('/config')->getBody()->getContents(),
+            false,
+            512,
+            JSON_THROW_ON_ERROR
+        );
     }
 
     /**
@@ -217,10 +229,10 @@ public function toArray(): array
             $config['logging'] = $this->logging->toArray();
         }
 
-        if (count($this->apps)) {
+        if ($this->apps !== []) {
             $apps = [];
 
-            array_map(static function (App $app, string $appNamespace) use (&$apps) {
+            array_map(static function (App $app, string $appNamespace) use (&$apps): void {
                 $apps[$appNamespace] = $app->toArray();
             }, $this->apps, array_keys($this->apps));
 
@@ -231,13 +243,11 @@ public function toArray(): array
     }
 
     /**
-     * @param string $hostIdentifier
-     * @return void
      * @throws \Exception
      */
     protected function buildHostsCache(string $hostIdentifier): void
     {
-        if (!key_exists($hostIdentifier, $this->hostsCache)) {
+        if (!array_key_exists($hostIdentifier, $this->hostsCache)) {
             //Find the host so we can get its path
 
             $hostPath = null;

diff --git a/src/Config/Admin.php b/src/Config/Admin.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace mattvb91\CaddyPhp\Config;
 
 use mattvb91\CaddyPhp\Interfaces\Arrayable;

diff --git a/src/Config/Apps/Cache.php b/src/Config/Apps/Cache.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace mattvb91\CaddyPhp\Config\Apps;
 
 use mattvb91\CaddyPhp\Config\Apps\Cache\Api;
@@ -116,7 +118,7 @@ public function toArray(): array
         }
 
         if (isset($this->cacheKeys)) {
-            $array['cache_keys'] = array_map(static function (Key $key) {
+            $array['cache_keys'] = array_map(static function (Key $key): array {
                 return [$key->getPattern() => $key->toArray()];
             }, $this->cacheKeys)[0]; //TODO there has to be a better way than [0] access to get this level
         }

diff --git a/src/Config/Apps/Cache/Api.php b/src/Config/Apps/Cache/Api.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace mattvb91\CaddyPhp\Config\Apps\Cache;
 
 use mattvb91\CaddyPhp\Config\Apps\Cache\Api\Souin;

diff --git a/src/Config/Apps/Cache/Api/Souin.php b/src/Config/Apps/Cache/Api/Souin.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace mattvb91\CaddyPhp\Config\Apps\Cache\Api;
 
 use mattvb91\CaddyPhp\Interfaces\Arrayable;

diff --git a/src/Config/Apps/Cache/Cdn.php b/src/Config/Apps/Cache/Cdn.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace mattvb91\CaddyPhp\Config\Apps\Cache;
 
 use mattvb91\CaddyPhp\Interfaces\Arrayable;
@@ -9,27 +11,17 @@ class Cdn implements Arrayable
     private bool $dynamic;
     private string $strategy;
 
-    /**
-     * @param bool $_dynamic
-     * @param string $_strategy
-     */
     public function __construct(bool $_dynamic = true, string $_strategy = 'hard')
     {
         $this->dynamic = $_dynamic;
         $this->strategy = $_strategy;
     }
 
-    /**
-     * @param bool $dynamic
-     */
     public function setDynamic(bool $dynamic): void
     {
         $this->dynamic = $dynamic;
     }
 
-    /**
-     * @param string $strategy
-     */
     public function setStrategy(string $strategy): void
     {
         $this->strategy = $strategy;

diff --git a/src/Config/Apps/Cache/Key.php b/src/Config/Apps/Cache/Key.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace mattvb91\CaddyPhp\Config\Apps\Cache;
 
 use mattvb91\CaddyPhp\Interfaces\Arrayable;

diff --git a/src/Config/Apps/Cache/Nuts.php b/src/Config/Apps/Cache/Nuts.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace mattvb91\CaddyPhp\Config\Apps\Cache;
 
 use mattvb91\CaddyPhp\Interfaces\Arrayable;

diff --git a/src/Config/Apps/Cache/Redis.php b/src/Config/Apps/Cache/Redis.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace mattvb91\CaddyPhp\Config\Apps\Cache;
 
 use mattvb91\CaddyPhp\Interfaces\Arrayable;

diff --git a/src/Config/Apps/Http.php b/src/Config/Apps/Http.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace mattvb91\CaddyPhp\Config\Apps;
 
 use mattvb91\CaddyPhp\Config\Apps\Http\Server;
@@ -63,7 +65,7 @@ public function toArray(): array
         }
 
         $servers = [];
-        array_map(static function (Server $server, string $key) use (&$servers) {
+        array_map(static function (Server $server, string $key) use (&$servers): void {
             $servers[$key] = $server->toArray();
         }, $this->servers, array_keys($this->servers));
 

diff --git a/src/Config/Apps/Http/Server.php b/src/Config/Apps/Http/Server.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace mattvb91\CaddyPhp\Config\Apps\Http;
 
 use mattvb91\CaddyPhp\Config\Apps\Http\Server\Route;
@@ -107,7 +109,7 @@ public function toArray(): array
     {
         $config = [
             'listen' => $this->listen,
-            'routes' => [...array_map(static function (Route $route) {
+            'routes' => [...array_map(static function (Route $route): array {
                 return $route->toArray();
             }, $this->routes)
             ],

diff --git a/src/Config/Apps/Http/Server/Route.php b/src/Config/Apps/Http/Server/Route.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace mattvb91\CaddyPhp\Config\Apps\Http\Server;
 
 use mattvb91\CaddyPhp\Interfaces\Apps\Servers\Routes\Handle\HandlerInterface;
@@ -70,13 +72,13 @@ public function toArray(): array
             $config['group'] = $this->group;
         }
 
-        $config['handle'] = [...array_map(static function (HandlerInterface $handler) {
+        $config['handle'] = [...array_map(static function (HandlerInterface $handler): array {
             return $handler->toArray();
         }, $this->handle)
         ];
 
         if (isset($this->match)) {
-            $config['match'] = array_map(static function (MatcherInterface $matcher) {
+            $config['match'] = array_map(static function (MatcherInterface $matcher): array {
                 return $matcher->toArray();
             }, $this->match);
 

diff --git a/src/Config/Apps/Http/Server/Routes/Handle/Authentication.php b/src/Config/Apps/Http/Server/Routes/Handle/Authentication.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace mattvb91\CaddyPhp\Config\Apps\Http\Server\Routes\Handle;
 
 use mattvb91\CaddyPhp\Interfaces\Apps\Servers\Routes\Handle\Authentication\ProviderInterface;
@@ -26,8 +28,8 @@ public function toArray(): array
             'handler' => $this->getHandler(),
         ];
 
-        if (count($this->providers)) {
-            $config['providers'] = array_map(static function (ProviderInterface $provider) {
+        if ($this->providers !== []) {
+            $config['providers'] = array_map(static function (ProviderInterface $provider): array {
                 return [$provider->getModuleName() => $provider->toArray()];
             }, $this->providers)[0];//TODO there has to be a better way than [0]
         }

diff --git a/src/Config/Apps/Http/Server/Routes/Handle/Authentication/Providers/HttpBasic.php b/src/Config/Apps/Http/Server/Routes/Handle/Authentication/Providers/HttpBasic.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace mattvb91\CaddyPhp\Config\Apps\Http\Server\Routes\Handle\Authentication\Providers;
 
 use mattvb91\CaddyPhp\Config\Apps\Http\Server\Routes\Handle\Authentication\Providers\HttpBasic\Account;
@@ -31,8 +33,8 @@ public function toArray(): array
     {
         $config = [];
 
-        if (count($this->accounts)) {
-            $config['accounts'] = [...array_map(function (Account $account) {
+        if ($this->accounts !== []) {
+            $config['accounts'] = [...array_map(function (Account $account): array {
                 return $account->toArray();
             }, $this->accounts)
             ];

diff --git a/src/Config/Apps/Http/Server/Routes/Handle/Authentication/Providers/HttpBasic/Account.php b/src/Config/Apps/Http/Server/Routes/Handle/Authentication/Providers/HttpBasic/Account.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace mattvb91\CaddyPhp\Config\Apps\Http\Server\Routes\Handle\Authentication\Providers\HttpBasic;
 
 use mattvb91\CaddyPhp\Interfaces\Arrayable;

diff --git a/src/Config/Apps/Http/Server/Routes/Handle/Authentication/Providers/HttpBasic/Hash/Bcrypt.php b/src/Config/Apps/Http/Server/Routes/Handle/Authentication/Providers/HttpBasic/Hash/Bcrypt.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace mattvb91\CaddyPhp\Config\Apps\Http\Server\Routes\Handle\Authentication\Providers\HttpBasic\Hash;
 
 use mattvb91\CaddyPhp\Interfaces\Apps\Servers\Routes\Handle\Authentication\Providers\HttpBasic\HashInterface;

diff --git a/src/Config/Apps/Http/Server/Routes/Handle/Cache.php b/src/Config/Apps/Http/Server/Routes/Handle/Cache.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace mattvb91\CaddyPhp\Config\Apps\Http\Server\Routes\Handle;
 
 use mattvb91\CaddyPhp\Config\Logs\LogLevel;

diff --git a/src/Config/Apps/Http/Server/Routes/Handle/Error.php b/src/Config/Apps/Http/Server/Routes/Handle/Error.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace mattvb91\CaddyPhp\Config\Apps\Http\Server\Routes\Handle;
 
 use mattvb91\CaddyPhp\Interfaces\Apps\Servers\Routes\Handle\HandlerInterface;

diff --git a/src/Config/Apps/Http/Server/Routes/Handle/FileServer.php b/src/Config/Apps/Http/Server/Routes/Handle/FileServer.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace mattvb91\CaddyPhp\Config\Apps\Http\Server\Routes\Handle;
 
 use mattvb91\CaddyPhp\Interfaces\Apps\Servers\Routes\Handle\HandlerInterface;

diff --git a/src/Config/Apps/Http/Server/Routes/Handle/Headers.php b/src/Config/Apps/Http/Server/Routes/Handle/Headers.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace mattvb91\CaddyPhp\Config\Apps\Http\Server\Routes\Handle;
 
 use mattvb91\CaddyPhp\Config\Apps\Http\Server\Routes\Handle\Headers\Request;