You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
137 lines
3.5 KiB
137 lines
3.5 KiB
<?php declare(strict_types=1);
|
|
/*
|
|
* This file is part of PHPUnit.
|
|
*
|
|
* (c) Sebastian Bergmann <sebastian@phpunit.de>
|
|
*
|
|
* For the full copyright and license information, please view the LICENSE
|
|
* file that was distributed with this source code.
|
|
*/
|
|
namespace PHPUnit\Framework\Constraint;
|
|
|
|
use function is_string;
|
|
use function sprintf;
|
|
use function strpos;
|
|
use function trim;
|
|
use PHPUnit\Framework\ExpectationFailedException;
|
|
use SebastianBergmann\Comparator\ComparisonFailure;
|
|
use SebastianBergmann\Comparator\Factory as ComparatorFactory;
|
|
|
|
/**
|
|
* @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
|
|
*/
|
|
final class IsEqual extends Constraint
|
|
{
|
|
/**
|
|
* @var mixed
|
|
*/
|
|
private $value;
|
|
|
|
/**
|
|
* @var float
|
|
*/
|
|
private $delta;
|
|
|
|
/**
|
|
* @var bool
|
|
*/
|
|
private $canonicalize;
|
|
|
|
/**
|
|
* @var bool
|
|
*/
|
|
private $ignoreCase;
|
|
|
|
public function __construct($value, float $delta = 0.0, bool $canonicalize = false, bool $ignoreCase = false)
|
|
{
|
|
$this->value = $value;
|
|
$this->delta = $delta;
|
|
$this->canonicalize = $canonicalize;
|
|
$this->ignoreCase = $ignoreCase;
|
|
}
|
|
|
|
/**
|
|
* Evaluates the constraint for parameter $other.
|
|
*
|
|
* If $returnResult is set to false (the default), an exception is thrown
|
|
* in case of a failure. null is returned otherwise.
|
|
*
|
|
* If $returnResult is true, the result of the evaluation is returned as
|
|
* a boolean value instead: true in case of success, false in case of a
|
|
* failure.
|
|
*
|
|
* @throws ExpectationFailedException
|
|
*/
|
|
public function evaluate($other, string $description = '', bool $returnResult = false): ?bool
|
|
{
|
|
// If $this->value and $other are identical, they are also equal.
|
|
// This is the most common path and will allow us to skip
|
|
// initialization of all the comparators.
|
|
if ($this->value === $other) {
|
|
return true;
|
|
}
|
|
|
|
$comparatorFactory = ComparatorFactory::getInstance();
|
|
|
|
try {
|
|
$comparator = $comparatorFactory->getComparatorFor(
|
|
$this->value,
|
|
$other,
|
|
);
|
|
|
|
$comparator->assertEquals(
|
|
$this->value,
|
|
$other,
|
|
$this->delta,
|
|
$this->canonicalize,
|
|
$this->ignoreCase,
|
|
);
|
|
} catch (ComparisonFailure $f) {
|
|
if ($returnResult) {
|
|
return false;
|
|
}
|
|
|
|
throw new ExpectationFailedException(
|
|
trim($description . "\n" . $f->getMessage()),
|
|
$f,
|
|
);
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Returns a string representation of the constraint.
|
|
*
|
|
* @throws \SebastianBergmann\RecursionContext\InvalidArgumentException
|
|
*/
|
|
public function toString(): string
|
|
{
|
|
$delta = '';
|
|
|
|
if (is_string($this->value)) {
|
|
if (strpos($this->value, "\n") !== false) {
|
|
return 'is equal to <text>';
|
|
}
|
|
|
|
return sprintf(
|
|
"is equal to '%s'",
|
|
$this->value,
|
|
);
|
|
}
|
|
|
|
if ($this->delta != 0) {
|
|
$delta = sprintf(
|
|
' with delta <%F>',
|
|
$this->delta,
|
|
);
|
|
}
|
|
|
|
return sprintf(
|
|
'is equal to %s%s',
|
|
$this->exporter()->export($this->value),
|
|
$delta,
|
|
);
|
|
}
|
|
}
|