WriterTest::testSetHeader() - Code Metrics - Inspection of "add FormatterException" - The-Road-Bunch/csv-machine - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Branch — feature/static-formatter (adf5e0)

by Daniel

created 2018-04-19 23:18 UTC

WriterTest::testSetHeader() A

↳ Parent: Project

Complexity

Conditions	1
Paths	1

Size

Total Lines	8
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	4
nc	1
nop	0
dl	0
loc	8
rs	9.4285
c	0
b	0
f	0

<?php declare(strict_types=1);

/**
 * This file is part of the Csv-Machine package.
 *
 * (c) Dan McAdams <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace RoadBunch\Csv\Tests\Csv;


use PHPUnit\Framework\TestCase;
use RoadBunch\Csv;

/**
 * Class WriterTest
 *
 * @author  Dan McAdams
 * @package RoadBunch\Csv\Tests\Csv
 */
class WriterTest extends TestCase
{
    protected $filename;

    public function setUp()
    {
        $this->filename = sprintf('%s/%s.csv', __DIR__, md5(uniqid()));
    }

    public function tearDown()
    {
        if (is_file($this->filename)) {
            unlink($this->filename);
        }
    }

    public function testCreateWriter()
    {
        $writer = new WriterSpy();
        $this->assertNotNull($writer);
    }

    public function testAddRow()
    {
        $writer = new WriterSpy();
        $rowOne = ['Dan', 'McAdams'];
        $rowTwo = ['Lara', 'McAdams'];

        $writer->addRow($rowOne);
        $writer->addRow($rowTwo);

        $this->assertCount(2, $writer->getRows());
    }

    public function testAddRowsNotArrayOfArrays()
    {
        $this->expectException(Csv\Exception\InvalidInputArrayException::class);
        $writer = new Csv\Writer();
        $rows   = ['Dan', 'McAdams'];

        $writer->addRows($rows);
    }

    public function testAddRows()
    {
        $writer = new WriterSpy();
        $rows   = [
            ['Dan', 'McAdams'],
            ['Lara', 'McAdams'],
            ['Test', 'User']
        ];
        $writer->addRows($rows);
        $moreRows = [
            ['more1', 'row1'],
            ['more2', 'row2'],
            ['more3', 'row3']
        ];
        $writer->addRows($moreRows);
        $this->assertCount(6, $writer->getRows());

        return $writer;
    }

    public function testSetHeader()
    {
        $header = ['first_name', 'last_name'];

        $writer = new WriterSpy();
        $writer->setHeader($header);

        $this->assertEquals($header, $writer->getHeader());
    }

    public function testSetHeaderWithFormatters()
    {
        $writer = new Csv\Writer();
        $rows   = [['dan', 'mcadams']];
        $writer->addRows($rows);

        $header = ['first_name', 'last_name'];
        $expectedFormattedHeader = ['First Name', 'Last Name'];
        $formatters = [
            new Csv\Formatter\UpperCaseWordsFormatter(),
            new Csv\Formatter\UnderscoreToSpaceFormatter()
        ];
        $writer->setHeader($header, $formatters);

        $writer->saveToFile($this->filename);
        $this->assertCsvWrittenToFile($expectedFormattedHeader, $rows);
    }

    public function testWriteCsvToFile()
    {
        $header = ['first_name', 'last_name', 'email_address'];
        $rows   = [
            ['Dan', 'McAdams', '[email protected]'],
            ['Lara', 'McAdams', '[email protected]'],
            ['Test', 'User', '[email protected]']
        ];
        $writer = new Csv\Writer();
        $writer->setHeader($header);
        $writer->addRow();
        $writer->addRows($rows);
        $writer->saveToFile($this->filename);

        $handle = fopen($this->filename, 'r');
        $this->assertEquals($header, fgetcsv($handle));
        fclose($handle);

        return $writer;
    }

    /**
     * @depends testWriteCsvToFile
     */
    public function testWriteCsvToNonSeekableStream(Csv\WriterInterface $writer)
    {
        $header = ['first_name', 'last_name', 'email_address'];
        $writer->setHeader($header);

        ob_start();
        $writer->saveToFile('php://output');
        $output = ob_get_clean();

        $this->assertContains(implode(',', $header), $output);
    }

    /**
     * @depends testWriteCsvToFile
     */
    public function testWriteToString(Csv\WriterInterface $writer)
    {
        $header = ['first_name', 'last_name', 'email_address'];
        $writer->setHeader($header);

        $this->assertContains(implode(',', $header), $writer->writeToString());
    }

    /**
     * @depends testWriteCsvToFile
     */
    public function testWriteCsvDifferentLineEndings(Csv\Writer $writer)
    {
        $writer->setNewline(Csv\Newline::NEWLINE_CRLF);
        $writer->saveToFile($this->filename);
        $this->assertLineEnding(Csv\Newline::NEWLINE_CRLF);
    }

    private function assertCsvWrittenToFile($header, $rows)
    {
        $this->assertGreaterThan(0, filesize($this->filename), 'No data written to file');

        $handle = fopen($this->filename, 'r');
        $this->assertEquals($header, fgetcsv($handle));

        foreach ($rows as $row) {
            $this->assertEquals($row, fgetcsv($handle));
        }

        fclose($handle);
    }

    private function assertLineEnding($lineEnding)
    {
        $line = fgets(fopen($this->filename, 'r'));
        $this->assertEquals($lineEnding, substr($line, -2));
    }
}


