tests/PHPUnit/PHPUnit/Framework/Constraint/StringMatches.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_Constraint
  39  * @author     Sebastian Bergmann <sebastian@phpunit.de>
  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.5.0
  44  */
  45
  46 /**
  47  * ...
  48  *
  49  * @package    PHPUnit
  50  * @subpackage Framework_Constraint
  51  * @author     Sebastian Bergmann <sebastian@phpunit.de>
  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.5.14
  55  * @link       http://www.phpunit.de/
  56  * @since      Class available since Release 3.5.0
  57  */
  58 class PHPUnit_Framework_Constraint_StringMatches extends PHPUnit_Framework_Constraint_PCREMatch
  59 {
  60     /**
  61      * @var string
  62      */
  63     protected $string;
  64
  65     /**
  66      * @param string $string
  67      */
  68     public function __construct($string)
  69     {
  70         $this->pattern = preg_quote(preg_replace('/\r\n/', "\n", $string), '/');
  71         $this->pattern = str_replace(
  72           array(
  73             '%e',
  74             '%s',
  75             '%S',
  76             '%a',
  77             '%A',
  78             '%w',
  79             '%i',
  80             '%d',
  81             '%x',
  82             '%f',
  83             '%c'
  84           ),
  85           array(
  86             '\\' . DIRECTORY_SEPARATOR,
  87             '[^\r\n]+',
  88             '[^\r\n]*',
  89             '.+',
  90             '.*',
  91             '\s*',
  92             '[+-]?\d+',
  93             '\d+',
  94             '[0-9a-fA-F]+',
  95             '[+-]?\.?\d+\.?\d*(?:[Ee][+-]?\d+)?',
  96             '.'
  97           ),
  98           $this->pattern
  99         );
 100
 101         $this->pattern = '/^' . $this->pattern . '$/s';
 102         $this->string  = $string;
 103     }
 104
 105     /**
 106      * Creates the appropriate exception for the constraint which can be caught
 107      * by the unit test system. This can be called if a call to evaluate()
 108      * fails.
 109      *
 110      * @param   mixed   $other The value passed to evaluate() which failed the
 111      *                         constraint check.
 112      * @param   string  $description A string with extra description of what was
 113      *                               going on while the evaluation failed.
 114      * @param   boolean $not Flag to indicate negation.
 115      * @throws  PHPUnit_Framework_ExpectationFailedException
 116      */
 117     public function fail($other, $description, $not = FALSE)
 118     {
 119         $failureDescription = $this->failureDescription(
 120           $other,
 121           $description,
 122           $not
 123         );
 124
 125         if (!$not) {
 126             throw new PHPUnit_Framework_ExpectationFailedException(
 127               $failureDescription,
 128               PHPUnit_Framework_ComparisonFailure::diffEqual(
 129                 $this->string, $other
 130               ),
 131               $description
 132             );
 133         } else {
 134             throw new PHPUnit_Framework_ExpectationFailedException(
 135               $failureDescription,
 136               NULL
 137             );
 138         }
 139     }
 140 }