tests/PHPUnit/PHPUnit/Framework/Comparator/Array.php

   1 <?php
   2 /**
   3  * PHPUnit
   4  *
   5  * Copyright (c) 2002-2011, Sebastian Bergmann <sebastian@phpunit.de>.
   6  * All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  *
  12  *   * Redistributions of source code must retain the above copyright
  13  *     notice, this list of conditions and the following disclaimer.
  14  *
  15  *   * Redistributions in binary form must reproduce the above copyright
  16  *     notice, this list of conditions and the following disclaimer in
  17  *     the documentation and/or other materials provided with the
  18  *     distribution.
  19  *
  20  *   * Neither the name of Sebastian Bergmann nor the names of his
  21  *     contributors may be used to endorse or promote products derived
  22  *     from this software without specific prior written permission.
  23  *
  24  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  25  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  26  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  27  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  28  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  29  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  30  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  31  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  32  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  33  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  34  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  35  * POSSIBILITY OF SUCH DAMAGE.
  36  *
  37  * @package    PHPUnit
  38  * @subpackage Framework
  39  * @author     Bernhard Schussek <bschussek@2bepublished.at>
  40  * @copyright  2002-2011 Sebastian Bergmann <sebastian@phpunit.de>
  41  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  42  * @link       http://www.phpunit.de/
  43  * @since      File available since Release 3.6.0
  44  */
  45
  46 /**
  47  * Compares arrays for equality.
  48  *
  49  * @package    PHPUnit
  50  * @subpackage Framework_Comparator
  51  * @author     Bernhard Schussek <bschussek@2bepublished.at>
  52  * @copyright  2002-2011 Sebastian Bergmann <sebastian@phpunit.de>
  53  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  54  * @version    Release: 3.6.3
  55  * @link       http://www.phpunit.de/
  56  * @since      Class available since Release 3.6.0
  57  */
  58 class PHPUnit_Framework_Comparator_Array extends PHPUnit_Framework_Comparator
  59 {
  60     /**
  61      * Returns whether the comparator can compare two values.
  62      *
  63      * @param  mixed $expected The first value to compare
  64      * @param  mixed $actual The second value to compare
  65      * @return boolean
  66      */
  67     public function accepts($expected, $actual)
  68     {
  69         return is_array($expected) && is_array($actual);
  70     }
  71
  72     /**
  73      * Asserts that two values are equal.
  74      *
  75      * @param  mixed $expected The first value to compare
  76      * @param  mixed $actual The second value to compare
  77      * @param  float $delta The allowed numerical distance between two values to
  78      *                      consider them equal
  79      * @param  bool  $canonicalize If set to TRUE, arrays are sorted before
  80      *                             comparison
  81      * @param  bool  $ignoreCase If set to TRUE, upper- and lowercasing is
  82      *                           ignored when comparing string values
  83      * @throws PHPUnit_Framework_ComparisonFailure Thrown when the comparison
  84      *                           fails. Contains information about the
  85      *                           specific errors that lead to the failure.
  86      */
  87     public function assertEquals($expected, $actual, $delta = 0, $canonicalize = FALSE, $ignoreCase = FALSE, array &$processed = array())
  88     {
  89         if ($canonicalize) {
  90             sort($expected);
  91             sort($actual);
  92         }
  93
  94         $remaining = $actual;
  95         $expString = $actString = "Array (\n";
  96         $equal = TRUE;
  97
  98         foreach ($expected as $key => $value) {
  99             unset($remaining[$key]);
 100
 101             if (!array_key_exists($key, $actual)) {
 102                 $expString .= sprintf(
 103                   "    %s => %s\n",
 104
 105                   PHPUnit_Util_Type::export($key),
 106                   PHPUnit_Util_Type::shortenedExport($value)
 107                 );
 108                 $equal = FALSE;
 109                 continue;
 110             }
 111
 112             try {
 113                 $this->factory->getComparatorFor($value, $actual[$key])->assertEquals($value, $actual[$key], $delta, $canonicalize, $ignoreCase, $processed);
 114                 $expString .= sprintf(
 115                   "    %s => %s\n",
 116
 117                   PHPUnit_Util_Type::export($key),
 118                   PHPUnit_Util_Type::shortenedExport($value)
 119                 );
 120                 $actString .= sprintf(
 121                   "    %s => %s\n",
 122
 123                   PHPUnit_Util_Type::export($key),
 124                   PHPUnit_Util_Type::shortenedExport($actual[$key])
 125                 );
 126             }
 127
 128             catch (PHPUnit_Framework_ComparisonFailure $e) {
 129                 $expString .= sprintf(
 130                   "    %s => %s\n",
 131
 132                   PHPUnit_Util_Type::export($key),
 133                   $e->getExpectedAsString()
 134                     ? $this->indent($e->getExpectedAsString())
 135                     : PHPUnit_Util_Type::shortenedExport($e->getExpected())
 136                 );
 137                 $actString .= sprintf(
 138                   "    %s => %s\n",
 139
 140                   PHPUnit_Util_Type::export($key),
 141                   $e->getActualAsString()
 142                     ? $this->indent($e->getActualAsString())
 143                     : PHPUnit_Util_Type::shortenedExport($e->getActual())
 144                 );
 145                 $equal = FALSE;
 146             }
 147         }
 148
 149         foreach ($remaining as $key => $value) {
 150             $actString .= sprintf(
 151               "    %s => %s\n",
 152
 153               PHPUnit_Util_Type::export($key),
 154               PHPUnit_Util_Type::shortenedExport($value)
 155             );
 156             $equal = FALSE;
 157         }
 158
 159         $expString .= ')';
 160         $actString .= ')';
 161
 162         if (!$equal) {
 163             throw new PHPUnit_Framework_ComparisonFailure(
 164               $expected,
 165               $actual,
 166               $expString,
 167               $actString,
 168               FALSE,
 169              'Failed asserting that two arrays are equal.'
 170             );
 171         }
 172     }
 173
 174     protected function indent($lines)
 175     {
 176         return trim(str_replace("\n", "\n    ", $lines));
 177     }
 178 }