Printer, Dumper: array wrapping counts with property/constant name le…

…ngth [Closes #45] (#47)
nette · Nov 20, 2019 · 22228fd · 22228fd
1 parent 4d46580
commit 22228fd
Show file tree

Hide file tree

Showing 8 changed files with 159 additions and 46 deletions.
diff --git a/src/PhpGenerator/Dumper.php b/src/PhpGenerator/Dumper.php
@@ -32,13 +32,13 @@ final class Dumper
 	/**
 	 * Returns a PHP representation of a variable.
 	 */
-	public function dump($var): string
+	public function dump($var, int $indent = 0): string
 	{
-		return $this->dumpVar($var);
+		return $this->dumpVar($var, [], 0, $indent);
 	}
 
 
-	private function dumpVar(&$var, array $parents = [], int $level = 0): string
+	private function dumpVar(&$var, array $parents = [], int $level = 0, int $indent = 0): string
 	{
 		if ($var instanceof PhpLiteral) {
 			return (string) $var;
@@ -50,7 +50,7 @@ private function dumpVar(&$var, array $parents = [], int $level = 0): string
 			return $this->dumpString($var);
 
 		} elseif (is_array($var)) {
-			return $this->dumpArray($var, $parents, $level);
+			return $this->dumpArray($var, $parents, $level, $indent);
 
 		} elseif (is_object($var)) {
 			return $this->dumpObject($var, $parents, $level);
@@ -86,7 +86,7 @@ private function dumpString(string $var): string
 	}
 
 
-	private function dumpArray(array &$var, array $parents, int $level): string
+	private function dumpArray(array &$var, array $parents, int $level, int $indent): string
 	{
 		if (empty($var)) {
 			return '[]';
@@ -102,14 +102,18 @@ private function dumpArray(array &$var, array $parents, int $level): string
 		$counter = 0;
 
 		foreach ($var as $k => &$v) {
-			$item = ($k === $counter ? '' : $this->dumpVar($k, $parents, $level + 1) . ' => ') . $this->dumpVar($v, $parents, $level + 1);
+			$keyPart = $k === $counter ? '' : $this->dumpVar($k, $parents) . ' => ';
 			$counter = is_int($k) ? max($k + 1, $counter) : $counter;
-			$outInline .= ($outInline === '' ? '' : ', ') . $item;
-			$outWrapped .= $this->indentation . $item . ",\n" . $space;
+			$outInline .= ($outInline === '' ? '' : ', ') . $keyPart;
+			$outInline .= $this->dumpVar($v, $parents, 0, $indent + strlen($outInline));
+			$outWrapped .= $this->indentation
+				. $keyPart
+				. $this->dumpVar($v, $parents, $level + 1, strlen($keyPart))
+				. ",\n$space";
 		}
 
 		array_pop($parents);
-		$wrap = strpos($outInline, "\n") !== false || strlen($outInline) > $this->wrapLength - $level * self::INDENT_SIZE;
+		$wrap = strpos($outInline, "\n") !== false || $level * self::INDENT_SIZE + $indent + strlen($outInline) + 3 > $this->wrapLength; // 3 = [],
 		return '[' . ($wrap ? $outWrapped : $outInline) . ']';
 	}
 
@@ -148,7 +152,10 @@ private function dumpObject(&$var, array $parents, int $level): string
 
 		foreach ($arr as $k => &$v) {
 			if (!isset($props) || isset($props[$k])) {
-				$out .= $space . $this->indentation . $this->dumpVar($k, $parents, $level + 1) . ' => ' . $this->dumpVar($v, $parents, $level + 1) . ",\n";
+				$out .= $space . $this->indentation
+					. ($keyPart = $this->dumpVar($k, $parents) . ' => ')
+					. $this->dumpVar($v, $parents, $level + 1, strlen($keyPart))
+					. ",\n";
 			}
 		}
 

diff --git a/src/PhpGenerator/Printer.php b/src/PhpGenerator/Printer.php
@@ -112,19 +112,22 @@ public function printClass(ClassType $class, PhpNamespace $namespace = null): st
 
 		$consts = [];
 		foreach ($class->getConstants() as $const) {
+			$def = ($const->getVisibility() ? $const->getVisibility() . ' ' : '') . 'const ' . $const->getName() . ' = ';
 			$consts[] = Helpers::formatDocComment((string) $const->getComment())
-				. ($const->getVisibility() ? $const->getVisibility() . ' ' : '')
-				. 'const ' . $const->getName() . ' = ' . $this->dump($const->getValue()) . ";\n";
+				. $def
+				. $this->dump($const->getValue(), strlen($def)) . ";\n";
 		}
 
 		$properties = [];
 		foreach ($class->getProperties() as $property) {
 			$type = $property->getType();
-			$properties[] = Helpers::formatDocComment((string) $property->getComment())
-				. ($property->getVisibility() ?: 'public') . ($property->isStatic() ? ' static' : '') . ' '
+			$def = (($property->getVisibility() ?: 'public') . ($property->isStatic() ? ' static' : '') . ' '
 				. ($type ? ($property->isNullable() ? '?' : '') . ($this->resolveTypes && $namespace ? $namespace->unresolveName($type) : $type) . ' ' : '')
-				. '$' . $property->getName()
-				. ($property->getValue() === null && !$property->isInitialized() ? '' : ' = ' . $this->dump($property->getValue()))
+				. '$' . $property->getName());
+
+			$properties[] = Helpers::formatDocComment((string) $property->getComment())
+				. $def
+				. ($property->getValue() === null && !$property->isInitialized() ? '' : ' = ' . $this->dump($property->getValue(), strlen($def) + 3)) // 3 = ' = '
 				. ";\n";
 		}
 
@@ -214,11 +217,11 @@ protected function indent(string $s): string
 	}
 
 
-	protected function dump($var): string
+	protected function dump($var, int $firstIndent = 0): string
 	{
 		$dumper = new Dumper;
 		$dumper->indentation = $this->indentation;
-		return $dumper->dump($var);
+		return $dumper->dump($var, $firstIndent);
 	}
 
 

diff --git a/tests/PhpGenerator/Dumper.dump().indent.phpt b/tests/PhpGenerator/Dumper.dump().indent.phpt
@@ -0,0 +1,40 @@
+<?php
+
+/**
+ * Test: Nette\PhpGenerator\Dumper::dump()
+ */
+
+declare(strict_types=1);
+
+use Nette\PhpGenerator\Dumper;
+use Tester\Assert;
+
+
+require __DIR__ . '/../bootstrap.php';
+
+
+$dumper = new Dumper;
+
+Assert::same('[1, 2, 3]', $dumper->dump([1, 2, 3], $dumper->wrapLength - 10));
+
+same('[
+	1,
+	2,
+	3,
+]', $dumper->dump([1, 2, 3], $dumper->wrapLength - 8));
+
+
+// ignore indent after new line
+same('[
+	[1, 2, 3],
+]', $dumper->dump([[1, 2, 3]], $dumper->wrapLength - 8));
+
+
+// counts with length of key
+Assert::same('[8 => 1, 2, 3]', $dumper->dump([8 => 1, 2, 3], $dumper->wrapLength - 15));
+
+same('[
+	8 => 1,
+	2,
+	3,
+]', $dumper->dump([8 => 1, 2, 3], $dumper->wrapLength - 13));
diff --git a/tests/PhpGenerator/Dumper.dump().wrap.phpt b/tests/PhpGenerator/Dumper.dump().wrap.phpt
@@ -0,0 +1,53 @@
+<?php
+
+/**
+ * Test: Nette\PhpGenerator\Dumper::dump()
+ */
+
+declare(strict_types=1);
+
+use Nette\PhpGenerator\Dumper;
+
+
+require __DIR__ . '/../bootstrap.php';
+
+
+$dumper = new Dumper;
+$dumper->wrapLength = 21;
+same("[
+	'a' => [1, 2, 3],
+	'aaaaaaaaa' => [
+		1,
+		2,
+		3,
+	],
+]",
+	$dumper->dump([
+		'a' => [1, 2, 3],
+		'aaaaaaaaa' => [1, 2, 3],
+	])
+);
+
+same("(object) [
+	'a' => [1, 2, 3],
+	'aaaaaaaaa' => [
+		1,
+		2,
+		3,
+	],
+]",
+	$dumper->dump((object) [
+		'a' => [1, 2, 3],
+		'aaaaaaaaa' => [1, 2, 3],
+	])
+);
+
+
+$dumper = new Dumper;
+$dumper->wrapLength = 100;
+same("[
+	[
+		'a',
+		'looooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooong',
+	],
+]", $dumper->dump([['a', 'looooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooong']]));
diff --git a/tests/PhpGenerator/Printer.phpt b/tests/PhpGenerator/Printer.phpt
@@ -26,7 +26,8 @@ $class->addConstant('FORCE_ARRAY', new PhpLiteral('Nette\Utils\Json::FORCE_ARRAY
 	->setVisibility('private')
 	->addComment('Commented');
 
-$class->addConstant('MULTILINE', ['aaaaaaaaaaaa' => 1, 'bbbbbbbbbbb' => 2, 'cccccccccccccc' => 3, 'dddddddddddd' => 4, 'eeeeeeeeeeee' => 5]);
+$class->addConstant('MULTILINE_LONG', ['aaaaaaa' => 1, 'bbbbbbb' => 2, 'ccccccc' => 3, 'ddddddd' => 4, 'eeeeee' => 5]);
+$class->addConstant('SHORT', ['aaaaaaa' => 1, 'bbbbbbb' => 2, 'ccccccc' => 3, 'ddddddd' => 4, 'eeeeee' => 5]);
 
 $class->addProperty('handle')
 	->setVisibility('private')
@@ -35,7 +36,8 @@ $class->addProperty('handle')
 $class->addProperty('order')
 	->setValue(new PhpLiteral('RecursiveIteratorIterator::SELF_FIRST'));
 
-$class->addProperty('multiline', ['aaaaaaaaaaaa' => 1, 'bbbbbbbbbbb' => 2, 'cccccccccccccc' => 3, 'dddddddddddd' => 4, 'eeeeeeeeeeee' => 5]);
+$class->addProperty('multilineLong', ['aaaaaaa' => 1, 'bbbbbbb' => 2, 'ccccccc' => 3, 'ddddddd' => 4, 'eeeeee' => 5]);
+$class->addProperty('short', ['aaaaaaa' => 1, 'bbbbbbb' => 2, 'ccccccc' => 3, 'ddddddd' => 4, 'eeeeee' => 5]);
 
 $class->addMethod('first')
 	->addComment('@return resource')

diff --git a/tests/PhpGenerator/PsrPrinter.phpt b/tests/PhpGenerator/PsrPrinter.phpt
@@ -25,7 +25,8 @@ $class->addConstant('FORCE_ARRAY', new PhpLiteral('Nette\Utils\Json::FORCE_ARRAY
 	->setVisibility('private')
 	->addComment('Commented');
 
-$class->addConstant('MULTILINE', ['aaaaaaaaaaaa' => 1, 'bbbbbbbbbbb' => 2, 'cccccccccccccc' => 3, 'dddddddddddd' => 4, 'eeeeeeeeeeee' => 5]);
+$class->addConstant('MULTILINE_LONG', ['aaaaaaa' => 1, 'bbbbbbb' => 2, 'ccccccc' => 3, 'ddddddd' => 4, 'eeeeee' => 5]);
+$class->addConstant('SHORT', ['aaaaaaa' => 1, 'bbbbbbb' => 2, 'ccccccc' => 3, 'ddddddd' => 4, 'eeeeee' => 5]);
 
 $class->addProperty('handle')
 	->setVisibility('private')
@@ -34,7 +35,8 @@ $class->addProperty('handle')
 $class->addProperty('order')
 	->setValue(new PhpLiteral('RecursiveIteratorIterator::SELF_FIRST'));
 
-$class->addProperty('multiline', ['aaaaaaaaaaaa' => 1, 'bbbbbbbbbbb' => 2, 'cccccccccccccc' => 3, 'dddddddddddd' => 4, 'eeeeeeeeeeee' => 5]);
+$class->addProperty('multilineLong', ['aaaaaaa' => 1, 'bbbbbbb' => 2, 'ccccccc' => 3, 'ddddddd' => 4, 'eeeeee' => 5]);
+$class->addProperty('short', ['aaaaaaa' => 1, 'bbbbbbb' => 2, 'ccccccc' => 3, 'ddddddd' => 4, 'eeeeee' => 5]);
 
 $class->addMethod('first')
 	->addComment('@return resource')

diff --git a/tests/PhpGenerator/expected/Printer.class.expect b/tests/PhpGenerator/expected/Printer.class.expect
@@ -11,27 +11,30 @@ final class Example extends ParentClass implements IExample
 
 	/** Commented */
 	private const FORCE_ARRAY = Nette\Utils\Json::FORCE_ARRAY;
-	const MULTILINE = [
-		'aaaaaaaaaaaa' => 1,
-		'bbbbbbbbbbb' => 2,
-		'cccccccccccccc' => 3,
-		'dddddddddddd' => 4,
-		'eeeeeeeeeeee' => 5,
+	const MULTILINE_LONG = [
+		'aaaaaaa' => 1,
+		'bbbbbbb' => 2,
+		'ccccccc' => 3,
+		'ddddddd' => 4,
+		'eeeeee' => 5,
 	];
+	const SHORT = ['aaaaaaa' => 1, 'bbbbbbb' => 2, 'ccccccc' => 3, 'ddddddd' => 4, 'eeeeee' => 5];
 
 	/** @var resource  orignal file handle */
 	private $handle;
 
 	public $order = RecursiveIteratorIterator::SELF_FIRST;
 
-	public $multiline = [
-		'aaaaaaaaaaaa' => 1,
-		'bbbbbbbbbbb' => 2,
-		'cccccccccccccc' => 3,
-		'dddddddddddd' => 4,
-		'eeeeeeeeeeee' => 5,
+	public $multilineLong = [
+		'aaaaaaa' => 1,
+		'bbbbbbb' => 2,
+		'ccccccc' => 3,
+		'ddddddd' => 4,
+		'eeeeee' => 5,
 	];
 
+	public $short = ['aaaaaaa' => 1, 'bbbbbbb' => 2, 'ccccccc' => 3, 'ddddddd' => 4, 'eeeeee' => 5];
+
 
 	/**
 	 * @return resource

diff --git a/tests/PhpGenerator/expected/PsrPrinter.class.expect b/tests/PhpGenerator/expected/PsrPrinter.class.expect
@@ -11,27 +11,30 @@ final class Example extends ParentClass implements IExample
 
     /** Commented */
     private const FORCE_ARRAY = Nette\Utils\Json::FORCE_ARRAY;
-    const MULTILINE = [
-        'aaaaaaaaaaaa' => 1,
-        'bbbbbbbbbbb' => 2,
-        'cccccccccccccc' => 3,
-        'dddddddddddd' => 4,
-        'eeeeeeeeeeee' => 5,
+    const MULTILINE_LONG = [
+        'aaaaaaa' => 1,
+        'bbbbbbb' => 2,
+        'ccccccc' => 3,
+        'ddddddd' => 4,
+        'eeeeee' => 5,
     ];
+    const SHORT = ['aaaaaaa' => 1, 'bbbbbbb' => 2, 'ccccccc' => 3, 'ddddddd' => 4, 'eeeeee' => 5];
 
     /** @var resource  orignal file handle */
     private $handle;
 
     public $order = RecursiveIteratorIterator::SELF_FIRST;
 
-    public $multiline = [
-        'aaaaaaaaaaaa' => 1,
-        'bbbbbbbbbbb' => 2,
-        'cccccccccccccc' => 3,
-        'dddddddddddd' => 4,
-        'eeeeeeeeeeee' => 5,
+    public $multilineLong = [
+        'aaaaaaa' => 1,
+        'bbbbbbb' => 2,
+        'ccccccc' => 3,
+        'ddddddd' => 4,
+        'eeeeee' => 5,
     ];
 
+    public $short = ['aaaaaaa' => 1, 'bbbbbbb' => 2, 'ccccccc' => 3, 'ddddddd' => 4, 'eeeeee' => 5];
+
     /**
      * @return resource
      */