262896086a
* Improve Coverage for Sylk I believe that both BaseReader and Sylk Reader are now 100% covered. Documentation available for this format is sparse. It was always incomplete, and in some cases inaccurate. My goal was to use PhpSpreadsheet to load the test file, save it as Xlsx, and visually compare the two, then add a test loaded with assertions. Cell values and calculated values, and border styles were generally handled pretty well without changes. Other types of styling were not handled so well. I added a few cells to exercise some previously uncovered code. Sylk files must be ASCII. I have deprecated the use of the setEncoding and getEncoding functions, which had no test cases.
279 lines
8.8 KiB
PHP
279 lines
8.8 KiB
PHP
<?php
|
|
|
|
namespace PhpOffice\PhpSpreadsheetTests\Reader;
|
|
|
|
use PhpOffice\PhpSpreadsheet\Reader\Csv;
|
|
use PhpOffice\PhpSpreadsheet\Reader\Exception as ReaderException;
|
|
use PHPUnit\Framework\TestCase;
|
|
|
|
class CsvTest extends TestCase
|
|
{
|
|
/**
|
|
* @dataProvider providerDelimiterDetection
|
|
*
|
|
* @param string $filename
|
|
* @param string $expectedDelimiter
|
|
* @param string $cell
|
|
* @param float|int|string $expectedValue
|
|
*/
|
|
public function testDelimiterDetection($filename, $expectedDelimiter, $cell, $expectedValue): void
|
|
{
|
|
$reader = new Csv();
|
|
self::assertNull($reader->getDelimiter());
|
|
|
|
$spreadsheet = $reader->load($filename);
|
|
|
|
self::assertSame($expectedDelimiter, $reader->getDelimiter(), 'should be able to infer the delimiter');
|
|
|
|
$actual = $spreadsheet->getActiveSheet()->getCell($cell)->getValue();
|
|
self::assertSame($expectedValue, $actual, 'should be able to retrieve correct value');
|
|
}
|
|
|
|
public function providerDelimiterDetection()
|
|
{
|
|
return [
|
|
[
|
|
'tests/data/Reader/CSV/enclosure.csv',
|
|
',',
|
|
'C4',
|
|
'username2',
|
|
],
|
|
[
|
|
'tests/data/Reader/CSV/semicolon_separated.csv',
|
|
';',
|
|
'C2',
|
|
'25,5',
|
|
],
|
|
[
|
|
'tests/data/Reader/CSV/line_break_in_enclosure.csv',
|
|
',',
|
|
'A3',
|
|
'Test',
|
|
],
|
|
[
|
|
'tests/data/Reader/CSV/line_break_in_enclosure_with_escaped_quotes.csv',
|
|
',',
|
|
'A3',
|
|
'Test',
|
|
],
|
|
[
|
|
'tests/data/Reader/HTML/csv_with_angle_bracket.csv',
|
|
',',
|
|
'B1',
|
|
'Number of items with weight <= 50kg',
|
|
],
|
|
[
|
|
'samples/Reader/sampleData/example1.csv',
|
|
',',
|
|
'I4',
|
|
'100%',
|
|
],
|
|
[
|
|
'samples/Reader/sampleData/example2.csv',
|
|
',',
|
|
'D8',
|
|
-58.373161,
|
|
],
|
|
[
|
|
'tests/data/Reader/CSV/empty.csv',
|
|
',',
|
|
'A1',
|
|
null,
|
|
],
|
|
[
|
|
'tests/data/Reader/CSV/no_delimiter.csv',
|
|
',',
|
|
'A1',
|
|
'SingleLine',
|
|
],
|
|
];
|
|
}
|
|
|
|
/**
|
|
* @dataProvider providerCanLoad
|
|
*
|
|
* @param bool $expected
|
|
* @param string $filename
|
|
*/
|
|
public function testCanLoad($expected, $filename): void
|
|
{
|
|
$reader = new Csv();
|
|
self::assertSame($expected, $reader->canRead($filename));
|
|
}
|
|
|
|
public function providerCanLoad()
|
|
{
|
|
return [
|
|
[false, 'tests/data/Reader/Ods/data.ods'],
|
|
[false, 'tests/data/Reader/Xml/WithoutStyle.xml'],
|
|
[true, 'tests/data/Reader/CSV/enclosure.csv'],
|
|
[true, 'tests/data/Reader/CSV/semicolon_separated.csv'],
|
|
[true, 'tests/data/Reader/CSV/contains_html.csv'],
|
|
[true, 'tests/data/Reader/CSV/csv_without_extension'],
|
|
[true, 'tests/data/Reader/HTML/csv_with_angle_bracket.csv'],
|
|
[true, 'tests/data/Reader/CSV/empty.csv'],
|
|
[true, 'samples/Reader/sampleData/example1.csv'],
|
|
[true, 'samples/Reader/sampleData/example2.csv'],
|
|
];
|
|
}
|
|
|
|
public function testEscapeCharacters(): void
|
|
{
|
|
$reader = (new Csv())->setEscapeCharacter('"');
|
|
$worksheet = $reader->load('tests/data/Reader/CSV/backslash.csv')
|
|
->getActiveSheet();
|
|
|
|
$expected = [
|
|
['field 1', 'field 2\\'],
|
|
['field 3\\', 'field 4'],
|
|
];
|
|
|
|
self::assertSame('"', $reader->getEscapeCharacter());
|
|
self::assertSame($expected, $worksheet->toArray());
|
|
}
|
|
|
|
/**
|
|
* @dataProvider providerEncodings
|
|
*
|
|
* @param string $filename
|
|
* @param string $encoding
|
|
*/
|
|
public function testEncodings($filename, $encoding): void
|
|
{
|
|
$reader = new Csv();
|
|
$reader->setInputEncoding($encoding);
|
|
$spreadsheet = $reader->load($filename);
|
|
$sheet = $spreadsheet->getActiveSheet();
|
|
self::assertEquals('Å', $sheet->getCell('A1')->getValue());
|
|
}
|
|
|
|
public function testInvalidWorkSheetInfo(): void
|
|
{
|
|
$this->expectException(ReaderException::class);
|
|
$reader = new Csv();
|
|
$reader->listWorksheetInfo('');
|
|
}
|
|
|
|
/**
|
|
* @dataProvider providerEncodings
|
|
*
|
|
* @param string $filename
|
|
* @param string $encoding
|
|
*/
|
|
public function testWorkSheetInfo($filename, $encoding): void
|
|
{
|
|
$reader = new Csv();
|
|
$reader->setInputEncoding($encoding);
|
|
$info = $reader->listWorksheetInfo($filename);
|
|
self::assertEquals('Worksheet', $info[0]['worksheetName']);
|
|
self::assertEquals('B', $info[0]['lastColumnLetter']);
|
|
self::assertEquals(1, $info[0]['lastColumnIndex']);
|
|
self::assertEquals(2, $info[0]['totalRows']);
|
|
self::assertEquals(2, $info[0]['totalColumns']);
|
|
}
|
|
|
|
public function providerEncodings()
|
|
{
|
|
return [
|
|
['tests/data/Reader/CSV/encoding.iso88591.csv', 'ISO-8859-1'],
|
|
['tests/data/Reader/CSV/encoding.utf8.csv', 'UTF-8'],
|
|
['tests/data/Reader/CSV/encoding.utf8bom.csv', 'UTF-8'],
|
|
['tests/data/Reader/CSV/encoding.utf16be.csv', 'UTF-16BE'],
|
|
['tests/data/Reader/CSV/encoding.utf16le.csv', 'UTF-16LE'],
|
|
['tests/data/Reader/CSV/encoding.utf32be.csv', 'UTF-32BE'],
|
|
['tests/data/Reader/CSV/encoding.utf32le.csv', 'UTF-32LE'],
|
|
];
|
|
}
|
|
|
|
public function testUtf16LineBreak(): void
|
|
{
|
|
$reader = new Csv();
|
|
$reader->setInputEncoding('UTF-16BE');
|
|
$spreadsheet = $reader->load('tests/data/Reader/CSV/utf16be.line_break_in_enclosure.csv');
|
|
$sheet = $spreadsheet->getActiveSheet();
|
|
$expected = <<<EOF
|
|
This is a test
|
|
with line breaks
|
|
that breaks the
|
|
delimiters
|
|
EOF;
|
|
self::assertEquals($expected, $sheet->getCell('B3')->getValue());
|
|
}
|
|
|
|
public function testLineBreakEscape(): void
|
|
{
|
|
$reader = new Csv();
|
|
$spreadsheet = $reader->load('tests/data/Reader/CSV/line_break_in_enclosure_with_escaped_quotes.csv');
|
|
$sheet = $spreadsheet->getActiveSheet();
|
|
$expected = <<<EOF
|
|
This is a "test csv file"
|
|
with both "line breaks"
|
|
and "escaped
|
|
quotes" that breaks
|
|
the delimiters
|
|
EOF;
|
|
self::assertEquals($expected, $sheet->getCell('B3')->getValue());
|
|
}
|
|
|
|
public function testUtf32LineBreakEscape(): void
|
|
{
|
|
$reader = new Csv();
|
|
$reader->setInputEncoding('UTF-32LE');
|
|
$spreadsheet = $reader->load('tests/data/Reader/CSV/line_break_escaped_32le.csv');
|
|
$sheet = $spreadsheet->getActiveSheet();
|
|
$expected = <<<EOF
|
|
This is a "test csv file"
|
|
with both "line breaks"
|
|
and "escaped
|
|
quotes" that breaks
|
|
the delimiters
|
|
EOF;
|
|
self::assertEquals($expected, $sheet->getCell('B3')->getValue());
|
|
}
|
|
|
|
public function testSeparatorLine(): void
|
|
{
|
|
$reader = new Csv();
|
|
$reader->setSheetIndex(3);
|
|
$spreadsheet = $reader->load('tests/data/Reader/CSV/sep.csv');
|
|
self::assertEquals(';', $reader->getDelimiter());
|
|
$sheet = $spreadsheet->getActiveSheet();
|
|
self::assertEquals(3, $reader->getSheetIndex());
|
|
self::assertEquals(3, $spreadsheet->getActiveSheetIndex());
|
|
self::assertEquals('A', $sheet->getCell('A1')->getValue());
|
|
self::assertEquals(1, $sheet->getCell('B1')->getValue());
|
|
self::assertEquals(2, $sheet->getCell('A2')->getValue());
|
|
self::assertEquals(3, $sheet->getCell('B2')->getValue());
|
|
}
|
|
|
|
public function testDefaultSettings(): void
|
|
{
|
|
$reader = new Csv();
|
|
self::assertEquals('UTF-8', $reader->getInputEncoding());
|
|
self::assertEquals('"', $reader->getEnclosure());
|
|
$reader->setEnclosure('\'');
|
|
self::assertEquals('\'', $reader->getEnclosure());
|
|
$reader->setEnclosure('');
|
|
self::assertEquals('"', $reader->getEnclosure());
|
|
// following tests from BaseReader
|
|
self::assertTrue($reader->getReadEmptyCells());
|
|
self::assertFalse($reader->getIncludeCharts());
|
|
self::assertNull($reader->getLoadSheetsOnly());
|
|
}
|
|
|
|
public function testReadEmptyFileName(): void
|
|
{
|
|
$this->expectException(ReaderException::class);
|
|
$reader = new Csv();
|
|
$filename = '';
|
|
$reader->load($filename);
|
|
}
|
|
|
|
public function testReadNonexistentFileName(): void
|
|
{
|
|
$this->expectException(ReaderException::class);
|
|
$reader = new Csv();
|
|
$reader->load('tests/data/Reader/CSV/encoding.utf8.csvxxx');
|
|
}
|
|
}
|