CsvTest::providerNull() - Code Metrics - Inspection of "Drop all Scrutinizer annotations" - PHPOffice/PhpSpreadsheet - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Pull Request — master (#3743)

by Adrien

created 2023-09-26 04:28 UTC

CsvTest::providerNull() A

↳ Parent: Project

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	2
c	0
b	0
f	0
nc	1
nop	0
dl	0
loc	4
rs	10

<?php

declare(strict_types=1);

namespace PhpOffice\PhpSpreadsheetTests\Reader\Csv;

use PhpOffice\PhpSpreadsheet\Reader\Csv;
use PhpOffice\PhpSpreadsheet\Reader\Exception as ReaderException;
use PHPUnit\Framework\TestCase;

class CsvTest extends TestCase
{
    /**
     * @dataProvider providerDelimiterDetection
     */
    public function testDelimiterDetection(string $filename, string $expectedDelimiter, string $cell, string|float|int|null $expectedValue): void
    {
        $reader = new Csv();
        $delim1 = $reader->getDelimiter();
        self::assertNull($delim1);

        $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 static function providerDelimiterDetection(): array
    {
        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
     */
    public function testCanLoad(bool $expected, string $filename): void
    {
        $reader = new Csv();
        self::assertSame($expected, $reader->canRead($filename));
    }

    public static function providerCanLoad(): array
    {
        return [
            [false, 'tests/data/Reader/Ods/data.ods'],
            [false, 'samples/templates/excel2003.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());
    }

    public function testInvalidWorkSheetInfo(): void
    {
        $this->expectException(ReaderException::class);
        $reader = new Csv();
        $reader->listWorksheetInfo('');
    }

    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');
    }

    /**
     * @dataProvider providerEscapes
     */
    public function testInferSeparator(string $escape, string $delimiter): void
    {
        $reader = new Csv();
        $reader->setEscapeCharacter($escape);
        $filename = 'tests/data/Reader/CSV/escape.csv';
        $reader->listWorksheetInfo($filename);
        self::assertEquals($delimiter, $reader->getDelimiter());
    }

    public static function providerEscapes(): array
    {
        return [
            ['\\', ';'],
            ["\x0", ','],
            ['', ','],
        ];
    }

    public function testSetDelimiterNull(): void
    {
        $reader = new Csv();
        $reader->setDelimiter(',');
        self::assertSame(',', $reader->getDelimiter());
        $reader->setDelimiter(null);
        self::assertNull($reader->getDelimiter());
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace PhpOffice\PhpSpreadsheetTests\Reader\Csv;
6
7			use PhpOffice\PhpSpreadsheet\Reader\Csv;
8			use PhpOffice\PhpSpreadsheet\Reader\Exception as ReaderException;
9			use PHPUnit\Framework\TestCase;
10
11			class CsvTest extends TestCase
12			{
13			/**
14			* @dataProvider providerDelimiterDetection
15			*/
16			public function testDelimiterDetection(string $filename, string $expectedDelimiter, string $cell, string\|float\|int\|null $expectedValue): void
17			{
18			$reader = new Csv();
19			$delim1 = $reader->getDelimiter();
20			self::assertNull($delim1);
21
22			$spreadsheet = $reader->load($filename);
23
24			self::assertSame($expectedDelimiter, $reader->getDelimiter(), 'should be able to infer the delimiter');
25
26			$actual = $spreadsheet->getActiveSheet()->getCell($cell)->getValue();
27			self::assertSame($expectedValue, $actual, 'should be able to retrieve correct value');
28			}
29
30			public static function providerDelimiterDetection(): array
31			{
32			return [
33			[
34			'tests/data/Reader/CSV/enclosure.csv',
35			',',
36			'C4',
37			'username2',
38			],
39			[
40			'tests/data/Reader/CSV/semicolon_separated.csv',
41			';',
42			'C2',
43			'25,5',
44			],
45			[
46			'tests/data/Reader/CSV/line_break_in_enclosure.csv',
47			',',
48			'A3',
49			'Test',
50			],
51			[
52			'tests/data/Reader/CSV/line_break_in_enclosure_with_escaped_quotes.csv',
53			',',
54			'A3',
55			'Test',
56			],
57			[
58			'tests/data/Reader/HTML/csv_with_angle_bracket.csv',
59			',',
60			'B1',
61			'Number of items with weight <= 50kg',
62			],
63			[
64			'samples/Reader/sampleData/example1.csv',
65			',',
66			'I4',
67			'100%',
68			],
69			[
70			'samples/Reader/sampleData/example2.csv',
71			',',
72			'D8',
73			-58.373161,
74			],
75			[
76			'tests/data/Reader/CSV/empty.csv',
77			',',
78			'A1',
79			null,
80			],
81			[
82			'tests/data/Reader/CSV/no_delimiter.csv',
83			',',
84			'A1',
85			'SingleLine',
86			],
87			];
88			}
89
90			/**
91			* @dataProvider providerCanLoad
92			*/
93			public function testCanLoad(bool $expected, string $filename): void
94			{
95			$reader = new Csv();
96			self::assertSame($expected, $reader->canRead($filename));
97			}
98
99			public static function providerCanLoad(): array
100			{
101			return [
102			[false, 'tests/data/Reader/Ods/data.ods'],
103			[false, 'samples/templates/excel2003.xml'],
104			[true, 'tests/data/Reader/CSV/enclosure.csv'],
105			[true, 'tests/data/Reader/CSV/semicolon_separated.csv'],
106			[true, 'tests/data/Reader/CSV/contains_html.csv'],
107			[true, 'tests/data/Reader/CSV/csv_without_extension'],
108			[true, 'tests/data/Reader/HTML/csv_with_angle_bracket.csv'],
109			[true, 'tests/data/Reader/CSV/empty.csv'],
110			[true, 'samples/Reader/sampleData/example1.csv'],
111			[true, 'samples/Reader/sampleData/example2.csv'],
112			];
113			}
114
115			public function testEscapeCharacters(): void
116			{
117			$reader = (new Csv())->setEscapeCharacter('"');
118			$worksheet = $reader->load('tests/data/Reader/CSV/backslash.csv')
119			->getActiveSheet();
120
121			$expected = [
122			['field 1', 'field 2\\'],
123			['field 3\\', 'field 4'],
124			];
125
126			self::assertSame('"', $reader->getEscapeCharacter());
127			self::assertSame($expected, $worksheet->toArray());
128			}
129
130			public function testInvalidWorkSheetInfo(): void
131			{
132			$this->expectException(ReaderException::class);
133			$reader = new Csv();
134			$reader->listWorksheetInfo('');
135			}
136
137			public function testUtf16LineBreak(): void
138			{
139			$reader = new Csv();
140			$reader->setInputEncoding('UTF-16BE');
141			$spreadsheet = $reader->load('tests/data/Reader/CSV/utf16be.line_break_in_enclosure.csv');
142			$sheet = $spreadsheet->getActiveSheet();
143			$expected = <<<EOF
144			This is a test
145			with line breaks
146			that breaks the
147			delimiters
148			EOF;
149			self::assertEquals($expected, $sheet->getCell('B3')->getValue());
150			}
151
152			public function testLineBreakEscape(): void
153			{
154			$reader = new Csv();
155			$spreadsheet = $reader->load('tests/data/Reader/CSV/line_break_in_enclosure_with_escaped_quotes.csv');
156			$sheet = $spreadsheet->getActiveSheet();
157			$expected = <<<EOF
158			This is a "test csv file"
159			with both "line breaks"
160			and "escaped
161			quotes" that breaks
162			the delimiters
163			EOF;
164			self::assertEquals($expected, $sheet->getCell('B3')->getValue());
165			}
166
167			public function testUtf32LineBreakEscape(): void
168			{
169			$reader = new Csv();
170			$reader->setInputEncoding('UTF-32LE');
171			$spreadsheet = $reader->load('tests/data/Reader/CSV/line_break_escaped_32le.csv');
172			$sheet = $spreadsheet->getActiveSheet();
173			$expected = <<<EOF
174			This is a "test csv file"
175			with both "line breaks"
176			and "escaped
177			quotes" that breaks
178			the delimiters
179			EOF;
180			self::assertEquals($expected, $sheet->getCell('B3')->getValue());
181			}
182
183			public function testSeparatorLine(): void
184			{
185			$reader = new Csv();
186			$reader->setSheetIndex(3);
187			$spreadsheet = $reader->load('tests/data/Reader/CSV/sep.csv');
188			self::assertEquals(';', $reader->getDelimiter());
189			$sheet = $spreadsheet->getActiveSheet();
190			self::assertEquals(3, $reader->getSheetIndex());
191			self::assertEquals(3, $spreadsheet->getActiveSheetIndex());
192			self::assertEquals('A', $sheet->getCell('A1')->getValue());
193			self::assertEquals(1, $sheet->getCell('B1')->getValue());
194			self::assertEquals(2, $sheet->getCell('A2')->getValue());
195			self::assertEquals(3, $sheet->getCell('B2')->getValue());
196			}
197
198			public function testDefaultSettings(): void
199			{
200			$reader = new Csv();
201			self::assertEquals('UTF-8', $reader->getInputEncoding());
202			self::assertEquals('"', $reader->getEnclosure());
203			$reader->setEnclosure('\'');
204			self::assertEquals('\'', $reader->getEnclosure());
205			$reader->setEnclosure('');
206			self::assertEquals('"', $reader->getEnclosure());
207			// following tests from BaseReader
208			self::assertTrue($reader->getReadEmptyCells());
209			self::assertFalse($reader->getIncludeCharts());
210			self::assertNull($reader->getLoadSheetsOnly());
211			}
212
213			public function testReadEmptyFileName(): void
214			{
215			$this->expectException(ReaderException::class);
216			$reader = new Csv();
217			$filename = '';
218			$reader->load($filename);
219			}
220
221			public function testReadNonexistentFileName(): void
222			{
223			$this->expectException(ReaderException::class);
224			$reader = new Csv();
225			$reader->load('tests/data/Reader/CSV/encoding.utf8.csvxxx');
226			}
227
228			/**
229			* @dataProvider providerEscapes
230			*/
231			public function testInferSeparator(string $escape, string $delimiter): void
232			{
233			$reader = new Csv();
234			$reader->setEscapeCharacter($escape);
235			$filename = 'tests/data/Reader/CSV/escape.csv';
236			$reader->listWorksheetInfo($filename);
237			self::assertEquals($delimiter, $reader->getDelimiter());
238			}
239
240			public static function providerEscapes(): array
241			{
242			return [
243			['\\', ';'],
244			["\x0", ','],
245			['', ','],
246			];
247			}
248
249			public function testSetDelimiterNull(): void
250			{
251			$reader = new Csv();
252			$reader->setDelimiter(',');
253			self::assertSame(',', $reader->getDelimiter());
254			$reader->setDelimiter(null);
255			self::assertNull($reader->getDelimiter());
			1 ignored issue – show Bug introduced 2021-09-05 17:22 UTC by Report Bug Copy Issue Report Are you sure the usage of `$reader->getDelimiter()` targeting `PhpOffice\PhpSpreadsheet...der\Csv::getDelimiter()` seems to always return null. This check looks for function or method calls that always return null and whose return value is used. class A { function getObject() { return null; } } $a = new A(); if ($a->getObject()) { The method `getObject()` can return nothing but null, so it makes no sense to use the return value. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
256			}
257			}
258

PHPOffice / PhpSpreadsheet

Pull Request — master (#3743)

CsvTest::providerNull() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like