Semantic versioning: Marked the current state of the repo as 1.0.0-rc.1

yielded different sort orders (that's sort of ok, as rating is ambiguous).

See https://travis-ci.org/parsecsv/parsecsv-for-php/jobs/336540118

.editorconfig

@@ -0,0 +1,15 @@
+# @see http://editorconfig.org/
+
+# This is the top-most .editorconfig file; do not search in parent directories.
+root = true
+
+# All files.
+[*]
+indent_style = space
+indent_size = 4
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[composer.json]
+indent_size = 4

.gitignore

@@ -1,2 +1,6 @@
+*.bak
+/.idea
+/phive.xml
+/tools
+composer.lock
 vendor/
-composer.lock

.travis.yml

@@ -0,0 +1,18 @@
+language: php
+
+php:
+  - 7.2
+  - 7.1
+  - 7.0
+  - 5.6
+  - 5.5
+  - 5.4
+
+script:
+  - phpunit --configuration tests/phpunit.xml
+
+notifications:
+  email:
+    - will.knauss@gmail.com
+  on_success: never
+  on_failure: always

ChangeLog.txt

@@ -1,3 +1,23 @@
+ParseCsvForPhp 1.0.0-rc.1
+-----------------------------------
+Date: unreleased
+
+- Renamed class from parseCSV to ParseCsvForPhp
+
+- Added support for MS Excel's "sep=" to detect the
+  delimiter (Issue #60).
+
+- MIME: output() sends correct MIME type to browser
+  if the separator is a tab tab (Issue #79)
+
+- Added support for mb_convert_encoding() instead of
+  iconv() (Issue #109)
+
+- A number of minor bug fixes - see GitHub issues
+
+-----------------------------------
+
+
 parseCSV 0.4.3 beta
 -----------------------------------
 Date: 1-July-2008
@@ -10,7 +30,7 @@ Date: 1-July-2008
 - Issue #6. Raw loaded file data is now cleared from
   file_data property when it has been successfully
   parsed to keep parseCSV's memory footprint to a
-  minimum. Specifically handy when using mulitple
+  minimum. Specifically handy when using multiple
   instances of parseCSV to process large files.
 
 -----------------------------------
@@ -159,7 +179,7 @@ Date: 2-Jan-2007
 
 - Added auto() function to automatically detect
   delimiter character.
-  Useful for user upload incase delimiter is
+  Useful for user upload in case delimiter is
   comma (,), tab, or semi-colon (;). Some
   versions of MS Excel for Windows use
   semi-colons instead of commas when saving to
@@ -170,7 +190,7 @@ Date: 2-Jan-2007
   almost no matter what the delimiter is.
 
 - Generally updated some of the core workings
-  to increase performance, and offer better 
+  to increase performance, and offer better
   support for large (1MB and up) files.
 
 - Added code examples to header comment.

Makefile

@@ -0,0 +1,15 @@
+COMPOSER_BIN_DIR := vendor/bin
+PHPUNIT_ARGS = -c tests/phpunit.xml
+
+test: phpunit-dep
+	${COMPOSER_BIN_DIR}/phpunit ${PHPUNIT_ARGS}
+
+phpunit-dep:
+	test -f ${COMPOSER_BIN_DIR}/phpunit || ( \
+		echo "phpunit is required to run tests." \
+			"Please run: composer install" >&2 && \
+		exit 1 \
+	)
+
+.SILENT:
+.PHONY: test phpunit-dep

README.md

@@ -1,22 +1,30 @@
-# parseCSV
+# ParseCsvForPhp
 
-Note: parseCSV is now being revised to PHP 5 standards. If you have an issue or a feature request we encourage you to open an issue.
-
-parseCSV is an easy to use PHP class that reads and writes CSV data properly. It
+This is an easy-to-use PHP class that reads and writes CSV data properly. It
 fully conforms to the specifications outlined on the on the
-[Wikipedia article][CSV]. It has many advanced features which help make your
+[Wikipedia article][CSV] (and thus RFC 4180). It has many advanced features which help make your
 life easier when dealing with CSV data.
 
-This library was originaly created in early 2007 by [jimeh](https://github.com/jimeh) due to the lack of built-in
+You may not need a library at all: before using ParseCsvForPhp, please make sure if PHP's own `str_getcsv()`, ``fgetcvs()`` or `fputcsv()` meets your needs.
+
+This library was originally created in early 2007 by [jimeh](https://github.com/jimeh) due to the lack of built-in
 and third-party support for handling CSV data in PHP.
 
 [csv]: http://en.wikipedia.org/wiki/Comma-separated_values
 
+## Installation
+Installation is easy using Composer. Include the following in your composer.json
+```
+"parsecsv/php-parsecsv": "1.0.0"
+```
+
+You may also manually include the ParseCsvForPhp.php file
+```php
+require_once 'ParseCsvForPhp.php';
+```
 
 ## Features
 
-* parseCSV is the only complete and fully featured CSV solution for PHP (as
-  far as I know).
 * Supports enclosed values, enclosed commas, double quotes and new lines.
 * Automatic delimiter character detection.
 * Sort data by specific fields/columns.
@@ -26,9 +34,10 @@ and third-party support for handling CSV data in PHP.
 * Error detection for incorrectly formatted input. It attempts to be
   intelligent, but can not be trusted 100% due to the structure of CSV, and
   how different programs like Excel for example outputs CSV data.
-* Support for character encoding conversion using PHP's _iconv_ function
-  (requires PHP 5).
-* Supports both PHP 4 & 5.
+* Support for character encoding conversion using PHP's 
+  `iconv()` and `mb_convert_encoding()` functions (requires PHP 5).
+* Supports PHP 5.4 and higher. 
+  It certainly works with PHP 7.2 and all versions in between.
 
 
 ## Example Usage
@@ -36,14 +45,14 @@ and third-party support for handling CSV data in PHP.
 **General**
 
 ```php
-$csv = new parseCSV('data.csv');
+$csv = new ParseCsvForPhp('data.csv');
 print_r($csv->data);
 ```
 
 **Tab delimited, and encoding conversion**
 
 ```php
-$csv = new parseCSV();
+$csv = new ParseCsvForPhp();
 $csv->encoding('UTF-16', 'UTF-8');
 $csv->delimiter = "\t";
 $csv->parse('data.tsv');
@@ -53,7 +62,7 @@ print_r($csv->data);
 **Auto-detect delimiter character**
 
 ```php
-$csv = new parseCSV();
+$csv = new ParseCsvForPhp();
 $csv->auto('data.csv');
 print_r($csv->data);
 ```
@@ -61,7 +70,7 @@ print_r($csv->data);
 **Modify data in a CSV file**
 
 ```php
-$csv = new parseCSV();
+$csv = new ParseCsvForPhp();
 $csv->sort_by = 'id';
 $csv->parse('data.csv');
 # "4" is the value of the "id" column of the CSV row
@@ -69,27 +78,36 @@ $csv->data[4] = array('firstname' => 'John', 'lastname' => 'Doe', 'email' => 'jo
 $csv->save();
 ```
 
-**Add row/entry to end of CSV file**
-
-_Only recommended when you know the extact sctructure of the file._
+**Replace field names or set ones if missing**
 
 ```php
-$csv = new parseCSV();
-$csv->save('data.csv', array('1986', 'Home', 'Nowhere', ''), true);
+$csv = new ParseCsvForPhp();
+$csv->fields = ['id', 'name', 'category']
+$csv->parse('data.csv');
 ```
 
-**Convert 2D array to csv data and send headers to browser to treat output as
+**Add row/entry to end of CSV file**
+
+_Only recommended when you know the exact structure of the file._
+
+```php
+$csv = new ParseCsvForPhp();
+$csv->save('data.csv', array(array('1986', 'Home', 'Nowhere', '')), true);
+```
+
+**Convert 2D array to CSV data and send headers to browser to treat output as
 a file and download it**
 
 ```php
-$csv = new parseCSV();
+$csv = new ParseCsvForPhp();
 $csv->output('movies.csv', $array, array('field 1', 'field 2'), ',');
 ```
 
+For more complex examples, see the ``tests`` and `examples` directories. 
 
 ## Credits
 
-* parseCSV is based on the concept of [Ming Hong Ng][ming]'s [CsvFileParser][]
+* ParseCsvForPhp is based on the concept of [Ming Hong Ng][ming]'s [CsvFileParser][]
   class.
 
 [ming]: http://minghong.blogspot.com/

composer.json

@@ -6,10 +6,16 @@
         {
             "name": "Jim Myhrberg",
             "email": "contact@jimeh.me"
+        },
+        {
+            "name": "William Knauss",
+            "email": "will.knauss@gmail.com"
         }
     ],
     "autoload": {
-        "classmap": ["."]
+        "classmap": [
+            "."
+        ]
     },
     "require-dev": {
         "phpunit/phpunit": "4.1.*"

examples/basic.php

@@ -2,12 +2,12 @@
 <?php
 
 
-# include parseCSV class.
-require_once('../parsecsv.lib.php');
+# include ParseCsvForPhp class.
+require_once('../ParseCsvForPhp.php');
 
 
-# create new parseCSV object.
-$csv = new parseCSV();
+# create new object.
+$csv = new ParseCsvForPhp();
 
 
 # Parse '_books.csv' using automatic delimiter detection...
@@ -28,21 +28,29 @@ $csv->auto('_books.csv');
 ?>
 </pre>
 <style type="text/css" media="screen">
-	table { background-color: #BBB; }
-	th { background-color: #EEE; }
-	td { background-color: #FFF; }
+    table {
+        background-color: #BBB;
+    }
+
+    th {
+        background-color: #EEE;
+    }
+
+    td {
+        background-color: #FFF;
+    }
 </style>
 <table border="0" cellspacing="1" cellpadding="3">
-	<tr>
-		<?php foreach ($csv->titles as $value): ?>
-		<th><?php echo $value; ?></th>
-		<?php endforeach; ?>
-	</tr>
-	<?php foreach ($csv->data as $key => $row): ?>
-	<tr>
-		<?php foreach ($row as $value): ?>
-		<td><?php echo $value; ?></td>
-		<?php endforeach; ?>
-	</tr>
-	<?php endforeach; ?>
+    <tr>
+        <?php foreach ($csv->titles as $value): ?>
+            <th><?php echo $value; ?></th>
+        <?php endforeach; ?>
+    </tr>
+    <?php foreach ($csv->data as $key => $row): ?>
+        <tr>
+            <?php foreach ($row as $value): ?>
+                <td><?php echo $value; ?></td>
+            <?php endforeach; ?>
+        </tr>
+    <?php endforeach; ?>
 </table>

examples/conditions.php

@@ -2,12 +2,12 @@
 <?php
 
 
-# include parseCSV class.
-require_once('../parsecsv.lib.php');
+# include ParseCsvForPhp class.
+require_once('../ParseCsvForPhp.php');
 
 
-# create new parseCSV object.
-$csv = new parseCSV();
+# create new object.
+$csv = new ParseCsvForPhp();
 
 
 # Example conditions:
@@ -28,21 +28,29 @@ $csv->auto('_books.csv');
 ?>
 </pre>
 <style type="text/css" media="screen">
-	table { background-color: #BBB; }
-	th { background-color: #EEE; }
-	td { background-color: #FFF; }
+    table {
+        background-color: #BBB;
+    }
+
+    th {
+        background-color: #EEE;
+    }
+
+    td {
+        background-color: #FFF;
+    }
 </style>
 <table border="0" cellspacing="1" cellpadding="3">
-	<tr>
-		<?php foreach ($csv->titles as $value): ?>
-		<th><?php echo $value; ?></th>
-		<?php endforeach; ?>
-	</tr>
-	<?php foreach ($csv->data as $key => $row): ?>
-	<tr>
-		<?php foreach ($row as $value): ?>
-		<td><?php echo $value; ?></td>
-		<?php endforeach; ?>
-	</tr>
-	<?php endforeach; ?>
-</table>
+    <tr>
+        <?php foreach ($csv->titles as $value): ?>
+            <th><?php echo $value; ?></th>
+        <?php endforeach; ?>
+    </tr>
+    <?php foreach ($csv->data as $key => $row): ?>
+        <tr>
+            <?php foreach ($row as $value): ?>
+                <td><?php echo $value; ?></td>
+            <?php endforeach; ?>
+        </tr>
+    <?php endforeach; ?>
+</table>

examples/download.php

@@ -1,12 +1,12 @@
 <?php
 
 
-# include parseCSV class.
-require_once('../parsecsv.lib.php');
+# include ParseCsvForPhp class.
+require_once('../ParseCsvForPhp.php');
 
 
-# create new parseCSV object.
-$csv = new parseCSV();
+# create new object.
+$csv = new ParseCsvForPhp();
 
 
 # Parse '_books.csv' using automatic delimiter detection...
@@ -31,4 +31,4 @@ $csv->output('books.csv');
 # or is set to null, output will only return the generated CSV
 # output data, and will not output to the browser itself.
 
-?>
+?>

examples/limit.php

@@ -2,12 +2,12 @@
 <?php
 
 
-# include parseCSV class.
-require_once('../parsecsv.lib.php');
+# include class.
+require_once('../ParseCsvForPhp.php');
 
 
-# create new parseCSV object.
-$csv = new parseCSV();
+# create new object.
+$csv = new ParseCsvForPhp();
 
 
 # if sorting is enabled, the whole CSV file
@@ -41,21 +41,29 @@ $csv->auto('_books.csv');
 ?>
 </pre>
 <style type="text/css" media="screen">
-	table { background-color: #BBB; }
-	th { background-color: #EEE; }
-	td { background-color: #FFF; }
+    table {
+        background-color: #BBB;
+    }
+
+    th {
+        background-color: #EEE;
+    }
+
+    td {
+        background-color: #FFF;
+    }
 </style>
 <table border="0" cellspacing="1" cellpadding="3">
-	<tr>
-		<?php foreach ($csv->titles as $value): ?>
-		<th><?php echo $value; ?></th>
-		<?php endforeach; ?>
-	</tr>
-	<?php foreach ($csv->data as $key => $row): ?>
-	<tr>
-		<?php foreach ($row as $value): ?>
-		<td><?php echo $value; ?></td>
-		<?php endforeach; ?>
-	</tr>
-	<?php endforeach; ?>
-</table>
+    <tr>
+        <?php foreach ($csv->titles as $value): ?>
+            <th><?php echo $value; ?></th>
+        <?php endforeach; ?>
+    </tr>
+    <?php foreach ($csv->data as $key => $row): ?>
+        <tr>
+            <?php foreach ($row as $value): ?>
+                <td><?php echo $value; ?></td>
+            <?php endforeach; ?>
+        </tr>
+    <?php endforeach; ?>
+</table>

tests/Bootstrap.php

@@ -0,0 +1,13 @@
+<?php
+
+$dir = realpath(__DIR__);
+defined('BASE') OR define('BASE', dirname($dir) . '/');
+
+require_once BASE . 'ParseCsvForPhp.php';
+
+if (!class_exists('PHPUnit\Framework\TestCase')) {
+    // we run on an older PHPUnit version without namespaces.
+    require_once __DIR__ . '/PHPUnit_Framework_TestCase.inc.php';
+}
+
+require_once BASE . 'tests/properties/BaseClass.php';

tests/PHPUnit_Framework_TestCase.inc.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace PHPUnit\Framework;
+
+// Only needed to keep unit test code compatible with older PHPUnit versions
+
+/** @noinspection PhpUndefinedClassInspection */
+/** @noinspection AutoloadingIssuesInspection */
+class TestCase extends \PHPUnit_Framework_TestCase {
+
+}

tests/example_files/UTF-8_sep_row_but_no_BOM.csv

@@ -0,0 +1,5 @@
+sep=;
+title;isbn;publishedAt
+Красивая кулинария;5454-5587-3210;21.05.2011
+The Wine Connoisseurs;2547-8548-2541;12.12.2011
+Weißwein;1313-4545-8875;23.02.2012

tests/example_files/UTF-8_with_BOM_and_sep_row.csv

@@ -0,0 +1,5 @@
+sep=;
+title;isbn;publishedAt
+Красивая кулинария;5454-5587-3210;21.05.2011
+The Wine Connoisseurs;2547-8548-2541;12.12.2011
+Weißwein;1313-4545-8875;23.02.2012

tests/example_files/auto-double-enclosure.csv

@@ -0,0 +1,3 @@
+"column1","column2"
+"value1","value2"
+"value3","value4"

tests/example_files/auto-single-enclosure.csv

@@ -0,0 +1,3 @@
+'column1','column2'
+'value1','value2'
+'value3','value4'

tests/example_files/single_column.csv

@@ -0,0 +1,5 @@
+SMS
+0444
+5555
+6606
+7777

tests/methods/ConstructTest.php

@@ -0,0 +1,45 @@
+<?php
+
+class ConstructTest extends PHPUnit\Framework\TestCase {
+
+    /**
+     * @access protected
+     * @var ParseCsvForPhp object
+     */
+    protected $csv = null;
+
+    public function test_offset_param() {
+        $offset = 10;
+        $this->csv = new ParseCsvForPhp(null, $offset);
+        $this->assertTrue(is_numeric($this->csv->offset));
+        $this->assertEquals($offset, $this->csv->offset);
+    }
+
+    public function test_limit_param() {
+        $limit = 10;
+        $this->csv = new ParseCsvForPhp(null, null, $limit);
+        $this->assertTrue(is_numeric($this->csv->limit));
+        $this->assertEquals($limit, $this->csv->limit);
+    }
+
+    public function test_conditions_param() {
+        $conditions = 'some column NOT value';
+        $this->csv = new ParseCsvForPhp(null, null, null, $conditions);
+        $this->assertTrue(is_string($this->csv->conditions));
+        $this->assertEquals($conditions, $this->csv->conditions);
+    }
+
+    public function test_keep_file_data_param() {
+        $keep = true;
+        $this->csv = new ParseCsvForPhp(null, null, null, null, $keep);
+        $this->assertTrue(is_bool($this->csv->keep_file_data));
+        $this->assertEquals($keep, $this->csv->keep_file_data);
+    }
+
+    public function test_input_param() {
+        $csv = "col1,col2,col3\r\nval1,val2,val3\r\nval1A,val2A,val3A\r\n";
+        $this->csv = new ParseCsvForPhp($csv, null, null, null, true);
+        $this->assertTrue(is_string($this->csv->file_data));
+        $this->assertEquals($csv, $this->csv->file_data);
+    }
+}

tests/methods/ParseTest.php

@@ -0,0 +1,169 @@
+<?php
+
+class ParseTest extends PHPUnit\Framework\TestCase {
+
+    /**
+     * @access protected
+     * @var ParseCsvForPhp
+     */
+    protected $csv;
+
+    /**
+     * Setup
+     * Setup our test environment objects
+     *
+     * @access public
+     */
+    public function setUp() {
+        $this->csv = new ParseCsvForPhp();
+    }
+
+    public function test_parse() {
+        // can we trick 'is_readable' into whining? See #67.
+        $this->parse_repetitive_string('c:/looks/like/a/path');
+        $this->parse_repetitive_string('http://looks/like/an/url');
+    }
+
+    private function parse_repetitive_string($content) {
+        $this->csv->delimiter = ';';
+        $this->csv->heading = false;
+        $success = $this->csv->parse(str_repeat($content . ';', 500));
+        $this->assertEquals(true, $success);
+
+        $row = array_pop($this->csv->data);
+        $expected_data = array_fill(0, 500, $content);
+        $expected_data [] = '';
+        $this->assertEquals($expected_data, $row);
+    }
+
+    public function test_sep_row_auto_detection_UTF8_no_BOM() {
+        $this->_autoparse_magazine_file(
+            __DIR__ . '/../example_files/UTF-8_sep_row_but_no_BOM.csv');
+    }
+
+    public function testSingleColumnWithZeros() {
+        $this->csv->delimiter = null;
+        $this->csv->parse("URL\nhttp://www.amazon.com/ROX-Ice-Ball-Maker-Original/dp/B00MX59NMQ/ref=sr_1_1?ie=UTF8&qid=1435604374&sr=8-1&keywords=rox,+ice+molds");
+        $row = array_pop($this->csv->data);
+        $expected_data = ['URL' => 'http://www.amazon.com/ROX-Ice-Ball-Maker-Original/dp/B00MX59NMQ/ref=sr_1_1?ie=UTF8&qid=1435604374&sr=8-1&keywords=rox,+ice+molds'];
+        $this->assertEquals($expected_data, $row);
+    }
+
+    public function testAllNumericalCsv() {
+        $this->csv->heading = false;
+        $sInput = "86545235689\r\n34365587654\r\n13469874576";
+        $this->assertEquals(false, $this->csv->auto($sInput));
+        $this->assertEquals(null, $this->csv->delimiter);
+        $expected_data = explode("\r\n", $sInput);
+        $actual_data = array_map('reset', $this->csv->data);
+        $this->assertEquals($expected_data, $actual_data);
+    }
+
+    public function testMissingEndingLineBreak() {
+        $this->csv->heading = false;
+        $this->csv->enclosure = '"';
+        $sInput = "86545235689,a\r\n34365587654,b\r\n13469874576,\"c\r\nd\"";
+        $expected_data = [86545235689, 34365587654, 13469874576];
+        $actual_data = $this->csv->parse_string($sInput);
+        $actual_column = array_map('reset', $actual_data);
+        $this->assertEquals($expected_data, $actual_column);
+        $this->assertEquals([
+            'a',
+            'b',
+            "c\r\nd",
+        ], array_map('next', $actual_data));
+    }
+
+    public function test_sep_row_auto_detection_UTF8() {
+        $this->_autoparse_magazine_file(
+            __DIR__ . '/../example_files/UTF-8_with_BOM_and_sep_row.csv');
+    }
+
+    public function test_sep_row_auto_detection_UTF16() {
+        $this->_autoparse_magazine_file(
+            __DIR__ . '/../example_files/UTF-16LE_with_BOM_and_sep_row.csv');
+    }
+
+    protected function _autoparse_magazine_file($file) {
+        // This file (parse_test.php) is encoded in UTF-8, hence comparison will
+        // fail unless we to this:
+        $this->csv->output_encoding = 'UTF-8';
+
+        $this->csv->auto($file);
+        $this->assertEquals($this->_get_magazines_data(), $this->csv->data);
+    }
+
+    public function test_single_column() {
+        $this->csv->auto(__DIR__ . '/../example_files/single_column.csv');
+        $expected = [
+            ['SMS' => '0444'],
+            ['SMS' => '5555'],
+            ['SMS' => '6606'],
+            ['SMS' => '7777'],
+        ];
+        $this->assertEquals($expected, $this->csv->data);
+    }
+
+    public function test_Piwik_data() {
+        if (!function_exists('array_column')) {
+            // function only available in PHP >= 5.5
+            return;
+        }
+        $this->csv->use_mb_convert_encoding = true;
+        $this->csv->output_encoding = 'UTF-8';
+        $this->csv->auto(__DIR__ . '/../example_files/Piwik_API_download.csv');
+        $aAction27 = array_column($this->csv->data, 'url (actionDetails 27)');
+        $this->assertEquals([
+            'http://application/_Main/_GraphicMeanSTD_MDI/btnConfBandOptions',
+            '',
+            '',
+        ], $aAction27);
+
+        $aCity = array_column($this->csv->data, 'city');
+        $this->assertEquals([
+            'São Paulo',
+            'Johannesburg',
+            '',
+        ], $aCity);
+    }
+
+    protected function _get_magazines_data() {
+        return [
+            [
+                'title' => 'Красивая кулинария',
+                'isbn' => '5454-5587-3210',
+                'publishedAt' => '21.05.2011',
+            ],
+            [
+                'title' => 'The Wine Connoisseurs',
+                'isbn' => '2547-8548-2541',
+                'publishedAt' => '12.12.2011',
+            ],
+            [
+                'title' => 'Weißwein',
+                'isbn' => '1313-4545-8875',
+                'publishedAt' => '23.02.2012',
+            ],
+        ];
+    }
+
+    public function autoQuotesDataProvider() {
+        return array(
+            array('auto-double-enclosure.csv', '"'),
+            array('auto-single-enclosure.csv', "'"),
+        );
+    }
+
+    /**
+     * @dataProvider autoQuotesDataProvider
+     *
+     * @param string $file
+     * @param string $enclosure
+     */
+    public function testAutoQuotes($file, $enclosure) {
+        $csv = new ParseCsvForPhp();
+        $csv->auto(__DIR__ . '/../example_files/' . $file, true, null, null, $enclosure);
+        $this->assertArrayHasKey('column1', $csv->data[0], 'Data parsed incorrectly with enclosure ' . $enclosure);
+        $this->assertEquals('value1', $csv->data[0]['column1'], 'Data parsed incorrectly with enclosure ' . $enclosure);
+    }
+}

tests/methods/SaveTest.php

@@ -0,0 +1,65 @@
+<?php
+
+class SaveTest extends PHPUnit\Framework\TestCase {
+
+    /** @var ParseCsvForPhp */
+    private $csv;
+
+    private $temp_filename;
+
+    /**
+     * Setup our test environment objects; will be called before each test.
+     */
+    public function setUp() {
+        $this->csv = new ParseCsvForPhp();
+        $this->csv->auto(__DIR__ . '/../example_files/single_column.csv');
+
+        // Remove last 2 lines to simplify comparison
+        unset($this->csv->data[2], $this->csv->data[3]);
+
+        $temp_dir = str_replace("\\", '/', sys_get_temp_dir());
+        if (substr($temp_dir, -1) != '/') {
+            // From the PHP.net documentation:
+            // This function does not always add trailing slash. This behaviour
+            // is inconsistent across systems.
+            $temp_dir .= '/';
+        }
+        $this->temp_filename = $temp_dir . 'parsecsv_test_file.csv';
+    }
+
+    public function testSaveWithDefaultSettings() {
+        $expected = "SMS\r0444\r5555\r";
+        $this->saveAndCompare($expected);
+    }
+
+    public function testSaveWithDosLineEnding() {
+        $this->csv->linefeed = "\r\n";
+        $expected = "SMS\r\n0444\r\n5555\r\n";
+        $this->saveAndCompare($expected);
+    }
+
+    public function testSaveWithUnixLineEnding() {
+        $this->csv->linefeed = "\n";
+        $expected = "SMS\n0444\n5555\n";
+        $this->saveAndCompare($expected);
+    }
+
+    public function testSaveWithoutHeader() {
+        $this->csv->linefeed = "\n";
+        $this->csv->heading = false;
+        $expected = "0444\n5555\n";
+        $this->saveAndCompare($expected);
+    }
+
+    public function testAllQuotes() {
+        $this->csv->enclose_all = true;
+        $expected = "\"SMS\"\r\"0444\"\r\"5555\"\r";
+        $this->saveAndCompare($expected);
+    }
+
+    private function saveAndCompare($expected) {
+        $this->csv->save($this->temp_filename);
+        $content = file_get_contents($this->temp_filename);
+        $this->assertEquals($expected, $content);
+    }
+}

tests/phpunit.xml

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<phpunit
+    bootstrap="Bootstrap.php"
+    colors="false"
+    convertNoticesToExceptions="true"
+    convertWarningsToExceptions="true"
+    stopOnError="true"
+    stopOnFailure="true"
+    stopOnIncomplete="true"
+    stopOnSkipped="false">
+    <testsuites>
+        <testsuite name="ParseCsvForPhp Test Suite">
+            <directory suffix="est.php">properties/</directory>
+            <directory suffix="est.php">methods/</directory>
+        </testsuite>
+    </testsuites>
+</phpunit>

tests/properties/BaseClass.php

@@ -0,0 +1,28 @@
+<?php
+
+class BaseClass extends PHPUnit\Framework\TestCase {
+
+    /**
+     * @access protected
+     * @var ParseCsvForPhp object
+     */
+    protected $csv;
+
+    /**
+     * Setup
+     * Setup our test environment objects
+     *
+     * @access public
+     */
+    public function setUp() {
+        $this->csv = new ParseCsvForPhp();
+    }
+
+    protected function _compareWithExpected($expected) {
+        $this->csv->auto(__DIR__ . '/../../examples/_books.csv');
+        $actual = array_map(function ($row) {
+            return $row['title'];
+        }, $this->csv->data);
+        $this->assertEquals($expected, $actual);
+    }
+}

tests/properties/ConditionsTest.php

@@ -0,0 +1,47 @@
+<?php
+
+class ConditionsTest extends BaseClass {
+
+    public function testNotDanBrown() {
+        $this->csv->conditions = 'author does not contain dan brown';
+
+        $this->_compareWithExpected([
+            'The Killing Kind',
+            'The Third Secret',
+            'The Last Templar',
+            'The Traveller',
+            'Crisis Four',
+            'Prey',
+            'The Broker (Paperback)',
+            'Without Blood (Paperback)',
+            'State of Fear (Paperback)',
+            'The Rule of Four (Paperback)',
+        ]);
+    }
+
+    public function testRating() {
+        $this->csv->conditions = 'rating < 3';
+        $this->_compareWithExpected([
+            'The Killing Kind',
+            'The Third Secret',
+        ]);
+
+        $this->csv->conditions = 'rating >= 5';
+        $this->_compareWithExpected([
+            'The Traveller',
+            'Prey',
+            'State of Fear (Paperback)',
+            'Digital Fortress : A Thriller (Mass Market Paperback)',
+            'Angels & Demons (Mass Market Paperback)',
+        ]);
+    }
+
+    public function testTitleContainsSecretOrCode() {
+        $this->csv->conditions = 'title contains code OR title contains SECRET';
+
+        $this->_compareWithExpected([
+            'The Third Secret',
+            'The Da Vinci Code (Hardcover)',
+        ]);
+    }
+}

tests/properties/SortByTest.php

@@ -0,0 +1,58 @@
+<?php
+
+class SortByTest extends BaseClass {
+
+    public function testSortByRating() {
+        $this->csv->sort_by = 'rating';
+        $this->csv->conditions = 'title does not contain Blood';
+        $this->_compareWithExpected([
+            // Rating 0
+            'The Killing Kind',
+            'The Third Secret',
+
+            // Rating 3
+            'The Last Templar',
+            'The Broker (Paperback)',
+
+            // Rating 4
+            'Deception Point (Paperback)',
+            'The Rule of Four (Paperback)',
+            'The Da Vinci Code (Hardcover)',
+
+            // Rating 5
+            'State of Fear (Paperback)',
+            'Prey',
+            'Digital Fortress : A Thriller (Mass Market Paperback)',
+            'Angels & Demons (Mass Market Paperback)',
+        ]);
+    }
+
+    public function testReverseSortByRating() {
+        $this->csv->sort_by = 'rating';
+        $this->csv->conditions =
+            'title does not contain Prey AND ' .
+            'title does not contain Fortress AND ' .
+            'title does not contain Blood AND ' .
+            'title does not contain Fear';
+        $this->csv->sort_reverse = true;
+        $this->_compareWithExpected([
+
+            // Rating 5
+            'Angels & Demons (Mass Market Paperback)',
+            'The Traveller',
+
+            // Rating 4
+            'The Da Vinci Code (Hardcover)',
+            'The Rule of Four (Paperback)',
+            'Deception Point (Paperback)',
+
+            // Rating 3
+            'The Broker (Paperback)',
+            'The Last Templar',
+
+            // Rating 0
+            'The Third Secret',
+            'The Killing Kind',
+        ]);
+    }
+}

tests/properties/default_values_test.php

@@ -0,0 +1,149 @@
+<?php
+
+class default_values_properties_Test extends PHPUnit\Framework\TestCase {
+
+    /**
+     * @access protected
+     * @var ParseCsvForPhp object
+     */
+    protected $csv = null;
+
+    /**
+     * Setup
+     * Setup our test environment objects
+     *
+     * @access public
+     */
+    public function setUp() {
+        //setup parse CSV
+        $this->csv = new ParseCsvForPhp();
+    }
+
+    public function test_heading_default() {
+        $this->assertTrue(is_bool($this->csv->heading));
+        $this->assertTrue($this->csv->heading);
+    }
+
+    public function test_fields_default() {
+        $this->assertTrue(is_array($this->csv->fields));
+        $this->assertCount(0, $this->csv->fields);
+    }
+
+    public function test_sort_by_default() {
+        $this->assertNull($this->csv->sort_by);
+    }
+
+    public function test_sort_reverse_default() {
+        $this->assertTrue(is_bool($this->csv->sort_reverse));
+        $this->assertFalse($this->csv->sort_reverse);
+    }
+
+    public function test_sort_type_default() {
+        $this->assertNull($this->csv->sort_type);
+    }
+
+    public function test_delimiter_default() {
+        $this->assertTrue(is_string($this->csv->delimiter));
+        $this->assertEquals(',', $this->csv->delimiter);
+    }
+
+    public function test_enclosure_default() {
+        $this->assertTrue(is_string($this->csv->enclosure));
+        $this->assertEquals('"', $this->csv->enclosure);
+    }
+
+    public function test_enclose_all_default() {
+        $this->assertTrue(is_bool($this->csv->enclose_all));
+        $this->assertFalse($this->csv->enclose_all);
+    }
+
+    public function test_conditions_default() {
+        $this->assertNull($this->csv->conditions);
+    }
+
+    public function test_offset_default() {
+        $this->assertNull($this->csv->offset);
+    }
+
+    public function test_limit_default() {
+        $this->assertNull($this->csv->limit);
+    }
+
+    public function test_auto_depth_default() {
+        $this->assertTrue(is_numeric($this->csv->auto_depth));
+        $this->assertEquals(15, $this->csv->auto_depth);
+    }
+
+    public function test_auto_non_chars_default() {
+        $this->assertTrue(is_string($this->csv->auto_non_chars));
+        $this->assertEquals("a-zA-Z0-9\n\r", $this->csv->auto_non_chars);
+    }
+
+    public function test_auto_preferred_default() {
+        $this->assertTrue(is_string($this->csv->auto_preferred));
+        $this->assertEquals(",;\t.:|", $this->csv->auto_preferred);
+    }
+
+    public function test_convert_encoding_default() {
+        $this->assertTrue(is_bool($this->csv->convert_encoding));
+        $this->assertFalse($this->csv->convert_encoding);
+    }
+
+    public function test_input_encoding_default() {
+        $this->assertTrue(is_string($this->csv->input_encoding));
+        $this->assertEquals('ISO-8859-1', $this->csv->input_encoding);
+    }
+
+    public function test_output_encoding_default() {
+        $this->assertTrue(is_string($this->csv->output_encoding));
+        $this->assertEquals('ISO-8859-1', $this->csv->output_encoding);
+    }
+
+    public function test_linefeed_default() {
+        $this->assertTrue(is_string($this->csv->linefeed));
+        $this->assertEquals("\r", $this->csv->linefeed);
+    }
+
+    public function test_output_delimiter_default() {
+        $this->assertTrue(is_string($this->csv->output_delimiter));
+        $this->assertEquals(',', $this->csv->output_delimiter);
+    }
+
+    public function test_output_filename_default() {
+        $this->assertTrue(is_string($this->csv->output_filename));
+        $this->assertEquals('data.csv', $this->csv->output_filename);
+    }
+
+    public function test_keep_file_data_default() {
+        $this->assertTrue(is_bool($this->csv->keep_file_data));
+        $this->assertFalse($this->csv->keep_file_data);
+    }
+
+    public function test_file_default() {
+        $this->assertNull($this->csv->file);
+    }
+
+    public function test_file_data_default() {
+        $this->assertNull($this->csv->file_data);
+    }
+
+    public function test_error_default() {
+        $this->assertTrue(is_numeric($this->csv->error));
+        $this->assertEquals(0, $this->csv->error);
+    }
+
+    public function test_error_info_default() {
+        $this->assertTrue(is_array($this->csv->error_info));
+        $this->assertCount(0, $this->csv->error_info);
+    }
+
+    public function test_titles_default() {
+        $this->assertTrue(is_array($this->csv->titles));
+        $this->assertCount(0, $this->csv->titles);
+    }
+
+    public function test_data_default() {
+        $this->assertTrue(is_array($this->csv->data));
+        $this->assertCount(0, $this->csv->data);
+    }
+}

tests/properties/worthless_test.php

@@ -0,0 +1,138 @@
+<?php
+
+class worthless_properties_Test extends PHPUnit\Framework\TestCase {
+
+    /**
+     * @access protected
+     * @var    ParseCsvForPhp
+     */
+    protected $csv = null;
+
+    /**
+     * Reflection Object
+     * The reflection class object
+     *
+     * @access protected
+     * @var    ReflectionClass
+     */
+    protected $reflection = null;
+
+    /**
+     * Reflection Properties
+     * The reflected class properties
+     *
+     * @access protected
+     * @var ReflectionProperty[]
+     */
+    protected $properties = null;
+
+    /**
+     * Setup
+     * Setup our test environment objects
+     *
+     * @access public
+     */
+    public function setUp() {
+        //setup parse CSV
+        $this->csv = new ParseCsvForPhp();
+
+        //setup the reflection class
+        $this->reflection = new ReflectionClass($this->csv);
+
+        //setup the reflected class properties
+        $this->properties = $this->reflection->getProperties();
+    }
+
+    /**
+     * Tear down
+     * Tear down our test environment objects
+     *
+     * @access public
+     */
+    public function tearDown() {
+        $this->csv = null;
+        $this->reflection = null;
+        $this->properties = null;
+    }
+
+    /**
+     * test_propertiesCount
+     * Counts the number of properties to make sure we didn't add or
+     * subtract any without thinking
+     *
+     * @access public
+     */
+    public function test_propertiesCount() {
+        $this->assertCount(28, $this->properties);
+    }
+
+    /**
+     * test_property_names
+     * We have an expected set of properties that should exists
+     * Make sure our expected number of properties matches the real
+     * count of properties and also check to make sure our expected
+     * properties exists within the class
+     *
+     * @access public
+     */
+    public function test_property_names() {
+        //set our expected properties name(s)
+        $expected_names = array(
+            'heading',
+            'fields',
+            'sort_by',
+            'sort_reverse',
+            'sort_type',
+            'delimiter',
+            'enclosure',
+            'enclose_all',
+            'conditions',
+            'offset',
+            'limit',
+            'auto_depth',
+            'auto_non_chars',
+            'auto_preferred',
+            'convert_encoding',
+            'input_encoding',
+            'output_encoding',
+            'use_mb_convert_encoding',
+            'linefeed',
+            'output_delimiter',
+            'output_filename',
+            'keep_file_data',
+            'file',
+            'file_data',
+            'error',
+            'error_info',
+            'titles',
+            'data',
+        );
+
+        // Find our real properties
+        $real_properties = array_map(function (ReflectionProperty $property) {
+            return $property->getName();
+        }, $this->properties);
+
+        // Lets make sure our expected matches the number of real properties
+        $this->assertEquals($expected_names, $real_properties);
+    }
+
+    /**
+     * test_count_public_properties
+     * We at this point only have public properties so
+     * lets verify all properties are public
+     *
+     * @access public
+     */
+    public function test_count_public_properties() {
+        $counter = 0;
+
+        for ($a = count($this->properties) - 1; $a >= 0; $a--) {
+            if ($this->properties[$a]->isPublic() === true) {
+                $counter++;
+            }
+        }
+
+        $this->assertCount($counter, $this->properties);
+    }
+}