tests/PHPUnit/Framework/ComparisonFailure/String.php

   1 <?php
   2 /**
   3  * PHPUnit
   4  *
   5  * Copyright (c) 2002-2009, Sebastian Bergmann <sb@sebastian-bergmann.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  * @category   Testing
  38  * @package    PHPUnit
  39  * @author     Jan Borsodi <jb@ez.no>
  40  * @author     Sebastian Bergmann <sb@sebastian-bergmann.de>
  41  * @copyright  2002-2009 Sebastian Bergmann <sb@sebastian-bergmann.de>
  42  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  43
  44  * @link       http://www.phpunit.de/
  45  * @since      File available since Release 3.0.0
  46  */
  47
  48 require_once 'PHPUnit/Framework.php';
  49 require_once 'PHPUnit/Util/Filter.php';
  50
  51 PHPUnit_Util_Filter::addFileToFilter(__FILE__, 'PHPUNIT');
  52
  53 /**
  54  * Thrown when an assertion for string equality failed.
  55  *
  56  * @category   Testing
  57  * @package    PHPUnit
  58  * @author     Jan Borsodi <jb@ez.no>
  59  * @author     Sebastian Bergmann <sb@sebastian-bergmann.de>
  60  * @copyright  2002-2009 Sebastian Bergmann <sb@sebastian-bergmann.de>
  61  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  62  * @version    Release: 3.3.17
  63  * @link       http://www.phpunit.de/
  64  * @since      Class available since Release 3.0.0
  65  */
  66 class PHPUnit_Framework_ComparisonFailure_String extends PHPUnit_Framework_ComparisonFailure
  67 {
  68     /**
  69      * Returns a string describing the difference between
  70      * the expected and the actual string value.
  71      */
  72     public function toString()
  73     {
  74         $expected = (string)$this->expected;
  75         $actual   = (string)$this->actual;
  76
  77         if (strpos($expected, "\n") !== FALSE || strpos($actual, "\n") !== FALSE) {
  78             if ($this->hasDiff()) {
  79                 return $this->diff($expected, $actual);
  80             } else {
  81                 return '';
  82             }
  83         }
  84
  85         $expectedLen = strlen($expected);
  86         $actualLen   = strlen($actual);
  87         $minLen      = min($expectedLen, $actualLen);
  88         $maxLen      = max($expectedLen, $actualLen);
  89
  90         for ($i = 0; $i < $minLen; ++$i) {
  91             if ($expected[$i] != $actual[$i]) break;
  92         }
  93
  94         $startPos = $i;
  95         $endPos   = $minLen;
  96
  97         if ($minLen > 0) {
  98             for ($i = $minLen - 1; $i > $startPos; --$i) {
  99                 if ($expected[$i] != $actual[$i]) break;
 100             }
 101
 102             $endPos = $i + 1;
 103         }
 104
 105         return sprintf(
 106           "%s%sexpected string <%s>\n" .
 107           "%sdifference      <%s>\n" .
 108           '%sgot string      <%s>',
 109
 110           $this->message,
 111           ($this->message != '') ? ' ' : '',
 112           $expected,
 113           ($this->message != '') ? str_repeat(' ', strlen($this->message) + 1) : '',
 114           str_repeat(' ', $startPos) . str_repeat('x', $endPos - $startPos) . str_repeat('?', $maxLen - $minLen),
 115           ($this->message != '') ? str_repeat(' ', strlen($this->message) + 1) : '',
 116           $actual
 117         );
 118     }
 119 }
 120 ?>