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 DateTimeInterface instances for equality.
Chris@0:  */
Chris@0: class DateTimeComparator extends ObjectComparator
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@0:         return ($expected instanceof \DateTime || $expected instanceof \DateTimeInterface) &&
Chris@0:             ($actual instanceof \DateTime || $actual instanceof \DateTimeInterface);
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:         /** @var \DateTimeInterface $expected */
Chris@14:         /** @var \DateTimeInterface $actual */
Chris@14:         $delta = new \DateInterval(\sprintf('PT%dS', \abs($delta)));
Chris@0: 
Chris@14:         $actualClone = (clone $actual)
Chris@14:             ->setTimezone(new \DateTimeZone('UTC'));
Chris@0: 
Chris@14:         $expectedLower = (clone $expected)
Chris@14:             ->setTimezone(new \DateTimeZone('UTC'))
Chris@14:             ->sub($delta);
Chris@14: 
Chris@14:         $expectedUpper = (clone $expected)
Chris@14:             ->setTimezone(new \DateTimeZone('UTC'))
Chris@14:             ->add($delta);
Chris@14: 
Chris@14:         if ($actualClone < $expectedLower || $actualClone > $expectedUpper) {
Chris@0:             throw new ComparisonFailure(
Chris@0:                 $expected,
Chris@0:                 $actual,
Chris@0:                 $this->dateTimeToString($expected),
Chris@0:                 $this->dateTimeToString($actual),
Chris@0:                 false,
Chris@0:                 'Failed asserting that two DateTime objects are equal.'
Chris@0:             );
Chris@0:         }
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Returns an ISO 8601 formatted string representation of a datetime or
Chris@0:      * 'Invalid DateTimeInterface object' if the provided DateTimeInterface was not properly
Chris@0:      * initialized.
Chris@0:      */
Chris@14:     private function dateTimeToString(\DateTimeInterface $datetime): string
Chris@0:     {
Chris@0:         $string = $datetime->format('Y-m-d\TH:i:s.uO');
Chris@0: 
Chris@14:         return $string ?: 'Invalid DateTimeInterface object';
Chris@0:     }
Chris@0: }