Merge pull request #43 from mvorisek/gh_add_phpstan

Add PHPStan

Author: Willem Stuursma-Ruwen

.travis.yml

@@ -50,4 +50,4 @@ before_script:
 script:
   - vendor/bin/phpunit 
   - vendor/bin/phpcs --standard=PSR2 classes/ tests/
-
+  - vendor/bin/phpstan analyse

classes/mutex/PHPRedisMutex.php

@@ -35,7 +35,7 @@ class PHPRedisMutex extends RedisMutex
      * @param array<\Redis|\RedisCluster> $redisAPIs The Redis connections.
      * @param string $name The lock name.
      * @param int $timeout The time in seconds a lock expires after. Default is
-     * 3 seconds.
+     *                     3 seconds.
      * @throws \LengthException The timeout must be greater than 0.
      */
     public function __construct(array $redisAPIs, string $name, int $timeout = 3)
@@ -44,7 +44,7 @@ public function __construct(array $redisAPIs, string $name, int $timeout = 3)
     }
 
     /**
-     * @param \Redis|\RedisCluster $redisApi The Redis or RedisCluster connection.
+     * @param \Redis|\RedisCluster $redisAPI The Redis or RedisCluster connection.
      * @throws LockAcquireException
      */
     protected function add($redisAPI, string $key, string $value, int $expire): bool

classes/mutex/PgAdvisoryLockMutex.php

@@ -32,7 +32,7 @@ public function __construct(\PDO $PDO, string $name)
 
         $hashed_name = hash('sha256', $name, true);
 
-        if (false === $hashed_name) {
+        if (false === $hashed_name) { // @phpstan-ignore-line
             throw new RuntimeException('Unable to hash the key, sha256 algorithm is not supported.');
         }
 

classes/mutex/SemaphoreMutex.php

@@ -33,7 +33,7 @@ class SemaphoreMutex extends LockMutex
      * $mutex     = new SemaphoreMutex($semaphore);
      * </code>
      *
-     * @param resource semaphore The semaphore id.
+     * @param resource $semaphore The semaphore id.
      * @throws \InvalidArgumentException The semaphore id is not a valid resource.
      */
     public function __construct($semaphore)

classes/mutex/TransactionalMutex.php

@@ -106,7 +106,6 @@ private static function checkAutocommit(\PDO $pdo): void
      * @throws LockAcquireException The transaction was not commited.
      * @return mixed The return value of the execution block.
      * @SuppressWarnings(PHPMD)
-     *
      */
     public function synchronized(callable $code)
     {
@@ -129,7 +128,7 @@ public function synchronized(callable $code)
                 $this->rollBack($e);
 
                 if (self::hasPDOException($e)) {
-                    return; // Replay
+                    return null; // Replay
                 } else {
                     throw $e;
                 }
@@ -140,10 +139,10 @@ public function synchronized(callable $code)
     /**
      * Checks if an exception or any of its previous exceptions is a PDOException.
      *
-     * @param \Exception $exception The exception.
-     * @return boolean True if there's a PDOException.
+     * @param \Throwable $exception The exception.
+     * @return bool True if there's a PDOException.
      */
-    private static function hasPDOException(\Exception $exception)
+    private static function hasPDOException(\Throwable $exception)
     {
         if ($exception instanceof PDOException) {
             return true;

classes/util/Loop.php

@@ -97,7 +97,7 @@ public function execute(callable $code)
         $result = null;
         for ($i = 0; $this->looping && microtime(true) < $deadline; ++$i) {
             $result = $code();
-            if (!$this->looping) {
+            if (!$this->looping) { // @phpstan-ignore-line
                 break;
             }
 

composer.json

@@ -57,6 +57,7 @@
         "johnkary/phpunit-speedtrap": "^3.0",
         "mikey179/vfsstream": "^1.6",
         "php-mock/php-mock-phpunit": "^2.1",
+        "phpstan/phpstan": "^0.12.58",
         "phpunit/phpunit": "^9.4",
         "predis/predis": "^1.1",
         "spatie/async": "^1.5",

phpstan.neon.dist

@@ -0,0 +1,9 @@
+parameters:
+    level: 5
+    paths:
+        - ./
+    excludes_analyse:
+        - vendor/
+
+    # TODO review once we drop PHP 7.x support
+    treatPhpDocTypesAsCertain: false

tests/mutex/FlockMutexTest.php

@@ -22,7 +22,7 @@ class FlockMutexTest extends TestCase
     private $mutex;
 
     /**
-     * @var resource
+     * @var string
      */
     private $file;
 
@@ -31,7 +31,7 @@ protected function setUp(): void
         parent::setUp();
 
         $this->file = tempnam(sys_get_temp_dir(), 'flock-');
-        $this->mutex = Liberator::liberate(new FlockMutex(fopen($this->file, 'r'), 1));
+        $this->mutex = Liberator::liberate(new FlockMutex(fopen($this->file, 'r'), 1)); // @phpstan-ignore-line
     }
 
     protected function tearDown(): void
@@ -46,10 +46,10 @@ protected function tearDown(): void
      */
     public function testCodeExecutedOutsideLockIsNotThrown(int $strategy)
     {
-        $this->mutex->strategy = $strategy;
+        $this->mutex->strategy = $strategy; // @phpstan-ignore-line
 
         $this->assertTrue($this->mutex->synchronized(function (): bool {
-            usleep(1.1e6);
+            usleep(1100 * 1000);
 
             return true;
         }));
@@ -66,7 +66,7 @@ public function testTimeoutOccurs(int $strategy)
         $another_resource = fopen($this->file, 'r');
         flock($another_resource, LOCK_EX);
 
-        $this->mutex->strategy = $strategy;
+        $this->mutex->strategy = $strategy; // @phpstan-ignore-line
 
         try {
             $this->mutex->synchronized(
@@ -94,7 +94,7 @@ public function testNoTimeoutWaitsForever()
         $another_resource = fopen($this->file, 'r');
         flock($another_resource, LOCK_EX);
 
-        $this->mutex->strategy = FlockMutex::STRATEGY_BLOCK;
+        $this->mutex->strategy = FlockMutex::STRATEGY_BLOCK; // @phpstan-ignore-line
 
         $timebox = new PcntlTimeout(1);
         $timebox->timeBoxed(function () {

tests/mutex/LockMutexTest.php

@@ -17,7 +17,7 @@
 class LockMutexTest extends TestCase
 {
     /**
-     * @var \PHPUnit\Framework\MockObject\MockObject The SUT
+     * @var \PHPUnit\Framework\MockObject\MockObject|LockMutex The SUT
      */
     private $mutex;