tests/PHPUnit/Extensions/Database/DataSet/CsvDataSet.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/Util/Filter.php';
  48
  49 require_once 'PHPUnit/Extensions/Database/DataSet/AbstractDataSet.php';
  50 require_once 'PHPUnit/Extensions/Database/DataSet/DefaultTableIterator.php';
  51 require_once 'PHPUnit/Extensions/Database/DataSet/DefaultTable.php';
  52 require_once 'PHPUnit/Extensions/Database/DataSet/DefaultTableMetaData.php';
  53
  54 PHPUnit_Util_Filter::addFileToFilter(__FILE__, 'PHPUNIT');
  55
  56 /**
  57  * Creates CsvDataSets.
  58  *
  59  * You can incrementally add CSV files as tables to your datasets
  60  *
  61  * @category   Testing
  62  * @package    PHPUnit
  63  * @author     Mike Lively <m@digitalsandwich.com>
  64  * @copyright  2009 Mike Lively <m@digitalsandwich.com>
  65  * @license    http://www.opensource.org/licenses/bsd-license.php  BSD License
  66  * @version    Release: 3.3.17
  67  * @link       http://www.phpunit.de/
  68  * @since      Class available since Release 3.3.0
  69  */
  70 class PHPUnit_Extensions_Database_DataSet_CsvDataSet extends PHPUnit_Extensions_Database_DataSet_AbstractDataSet
  71 {
  72     protected $tables = array();
  73     protected $delimiter = ',';
  74     protected $enclosure = '"';
  75     protected $escape = '"';
  76
  77     /**
  78      * Creates a new CSV dataset
  79      *
  80      * You can pass in the parameters for how csv files will be read.
  81      *
  82      * @param string $delimiter
  83      * @param string $enclosure
  84      * @param string $escape
  85      */
  86     public function __construct($delimiter = ',', $enclosure = '"', $escape = '"')
  87     {
  88         $this->delimiter = $delimiter;
  89         $this->enclosure = $enclosure;
  90         $this->escape = $escape;
  91     }
  92
  93     /**
  94      * Adds a table to the dataset
  95      *
  96      * The table will be given the passed name. $csvFile should be a path to
  97      * a valid csv file (based on the arguments passed to the constructor.)
  98      *
  99      * @param string $tableName
 100      * @param string $csvFile
 101      */
 102     public function addTable($tableName, $csvFile)
 103     {
 104         if (!is_file($csvFile)) {
 105             throw new InvalidArgumentException("Could not find csv file: {$csvFile}");
 106         }
 107
 108         if (!is_readable($csvFile)) {
 109             throw new InvalidArgumentException("Could not read csv file: {$csvFile}");
 110         }
 111
 112         $fh = fopen($csvFile, 'r');
 113         $columns = $this->getCsvRow($fh);
 114
 115         if ($columns === FALSE)
 116         {
 117             throw new InvalidArgumentException("Could not determine the headers from the given file {$csvFile}");
 118         }
 119
 120         $metaData = new PHPUnit_Extensions_Database_DataSet_DefaultTableMetaData($tableName, $columns);
 121         $table = new PHPUnit_Extensions_Database_DataSet_DefaultTable($metaData);
 122
 123         while (($row = $this->getCsvRow($fh)) !== FALSE)
 124         {
 125             $table->addRow(array_combine($columns, $row));
 126         }
 127
 128         $this->tables[$tableName] = $table;
 129     }
 130
 131     /**
 132      * Creates an iterator over the tables in the data set. If $reverse is
 133      * true a reverse iterator will be returned.
 134      *
 135      * @param bool $reverse
 136      * @return PHPUnit_Extensions_Database_DataSet_ITableIterator
 137      */
 138     protected function createIterator($reverse = FALSE)
 139     {
 140         return new PHPUnit_Extensions_Database_DataSet_DefaultTableIterator($this->tables, $reverse);
 141     }
 142
 143     /**
 144      * Returns a row from the csv file in an indexed array.
 145      *
 146      * @param resource $fh
 147      * @return array
 148      */
 149     protected function getCsvRow($fh)
 150     {
 151         if (version_compare(PHP_VERSION, '5.3.0', '>')) {
 152             return fgetcsv($fh, NULL, $this->delimiter, $this->enclosure, $this->escape);
 153         } else {
 154             return fgetcsv($fh, NULL, $this->delimiter, $this->enclosure);
 155         }
 156     }
 157 }
 158 ?>