NN2024010801/vendor/maatwebsite/excel/tests/Concerns/FromQueryTest.php

<?php

namespace Maatwebsite\Excel\Tests\Concerns;

use Illuminate\Support\Facades\DB;
use Maatwebsite\Excel\Tests\Data\Stubs\Database\Group;
use Maatwebsite\Excel\Tests\Data\Stubs\Database\User;
use Maatwebsite\Excel\Tests\Data\Stubs\FromGroupUsersQueuedQueryExport;
use Maatwebsite\Excel\Tests\Data\Stubs\FromNestedArraysQueryExport;
use Maatwebsite\Excel\Tests\Data\Stubs\FromNonEloquentQueryExport;
use Maatwebsite\Excel\Tests\Data\Stubs\FromUsersQueryExport;
use Maatwebsite\Excel\Tests\Data\Stubs\FromUsersQueryExportWithEagerLoad;
use Maatwebsite\Excel\Tests\Data\Stubs\FromUsersQueryExportWithPrepareRows;
use Maatwebsite\Excel\Tests\Data\Stubs\FromUsersScoutExport;
use Maatwebsite\Excel\Tests\TestCase;

class FromQueryTest extends TestCase
{
    /**
     * Setup the test environment.
     */
    protected function setUp(): void
    {
        parent::setUp();

        $this->loadLaravelMigrations(['--database' => 'testing']);
        $this->withFactories(__DIR__ . '/../Data/Stubs/Database/Factories');
        $this->loadMigrationsFrom(dirname(__DIR__) . '/Data/Stubs/Database/Migrations');

        $group = factory(Group::class)->create([
            'name' => 'Group 1',
        ]);

        factory(User::class)->times(100)->create()->each(function (User $user) use ($group) {
            $user->groups()->save($group);
        });

        $group_two = factory(Group::class)->create([
            'name' => 'Group 2',
        ]);

        factory(User::class)->times(5)->create()->each(function (User $user) use ($group_two) {
            $user->groups()->save($group_two);
        });
    }

    /**
     * @test
     */
    public function can_export_from_query()
    {
        $export = new FromUsersQueryExport;

        $response = $export->store('from-query-store.xlsx');

        $this->assertTrue($response);

        $contents = $this->readAsArray(__DIR__ . '/../Data/Disks/Local/from-query-store.xlsx', 'Xlsx');

        $allUsers = $export->query()->get()->map(function (User $user) {
            return array_values($user->toArray());
        })->toArray();

        $this->assertEquals($allUsers, $contents);
    }

    /**
     * @test
     */
    public function can_export_from_relation_query_queued()
    {
        $export = new FromGroupUsersQueuedQueryExport();

        $export->queue('from-query-store.xlsx');

        $contents = $this->readAsArray(__DIR__ . '/../Data/Disks/Local/from-query-store.xlsx', 'Xlsx');

        $allUsers = $export->query()->get()->map(function ($row) use ($export) {
            return $export->map($row);
        })->toArray();

        $this->assertEquals($allUsers, $contents);
    }

    /**
     * @test
     */
    public function can_export_from_query_with_eager_loads()
    {
        DB::connection()->enableQueryLog();
        $export = new FromUsersQueryExportWithEagerLoad();

        $response = $export->store('from-query-with-eager-loads.xlsx');

        $this->assertTrue($response);

        // Should be 2 queries:
        // 1) select all users
        // 2) eager load query for groups
        $this->assertCount(2, DB::getQueryLog());
        DB::connection()->disableQueryLog();

        $contents = $this->readAsArray(__DIR__ . '/../Data/Disks/Local/from-query-with-eager-loads.xlsx', 'Xlsx');

        $allUsers = $export->query()->get()->map(function (User $user) use ($export) {
            return $export->map($user);
        })->toArray();

        $this->assertEquals($allUsers, $contents);
    }

    /**
     * @test
     */
    public function can_export_from_query_with_eager_loads_and_queued()
    {
        DB::connection()->enableQueryLog();
        $export = new FromUsersQueryExportWithEagerLoad();

        $export->queue('from-query-with-eager-loads.xlsx');

        // Should be 3 queries:
        // 1) Count users to create chunked queues
        // 2) select all users
        // 3) eager load query for groups
        $this->assertCount(3, DB::getQueryLog());
        DB::connection()->disableQueryLog();

        $contents = $this->readAsArray(__DIR__ . '/../Data/Disks/Local/from-query-with-eager-loads.xlsx', 'Xlsx');

        $allUsers = $export->query()->get()->map(function (User $user) use ($export) {
            return $export->map($user);
        })->toArray();

        $this->assertEquals($allUsers, $contents);
    }

