Support PHPUnit 12 by avoiding removed methods getMockForAbstractClass() and addMethods()

.github/workflows/tests.yml

@@ -13,6 +13,7 @@ jobs:
     strategy:
       matrix:
         php-version:
+          - '8.4'
           - '8.3'
           - '8.2'
           - '8.1'
@@ -23,6 +24,10 @@ jobs:
           - '7.1'
           - '7.0'
         phpunit-version:
+          - '12.0.0'
+          - '11.5.0'
+          - '11.4.0'
+          - '11.3.0'
           - '11.2.0'
           - '11.1.0'
           - '11.0.0'
@@ -58,6 +63,52 @@ jobs:
           - '6.0.0'
 
         exclude:
+          # PHP 8.4 Exclusions
+          - php-version: '8.4'
+            phpunit-version: '9.4.0'
+          - php-version: '8.4'
+            phpunit-version: '9.3.0'
+          - php-version: '8.4'
+            phpunit-version: '9.2.0'
+          - php-version: '8.4'
+            phpunit-version: '9.1.0'
+          - php-version: '8.4'
+            phpunit-version: '9.0.0'
+          - php-version: '8.4'
+            phpunit-version: '8.4.0'
+          - php-version: '8.4'
+            phpunit-version: '8.3.0'
+          - php-version: '8.4'
+            phpunit-version: '8.2.0'
+          - php-version: '8.4'
+            phpunit-version: '8.1.0'
+          - php-version: '8.4'
+            phpunit-version: '8.0.0'
+          - php-version: '8.4'
+            phpunit-version: '7.5.0'
+          - php-version: '8.4'
+            phpunit-version: '7.4.0'
+          - php-version: '8.4'
+            phpunit-version: '7.3.0'
+          - php-version: '8.4'
+            phpunit-version: '7.2.0'
+          - php-version: '8.4'
+            phpunit-version: '7.1.0'
+          - php-version: '8.4'
+            phpunit-version: '7.0.0'
+          - php-version: '8.4'
+            phpunit-version: '6.5.0'
+          - php-version: '8.4'
+            phpunit-version: '6.4.0'
+          - php-version: '8.4'
+            phpunit-version: '6.3.0'
+          - php-version: '8.4'
+            phpunit-version: '6.2.0'
+          - php-version: '8.4'
+            phpunit-version: '6.1.0'
+          - php-version: '8.4'
+            phpunit-version: '6.0.0'
+
           # PHP 8.3 Exclusions
           - php-version: '8.3'
             phpunit-version: '9.4.0'
@@ -105,6 +156,8 @@ jobs:
             phpunit-version: '6.0.0'
 
           # PHP 8.2 Exclusions
+          - php-version: '8.2'
+            phpunit-version: '12.0.0'
           - php-version: '8.2'
             phpunit-version: '9.4.0'
           - php-version: '8.2'
@@ -151,6 +204,14 @@ jobs:
             phpunit-version: '6.0.0'
 
           # PHP 8.1 Exclusions
+          - php-version: '8.1'
+            phpunit-version: '12.0.0'
+          - php-version: '8.1'
+            phpunit-version: '11.5.0'
+          - php-version: '8.1'
+            phpunit-version: '11.4.0'
+          - php-version: '8.1'
+            phpunit-version: '11.3.0'
           - php-version: '8.1'
             phpunit-version: '11.2.0'
           - php-version: '8.1'
@@ -203,6 +264,14 @@ jobs:
             phpunit-version: '6.0.0'
 
           # PHP 8.0 Exclusions
+          - php-version: '8.0'
+            phpunit-version: '12.0.0'
+          - php-version: '8.0'
+            phpunit-version: '11.5.0'
+          - php-version: '8.0'
+            phpunit-version: '11.4.0'
+          - php-version: '8.0'
+            phpunit-version: '11.3.0'
           - php-version: '8.0'
             phpunit-version: '11.2.0'
           - php-version: '8.0'
@@ -263,6 +332,14 @@ jobs:
             phpunit-version: '6.0.0'
 
           # PHP 7.4 Exclusions
+          - php-version: '7.4'
+            phpunit-version: '12.0.0'
+          - php-version: '7.4'
+            phpunit-version: '11.5.0'
+          - php-version: '7.4'
+            phpunit-version: '11.4.0'
+          - php-version: '7.4'
+            phpunit-version: '11.3.0'
           - php-version: '7.4'
             phpunit-version: '11.2.0'
           - php-version: '7.4'
@@ -309,6 +386,14 @@ jobs:
             phpunit-version: '6.0.0'
 
           # PHP 7.3 Exclusions
+          - php-version: '7.3'
+            phpunit-version: '12.0.0'
+          - php-version: '7.3'
+            phpunit-version: '11.5.0'
+          - php-version: '7.3'
+            phpunit-version: '11.4.0'
+          - php-version: '7.3'
+            phpunit-version: '11.3.0'
           - php-version: '7.3'
             phpunit-version: '11.2.0'
           - php-version: '7.3'
@@ -329,6 +414,14 @@ jobs:
             phpunit-version: '10.0.0'
 
           # PHP 7.2 Exclusions
+          - php-version: '7.2'
+            phpunit-version: '12.0.0'
+          - php-version: '7.2'
+            phpunit-version: '11.5.0'
+          - php-version: '7.2'
+            phpunit-version: '11.4.0'
+          - php-version: '7.2'
+            phpunit-version: '11.3.0'
           - php-version: '7.2'
             phpunit-version: '11.2.0'
           - php-version: '7.2'
@@ -363,6 +456,14 @@ jobs:
             phpunit-version: '9.0.0'
 
           # PHP 7.1 Exclusions
