Set support for PHPUnit versions of "^9.6.21 | ^10.0 | ^11.0"

Author: Heiko Jerichen

.idea/codeStyles/Project.xml

@@ -12,7 +12,7 @@
     "require": {
         "php": "^8.2",
         "phpspec/prophecy": "^1.8",
-        "phpunit/php-text-template": "^2.0"
+        "phpunit/php-text-template": "^2.0 | ^3.0 | ^4.0"
     },
     "autoload": {
         "psr-4": {
@@ -22,7 +22,7 @@
     },
     "require-dev": {
         "roave/security-advisories": "dev-latest",
-        "phpunit/phpunit": "^9.0",
+        "phpunit/phpunit": "^9.6.21 | ^10.0 | ^11.0",
         "phpspec/prophecy-phpunit": "^2.0"
     }
 }

composer.json

@@ -0,0 +1,3 @@
+<?php
+
+error_reporting(E_ALL);

phpunit.bootstrap.php

@@ -1,15 +1,20 @@
 <phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.5/phpunit.xsd"
+         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/11.5/phpunit.xsd"
          cacheResult="false"
-         bootstrap="./vendor/autoload.php">
+         bootstrap="./vendor/autoload.php"
+         displayDetailsOnTestsThatTriggerDeprecations="true"
+         displayDetailsOnTestsThatTriggerErrors="true"
+         displayDetailsOnTestsThatTriggerNotices="true"
+         displayDetailsOnTestsThatTriggerWarnings="true"
+         displayDetailsOnPhpunitDeprecations="true">
     <testsuites>
         <testsuite name="Test Suite">
             <directory>./tests</directory>
         </testsuite>
     </testsuites>
-    <coverage>
+    <source>
         <include>
-            <directory suffix=".php">./src</directory>
+            <directory>./src</directory>
         </include>
-    </coverage>
+    </source>
 </phpunit>

phpunit.xml.dist

@@ -325,7 +325,7 @@ public function pcntl_async_signals($on = null): MethodProphecy
      * @since 4.1.0
      * @since 5.0
      */
-    public function pcntl_signal($signo, callable $handler, bool $restart_syscalls = null): MethodProphecy
+    public function pcntl_signal(int $signo, callable|int $handler, ?bool $restart_syscalls = null): MethodProphecy
     {
         return $this->__call('pcntl_signal', func_get_args());
     }

src/PHPBuiltInFunctions.php

@@ -2,6 +2,7 @@
 
 namespace HJerichen\ProphecyPHP;
 
+use Prophecy\Exception\Prediction\PredictionException;
 use Prophecy\Prophet;
 use SebastianBergmann\Template\Template;
 
@@ -10,13 +11,12 @@
  */
 class PHPProphet
 {
-    private Prophet $prophet;
     /** @var NamespaceProphecy[] */
     private array $namespaceProphecies = [];
 
-    public function __construct(Prophet $prophet)
-    {
-        $this->prophet = $prophet;
+    public function __construct(
+        public readonly Prophet $prophet
+    ) {
     }
 
     public function prophesize(string $namespace): NamespaceProphecy
@@ -36,6 +36,7 @@ public function prophesize(string $namespace): NamespaceProphecy
         return $this->namespaceProphecies[$namespace];
     }
 
+    /** @throws PredictionException */
     public function checkPredictions(): void
     {
         $this->prophet->checkPredictions();
@@ -47,4 +48,9 @@ public function unReveal(): void
             $namespaceProphecy->unReveal();
         }
     }
+
+    public function __destruct()
+    {
+        $this->unReveal();
+    }
 }

src/PHPProphet.php

@@ -2,32 +2,61 @@
 
 namespace HJerichen\ProphecyPHP;
 
+use PHPUnit\Framework\AssertionFailedError;
+use PHPUnit\Framework\Attributes\After;
+use PHPUnit\Framework\Attributes\PostCondition;
 use PHPUnit\Framework\TestCase;
+use Prophecy\Exception\Prediction\PredictionException;
+use Prophecy\Prophecy\MethodProphecy;
 use Prophecy\Prophet;
