Merge pull request #655 from stof/refactor_comparator

stof · web-flow · commit 53538f0a1501 · 2025-10-27T23:41:11.000+01:00
Refactor the ProphecyComparator to use composition
diff --git a/spec/Prophecy/Comparator/ProphecyComparatorSpec.php b/spec/Prophecy/Comparator/ProphecyComparatorSpec.php
@@ -3,14 +3,15 @@
 namespace spec\Prophecy\Comparator;
 
 use PhpSpec\ObjectBehavior;
-use Prophecy\Argument;
 use Prophecy\Prophet;
+use SebastianBergmann\Comparator\Comparator;
+use SebastianBergmann\Comparator\Factory;
 
 class ProphecyComparatorSpec extends ObjectBehavior
 {
     function it_is_a_comparator()
     {
-        $this->shouldHaveType('SebastianBergmann\Comparator\ObjectComparator');
+        $this->shouldHaveType(Comparator::class);
     }
 
     function it_accepts_only_prophecy_objects()
@@ -35,6 +36,9 @@ function it_asserts_that_an_object_is_equal_to_its_revealed_prophecy()
         $prophecy = $prophet->prophesize('Prophecy\Prophecy\ObjectProphecy');
         $prophecy->__call('reveal', array())->willReturn(new \stdClass());
 
+        $factory = new Factory();
+        $factory->register($this->getWrappedObject());
+
         $this->shouldNotThrow()->duringAssertEquals($prophecy->reveal(), $prophecy);
     }
 }
diff --git a/src/Prophecy/Comparator/ProphecyComparator.php b/src/Prophecy/Comparator/ProphecyComparator.php
@@ -12,20 +12,22 @@
 namespace Prophecy\Comparator;
 
 use Prophecy\Prophecy\ProphecyInterface;
+use SebastianBergmann\Comparator\Comparator;
+use SebastianBergmann\Comparator\Factory;
 use SebastianBergmann\Comparator\ObjectComparator;
 
 /**
  * @final
  */
-class ProphecyComparator extends ObjectComparator
+class ProphecyComparator extends Comparator
 {
     /**
      * @param mixed $expected
      * @param mixed $actual
      */
     public function accepts($expected, $actual): bool
     {
-        return is_object($expected) && is_object($actual) && $actual instanceof ProphecyInterface;
+        return \is_object($expected) && $actual instanceof ProphecyInterface;
     }
 
     /**
@@ -34,11 +36,23 @@ public function accepts($expected, $actual): bool
      * @param float $delta
      * @param bool  $canonicalize
      * @param bool  $ignoreCase
-     * @param mixed[] $processed
      */
-    public function assertEquals($expected, $actual, $delta = 0.0, $canonicalize = false, $ignoreCase = false, array &$processed = array()): void
+    public function assertEquals($expected, $actual, $delta = 0.0, $canonicalize = false, $ignoreCase = false): void
     {
         \assert($actual instanceof ProphecyInterface);
-        parent::assertEquals($expected, $actual->reveal(), $delta, $canonicalize, $ignoreCase, $processed);
+        $this->getComparatorFactory()->getComparatorFor($expected, $actual->reveal())->assertEquals($expected, $actual->reveal(), $delta, $canonicalize, $ignoreCase);
+    }
+
+    private function getComparatorFactory(): Factory
+    {
+        // sebastianbergmann/comparator 5+
+        // @phpstan-ignore function.alreadyNarrowedType
+        if (\method_exists($this, 'factory')) {
+            return $this->factory();
+        }
+
+        // sebastianbergmann/comparator <5
+        // @phpstan-ignore property.private
+        return $this->factory;
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -3,14 +3,15 @@`
`3`	`3`	`namespace spec\Prophecy\Comparator;`
`4`	`4`
`5`	`5`	`use PhpSpec\ObjectBehavior;`
`6`		`-use Prophecy\Argument;`
`7`	`6`	`use Prophecy\Prophet;`
	`7`	`+use SebastianBergmann\Comparator\Comparator;`
	`8`	`+use SebastianBergmann\Comparator\Factory;`
`8`	`9`
`9`	`10`	`class ProphecyComparatorSpec extends ObjectBehavior`
`10`	`11`	`{`
`11`	`12`	`function it_is_a_comparator()`
`12`	`13`	`{`
`13`		`- $this->shouldHaveType('SebastianBergmann\Comparator\ObjectComparator');`
	`14`	`+ $this->shouldHaveType(Comparator::class);`
`14`	`15`	`}`
`15`	`16`
`16`	`17`	`function it_accepts_only_prophecy_objects()`
`@@ -35,6 +36,9 @@ function it_asserts_that_an_object_is_equal_to_its_revealed_prophecy()`
`35`	`36`	`$prophecy = $prophet->prophesize('Prophecy\Prophecy\ObjectProphecy');`
`36`	`37`	`$prophecy->__call('reveal', array())->willReturn(new \stdClass());`
`37`	`38`
	`39`	`+ $factory = new Factory();`
	`40`	`+ $factory->register($this->getWrappedObject());`
	`41`	`+`
`38`	`42`	`$this->shouldNotThrow()->duringAssertEquals($prophecy->reveal(), $prophecy);`
`39`	`43`	`}`
`40`	`44`	`}`