Chris@0: <?php
Chris@0: /*
Chris@14:  * This file is part of sebastian/comparator.
Chris@0:  *
Chris@0:  * (c) Sebastian Bergmann <sebastian@phpunit.de>
Chris@0:  *
Chris@0:  * For the full copyright and license information, please view the LICENSE
Chris@0:  * file that was distributed with this source code.
Chris@0:  */
Chris@0: 
Chris@0: namespace SebastianBergmann\Comparator;
Chris@0: 
Chris@0: /**
Chris@0:  * Compares objects for equality.
Chris@0:  */
Chris@0: class ObjectComparator extends ArrayComparator
Chris@0: {
Chris@0:     /**
Chris@0:      * Returns whether the comparator can compare two values.
Chris@0:      *
Chris@14:      * @param mixed $expected The first value to compare
Chris@14:      * @param mixed $actual   The second value to compare
Chris@14:      *
Chris@0:      * @return bool
Chris@0:      */
Chris@0:     public function accepts($expected, $actual)
Chris@0:     {
Chris@14:         return \is_object($expected) && \is_object($actual);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Asserts that two values are equal.
Chris@0:      *
Chris@0:      * @param mixed $expected     First value to compare
Chris@0:      * @param mixed $actual       Second value to compare
Chris@0:      * @param float $delta        Allowed numerical distance between two values to consider them equal
Chris@0:      * @param bool  $canonicalize Arrays are sorted before comparison when set to true
Chris@0:      * @param bool  $ignoreCase   Case is ignored when set to true
Chris@0:      * @param array $processed    List of already processed elements (used to prevent infinite recursion)
Chris@0:      *
Chris@0:      * @throws ComparisonFailure
Chris@0:      */
Chris@14:     public function assertEquals($expected, $actual, $delta = 0.0, $canonicalize = false, $ignoreCase = false, array &$processed = [])
Chris@0:     {
Chris@14:         if (\get_class($actual) !== \get_class($expected)) {
Chris@0:             throw new ComparisonFailure(
Chris@0:                 $expected,
Chris@0:                 $actual,
Chris@0:                 $this->exporter->export($expected),
Chris@0:                 $this->exporter->export($actual),
Chris@0:                 false,
Chris@14:                 \sprintf(
Chris@0:                     '%s is not instance of expected class "%s".',
Chris@0:                     $this->exporter->export($actual),
Chris@14:                     \get_class($expected)
Chris@0:                 )
Chris@0:             );
Chris@0:         }
Chris@0: 
Chris@0:         // don't compare twice to allow for cyclic dependencies
Chris@14:         if (\in_array([$actual, $expected], $processed, true) ||
Chris@14:             \in_array([$expected, $actual], $processed, true)) {
Chris@0:             return;
Chris@0:         }
Chris@0: 
Chris@14:         $processed[] = [$actual, $expected];
Chris@0: 
Chris@0:         // don't compare objects if they are identical
Chris@0:         // this helps to avoid the error "maximum function nesting level reached"
Chris@0:         // CAUTION: this conditional clause is not tested
Chris@0:         if ($actual !== $expected) {
Chris@0:             try {
Chris@0:                 parent::assertEquals(
Chris@0:                     $this->toArray($expected),
Chris@0:                     $this->toArray($actual),
Chris@0:                     $delta,
Chris@0:                     $canonicalize,
Chris@0:                     $ignoreCase,
Chris@0:                     $processed
Chris@0:                 );
Chris@0:             } catch (ComparisonFailure $e) {
Chris@0:                 throw new ComparisonFailure(
Chris@0:                     $expected,
Chris@0:                     $actual,
Chris@0:                     // replace "Array" with "MyClass object"
Chris@14:                     \substr_replace($e->getExpectedAsString(), \get_class($expected) . ' Object', 0, 5),
Chris@14:                     \substr_replace($e->getActualAsString(), \get_class($actual) . ' Object', 0, 5),
Chris@0:                     false,
Chris@0:                     'Failed asserting that two objects are equal.'
Chris@0:                 );
Chris@0:             }
Chris@0:         }
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Converts an object to an array containing all of its private, protected
Chris@0:      * and public properties.
Chris@0:      *
Chris@14:      * @param object $object
Chris@14:      *
Chris@0:      * @return array
Chris@0:      */
Chris@0:     protected function toArray($object)
Chris@0:     {
Chris@0:         return $this->exporter->toArray($object);
Chris@0:     }
Chris@0: }