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