PHPLIB-462: Add compatibility layer for constraint changes

Author: alcaeus

tests/Compat/ConstraintTrait.php

@@ -0,0 +1,25 @@
+<?php
+
+namespace MongoDB\Tests\Compat;
+
+use PHPUnit\Framework\Constraint\Constraint;
+use ReflectionClass;
+
+$r = new ReflectionClass(Constraint::class);
+if (\PHP_VERSION_ID < 70000 || ! $r->getMethod('matches')->hasReturnType()) {
+    /**
+     * @internal
+     */
+    trait ConstraintTrait
+    {
+        use Legacy\ConstraintTraitForV6;
+    }
+} else {
+    /**
+     * @internal
+     */
+    trait ConstraintTrait
+    {
+        use Legacy\ConstraintTraitForV7;
+    }
+}

tests/Compat/Legacy/ConstraintTraitForV6.php

@@ -0,0 +1,90 @@
+<?php
+
+namespace MongoDB\Tests\Compat\Legacy;
+
+use SebastianBergmann\Exporter\Exporter;
+
+/**
+ * @internal
+ */
+trait ConstraintTraitForV6
+{
+    /**
+     * @return int
+     */
+    public function count()
+    {
+        return $this->doCount();
+    }
+
+    /**
+     * @return string
+     */
+    public function toString()
+    {
+        return $this->doToString();
+    }
+
+    /**
+     * @param mixed $other
+     *
+     * @return string
+     */
+    protected function additionalFailureDescription($other)
+    {
+        return $this->doAdditionalFailureDescription($other);
+    }
+
+    /**
+     * @return Exporter
+     */
+    protected function exporter()
+    {
+        return $this->exporter;
+    }
+
+    /**
+     * @param mixed $other
+     *
+     * @return string
+     */
+    protected function failureDescription($other)
+    {
+        return $this->doFailureDescription($other);
+    }
+
+    /**
+     * @param mixed $other
+     *
+     * @return bool
+     */
+    protected function matches($other)
+    {
+        return $this->doMatches($other);
+    }
+
+    private function doAdditionalFailureDescription($other)
+    {
+        return '';
+    }
+
+    private function doCount()
+    {
+        return 1;
+    }
+
+    private function doFailureDescription($other)
+    {
+        return $this->exporter()->export($other) . ' ' . $this->toString();
+    }
+
+    private function doMatches($other)
+    {
+        return false;
+    }
+
+    private function doToString()
+    {
+        return '';
+    }
+}

tests/Compat/Legacy/ConstraintTraitForV7.php

@@ -0,0 +1,59 @@
+<?php
+
+namespace MongoDB\Tests\Compat\Legacy;
+
+/**
+ * @internal
+ */
+trait ConstraintTraitForV7
+{
+    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);
+    }
+
+    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 '';
+    }
+}

tests/SpecTests/DocumentsMatchConstraint.php

@@ -4,6 +4,7 @@
 
 use MongoDB\Model\BSONArray;
 use MongoDB\Model\BSONDocument;
+use MongoDB\Tests\Compat\ConstraintTrait;
 use PHPUnit\Framework\Constraint\Constraint;
 use ArrayObject;
 use InvalidArgumentException;
@@ -17,6 +18,8 @@
  */
 class DocumentsMatchConstraint extends Constraint
 {
+    use ConstraintTrait;
+
     private $ignoreExtraKeysInRoot = false;
     private $ignoreExtraKeysInEmbedded = false;
     private $placeholders = [];
@@ -38,50 +41,12 @@ class DocumentsMatchConstraint extends Constraint
      */
     public function __construct($value, $ignoreExtraKeysInRoot = false, $ignoreExtraKeysInEmbedded = false, array $placeholders = [])
     {
-        parent::__construct();
         $this->value = $this->prepareBSON($value, true, $this->sortKeys);
         $this->ignoreExtraKeysInRoot = $ignoreExtraKeysInRoot;
         $this->ignoreExtraKeysInEmbedded = $ignoreExtraKeysInEmbedded;
         $this->placeholders = $placeholders;
     }
 
-    /**
-     * Returns a string representation of the constraint.
-     *
-     * @return string
-     */
-    public function toString()
-    {
-        return 'matches ' . json_encode($this->value);
-    }
-
-    /**
-     * Evaluates the constraint for parameter $other. Returns true if the
-     * constraint is met, false otherwise.
-     *
-     * @param mixed $other
-     * @return boolean
-     */
-    protected function matches($other)
-    {
-        /* TODO: If ignoreExtraKeys and sortKeys are both false, then we may be
-         * able to skip preparation, convert both documents to extended JSON,
-         * and compare strings.
-         *
-         * If ignoreExtraKeys is false and sortKeys is true, we still be able to
-         * compare JSON strings but will still require preparation to sort keys
-         * in all documents and sub-documents. */
-        $other = $this->prepareBSON($other, true, $this->sortKeys);
-
-        try {
-            $this->assertEquals($this->value, $other, $this->ignoreExtraKeysInRoot);
-        } catch (RuntimeException $e) {
-            return false;
-        }
-
-        return true;
-    }
-
     /**
      * Compares two documents recursively.
      *
@@ -131,6 +96,31 @@ private function assertEquals(ArrayObject $expected, ArrayObject $actual, $ignor
         }
     }
 
+    private function doMatches($other)
+    {
+        /* TODO: If ignoreExtraKeys and sortKeys are both false, then we may be
+         * able to skip preparation, convert both documents to extended JSON,
+         * and compare strings.
+         *
+         * If ignoreExtraKeys is false and sortKeys is true, we still be able to
+         * compare JSON strings but will still require preparation to sort keys
+         * in all documents and sub-documents. */
+        $other = $this->prepareBSON($other, true, $this->sortKeys);
+
+        try {
+            $this->assertEquals($this->value, $other, $this->ignoreExtraKeysInRoot);
+        } catch (RuntimeException $e) {
+            return false;
+        }
+
+        return true;
+    }
+
+    private function doToString()
+    {
+        return 'matches ' . json_encode($this->value);
+    }
+
     /**
      * Prepare a BSON document or array for comparison.
      *