tests/PHPUnit/Extensions/Database/DataSet/AbstractTable.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     Mike Lively <m@digitalsandwich.com>
  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 3.2.0
  45  */
  46
  47 require_once 'PHPUnit/Framework.php';
  48 require_once 'PHPUnit/Util/Filter.php';
  49
  50 require_once 'PHPUnit/Extensions/Database/DataSet/ITable.php';
  51
  52 PHPUnit_Util_Filter::addFileToFilter(__FILE__, 'PHPUNIT');
  53
  54 /**
  55  * Provides a basic functionality for dbunit tables
  56  *
  57  * @category   Testing
  58  * @package    PHPUnit
  59  * @author     Mike Lively <m@digitalsandwich.com>
  60  * @copyright  2009 Mike Lively <m@digitalsandwich.com>
  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.2.0
  65  */
  66 class PHPUnit_Extensions_Database_DataSet_AbstractTable implements PHPUnit_Extensions_Database_DataSet_ITable
  67 {
  68
  69     /**
  70      * @var PHPUnit_Extensions_Database_DataSet_ITableMetaData
  71      */
  72     protected $tableMetaData;
  73
  74     /**
  75      * A 2-dimensional array containing the data for this table.
  76      *
  77      * @var array
  78      */
  79     protected $data;
  80
  81     /**
  82      * Sets the metadata for this table.
  83      *
  84      * @param PHPUnit_Extensions_Database_DataSet_ITableMetaData $tableMetaData
  85      * @deprecated
  86      */
  87     protected function setTableMetaData(PHPUnit_Extensions_Database_DataSet_ITableMetaData $tableMetaData)
  88     {
  89         $this->tableMetaData = $tableMetaData;
  90     }
  91
  92     /**
  93      * Returns the table's meta data.
  94      *
  95      * @return PHPUnit_Extensions_Database_DataSet_ITableMetaData
  96      */
  97     public function getTableMetaData()
  98     {
  99         return $this->tableMetaData;
 100     }
 101
 102     /**
 103      * Returns the number of rows in this table.
 104      *
 105      * @return int
 106      */
 107     public function getRowCount()
 108     {
 109         return count($this->data);
 110     }
 111
 112     /**
 113      * Returns the value for the given column on the given row.
 114      *
 115      * @param int $row
 116      * @param int $column
 117      * @todo reorganize this function to throw the exception first.
 118      */
 119     public function getValue($row, $column)
 120     {
 121         if (isset($this->data[$row][$column])) {
 122             return (string)$this->data[$row][$column];
 123         } else {
 124             if (!in_array($column, $this->getTableMetaData()->getColumns()) || $this->getRowCount() <= $row) {
 125                 throw new InvalidArgumentException("The given row ({$row}) and column ({$column}) do not exist in table {$this->getTableMetaData()->getTableName()}");
 126             } else {
 127                 return NULL;
 128             }
 129         }
 130     }
 131
 132     /**
 133      * Returns the an associative array keyed by columns for the given row.
 134      *
 135      * @param int $row
 136      * @return array
 137      */
 138     public function getRow($row)
 139     {
 140         if (isset($this->data[$row])) {
 141             return $this->data[$row];
 142         } else {
 143             if ($this->getRowCount() <= $row) {
 144                 throw new InvalidArgumentException("The given row ({$row}) does not exist in table {$this->getTableMetaData()->getTableName()}");
 145             } else {
 146                 return NULL;
 147             }
 148         }
 149     }
 150
 151     /**
 152      * Asserts that the given table matches this table.
 153      *
 154      * @param PHPUnit_Extensions_Database_DataSet_ITable $other
 155      */
 156     public function assertEquals(PHPUnit_Extensions_Database_DataSet_ITable $other)
 157     {
 158         $thisMetaData = $this->getTableMetaData();
 159         $otherMetaData = $other->getTableMetaData();
 160
 161         $thisMetaData->assertEquals($otherMetaData);
 162
 163         if ($this->getRowCount() != $other->getRowCount()) {
 164             throw new Exception("Expected row count of {$this->getRowCount()}, has a row count of {$other->getRowCount()}");
 165         }
 166
 167         $columns = $thisMetaData->getColumns();
 168         for ($i = 0; $i < $this->getRowCount(); $i++) {
 169             foreach ($columns as $columnName) {
 170                 if ($this->getValue($i, $columnName) != $other->getValue($i, $columnName)) {
 171                     throw new Exception("Expected value of {$this->getValue($i, $columnName)} for row {$i} column {$columnName}, has a value of {$other->getValue($i, $columnName)}");
 172                 }
 173             }
 174         }
 175
 176         return TRUE;
 177     }
 178
 179     public function __toString()
 180     {
 181         $columns = $this->getTableMetaData()->getColumns();
 182
 183         $lineSeperator = str_repeat('+----------------------', count($columns)) . "+\n";
 184         $lineLength = strlen($lineSeperator) - 1;
 185
 186         $tableString = $lineSeperator;
 187         $tableString .= '| ' . str_pad($this->getTableMetaData()->getTableName(), $lineLength - 4, ' ', STR_PAD_RIGHT) . " |\n";
 188         $tableString .= $lineSeperator;
 189         $tableString .= $this->rowToString($columns);
 190         $tableString .= $lineSeperator;
 191
 192         for ($i = 0; $i < $this->getRowCount(); $i++) {
 193             $values = array();
 194             foreach ($columns as $columnName) {
 195                 $values[] = $this->getValue($i, $columnName);
 196             }
 197
 198             $tableString .= $this->rowToString($values);
 199             $tableString .= $lineSeperator;
 200         }
 201
 202         return "\n" . $tableString . "\n";
 203     }
 204
 205     protected function rowToString(Array $row)
 206     {
 207         $rowString = '';
 208         foreach ($row as $value) {
 209             if (is_null($value)) {
 210                 $value = 'NULL';
 211             }
 212             $rowString .= '| ' . str_pad(substr($value, 0, 20), 20, ' ', STR_PAD_BOTH) . ' ';
 213         }
 214
 215         return $rowString . "|\n";
 216     }
 217 }
 218 ?>