    /**
     * @test
     */
    public function can_export_from_query_builder_without_using_eloquent()
    {
        $export = new FromNonEloquentQueryExport();

        $response = $export->store('from-query-without-eloquent.xlsx');

        $this->assertTrue($response);

        $contents = $this->readAsArray(__DIR__ . '/../Data/Disks/Local/from-query-without-eloquent.xlsx', 'Xlsx');

        $allUsers = $export->query()->get()->map(function ($row) {
            return array_values((array) $row);
        })->all();

        $this->assertEquals($allUsers, $contents);
    }

    /**
     * @test
     */
    public function can_export_from_query_builder_without_using_eloquent_and_queued()
    {
        $export = new FromNonEloquentQueryExport();

        $export->queue('from-query-without-eloquent.xlsx');

        $contents = $this->readAsArray(__DIR__ . '/../Data/Disks/Local/from-query-without-eloquent.xlsx', 'Xlsx');

        $allUsers = $export->query()->get()->map(function ($row) {
            return array_values((array) $row);
        })->all();

        $this->assertEquals($allUsers, $contents);
    }

    /**
     * @test
     */
    public function can_export_from_query_builder_with_nested_arrays()
    {
        $export = new FromNestedArraysQueryExport();

        $response = $export->store('from-query-with-nested-arrays.xlsx');

        $this->assertTrue($response);

        $contents = $this->readAsArray(__DIR__ . '/../Data/Disks/Local/from-query-with-nested-arrays.xlsx', 'Xlsx');

        $this->assertEquals($this->format_nested_arrays_expected_data($export->query()->get()), $contents);
    }

    /**
     * @test
     */
    public function can_export_from_query_builder_with_nested_arrays_queued()
    {
        $export = new FromNestedArraysQueryExport();

        $export->queue('from-query-with-nested-arrays.xlsx');

        $contents = $this->readAsArray(__DIR__ . '/../Data/Disks/Local/from-query-with-nested-arrays.xlsx', 'Xlsx');

        $this->assertEquals($this->format_nested_arrays_expected_data($export->query()->get()), $contents);
    }

    /**
     * @test
     */
    public function can_export_from_query_with_batch_caching()
    {
        config()->set('excel.cache.driver', 'batch');

        $export = new FromUsersQueryExport;

        $response = $export->store('from-query-store.xlsx');

        $this->assertTrue($response);

        $contents = $this->readAsArray(__DIR__ . '/../Data/Disks/Local/from-query-store.xlsx', 'Xlsx');

        $allUsers = $export->query()->get()->map(function (User $user) {
            return array_values($user->toArray());
        })->toArray();

        $this->assertEquals($allUsers, $contents);
    }

    /**
     * @test
     */
    public function can_export_from_query_with_prepare_rows()
    {
        $export = new FromUsersQueryExportWithPrepareRows;

        $this->assertTrue(method_exists($export, 'prepareRows'));

        $response = $export->store('from-query-store.xlsx');

        $this->assertTrue($response);

        $contents = $this->readAsArray(__DIR__ . '/../Data/Disks/Local/from-query-store.xlsx', 'Xlsx');

        $allUsers = $export->query()->get()->map(function (User $user) {
            $user->name .= '_prepared_name';

            return array_values($user->toArray());
        })->toArray();

        $this->assertEquals($allUsers, $contents);
    }

    /**
     * @test
     */
    public function can_export_from_scout()
    {
        if (!class_exists('\Laravel\Scout\Engines\DatabaseEngine')) {
            $this->markTestSkipped('Laravel Scout is too old');

            return;
        }

        $export = new FromUsersScoutExport;

        $response = $export->store('from-scout-store.xlsx');

        $this->assertTrue($response);

        $contents = $this->readAsArray(__DIR__ . '/../Data/Disks/Local/from-scout-store.xlsx', 'Xlsx');

        $allUsers = $export->query()->get()->map(function (User $user) {
            return array_values($user->toArray());
        })->toArray();

        $this->assertEquals($allUsers, $contents);
    }

    protected function format_nested_arrays_expected_data($groups)
    {
        $expected = [];
        foreach ($groups as $group) {
            $group_row = [$group->name, ''];

            foreach ($group->users as $key => $user) {
                if ($key === 0) {
                    $group_row[1] = $user->email;
                    $expected[]   = $group_row;
                    continue;
                }

                $expected[] = ['', $user->email];
            }
        }

        return $expected;
    }
}