add linter + fix php 8.4 warning + min php 8.3

Author: achretien

.github/workflows/php.yml

@@ -0,0 +1,24 @@
+name: PHP Linting
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  phplint:
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: "laravel-pint"
+        uses: aglipanci/[email protected]
+        with:
+          testMode: true
+          verboseMode: true
+          configPath: "pint.json"

.github/workflows/pint.yml

@@ -13,12 +13,15 @@
     }
   ],
   "require": {
-    "yiisoft/yii2-queue": "^2.0",
+    "php": "^8.3",
+    "nesbot/carbon": "^2.0 | ^3.0",
     "yiisoft/yii2-httpclient": "^2.0",
-    "nesbot/carbon": "^2.0 | ^3.0"
+    "yiisoft/yii2-queue": "^2.0"
   },
   "require-dev": {
-    "roave/security-advisories": "dev-latest"
+    "roave/security-advisories": "dev-latest",
+    "rector/rector": "^2.1",
+    "laravel/pint": "^1.24"
   },
   "autoload": {
     "psr-4": {
@@ -34,6 +37,7 @@
     }
   ],
   "config": {
+    "sort-packages": true,
     "allow-plugins": {
       "yiisoft/yii2-composer": true
     }

composer.json

@@ -0,0 +1,19 @@
+{
+  "preset": "empty",
+  "rules": {
+    "@PhpCsFixer": true,
+    "ordered_class_elements": {
+      "sort_algorithm": "alpha"
+    },
+    "list_syntax": {
+      "syntax": "short"
+    },
+    "concat_space": {
+      "spacing": "one"
+    },
+    "ternary_to_null_coalescing": true,
+    "multiline_whitespace_before_semicolons": {
+      "strategy": "no_multi_line"
+    }
+  }
+}

pint.json

@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Config\RectorConfig;
+
+return RectorConfig::configure()
+    ->withPaths([
+        __DIR__ . '/src',
+    ])
+    ->withPhpSets(php84: true)
+    ->withPreparedSets(
+        deadCode: true,
+        codeQuality: true,
+        typeDeclarations: true,
+        instanceOf: true
+    );

rector.php

@@ -4,7 +4,5 @@
 
 interface AzureJobInterface
 {
-    // region Getters/Setters
     public function getQueue(): ?string;
-    // endregion Getters/Setters
-}
+}

src/AzureJobInterface.php

@@ -9,17 +9,13 @@
  */
 class Command extends CliCommand
 {
-    // region Controllers Actions
     public function actionListen(?string $queue = null): void
     {
         $this->queue->run(true, $queue);
     }
-    // endregion Controllers Actions
 
-    // region Protected Methods
     protected function isWorkerAction($actionID): bool
     {
-        return $actionID === 'listen';
+        return 'listen' === $actionID;
     }
-    // endregion Protected Methods
 }

src/Command.php

@@ -12,7 +12,6 @@
 
 class Queue extends \yii\queue\cli\Queue
 {
-    // region Public Properties
     /**
      * use this property to filter job execution on a specific id
      * You can use this property when you need to run multiple environments with the same queue at the same time, multiple locals environments for example.
@@ -21,16 +20,16 @@ class Queue extends \yii\queue\cli\Queue
      */
     public ?string $id = null;
     public string $queue = 'default';
+
     /** @var ServiceBus[] */
     public array $queues = [
         'default' => 'serviceBus',
     ];
-    // endregion Public Properties
 
-    // region Initialization
     /**
-     * @throws \yii\base\InvalidConfigException
+     * @throws InvalidConfigException
      */
+    #[\Override]
     public function init(): void
     {
         parent::init();
@@ -41,9 +40,8 @@ public function init(): void
             $this->queues[$queue] = Instance::ensure($config, ServiceBus::class);
         }
     }
-    // endregion Initialization
 