-use ReflectionException;
-use ReflectionMethod;
 
 /**
  * @author Heiko Jerichen <[email protected]>
  */
 trait PHPProphetTrait
 {
     private PHPProphet $phpProphet;
+    private bool $phpProphecyAssertionsCounted = false;
 
-    /**
-     * @param string $namespace
-     * @return NamespaceProphecy
-     * @throws ReflectionException
-     */
     private function prophesizePHP(string $namespace): NamespaceProphecy
     {
         return $this->getPHPProphet()->prophesize($namespace);
     }
 
     /**
-     * @return PHPProphet
-     * @throws ReflectionException
+     * @postCondition
+     */
+    #[PostCondition]
+    protected function verifyPhpProphecyDoubles(): void
+    {
+        if ($this->prophecyIsUsed()) return;
+        if (!$this->phpProphecyIsUsed()) return;
+
+        try {
+            $this->phpProphet->checkPredictions();
+        } catch (PredictionException $e) {
+            throw new AssertionFailedError($e->getMessage());
+        } finally {
+            $this->countProphecyAssertions();
+        }
+    }
+
+    /**
+     * @after
      */
+    #[After]
+    protected function tearDownPhpProphecy(): void
+    {
+        try {
+            if ($this->prophecyIsUsed()) return;
+            if (!$this->phpProphecyIsUsed()) return;
+            if ($this->phpProphecyAssertionsCounted) return;
+            $this->countProphecyAssertions();
+        } finally {
+            unset($this->phpProphet);
+        }
+    }
+
     private function getPHPProphet(): PHPProphet
     {
         if (!isset($this->phpProphet)) {
@@ -36,30 +65,35 @@ private function getPHPProphet(): PHPProphet
         return $this->phpProphet;
     }
 
-    /**
-     * @return Prophet
-     * @throws ReflectionException
-     */
     private function getProphetFromTestCase(): Prophet
     {
-        $refectionMethod = new ReflectionMethod(TestCase::class, 'getProphet');
-        $refectionMethod->setAccessible(true);
-        return $refectionMethod->invoke($this);
+        return $this->prophet ?? new Prophet();
     }
 
-    /**
-     * @noinspection PhpUnused
-     * @noinspection UnknownInspectionInspection
-     * @noinspection PhpUnhandledExceptionInspection
-     * @noinspection PhpUndefinedClassInspection
-     */
-    public function runBare(): void
+    private function prophecyIsUsed(): bool
     {
-        try {
-            parent::runBare();
-        } finally {
-            if (isset($this->phpProphet)) {
-                $this->phpProphet->unReveal();
+        return isset($this->prophet) || isset($this->prophecyAssertionsCounted);
+    }
+
+    private function phpProphecyIsUsed(): bool
+    {
+        return isset($this->phpProphet);
+    }
+
+    /** @internal */
+    private function countProphecyAssertions(): void
+    {
+        assert($this instanceof TestCase);
+        assert($this->phpProphet !== null);
+        $this->phpProphecyAssertionsCounted = true;
+
+        foreach ($this->phpProphet->prophet->getProphecies() as $objectProphecy) {
+            foreach ($objectProphecy->getMethodProphecies() as $methodProphecies) {
+                foreach ($methodProphecies as $methodProphecy) {
+                    assert($methodProphecy instanceof MethodProphecy);
+
+                    $this->addToAssertionCount(count($methodProphecy->getCheckedPredictions()));
+                }
             }
         }
     }

src/PHPProphetTrait.php

@@ -11,7 +11,6 @@
 use PHPUnit\Framework\TestCase;
 use Prophecy\Argument;
 use Prophecy\Exception\Prediction\PredictionException;
-use ReflectionProperty;
 
 /**
  * @author Heiko Jerichen <[email protected]>
@@ -90,7 +89,6 @@ public function testFunctionWillReturnSimpleWithWrongParameter(): void
 
         $this->expectException(FunctionProphecyNotFoundException::class);
 
-        /** @noinspection PhpExpressionResultUnusedInspection */
         date('d.m.Y H:i');
     }
 
@@ -109,7 +107,6 @@ public function testFunctionWillReturnSimpleWithMoreThenOneParameterButWithOnyOn
 
         $this->expectException(FunctionProphecyNotFoundException::class);
 
-        /** @noinspection PhpExpressionResultUnusedInspection */
         date('d.m.Y H:i:s');
     }
 
@@ -126,10 +123,12 @@ public function testFunctionShouldBeCalledNotFulfilled(): void
         $this->php->file_put_contents('/tmp/test.txt', 'test')->shouldBeCalled();
         $this->php->reveal();
 
-        $this->resetProphecy();
-
-        $this->expectException(PredictionException::class);
-        $this->phpProphet->checkPredictions();
+        try {
+            $this->expectException(PredictionException::class);
+            $this->phpProphet->checkPredictions();
+        } finally {
+            $this->resetProphecy();
+        }
     }
 
     public function testOverwriteProphecy(): void
@@ -151,6 +150,7 @@ public function testCalculateCorrectProphecy(): void
         self::assertEquals('2019', date('Y'));
     }
 
+    /** @noinspection PhpUnreachableStatementInspection */
     public function testExit(): void
     {
         $exception = new BadFunctionCallException('Function "exit" can not be mocked.');
@@ -160,6 +160,7 @@ public function testExit(): void
         $this->php->reveal();
     }
 
+    /** @noinspection PhpUnreachableStatementInspection */
     public function testDie(): void
     {
         $exception = new BadFunctionCallException('Function "die" can not be mocked.');
@@ -174,10 +175,6 @@ public function testDie(): void
 
     private function resetProphecy(): void
     {
-        $reflectionProperty = new ReflectionProperty(TestCase::class, 'prophet');
-        $reflectionProperty->setAccessible(true);
-
-        /** @noinspection PhpRedundantOptionalArgumentInspection */
-        $reflectionProperty->setValue($this, null);
+        unset($this->prophet, $this->phpProphet);
     }
 }