silverstripe-framework/tests/php/Dev/CSVParserTest.php

<?php

namespace SilverStripe\Dev\Tests;

use SilverStripe\Dev\CSVParser;
use SilverStripe\Dev\SapphireTest;

class CSVParserTest extends SapphireTest
{

    /**
     * Name of csv test dir
     *
     * @var string
     */
    protected $csvPath = null;

    protected function setUp(): void
    {
        parent::setUp();
        $this->csvPath = __DIR__ . '/CsvBulkLoaderTest/csv/';
    }

    public function testParsingWithHeaders()
    {
        /* By default, a CSV file will be interpreted as having headers */
        $csv = new CSVParser($this->csvPath . 'PlayersWithHeader.csv');

        $firstNames = $birthdays = $biographies = $registered = [];
        foreach ($csv as $record) {
            /* Each row in the CSV file will be keyed with the header row */
            $this->assertEquals(
                ['FirstName','Biography','Birthday','IsRegistered'],
                array_keys($record ?? [])
            );
            $firstNames[] = $record['FirstName'];
            $biographies[] = $record['Biography'];
            $birthdays[] = $record['Birthday'];
            $registered[] = $record['IsRegistered'];
        }

        $this->assertEquals(
            ['John','Jane','Jamie','Järg','Jacob'],
            $firstNames
        );

        $this->assertEquals(
            [
                "He's a good guy",
                "She is awesome."
                    . PHP_EOL
                    . "So awesome that she gets multiple rows and \"escaped\" strings in her biography",
                "Pretty old, with an escaped comma",
                "Unicode FTW",
                "Likes leading tabs in his biography",
            ],
            $biographies
        );
        $this->assertEquals([
            "1988-01-31",
            "1982-01-31",
            "1882-01-31",
            "1982-06-30",
            "2000-04-30",
        ], $birthdays);
        $this->assertEquals(
            ['1', '0', '1', '1', '0'],
            $registered
        );
    }

    public function testParsingWithHeadersAndColumnMap()
    {
        /* By default, a CSV file will be interpreted as having headers */
        $csv = new CSVParser($this->csvPath . 'PlayersWithHeader.csv');

        /* We can set up column remapping.  The keys are case-insensitive. */
        $csv->mapColumns([
            'FirstName' => '__fn',
            'bIoGrApHy' => '__BG',
        ]);

        $firstNames = $birthdays = $biographies = $registered = [];
        foreach ($csv as $record) {
            /* Each row in the CSV file will be keyed with the renamed columns.  Any unmapped column names will be
            * left as-is. */
            $this->assertEquals(['__fn','__BG','Birthday','IsRegistered'], array_keys($record ?? []));
            $firstNames[] = $record['__fn'];
            $biographies[] = $record['__BG'];
            $birthdays[] = $record['Birthday'];
            $registered[] = $record['IsRegistered'];
        }

        $this->assertEquals(['John','Jane','Jamie','Järg','Jacob'], $firstNames);
        $this->assertEquals(
            [
                "He's a good guy",
                "She is awesome."
                    . PHP_EOL
                    . "So awesome that she gets multiple rows and \"escaped\" strings in her biography",
                "Pretty old, with an escaped comma",
                "Unicode FTW",
                "Likes leading tabs in his biography",
            ],
            $biographies
        );
        $this->assertEquals([
            "1988-01-31",
            "1982-01-31",
            "1882-01-31",
            "1982-06-30",
            "2000-04-30",
        ], $birthdays);
        $this->assertEquals(['1', '0', '1', '1', '0'], $registered);
    }

    public function testParsingWithExplicitHeaderRow()
    {
        /* If your CSV file doesn't have a header row */
        $csv = new CSVParser($this->csvPath . 'PlayersWithHeader.csv');

        $csv->provideHeaderRow(['__fn','__bio','__bd','__reg']);

        $firstNames = $birthdays = $biographies = $registered = [];
        foreach ($csv as $record) {
            /* Each row in the CSV file will be keyed with the header row that you gave */
            $this->assertEquals(['__fn','__bio','__bd','__reg'], array_keys($record ?? []));
            $firstNames[] = $record['__fn'];
            $biographies[] = $record['__bio'];
            $birthdays[] = $record['__bd'];
            $registered[] = $record['__reg'];
        }

        /* And the first row will be returned in the data */
        $this->assertEquals(['FirstName','John','Jane','Jamie','Järg','Jacob'], $firstNames);
        $this->assertEquals(
            [
                'Biography',
                "He's a good guy",
                "She is awesome."
                    . PHP_EOL
                    . "So awesome that she gets multiple rows and \"escaped\" strings in her biography",
                "Pretty old, with an escaped comma",
                "Unicode FTW",
                "Likes leading tabs in his biography"
            ],
            $biographies
        );
        $this->assertEquals([
            "Birthday",
            "1988-01-31",
            "1982-01-31",
            "1882-01-31",
            "1982-06-30",
            "2000-04-30",
        ], $birthdays);
        $this->assertEquals(['IsRegistered', '1', '0', '1', '1', '0'], $registered);
    }
}