1			<?php declare(strict_types=1);
2
3			/**
4			* This file is part of the Csv-Machine package.
5			*
6			* (c) Dan McAdams <[email protected]>
7			*
8			* For the full copyright and license information, please view the LICENSE
9			* file that was distributed with this source code.
10			*/
11
12			namespace RoadBunch\Csv\Tests\Csv;
13
14
15			use PHPUnit\Framework\TestCase;
16			use RoadBunch\Csv;
17
18			/**
19			* Class WriterTest
20			*
21			* @author Dan McAdams
22			* @package RoadBunch\Csv\Tests\Csv
23			*/
24			class WriterTest extends TestCase
25			{
26			protected $filename;
27
28			public function setUp()
29			{
30			$this->filename = sprintf('%s/%s.csv', __DIR__, md5(uniqid()));
31			}
32
33			public function tearDown()
34			{
35			if (is_file($this->filename)) {
36			unlink($this->filename);
37			}
38			}
39
40			public function testCreateWriter()
41			{
42			$writer = new WriterSpy();
43			$this->assertNotNull($writer);
44			}
45
46			public function testAddRow()
47			{
48			$writer = new WriterSpy();
49			$rowOne = ['Dan', 'McAdams'];
50			$rowTwo = ['Lara', 'McAdams'];
51
52			$writer->addRow($rowOne);
53			$writer->addRow($rowTwo);
54
55			$this->assertCount(2, $writer->getRows());
56			}
57
58			public function testAddRowsNotArrayOfArrays()
59			{
60			$this->expectException(Csv\Exception\InvalidInputArrayException::class);
61			$writer = new Csv\Writer();
62			$rows = ['Dan', 'McAdams'];
63
64			$writer->addRows($rows);
65			}
66
67			public function testAddRows()
68			{
69			$writer = new WriterSpy();
70			$rows = [
71			['Dan', 'McAdams'],
72			['Lara', 'McAdams'],
73			['Test', 'User']
74			];
75			$writer->addRows($rows);
76			$moreRows = [
77			['more1', 'row1'],
78			['more2', 'row2'],
79			['more3', 'row3']
80			];
81			$writer->addRows($moreRows);
82			$this->assertCount(6, $writer->getRows());
83
84			return $writer;
85			}
86
87			public function testSetHeader()
88			{
89			$header = ['first_name', 'last_name'];
90
91			$writer = new WriterSpy();
92			$writer->setHeader($header);
93
94			$this->assertEquals($header, $writer->getHeader());
95			}
96
97			public function testSetHeaderWithFormatters()
98			{
99			$writer = new Csv\Writer();
100			$rows = [['dan', 'mcadams']];
101			$writer->addRows($rows);
102
103			$header = ['first_name', 'last_name'];
104			$expectedFormattedHeader = ['First Name', 'Last Name'];
105			$formatters = [
106			new Csv\Formatter\UpperCaseWordsFormatter(),
107			new Csv\Formatter\UnderscoreToSpaceFormatter()
108			];
109			$writer->setHeader($header, $formatters);
110
111			$writer->saveToFile($this->filename);
112			$this->assertCsvWrittenToFile($expectedFormattedHeader, $rows);
113			}
114
115			public function testWriteCsvToFile()
116			{
117			$header = ['first_name', 'last_name', 'email_address'];
118			$rows = [
119			['Dan', 'McAdams', '[email protected]'],
120			['Lara', 'McAdams', '[email protected]'],
121			['Test', 'User', '[email protected]']
122			];
123			$writer = new Csv\Writer();
124			$writer->setHeader($header);
125			$writer->addRow();
126			$writer->addRows($rows);
127			$writer->saveToFile($this->filename);
128
129			$handle = fopen($this->filename, 'r');
130			$this->assertEquals($header, fgetcsv($handle));
131			fclose($handle);
132
133			return $writer;
134			}
135
136			/**
137			* @depends testWriteCsvToFile
138			*/
139			public function testWriteCsvToNonSeekableStream(Csv\WriterInterface $writer)
140			{
141			$header = ['first_name', 'last_name', 'email_address'];
142			$writer->setHeader($header);
143
144			ob_start();
145			$writer->saveToFile('php://output');
146			$output = ob_get_clean();
147
148			$this->assertContains(implode(',', $header), $output);
149			}
150
151			/**
152			* @depends testWriteCsvToFile
153			*/
154			public function testWriteToString(Csv\WriterInterface $writer)
155			{
156			$header = ['first_name', 'last_name', 'email_address'];
157			$writer->setHeader($header);
158
159			$this->assertContains(implode(',', $header), $writer->writeToString());
160			}
161
162			/**
163			* @depends testWriteCsvToFile
164			*/
165			public function testWriteCsvDifferentLineEndings(Csv\Writer $writer)
166			{
167			$writer->setNewline(Csv\Newline::NEWLINE_CRLF);
168			$writer->saveToFile($this->filename);
169			$this->assertLineEnding(Csv\Newline::NEWLINE_CRLF);
170			}
171
172			private function assertCsvWrittenToFile($header, $rows)
173			{
174			$this->assertGreaterThan(0, filesize($this->filename), 'No data written to file');
175
176			$handle = fopen($this->filename, 'r');
177			$this->assertEquals($header, fgetcsv($handle));
178
179			foreach ($rows as $row) {
180			$this->assertEquals($row, fgetcsv($handle));
181			}
182
183			fclose($handle);
184			}
185
186			private function assertLineEnding($lineEnding)
187			{
188			$line = fgets(fopen($this->filename, 'r'));
189			$this->assertEquals($lineEnding, substr($line, -2));
190			}
191			}
192

The-Road-Bunch / csv-machine

Branch — feature/static-formatter (adf5e0)

WriterTest::testSetHeader() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like