annotate vendor/sebastian/comparator/src/ArrayComparator.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents 1fec387a4317
children
rev   line source
Chris@0 1 <?php
Chris@0 2 /*
Chris@14 3 * This file is part of sebastian/comparator.
Chris@0 4 *
Chris@0 5 * (c) Sebastian Bergmann <sebastian@phpunit.de>
Chris@0 6 *
Chris@0 7 * For the full copyright and license information, please view the LICENSE
Chris@0 8 * file that was distributed with this source code.
Chris@0 9 */
Chris@0 10
Chris@0 11 namespace SebastianBergmann\Comparator;
Chris@0 12
Chris@0 13 /**
Chris@0 14 * Compares arrays for equality.
Chris@0 15 */
Chris@0 16 class ArrayComparator extends Comparator
Chris@0 17 {
Chris@0 18 /**
Chris@0 19 * Returns whether the comparator can compare two values.
Chris@0 20 *
Chris@14 21 * @param mixed $expected The first value to compare
Chris@14 22 * @param mixed $actual The second value to compare
Chris@14 23 *
Chris@0 24 * @return bool
Chris@0 25 */
Chris@0 26 public function accepts($expected, $actual)
Chris@0 27 {
Chris@14 28 return \is_array($expected) && \is_array($actual);
Chris@0 29 }
Chris@0 30
Chris@0 31 /**
Chris@0 32 * Asserts that two values are equal.
Chris@0 33 *
Chris@0 34 * @param mixed $expected First value to compare
Chris@0 35 * @param mixed $actual Second value to compare
Chris@0 36 * @param float $delta Allowed numerical distance between two values to consider them equal
Chris@0 37 * @param bool $canonicalize Arrays are sorted before comparison when set to true
Chris@0 38 * @param bool $ignoreCase Case is ignored when set to true
Chris@0 39 * @param array $processed List of already processed elements (used to prevent infinite recursion)
Chris@0 40 *
Chris@0 41 * @throws ComparisonFailure
Chris@0 42 */
Chris@14 43 public function assertEquals($expected, $actual, $delta = 0.0, $canonicalize = false, $ignoreCase = false, array &$processed = [])
Chris@0 44 {
Chris@0 45 if ($canonicalize) {
Chris@14 46 \sort($expected);
Chris@14 47 \sort($actual);
Chris@0 48 }
Chris@0 49
Chris@14 50 $remaining = $actual;
Chris@14 51 $actualAsString = "Array (\n";
Chris@14 52 $expectedAsString = "Array (\n";
Chris@14 53 $equal = true;
Chris@0 54
Chris@0 55 foreach ($expected as $key => $value) {
Chris@0 56 unset($remaining[$key]);
Chris@0 57
Chris@14 58 if (!\array_key_exists($key, $actual)) {
Chris@14 59 $expectedAsString .= \sprintf(
Chris@0 60 " %s => %s\n",
Chris@0 61 $this->exporter->export($key),
Chris@0 62 $this->exporter->shortenedExport($value)
Chris@0 63 );
Chris@0 64
Chris@0 65 $equal = false;
Chris@0 66
Chris@0 67 continue;
Chris@0 68 }
Chris@0 69
Chris@0 70 try {
Chris@0 71 $comparator = $this->factory->getComparatorFor($value, $actual[$key]);
Chris@0 72 $comparator->assertEquals($value, $actual[$key], $delta, $canonicalize, $ignoreCase, $processed);
Chris@0 73
Chris@14 74 $expectedAsString .= \sprintf(
Chris@0 75 " %s => %s\n",
Chris@0 76 $this->exporter->export($key),
Chris@0 77 $this->exporter->shortenedExport($value)
Chris@0 78 );
Chris@14 79
Chris@14 80 $actualAsString .= \sprintf(
Chris@0 81 " %s => %s\n",
Chris@0 82 $this->exporter->export($key),
Chris@0 83 $this->exporter->shortenedExport($actual[$key])
Chris@0 84 );
Chris@0 85 } catch (ComparisonFailure $e) {
Chris@14 86 $expectedAsString .= \sprintf(
Chris@0 87 " %s => %s\n",
Chris@0 88 $this->exporter->export($key),
Chris@14 89 $e->getExpectedAsString() ? $this->indent($e->getExpectedAsString()) : $this->exporter->shortenedExport($e->getExpected())
Chris@0 90 );
Chris@0 91
Chris@14 92 $actualAsString .= \sprintf(
Chris@0 93 " %s => %s\n",
Chris@0 94 $this->exporter->export($key),
Chris@14 95 $e->getActualAsString() ? $this->indent($e->getActualAsString()) : $this->exporter->shortenedExport($e->getActual())
Chris@0 96 );
Chris@0 97
Chris@0 98 $equal = false;
Chris@0 99 }
Chris@0 100 }
Chris@0 101
Chris@0 102 foreach ($remaining as $key => $value) {
Chris@14 103 $actualAsString .= \sprintf(
Chris@0 104 " %s => %s\n",
Chris@0 105 $this->exporter->export($key),
Chris@0 106 $this->exporter->shortenedExport($value)
Chris@0 107 );
Chris@0 108
Chris@0 109 $equal = false;
Chris@0 110 }
Chris@0 111
Chris@14 112 $expectedAsString .= ')';
Chris@14 113 $actualAsString .= ')';
Chris@0 114
Chris@0 115 if (!$equal) {
Chris@0 116 throw new ComparisonFailure(
Chris@0 117 $expected,
Chris@0 118 $actual,
Chris@14 119 $expectedAsString,
Chris@14 120 $actualAsString,
Chris@0 121 false,
Chris@0 122 'Failed asserting that two arrays are equal.'
Chris@0 123 );
Chris@0 124 }
Chris@0 125 }
Chris@0 126
Chris@0 127 protected function indent($lines)
Chris@0 128 {
Chris@14 129 return \trim(\str_replace("\n", "\n ", $lines));
Chris@0 130 }
Chris@0 131 }