tests/PHPUnit/PHPUnit/Framework/Comparator/Scalar.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 scalar or NULL values 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_Scalar 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      * @since  Method available since Release 3.6.0
  67      */
  68     public function accepts($expected, $actual)
  69     {
  70         return ((is_scalar($expected) XOR NULL === $expected) &&
  71                  (is_scalar($actual) XOR NULL === $actual))
  72           // allow comparison between strings and objects featuring __toString()
  73           || (is_string($expected) && is_object($actual) && method_exists($actual, '__toString'))
  74           || (is_object($expected) && method_exists($expected, '__toString') && is_string($actual));
  75     }
  76
  77     /**
  78      * Asserts that two values are equal.
  79      *
  80      * @param  mixed $expected The first value to compare
  81      * @param  mixed $actual The second value to compare
  82      * @param  float $delta The allowed numerical distance between two values to
  83      *                      consider them equal
  84      * @param  bool  $canonicalize If set to TRUE, arrays are sorted before
  85      *                             comparison
  86      * @param  bool  $ignoreCase If set to TRUE, upper- and lowercasing is
  87      *                           ignored when comparing string values
  88      * @throws PHPUnit_Framework_ComparisonFailure Thrown when the comparison
  89      *                           fails. Contains information about the
  90      *                           specific errors that lead to the failure.
  91      */
  92     public function assertEquals($expected, $actual, $delta = 0, $canonicalize = FALSE, $ignoreCase = FALSE)
  93     {
  94         $expectedToCompare = $expected;
  95         $actualToCompare = $actual;
  96
  97         // always compare as strings to avoid strange behaviour
  98         // otherwise 0 == 'Foobar'
  99         if (is_string($expected) || is_string($actual)) {
 100             $expectedToCompare = (string)$expectedToCompare;
 101             $actualToCompare = (string)$actualToCompare;
 102
 103             if ($ignoreCase) {
 104                 $expectedToCompare = strtolower($expectedToCompare);
 105                 $actualToCompare = strtolower($actualToCompare);
 106             }
 107         }
 108
 109         if ($expectedToCompare != $actualToCompare) {
 110             if (is_string($expected) && is_string($actual)) {
 111                 throw new PHPUnit_Framework_ComparisonFailure(
 112                   $expected,
 113                   $actual,
 114                   PHPUnit_Util_Type::export($expected),
 115                   PHPUnit_Util_Type::export($actual),
 116                   FALSE,
 117                   'Failed asserting that two strings are equal.'
 118                 );
 119             }
 120
 121             throw new PHPUnit_Framework_ComparisonFailure(
 122               $expected,
 123               $actual,
 124               // no diff is required
 125               '',
 126               '',
 127               FALSE,
 128               sprintf(
 129                 'Failed asserting that %s matches expected %s.',
 130
 131                 PHPUnit_Util_Type::export($actual),
 132                 PHPUnit_Util_Type::export($expected)
 133               )
 134             );
 135         }
 136     }
 137 }