Skip to content

Add "format" to ArrayGenerator options #13

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.

Sign up for GitHub

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

Open
mlocati wants to merge 1 commit into
base: master
Choose a base branch
from
+88 −21
Open

Add "format" to ArrayGenerator options #13

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
93 changes: 74 additions & 19 deletions src/Generator/ArrayGenerator.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,21 @@ final class ArrayGenerator extends Generator
*/
const PRETTY_INDENT = ' ';

/**
* @private
*/
const FORMAT_NORMAL = 'normal';

/**
* @private
*/
const FORMAT_PRETTY = 'pretty';

/**
* @private
*/
const FORMAT_COMPACT = 'compact';

/**
* @var bool
*/
Expand All @@ -25,34 +40,66 @@ final class ArrayGenerator extends Generator
private $strictTypes;

/**
* @var bool
* @var string
*/
private $pretty;
private $format;

/**
* Constructs a new ArrayGenerator
* @param array|null $options
*
* bool includeEmpty Controls whether empty translations should be included (default: false)
* @param array {
* includeEmpty?: bool, // Controls whether empty translations should be included (default: false)
* strictTypes?: bool, // Add declare(strict_types=1) (default: false)
* format?: 'normal'|'pretty'|'compact' // How to format the code (default: 'normal')
* pretty?: bool, // Deprecated: use format instead (default: false)
* } | null $options
*/
public function __construct(?array $options = null)
{
$this->includeEmpty = (bool) ($options['includeEmpty'] ?? false);
$this->strictTypes = (bool) ($options['strictTypes'] ?? false);
$this->pretty = (bool) ($options['pretty'] ?? false);
if (!isset($options['format'])) {
$this->format = ($options['pretty'] ?? false) ? self::FORMAT_PRETTY : self::FORMAT_NORMAL;
} elseif (in_array($options['format'], [self::FORMAT_PRETTY, self::FORMAT_COMPACT], true)) {
$this->format = $options['format'];
} else {
$this->format = self::FORMAT_NORMAL;
}
}

public function generateString(Translations $translations): string
{
$array = $this->generateArray($translations);
$result = '<?php';
if ($this->pretty) {
$result .= $this->strictTypes ? "\n\ndeclare(strict_types=1);\n\n" : "\n\n";
if ($this->strictTypes) {
switch ($this->format) {
case self::FORMAT_PRETTY:
$result .= "\n\ndeclare(strict_types=1);\n\n";
break;
case self::FORMAT_COMPACT:
$result .= ' declare(strict_types=1);';
break;
case self::FORMAT_NORMAL:
default:
$result .= ' declare(strict_types=1); ';
break;
}
} else {
$result .= $this->strictTypes ? ' declare(strict_types=1); ' : ' ';
$result .= $this->format === self::FORMAT_PRETTY ? "\n\n" : ' ';
}
switch ($this->format) {
case self::FORMAT_PRETTY:
$result .= self::format($array, false);
break;
case self::FORMAT_COMPACT:
$result .= self::format($array, true);
break;
case self::FORMAT_NORMAL:
default:
$result .= 'return ' . var_export($array, true) . ';';
break;
}

return $result . 'return ' . ($this->pretty ? self::prettyExport($array) : (var_export($array, true) . ';'));
return $result;
}

public function generateArray(Translations $translations): array
Expand Down Expand Up @@ -95,34 +142,42 @@ private static function hasPluralTranslations(Translation $translation): bool
return implode('', $translation->getPluralTranslations()) !== '';
}

private static function prettyExport(array &$array): string
private static function format(array &$array, bool $compact): string
{
return self::prettyExportArray($array, 0) . ";\n";
return 'return ' . self::formatArray($array, $compact, 0) . ($compact ? ';' : ";\n");
}

private static function prettyExportArray(array &$array, int $depth): string
private static function formatArray(array &$array, bool $compact, int $depth): string
{
if ($array === []) {
return '[]';
}
$result = '[';
$isList = self::isList($array);
foreach ($array as $key => $value) {
$result .= "\n" . str_repeat(self::PRETTY_INDENT, $depth + 1);
if (!$compact) {
$result .= "\n" . str_repeat(self::PRETTY_INDENT, $depth + 1);
}
if (!$isList) {
$result .= var_export($key, true) . ' => ';
$result .= var_export($key, true) . ($compact ? '=>' : ' => ');
}
if (is_array($value)) {
$result .= self::prettyExportArray($value, $depth + 1);
$result .= self::formatArray($value, $compact, $depth + 1);
} else {
$result .= self::prettyExportScalar($value);
$result .= self::formatScalar($value);
}
$result .= ',';
}
return $result . "\n" . str_repeat(self::PRETTY_INDENT, $depth) . ']';
if ($compact) {
$result = substr($result, 0, -1);
} else {
$result .= "\n" . str_repeat(self::PRETTY_INDENT, $depth);
}

return $result . ']';
}

private static function prettyExportScalar($value): string
private static function formatScalar($value): string
{
return $value === null ? 'null' : var_export($value, true);
}
Expand Down
16 changes: 14 additions & 2 deletions tests/ArrayGeneratorTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,18 +83,30 @@ private function checkFormatting(array $expected, Translations $translations, ar
['strictTypes' => true],
['pretty' => true],
['strictTypes' => true, 'pretty' => true],
['strictTypes' => true, 'format' => 'pretty'],
['strictTypes' => true, 'format' => 'compact'],
] as $options) {
$phpCode = (new ArrayGenerator($options + $otherOptions))->generateString($translations);
if (empty($options['strictTypes'])) {
$this->assertStringNotContainsString('declare(strict_types=1);', $phpCode);
} else {
$this->assertStringContainsString('declare(strict_types=1);', $phpCode);
}
if (empty($options['pretty'])) {
if (!empty($options['pretty']) || ($options['format'] ?? '') === 'pretty') {
$this->assertStringEndsWith("];\n", $phpCode);
} elseif (($options['format'] ?? '') === 'compact') {
$this->assertStringEndsWith('];', $phpCode);
} else {
$this->assertStringEndsWith(');', $phpCode);
}
if (($options['format'] ?? '') === 'compact') {
self::assertStringNotContainsString("\n", $phpCode);
} else {
self::assertStringContainsString("\n", $phpCode);
}
if (($options['format'] ?? '') === 'compact' || (empty($options['pretty']) && ($options['format'] ?? '') !== 'pretty')) {
$prefix = '<?php ';
} else {
$this->assertStringEndsWith("];\n", $phpCode);
$prefix = "<?php\n";
}
$this->assertStringStartsWith($prefix, $phpCode);
Expand Down