tests/PHPUnit/Util/TestDox/NamePrettifier.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     Sebastian Bergmann <sb@sebastian-bergmann.de>
  40  * @copyright  2002-2009 Sebastian Bergmann <sb@sebastian-bergmann.de>
  41  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  42
  43  * @link       http://www.phpunit.de/
  44  * @since      File available since Release 2.3.0
  45  */
  46
  47 require_once 'PHPUnit/Util/Filter.php';
  48
  49 PHPUnit_Util_Filter::addFileToFilter(__FILE__, 'PHPUNIT');
  50
  51 /**
  52  * Prettifies class and method names for use in TestDox documentation.
  53  *
  54  * @category   Testing
  55  * @package    PHPUnit
  56  * @author     Sebastian Bergmann <sb@sebastian-bergmann.de>
  57  * @copyright  2002-2009 Sebastian Bergmann <sb@sebastian-bergmann.de>
  58  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  59  * @version    Release: 3.3.17
  60  * @link       http://www.phpunit.de/
  61  * @since      Class available since Release 2.1.0
  62  */
  63 class PHPUnit_Util_TestDox_NamePrettifier
  64 {
  65     /**
  66      * @var    string
  67      */
  68     protected $prefix = 'Test';
  69
  70     /**
  71      * @var    string
  72      */
  73     protected $suffix = 'Test';
  74
  75     /**
  76      * @var    array
  77      */
  78     protected $strings = array();
  79
  80     /**
  81      * Prettifies the name of a test class.
  82      *
  83      * @param  string  $testClassName
  84      * @return string
  85      */
  86     public function prettifyTestClass($testClassName)
  87     {
  88         $title = $testClassName;
  89
  90         if ($this->suffix !== NULL &&
  91             $this->suffix == substr($testClassName, -1 * strlen($this->suffix))) {
  92             $title = substr($title, 0, strripos($title, $this->suffix));
  93         }
  94
  95         if ($this->prefix !== NULL &&
  96             $this->prefix == substr($testClassName, 0, strlen($this->prefix))) {
  97             $title = substr($title, strlen($this->prefix));
  98         }
  99
 100         return $title;
 101     }
 102
 103     /**
 104      * Prettifies the name of a test method.
 105      *
 106      * @param  string  $testMethodName
 107      * @return string
 108      */
 109     public function prettifyTestMethod($testMethodName)
 110     {
 111         $buffer = '';
 112
 113         if (!is_string($testMethodName) || strlen($testMethodName) == 0) {
 114             return $buffer;
 115         }
 116
 117         $string = preg_replace('#\d+$#', '', $testMethodName);
 118
 119         if (in_array($string, $this->strings)) {
 120             $testMethodName = $string;
 121         } else {
 122             $this->strings[] = $string;
 123         }
 124
 125         $max = strlen($testMethodName);
 126
 127         if (substr($testMethodName, 0, 4) == 'test') {
 128             $offset = 4;
 129         } else {
 130             $offset = 0;
 131             $testMethodName[0] = strtoupper($testMethodName[0]);
 132         }
 133
 134         $wasNumeric = FALSE;
 135
 136         for ($i = $offset; $i < $max; $i++) {
 137             if ($i > $offset &&
 138                 ord($testMethodName[$i]) >= 65 &&
 139                 ord($testMethodName[$i]) <= 90) {
 140                 $buffer .= ' ' . strtolower($testMethodName[$i]);
 141             } else {
 142                 $isNumeric = is_numeric($testMethodName[$i]);
 143
 144                 if (!$wasNumeric && $isNumeric) {
 145                     $buffer .= ' ';
 146                     $wasNumeric = TRUE;
 147                 }
 148
 149                 if ($wasNumeric && !$isNumeric) {
 150                     $wasNumeric = FALSE;
 151                 }
 152
 153                 $buffer .= $testMethodName[$i];
 154             }
 155         }
 156
 157         return $buffer;
 158     }
 159
 160     /**
 161      * Sets the prefix of test names.
 162      *
 163      * @param  string  $prefix
 164      */
 165     public function setPrefix($prefix)
 166     {
 167         $this->prefix = $prefix;
 168     }
 169
 170     /**
 171      * Sets the suffix of test names.
 172      *
 173      * @param  string  $prefix
 174      */
 175     public function setSuffix($suffix)
 176     {
 177         $this->suffix = $suffix;
 178     }
 179 }
 180 ?>