bug #38681 [PHPUnitBridge] Support PHPUnit 8 and PHPUnit 9 in constraint compatibility trait (alcaeus)

This PR was merged into the 4.4 branch.

Discussion
----------

[PHPUnitBridge] Support PHPUnit 8 and PHPUnit 9 in constraint compatibility trait

| Q             | A
| ------------- | ---
| Branch?       | 5.x
| Bug fix?      | not really
| New feature?  | yes
| Deprecations? | no <!-- please update UPGRADE-*.md and src/**/CHANGELOG.md files -->
| License       | MIT

This expands the compatibility layer for PHPUnit constraints by supporting PHPUnit 8 and PHPUnit 9. Support for the latter requires also adding the `evaluate` method to the trait, as this method gets a signature change in PHPUnit 9.

Commits
-------

f79ad80009 Support PHPUnit 8 and PHPUnit 9 in constraint compatibility trait

Author: fabpot

ConstraintTrait.php

@@ -20,9 +20,19 @@ trait ConstraintTrait
     {
         use Legacy\ConstraintTraitForV6;
     }
-} else {
+} elseif ($r->getProperty('exporter')->isProtected()) {
     trait ConstraintTrait
     {
         use Legacy\ConstraintTraitForV7;
     }
+} elseif (\PHP_VERSION < 70100 || !$r->getMethod('evaluate')->hasReturnType()) {
+    trait ConstraintTrait
+    {
+        use Legacy\ConstraintTraitForV8;
+    }
+} else {
+    trait ConstraintTrait
+    {
+        use Legacy\ConstraintTraitForV9;
+    }
 }

Legacy/ConstraintLogicTrait.php

@@ -0,0 +1,62 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Bridge\PhpUnit\Legacy;
+
+/**
+ * @internal
+ */
+trait ConstraintLogicTrait
+{
+    private function doEvaluate($other, $description, $returnResult)
+    {
+        $success = false;
+
+        if ($this->matches($other)) {
+            $success = true;
+        }
+
+        if ($returnResult) {
+            return $success;
+        }
+
+        if (!$success) {
+            $this->fail($other, $description);
+        }
+
+        return null;
+    }
+
+    private function doAdditionalFailureDescription($other): string
+    {
+        return '';
+    }
+
+    private function doCount(): int
+    {
+        return 1;
+    }
+
+    private function doFailureDescription($other): string
+    {
+        return $this->exporter()->export($other).' '.$this->toString();
+    }
+
+    private function doMatches($other): bool
+    {
+        return false;
+    }
+
+    private function doToString(): string
+    {
+        return '';
+    }
+}

Legacy/ConstraintTraitForV6.php

@@ -18,6 +18,14 @@
  */
 trait ConstraintTraitForV6
 {
+    /**
+     * @return bool|null
+     */
+    public function evaluate($other, $description = '', $returnResult = false)
+    {
+        return $this->doEvaluate($other, $description, $returnResult);
+    }
+
     /**
      * @return int
      */
@@ -86,6 +94,25 @@ private function doCount()
         return 1;
     }
 
+    private function doEvaluate($other, $description, $returnResult)
+    {
+        $success = false;
+
+        if ($this->matches($other)) {
+            $success = true;
+        }
+
+        if ($returnResult) {
+            return $success;
+        }
+
+        if (!$success) {
+            $this->fail($other, $description);
+        }
+
+        return null;
+    }
+
     private function doFailureDescription($other)
     {
         return $this->exporter()->export($other).' '.$this->toString();

Legacy/ConstraintTraitForV7.php

@@ -18,6 +18,16 @@
  */
 trait ConstraintTraitForV7
 {
+    use ConstraintLogicTrait;
+
+    /**
+     * @return bool|null
+     */
+    public function evaluate($other, $description = '', $returnResult = false)
+    {
+        return $this->doEvaluate($other, $description, $returnResult);
+    }
+
     public function count(): int
     {
         return $this->doCount();
@@ -51,29 +61,4 @@ protected function matches($other): bool
     {
         return $this->doMatches($other);
     }
-
-    private function doAdditionalFailureDescription($other): string
-    {
-        return '';
-    }
-
-    private function doCount(): int
-    {
-        return 1;
-    }
-
-    private function doFailureDescription($other): string
-    {
-        return $this->exporter()->export($other).' '.$this->toString();
-    }
-
-    private function doMatches($other): bool
-    {
-        return false;
-    }
-
-    private function doToString(): string
-    {
-        return '';
-    }
 }

Legacy/ConstraintTraitForV8.php

@@ -0,0 +1,53 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Bridge\PhpUnit\Legacy;
+
+/**
+ * @internal
+ */
+trait ConstraintTraitForV8
+{
+    use ConstraintLogicTrait;
+
+    /**
+     * @return bool|null
+     */
+    public function evaluate($other, $description = '', $returnResult = false)
+    {
+        return $this->doEvaluate($other, $description, $returnResult);
+    }
+
+    public function count(): int
+    {
+        return $this->doCount();
+    }
+
+    public function toString(): string
+    {
+        return $this->doToString();
+    }
+
+    protected function additionalFailureDescription($other): string
+    {
+        return $this->doAdditionalFailureDescription($other);
+    }
+
+    protected function failureDescription($other): string
+    {
+        return $this->doFailureDescription($other);
+    }
+
+    protected function matches($other): bool
+    {
+        return $this->doMatches($other);
+    }
+}

Legacy/ConstraintTraitForV9.php

@@ -0,0 +1,50 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Bridge\PhpUnit\Legacy;
+
+/**
+ * @internal
+ */
+trait ConstraintTraitForV9
+{
+    use ConstraintLogicTrait;
+
+    public function evaluate($other, string $description = '', bool $returnResult = false): ?bool
+    {
+        return $this->doEvaluate($other, $description, $returnResult);
+    }
+
+    public function count(): int
+    {
+        return $this->doCount();
+    }
+
+    public function toString(): string
+    {
+        return $this->doToString();
+    }
+
+    protected function additionalFailureDescription($other): string
+    {
+        return $this->doAdditionalFailureDescription($other);
+    }
+
+    protected function failureDescription($other): string
+    {
+        return $this->doFailureDescription($other);
+    }
+
+    protected function matches($other): bool
+    {
+        return $this->doMatches($other);
+    }
+}