HeadingRowImportTest.php

<?php

namespace Maatwebsite\Excel\Tests;

use Maatwebsite\Excel\HeadingRowImport;
use Maatwebsite\Excel\Imports\HeadingRowFormatter;

class HeadingRowImportTest extends TestCase
{
    protected function tearDown(): void
    {
        HeadingRowFormatter::reset();
        parent::tearDown();
    }

    public function test_can_import_only_heading_row()
    {
        $import = new HeadingRowImport();

        $headings = $import->toArray('import-users-with-headings.xlsx');

        $this->assertEquals([
            [
                ['name', 'email'],
            ],
        ], $headings);
    }

    public function test_can_import_only_heading_row_with_custom_heading_row_formatter()
    {
        HeadingRowFormatter::extend('custom', function ($value) {
            return 'custom-' . $value;
        });

        HeadingRowFormatter::default('custom');

        $import = new HeadingRowImport();

        $headings = $import->toArray('import-users-with-headings.xlsx');

        $this->assertEquals([
            [
                ['custom-name', 'custom-email'],
            ],
        ], $headings);
    }

    public function test_can_import_only_heading_row_with_custom_heading_row_formatter_with_key()
    {
        HeadingRowFormatter::extend('custom', function ($value, $key) {
            return $key;
        });

        HeadingRowFormatter::default('custom');

        $import = new HeadingRowImport();

        $headings = $import->toArray('import-users-with-headings.xlsx');

        $this->assertEquals([
            [
                [0, 1],
            ],
        ], $headings);
    }

    public function test_can_import_only_heading_row_with_custom_row_number()
    {
        $import = new HeadingRowImport(2);

        $headings = $import->toArray('import-users-with-headings.xlsx');

        $this->assertEquals([
            [
                ['patrick_brouwers', 'patrick_at_maatwebsitenl'],
            ],
        ], $headings);
    }

    public function test_can_import_only_heading_row_for_multiple_sheets()
    {
        $import = new HeadingRowImport();

        $headings = $import->toArray('import-multiple-sheets.xlsx');

        $this->assertEquals([
            [
                ['1a1', '1b1'], // slugged first row of sheet 1
            ],
            [
                ['2a1', '2b1'], // slugged first row of sheet 2
            ],
        ], $headings);
    }

    public function test_can_import_only_heading_row_for_multiple_sheets_with_key()
    {
        HeadingRowFormatter::extend('custom', function ($value, $key) {
            return $key;
        });

        HeadingRowFormatter::default('custom');
        $import = new HeadingRowImport();

        $headings = $import->toArray('import-multiple-sheets.xlsx');

        $this->assertEquals([
            [
                [0, 1], // slugged first row of sheet 1
            ],
            [
                [0, 1], // slugged first row of sheet 2
            ],
        ], $headings);
    }

    public function test_can_import_only_heading_row_for_multiple_sheets_with_custom_row_number()
    {
        $import = new HeadingRowImport(2);

        $headings = $import->toArray('import-multiple-sheets.xlsx');

        $this->assertEquals([
            [
                ['1a2', '1b2'], // slugged 2nd row of sheet 1
            ],
            [
                ['2a2', '2b2'], // slugged 2nd row of sheet 2
            ],
        ], $headings);
    }

    public function test_can_import_heading_row_with_custom_formatter_defined_in_config()
    {
        HeadingRowFormatter::extend('custom2', function ($value) {
            return 'custom2-' . $value;
        });

        config()->set('excel.imports.heading_row.formatter', 'custom2');

        $import = new HeadingRowImport();

        $headings = $import->toArray('import-users-with-headings.xlsx');

        $this->assertEquals([
            [
                ['custom2-name', 'custom2-email'],
            ],
        ], $headings);
    }
}