Merge pull request #105 from phil-davis/phpstan-phpunit

Add phpstan-phpunit and phpstan-strict-rules

composer.json

@@ -48,6 +48,9 @@
     "require-dev": {
         "friendsofphp/php-cs-fixer": "^3.14",
         "phpstan/phpstan": "^1.9",
+        "phpstan/phpstan-phpunit": "^1.3",
+        "phpstan/phpstan-strict-rules": "^1.4",
+        "phpstan/extension-installer": "^1.2",
         "phpunit/phpunit" : "^9.6"
     },
     "scripts": {
@@ -65,5 +68,10 @@
             "composer cs-fixer",
             "composer phpunit"
         ]
+    },
+    "config": {
+        "allow-plugins": {
+            "phpstan/extension-installer": true
+        }
     }
 }

lib/EmitterTrait.php

@@ -172,7 +172,7 @@ public function removeAllListeners(string $eventName = null): void
     /**
      * The list of listeners.
      *
-     * @var array<string, mixed>
+     * @var array<string, array{0:boolean, 1:array<int, mixed>, 2:array<int, mixed>}>
      */
     protected array $listeners = [];
 }

lib/Loop/Loop.php

@@ -26,7 +26,7 @@ public function setTimeout(callable $cb, float $timeout): void
     {
         $triggerTime = microtime(true) + $timeout;
 
-        if (!$this->timers) {
+        if (0 === count($this->timers)) {
             // Special case when the timers array was empty.
             $this->timers[] = [$triggerTime, $cb];
 
@@ -200,7 +200,7 @@ public function tick(bool $block = false): bool
         if (!$block) {
             // Don't wait
             $streamWait = 0;
-        } elseif ($this->nextTick) {
+        } elseif (count($this->nextTick) > 0) {
             // There's a pending 'nextTick'. Don't wait.
             $streamWait = 0;
         } elseif (is_numeric($nextTimeout)) {
@@ -213,7 +213,7 @@ public function tick(bool $block = false): bool
 
         $this->runStreams($streamWait);
 
-        return $this->readStreams || $this->writeStreams || $this->nextTick || $this->timers;
+        return count($this->readStreams) > 0 || count($this->writeStreams) > 0 || count($this->nextTick) > 0 || count($this->timers) > 0;
     }
 
     /**
@@ -250,11 +250,11 @@ protected function runNextTicks(): void
     protected function runTimers(): ?float
     {
         $now = microtime(true);
-        while (($timer = array_pop($this->timers)) && $timer[0] < $now) {
+        while (($timer = array_pop($this->timers)) !== null && $timer[0] < $now) {
             $timer[1]();
         }
         // Add the last timer back to the array.
-        if ($timer) {
+        if (null !== $timer) {
             $this->timers[] = $timer;
 
             return max(0, $timer[0] - microtime(true));
@@ -271,7 +271,7 @@ protected function runTimers(): ?float
      */
     protected function runStreams(?float $timeout): void
     {
-        if ($this->readStreams || $this->writeStreams) {
+        if (count($this->readStreams) > 0 || count($this->writeStreams) > 0) {
             $read = $this->readStreams;
             $write = $this->writeStreams;
             $except = null;
@@ -289,7 +289,7 @@ protected function runStreams(?float $timeout): void
                     $writeCb();
                 }
             }
-        } elseif ($this->running && ($this->nextTick || $this->timers)) {
+        } elseif ($this->running && (count($this->nextTick) > 0 || count($this->timers) > 0)) {
             usleep(null !== $timeout ? intval($timeout * 1000000) : 200000);
         }
     }

lib/Loop/functions.php

@@ -137,7 +137,7 @@ function stop(): void
 function instance(Loop $newLoop = null): Loop
 {
     static $loop;
-    if ($newLoop) {
+    if ($newLoop instanceof Loop) {
         $loop = $newLoop;
     } elseif (!$loop) {
         $loop = new Loop();

lib/Promise.php

@@ -55,7 +55,7 @@ class Promise
      */
     public function __construct(callable $executor = null)
     {
-        if ($executor) {
+        if (is_callable($executor)) {
             $executor(
                 [$this, 'fulfill'],
                 [$this, 'reject']

lib/Promise/functions.php

@@ -34,7 +34,7 @@
 function all(array $promises): Promise
 {
     return new Promise(function ($success, $fail) use ($promises) {
-        if (empty($promises)) {
+        if (0 === count($promises)) {
             $success([]);
 
             return;

phpstan.neon

@@ -10,3 +10,21 @@ parameters:
     message: "#^Left side of && is always true.$#"
     count: 1
     path: lib/Loop/Loop.php
+  -
+    message: "#^Variable \\$timer might not be defined.$#"
+    count: 1
+    path: lib/Loop/Loop.php
+  -
+    message: "#^Only booleans are allowed in an if condition, int<0, max>|false given.$#"
+    count: 1
+    path: lib/Loop/Loop.php
+  -
+    message: "#^Instanceof between Generator<mixed, mixed, mixed, TReturn> and Generator will always evaluate to true.$#"
+    count: 1
+    path: lib/coroutine.php
+  -
+    message: "#^.* will always evaluate to true\\.$#"
+    path: tests/*
+  -
+    message: "#^.* will always evaluate to false\\.$#"
+    path: tests/*

tests/Event/CoroutineTest.php

@@ -173,7 +173,7 @@ public function testReturn(): void
             self::assertEquals(3, $value);
             $ok = true;
         })->otherwise(function ($reason) {
-            $this->fail($reason);
+            self::fail($reason);
         });
         Loop\run();
 
@@ -193,7 +193,7 @@ public function testReturnPromise(): void
         })->then(function ($value) use (&$ok) {
             $ok = $value;
         })->otherwise(function ($reason) {
-            $this->fail($reason);
+            self::fail($reason);
         });
 
         $promise->fulfill('omg it worked');

tests/Event/Loop/FunctionsTest.php

@@ -82,7 +82,7 @@ public function testAddWriteStream(): void
     {
         $h = fopen('php://temp', 'r+');
         if (false === $h) {
-            $this->fail('failed to open php://temp');
+            self::fail('failed to open php://temp');
         }
         addWriteStream($h, function () use ($h) {
             fwrite($h, 'hello world');
@@ -97,7 +97,7 @@ public function testAddReadStream(): void
     {
         $h = fopen('php://temp', 'r+');
         if (false === $h) {
-            $this->fail('failed to open php://temp');
+            self::fail('failed to open php://temp');
         }
         fwrite($h, 'hello world');
         rewind($h);

tests/Event/Loop/LoopTest.php

@@ -74,7 +74,7 @@ public function testAddWriteStream(): void
     {
         $h = fopen('php://temp', 'r+');
         if (false === $h) {
-            $this->fail('failed to open php://temp');
+            self::fail('failed to open php://temp');
         }
         $loop = new Loop();
         $loop->addWriteStream($h, function () use ($h, $loop) {
@@ -90,7 +90,7 @@ public function testAddReadStream(): void
     {
         $h = fopen('php://temp', 'r+');
         if (false === $h) {
-            $this->fail('failed to open php://temp');
+            self::fail('failed to open php://temp');
         }
         fwrite($h, 'hello world');
         rewind($h);

tests/Event/Promise/PromiseTest.php

@@ -199,7 +199,7 @@ public function testWaitRejectedException(): void
         });
         try {
             $promise->wait();
-            $this->fail('We did not get the expected exception');
+            self::fail('We did not get the expected exception');
         } catch (\Exception $e) {
             self::assertInstanceOf('OutOfBoundsException', $e);
             self::assertEquals('foo', $e->getMessage());
@@ -214,9 +214,8 @@ public function testWaitRejectedScalar(): void
         });
         try {
             $promise->wait();
-            $this->fail('We did not get the expected exception');
+            self::fail('We did not get the expected exception');
         } catch (\Exception $e) {
-            self::assertInstanceOf('Exception', $e);
             self::assertEquals('foo', $e->getMessage());
         }
     }