Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add option to limit export of (large) arrays (to speed up PHPUnit) #59

Merged
merged 8 commits into from
Jun 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 41 additions & 17 deletions src/Exporter.php
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,11 @@

final readonly class Exporter
{
public function __construct(
private int $shortenArraysLongerThan = 10
) {
}

/**
* Exports a value as a string.
*
Expand All @@ -58,30 +63,19 @@ public function export(mixed $value, int $indentation = 0): string

public function shortenedRecursiveExport(array &$data, ?RecursionContext $processed = null): string
{
$result = [];

if (!$processed) {
$processed = new RecursionContext;
}
$overallCount = count($data, COUNT_RECURSIVE);
$counter = 0;

$array = $data;
$export = $this->shortenedCountedRecursiveExport($data, $processed, $counter);

/* @noinspection UnusedFunctionResultInspection */
$processed->add($data);

foreach ($array as $key => $value) {
if (is_array($value)) {
if ($processed->contains($data[$key]) !== false) {
$result[] = '*RECURSION*';
} else {
$result[] = '[' . $this->shortenedRecursiveExport($data[$key], $processed) . ']';
}
} else {
$result[] = $this->shortenedExport($value);
}
if ($overallCount > $this->shortenArraysLongerThan) {
$export .= sprintf(', ...%d more elements', $overallCount - $this->shortenArraysLongerThan);
}

return implode(', ', $result);
return $export;
}

/**
Expand Down Expand Up @@ -195,6 +189,36 @@ public function toArray(mixed $value): array
return $array;
}

private function shortenedCountedRecursiveExport(array &$data, RecursionContext $processed, int &$counter): string
{
$result = [];

$array = $data;

/* @noinspection UnusedFunctionResultInspection */
$processed->add($data);

foreach ($array as $key => $value) {
if ($counter > $this->shortenArraysLongerThan) {
break;
}

if (is_array($value)) {
if ($processed->contains($data[$key]) !== false) {
$result[] = '*RECURSION*';
} else {
$result[] = '[' . $this->shortenedCountedRecursiveExport($data[$key], $processed, $counter) . ']';
}
} else {
$result[] = $this->shortenedExport($value);
}

$counter++;
}

return implode(', ', $result);
}

private function recursiveExport(mixed &$value, int $indentation = 0, ?RecursionContext $processed = null): string
{
if ($value === null) {
Expand Down
11 changes: 11 additions & 0 deletions tests/ExporterTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -321,6 +321,15 @@ public static function provideNonBinaryMultibyteStrings(): array

public static function shortenedRecursiveExportProvider(): array
{
$bigArray = [];

for ($i = 0; $i < 20_000; $i++) {
$bigArray[] = 'cast(\'foo' . $i . '\' as blob)';
}

$array = [1, 2, 'hello', 'world', true, false];
$deepArray = [$array, [$array, [$array, [$array, [$array, [$array, [$array, [$array, [$array, [$array]]]]]]]]]];

return [
'null' => [[null], 'null'],
'boolean true' => [[true], 'true'],
Expand All @@ -333,6 +342,8 @@ public static function shortenedRecursiveExportProvider(): array
'with assoc array key' => [['foo' => 'bar'], '\'bar\''],
'multidimensional array' => [[[1, 2, 3], [3, 4, 5]], '[1, 2, 3], [3, 4, 5]'],
'object' => [[new stdClass], 'stdClass Object ()'],
'big array' => [$bigArray, "'cast('foo0' as blob)', 'cast('foo1' as blob)', 'cast('foo2' as blob)', 'cast('foo3' as blob)', 'cast('foo4' as blob)', 'cast('foo5' as blob)', 'cast('foo6' as blob)', 'cast('foo7' as blob)', 'cast('foo8' as blob)', 'cast('foo9' as blob)', 'cast('foo10' as blob)', ...19990 more elements"],
'deep array' => [$deepArray, "[1, 2, 'hello', 'world', true, false], [[1, 2, 'hello', 'world']], ...69 more elements"],
];
}

Expand Down