2.2.0

CHANGELOG.md

@@ -2,6 +2,13 @@
 
 All notable changes to this project will be documented in this file.
 
+## [2.2.0] - 2021-02-05
+### Changed
+- Added support for `symfony/process:^5.0` 
+- Updated `phpunit/phpunit` 
+- Removed `version` from composer.json 
+- Switched to `psalm` for static analysis
+
 ## [2.1.1] - 2020-04-03
 ### Fix
 - Catch Exception when trying to count reserved jobs

composer.json

@@ -2,7 +2,6 @@
   "name": "ostark/craft-async-queue",
   "description": "A queue handler that moves queue execution to a non-blocking background process",
   "type": "craft-plugin",
-  "version": "2.1.1",
   "keywords": [
     "craft",
     "cms",
@@ -22,6 +21,7 @@
     }
   ],
   "require": {
+    "php": ">=7.1",
     "craftcms/cms": "^3.0.0",
     "symfony/process": "^4.2|^5.0"
   },
@@ -38,12 +38,11 @@
     "changelogUrl": "https://raw.githubusercontent.com/ostark/craft-async-queue/master/CHANGELOG.md"
   },
   "require-dev": {
-    "phpstan/phpstan": "^0.11.1",
-    "phpunit/phpunit": "^6.0"
+    "phpunit/phpunit": "^7.0",
+    "vimeo/psalm": "^4.4"
   },
   "scripts": {
-    "ps": "vendor/bin/phpstan analyse src --level=3 -c phpstan.neon",
-    "stan": "@ps",
+    "ps": "vendor/bin/phpstan.phar analyse src --level=3 -c phpstan.neon",
     "tests": "vendor/bin/phpunit -v"
   }
 }

psalm.xml

@@ -0,0 +1,28 @@
+<?xml version="1.0"?>
+<psalm
+        errorLevel="4"
+        resolveFromConfigFile="true"
+        autoloader="tests/bootstrap.php"
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xmlns="https://getpsalm.org/schema/config"
+        xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"
+>
+    <projectFiles>
+        <directory name="src"/>
+        <ignoreFiles>
+            <directory name="vendor"/>
+        </ignoreFiles>
+    </projectFiles>
+    <issueHandlers>
+        <InvalidNullableReturnType>
+            <errorLevel type="suppress">
+                <file name="./src/Plugin.php"/>
+            </errorLevel>
+        </InvalidNullableReturnType>
+        <NullableReturnStatement>
+            <errorLevel type="suppress">
+                <file name="./src/Plugin.php"/>
+            </errorLevel>
+        </NullableReturnStatement>
+    </issueHandlers>
+</psalm>

src/Exceptions/LogicException.php

@@ -6,7 +6,7 @@ class LogicException extends \LogicException implements ProcessException
 {
     protected $process;
 
-    public function setProcess(Process $process)
+    public function setProcess(Process $process): void
     {
         $this->process = $process;
     }

src/Exceptions/ProcessException.php

@@ -4,7 +4,7 @@
 
 interface ProcessException
 {
-    public function setProcess(Process $process);
+    public function setProcess(Process $process): void;
 
     public function getProcess(): Process;
 

src/Exceptions/RuntimeException.php

@@ -4,9 +4,13 @@
 
 class RuntimeException extends \RuntimeException implements ProcessException
 {
+
+    /**
+     * @var Process
+     */
     protected $process;
 
-    public function setProcess(Process $process)
+    public function setProcess(Process $process): void
     {
         $this->process = $process;
     }

src/Handlers/BackgroundQueueHandler.php

@@ -64,11 +64,7 @@ public function __invoke(PushEvent $event)
     }
 
 
-    /**
-     * @param \yii\queue\PushEvent $event
-     * @param bool                 $handled
-     */
-    protected function logPushEvent(PushEvent $event, $handled = false)
+    protected function logPushEvent(PushEvent $event, bool $handled = false): void
     {
         if (!YII_DEBUG) {
             return;

src/Plugin.php

@@ -30,7 +30,7 @@ class Plugin extends BasePlugin
     /**
      * Init plugin
      */
-    public function init()
+    public function init(): void
     {
         parent::init();
 

src/RateLimiter.php

@@ -49,13 +49,13 @@ public function canIUse(string $context = null): bool
         return ($currentUsage < $this->maxItems) ? true : false;
     }
 
-    public function increment()
+    public function increment(): void
     {
         $this->internalCount++;
     }
 
 
-    protected function logAttempt(int $currentUsage, string $context = null)
+    protected function logAttempt(int $currentUsage, string $context = null): void
     {
 
         \Craft::debug(

src/TestUtility/Utility.php

@@ -59,7 +59,7 @@ public static function contentHtml(): string
     }
 
 
-    public static function setup(Plugin $plugin)
+    public static function setup(Plugin $plugin): void
     {
         if (!\Craft::$app->getRequest()->getIsCpRequest()) {
             return;

tests/bootstrap.php

@@ -1,8 +1,11 @@
 <?php
 
-define('CRAFT_BASE_PATH', __DIR__);
-define('YII_DEBUG', true);
-define('TEST_FILE', '/tmp/craft-async-queue.txt');
+if (!defined('CRAFT_BASE_PATH')) {
+    define('CRAFT_BASE_PATH', __DIR__);
+    define('YII_DEBUG', true);
+    define('TEST_FILE', '/tmp/craft-async-queue.txt');
+}
+
 
 require_once __DIR__ . '/../vendor/autoload.php';
 require_once __DIR__.'/../vendor/yiisoft/yii2/Yii.php';