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 scalar or NULL values for equality.
Chris@0:  */
Chris@0: class ScalarComparator extends Comparator
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@14:      *
Chris@0:      * @since  Method available since Release 3.6.0
Chris@0:      */
Chris@0:     public function accepts($expected, $actual)
Chris@0:     {
Chris@14:         return ((\is_scalar($expected) xor null === $expected) &&
Chris@14:                (\is_scalar($actual) xor null === $actual))
Chris@0:                // allow comparison between strings and objects featuring __toString()
Chris@14:                || (\is_string($expected) && \is_object($actual) && \method_exists($actual, '__toString'))
Chris@14:                || (\is_object($expected) && \method_exists($expected, '__toString') && \is_string($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:      *
Chris@0:      * @throws ComparisonFailure
Chris@0:      */
Chris@0:     public function assertEquals($expected, $actual, $delta = 0.0, $canonicalize = false, $ignoreCase = false)
Chris@0:     {
Chris@0:         $expectedToCompare = $expected;
Chris@0:         $actualToCompare   = $actual;
Chris@0: 
Chris@0:         // always compare as strings to avoid strange behaviour
Chris@0:         // otherwise 0 == 'Foobar'
Chris@14:         if (\is_string($expected) || \is_string($actual)) {
Chris@0:             $expectedToCompare = (string) $expectedToCompare;
Chris@0:             $actualToCompare   = (string) $actualToCompare;
Chris@0: 
Chris@0:             if ($ignoreCase) {
Chris@14:                 $expectedToCompare = \strtolower($expectedToCompare);
Chris@14:                 $actualToCompare   = \strtolower($actualToCompare);
Chris@0:             }
Chris@0:         }
Chris@0: 
Chris@0:         if ($expectedToCompare != $actualToCompare) {
Chris@14:             if (\is_string($expected) && \is_string($actual)) {
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@0:                     'Failed asserting that two strings are equal.'
Chris@0:                 );
Chris@0:             }
Chris@0: 
Chris@0:             throw new ComparisonFailure(
Chris@0:                 $expected,
Chris@0:                 $actual,
Chris@0:                 // no diff is required
Chris@0:                 '',
Chris@0:                 '',
Chris@0:                 false,
Chris@14:                 \sprintf(
Chris@0:                     'Failed asserting that %s matches expected %s.',
Chris@0:                     $this->exporter->export($actual),
Chris@0:                     $this->exporter->export($expected)
Chris@0:                 )
Chris@0:             );
Chris@0:         }
Chris@0:     }
Chris@0: }