tests/PHPUnit/Framework/Constraint.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 if (!class_exists('PHPUnit_Framework_Constraint', FALSE)) {
  54
  55 /**
  56  * Abstract base class for constraints. which are placed upon any value.
  57  *
  58  * @category   Testing
  59  * @package    PHPUnit
  60  * @author     Jan Borsodi <jb@ez.no>
  61  * @author     Sebastian Bergmann <sb@sebastian-bergmann.de>
  62  * @copyright  2002-2009 Sebastian Bergmann <sb@sebastian-bergmann.de>
  63  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  64  * @version    Release: 3.3.17
  65  * @link       http://www.phpunit.de/
  66  * @since      Interface available since Release 3.0.0
  67  */
  68 abstract class PHPUnit_Framework_Constraint implements PHPUnit_Framework_SelfDescribing
  69 {
  70     /**
  71      * Evaluates the constraint for parameter $other. Returns TRUE if the
  72      * constraint is met, FALSE otherwise.
  73      *
  74      * @param mixed $other Value or object to evaluate.
  75      * @return bool
  76      */
  77     abstract public function evaluate($other);
  78
  79     /**
  80      * Creates the appropriate exception for the constraint which can be caught
  81      * by the unit test system. This can be called if a call to evaluate() fails.
  82      *
  83      * @param   mixed   $other The value passed to evaluate() which failed the
  84      *                         constraint check.
  85      * @param   string  $description A string with extra description of what was
  86      *                               going on while the evaluation failed.
  87      * @param   boolean $not Flag to indicate negation.
  88      * @throws  PHPUnit_Framework_ExpectationFailedException
  89      */
  90     public function fail($other, $description, $not = FALSE)
  91     {
  92         throw new PHPUnit_Framework_ExpectationFailedException(
  93           $this->failureDescription($other, $description, $not),
  94           NULL
  95         );
  96     }
  97
  98     protected function failureDescription($other, $description, $not)
  99     {
 100         $failureDescription = $this->customFailureDescription(
 101           $other, $description, $not
 102         );
 103
 104         if ($failureDescription === NULL) {
 105             $failureDescription = sprintf(
 106               'Failed asserting that %s %s.',
 107
 108                PHPUnit_Util_Type::toString($other),
 109                $this->toString()
 110             );
 111         }
 112
 113         if ($not) {
 114             $failureDescription = self::negate($failureDescription);
 115         }
 116
 117         if (!empty($description)) {
 118             $failureDescription = $description . "\n" . $failureDescription;
 119         }
 120
 121         return $failureDescription;
 122     }
 123
 124     protected function customFailureDescription($other, $description, $not)
 125     {
 126     }
 127
 128     public static function negate($string)
 129     {
 130         return str_replace(
 131           array(
 132             'contains ',
 133             'exists',
 134             'has ',
 135             'is ',
 136             'matches '
 137           ),
 138           array(
 139             'does not contain ',
 140             'does not exist',
 141             'does not have ',
 142             'is not ',
 143             'does not match '
 144           ),
 145           $string
 146         );
 147     }
 148 }
 149
 150 }
 151
 152 require_once 'PHPUnit/Framework/Constraint/And.php';
 153 require_once 'PHPUnit/Framework/Constraint/ArrayHasKey.php';
 154 require_once 'PHPUnit/Framework/Constraint/Attribute.php';
 155 require_once 'PHPUnit/Framework/Constraint/ClassHasAttribute.php';
 156 require_once 'PHPUnit/Framework/Constraint/ClassHasStaticAttribute.php';
 157 require_once 'PHPUnit/Framework/Constraint/IsFalse.php';
 158 require_once 'PHPUnit/Framework/Constraint/FileExists.php';
 159 require_once 'PHPUnit/Framework/Constraint/GreaterThan.php';
 160 require_once 'PHPUnit/Framework/Constraint/IsAnything.php';
 161 require_once 'PHPUnit/Framework/Constraint/IsEqual.php';
 162 require_once 'PHPUnit/Framework/Constraint/IsIdentical.php';
 163 require_once 'PHPUnit/Framework/Constraint/IsInstanceOf.php';
 164 require_once 'PHPUnit/Framework/Constraint/IsType.php';
 165 require_once 'PHPUnit/Framework/Constraint/LessThan.php';
 166 require_once 'PHPUnit/Framework/Constraint/Not.php';
 167 require_once 'PHPUnit/Framework/Constraint/IsNull.php';
 168 require_once 'PHPUnit/Framework/Constraint/ObjectHasAttribute.php';
 169 require_once 'PHPUnit/Framework/Constraint/Or.php';
 170 require_once 'PHPUnit/Framework/Constraint/PCREMatch.php';
 171 require_once 'PHPUnit/Framework/Constraint/StringContains.php';
 172 require_once 'PHPUnit/Framework/Constraint/TraversableContains.php';
 173 require_once 'PHPUnit/Framework/Constraint/TraversableContainsOnly.php';
 174 require_once 'PHPUnit/Framework/Constraint/IsTrue.php';
 175 require_once 'PHPUnit/Framework/Constraint/Xor.php';
 176 ?>