-    // region Public Methods
+    #[\Override]
     public function push($job): ?string
     {
         $defaultQueue = $this->queue;
@@ -67,11 +65,13 @@ public function push($job): ?string
     /**
      * Listens queue and runs each job.
      *
-     * @param bool $repeat  whether to continue listening when queue is empty.
-     * @param int  $timeout number of seconds to wait for next message.
+     * @param bool $repeat  whether to continue listening when queue is empty
+     * @param int  $timeout number of seconds to wait for next message
+     *
+     * @return null|int exit code
+     *
+     * @internal for worker command only
      *
-     * @return null|int exit code.
-     * @internal for worker command only.
      * @since    2.0.2
      */
     public function run(bool $repeat, ?string $queue = null, int $timeout = 30): ?int
@@ -83,15 +83,12 @@ public function run(bool $repeat, ?string $queue = null, int $timeout = 30): ?in
      * @param string $id of a job message
      *
      * @throws NotSupportedException
-     * @return void status code
      */
     public function status($id): void
     {
         throw new NotSupportedException('Status is not supported in the driver.');
     }
-    // endregion Public Methods
 
-    // region Protected Methods
     /**
      * @throws Exception
      * @throws InvalidConfigException
@@ -102,7 +99,7 @@ protected function processWorker(callable $canContinue, bool $repeat, string $qu
         while ($canContinue()) {
             $message = $this->queues[$queue]->receiveMessage(ServiceBus::PEEK_LOCK, $timeout);
 
-            if ($message !== null && $message->brokerProperties !== null) {
+            if (null !== $message && null !== $message->brokerProperties) {
                 if ($message->brokerProperties->to && !$message->brokerProperties->isTo($this->id)) {
                     continue;
                 }
@@ -116,14 +113,15 @@ protected function processWorker(callable $canContinue, bool $repeat, string $qu
     }
 
     /**
-     * @param       $message
-     * @param int   $ttr time to reserve in seconds
+     * @param int   $ttr      time to reserve in seconds
      * @param int   $delay
      * @param mixed $priority
+     * @param mixed $message
      *
-     * @throws \JsonException
-     * @throws \yii\httpclient\Exception
      * @return string id of a job message
+     *
+     * @throws \JsonException
+     * @throws Exception
      */
     protected function pushMessage($message, $ttr, $delay, $priority): string
     {
@@ -137,5 +135,4 @@ protected function pushMessage($message, $ttr, $delay, $priority): string
 
         return $azureMessage->brokerProperties->messageId;
     }
-    // endregion Protected Methods
 }

src/Queue.php

@@ -6,7 +6,6 @@
 
 class BrokerProperties implements \JsonSerializable
 {
-    // region Initialization
     public function __construct(
         public ?string $correlationId = null,
         public ?string $sessionId = null,
@@ -23,20 +22,11 @@ public function __construct(
         public ?string $replyToSessionId = null,
         public ?string $partitionKey = null,
     ) {
-        if ($this->messageId === null) {
+        if (null === $this->messageId) {
             $this->messageId = uniqid('', true);
         }
     }
-    // endregion Initialization
 
-    // region Getters/Setters
-    public function setDelay(int $value): void
-    {
-        $this->scheduledEnqueueTimeUtc = Carbon::now('UTC')->addSeconds($value);
-    }
-    // endregion Getters/Setters
-
-    // region Public Methods
     public function isTo(string $id): bool
     {
         return $this->to === $id;
@@ -56,5 +46,9 @@ public function jsonSerialize(): mixed
             'PartitionKey' => $this->partitionKey,
         ]);
     }
-    // endregion Public Methods
+
+    public function setDelay(int $value): void
+    {
+        $this->scheduledEnqueueTimeUtc = Carbon::now('UTC')->addSeconds($value);
+    }
 }

src/service/BrokerProperties.php

@@ -6,19 +6,15 @@
 
 class Message
 {
-    // region Initialization
     public function __construct(
         public ?string $body,
         public ?string $contentType = 'application/vnd.microsoft.servicebus.yml',
         public ?Carbon $date = null,
         public ?string $location = null,
         public ?BrokerProperties $brokerProperties = null,
         public array $properties = [],
-    ) {
-    }
-    // endregion Initialization
+    ) {}
 
-    // region Getters/Setters
     public function getProperty(string $propertyName): mixed
     {
         return $this->properties[strtolower($propertyName)] ?? null;
@@ -28,5 +24,4 @@ public function setProperty(string $propertyName, mixed $propertyValue): void
     {
         $this->properties[strtolower($propertyName)] = $propertyValue;
     }
-    // endregion Getters/Setters
 }