+          - php-version: '7.1'
+            phpunit-version: '12.0.0'
+          - php-version: '7.1'
+            phpunit-version: '11.5.0'
+          - php-version: '7.1'
+            phpunit-version: '11.4.0'
+          - php-version: '7.1'
+            phpunit-version: '11.3.0'
           - php-version: '7.1'
             phpunit-version: '11.2.0'
           - php-version: '7.1'
@@ -409,6 +510,14 @@ jobs:
             phpunit-version: '8.0.0'
 
           # PHP 7.0 Exclusions
+          - php-version: '7.0'
+            phpunit-version: '12.0.0'
+          - php-version: '7.0'
+            phpunit-version: '11.5.0'
+          - php-version: '7.0'
+            phpunit-version: '11.4.0'
+          - php-version: '7.0'
+            phpunit-version: '11.3.0'
           - php-version: '7.0'
             phpunit-version: '11.2.0'
           - php-version: '7.0'

autoload.php

@@ -90,6 +90,11 @@ class_alias(
 }
 
 if ($hasVersion
+    && version_compare(\PHPUnit\Runner\Version::id(), '12.0.0') >= 0
+) {
+    class_alias(\phpmock\phpunit\DefaultArgumentRemoverReturnTypes120::class, \phpmock\phpunit\DefaultArgumentRemover::class);
+    class_alias(\phpmock\phpunit\MockObjectProxyReturnTypes120::class, \phpmock\phpunit\MockObjectProxy::class);
+} elseif ($hasVersion
     && version_compare(\PHPUnit\Runner\Version::id(), '10.0.0') >= 0
 ) {
     class_alias(\phpmock\phpunit\DefaultArgumentRemoverReturnTypes100::class, \phpmock\phpunit\DefaultArgumentRemover::class);

classes/DefaultArgumentRemoverReturnTypes120.php

@@ -0,0 +1,128 @@
+<?php
+
+namespace phpmock\phpunit;
+
+use phpmock\generator\MockFunctionGenerator;
+use PHPUnit\Framework\MockObject\Invocation;
+use PHPUnit\Framework\MockObject\Rule\InvocationOrder;
+use ReflectionClass;
+
+/**
+ * Removes default arguments from the invocation.
+ *
+ * @author Markus Malkusch <[email protected]>
+ * @link bitcoin:1335STSwu9hST4vcMRppEPgENMHD2r1REK Donations
+ * @license http://www.wtfpl.net/txt/copying/ WTFPL
+ * @internal
+ */
+class DefaultArgumentRemoverReturnTypes120 extends InvocationOrder
+{
+    /**
+     * @SuppressWarnings(PHPMD)
+     */
+    public function invokedDo(Invocation $invocation): void
+    {
+    }
+
+    /**
+     * @SuppressWarnings(PHPMD)
+     */
+    public function matches(Invocation $invocation) : bool
+    {
+        $iClass = class_exists(Invocation::class);
+
+        if ($iClass
+            || $invocation instanceof Invocation\StaticInvocation
+        ) {
+            $this->removeDefaultArguments(
+                $invocation,
+                $iClass ? Invocation::class : Invocation\StaticInvocation::class
+            );
+        } elseif (!$this->shouldRemoveDefaultArgumentsWithReflection($invocation)) {
+            MockFunctionGenerator::removeDefaultArguments($invocation->parameters);
+        }
+
+        return false;
+    }
+
+    public function verify() : void
+    {
+    }
+
+    /**
+     * This method is not defined in the interface, but used in
+     * PHPUnit_Framework_MockObject_InvocationMocker::hasMatchers().
+     *
+     * @return boolean
+     * @see \PHPUnit_Framework_MockObject_InvocationMocker::hasMatchers()
+     */
+    public function hasMatchers()
+    {
+        return false;
+    }
+
+    public function toString() : string
+    {
+        return __CLASS__;
+    }
+
+    /**
+     * Remove default arguments from StaticInvocation or its children (hack)
+     *
+     * @SuppressWarnings(PHPMD)
+     */
+    private function removeDefaultArguments(Invocation $invocation, string $class)
+    {
+        if ($this->shouldRemoveDefaultArgumentsWithReflection($invocation)) {
+            return;
+        }
+
+        $remover = function () {
+            MockFunctionGenerator::removeDefaultArguments($this->parameters);
+        };
+
+        $remover->bindTo($invocation, $class)();
+    }
+
+    /**
+     * Alternative to remove default arguments from StaticInvocation or its children (hack)
+     *
+     * @SuppressWarnings(PHPMD.StaticAccess)
+     */
+    public static function removeDefaultArgumentsWithReflection(Invocation $invocation): Invocation
+    {
+        if (!(new self())->shouldRemoveDefaultArgumentsWithReflection($invocation)) {
+            return $invocation;
+        }
+
+        $reflection = new ReflectionClass($invocation);
+
+        $reflectionReturnType = $reflection->getProperty('returnType');
+        $reflectionReturnType->setAccessible(true);
+
+        $reflectionIsOptional = $reflection->getProperty('isReturnTypeNullable');
+        $reflectionIsOptional->setAccessible(true);
+
+        $returnType = $reflectionReturnType->getValue($invocation);
+
+        if ($reflectionIsOptional->getValue($invocation)) {
+            $returnType = '?' . $returnType;
+        }
+
+        $parameters = $invocation->parameters();
+        MockFunctionGenerator::removeDefaultArguments($parameters);
+
+        return new Invocation(
+            $invocation->className(),
+            $invocation->methodName(),
+            $parameters,
+            $returnType,
+            $invocation->object()
+        );
+    }
+
+    protected function shouldRemoveDefaultArgumentsWithReflection(Invocation $invocation)
+    {
+        return method_exists($invocation, 'parameters');
+    }
+}