tests/PHPUnit/Framework/Constraint/Xor.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 require_once 'PHPUnit/Util/Type.php';
  51
  52 PHPUnit_Util_Filter::addFileToFilter(__FILE__, 'PHPUNIT');
  53
  54 /**
  55  * Logical XOR.
  56  *
  57  * @category   Testing
  58  * @package    PHPUnit
  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_Constraint_Xor extends PHPUnit_Framework_Constraint
  67 {
  68     protected $constraints = array();
  69
  70     public function setConstraints(array $constraints)
  71     {
  72         $this->constraints = array();
  73
  74         foreach($constraints as $key => $constraint) {
  75             if (!($constraint instanceof PHPUnit_Framework_Constraint)) {
  76                 $constraint = new PHPUnit_Framework_Constraint_IsEqual($constraint);
  77             }
  78
  79             $this->constraints[] = $constraint;
  80         }
  81     }
  82
  83     /**
  84      * Evaluates the constraint for parameter $other. Returns TRUE if the
  85      * constraint is met, FALSE otherwise.
  86      *
  87      * @param mixed $other Value or object to evaluate.
  88      * @return bool
  89      */
  90     public function evaluate($other)
  91     {
  92         $result = FALSE;
  93
  94         foreach($this->constraints as $constraint) {
  95             if ($constraint->evaluate($other)) {
  96                 if ( $result )
  97                 {
  98                     return FALSE;
  99                 }
 100
 101                 $result = TRUE;
 102             }
 103         }
 104
 105         return $result;
 106     }
 107
 108     /**
 109      * @param   mixed   $other The value passed to evaluate() which failed the
 110      *                         constraint check.
 111      * @param   string  $description A string with extra description of what was
 112      *                               going on while the evaluation failed.
 113      * @param   boolean $not Flag to indicate negation.
 114      * @throws  PHPUnit_Framework_ExpectationFailedException
 115      */
 116     public function fail($other, $description, $not = FALSE)
 117     {
 118         throw new PHPUnit_Framework_ExpectationFailedException(
 119           sprintf(
 120             'Failed asserting that %s.',
 121
 122              $this->toString(),
 123              NULL,
 124              $description
 125           )
 126         );
 127     }
 128
 129     /**
 130      * Returns a string representation of the constraint.
 131      *
 132      * @return string
 133      */
 134     public function toString()
 135     {
 136         $text = '';
 137
 138         foreach($this->constraints as $key => $constraint) {
 139             if ($key > 0) {
 140                 $text .= ' xor ';
 141             }
 142
 143             $text .= $constraint->toString();
 144         }
 145
 146         return $text;
 147     }
 148 }
 149 ?>