Dumper, Helpers::formatDocComment(), Printer::printFunction() & etc normalizes whitespace

Author: dg

src/PhpGenerator/Dumper.php

@@ -198,6 +198,7 @@ private function dumpObject(object $var, array $parents, int $level): string
 	private function dumpLiteral(Literal $var, int $level): string
 	{
 		$s = $var->formatWith($this);
+		$s = Nette\Utils\Strings::normalizeNewlines($s);
 		$s = Nette\Utils\Strings::indent(trim($s), $level, $this->indentation);
 		return ltrim($s, $this->indentation);
 	}

src/PhpGenerator/Extractor.php

@@ -48,7 +48,7 @@ private function parseCode(string $code): void
 			throw new Nette\InvalidStateException('The input string is not a PHP code.');
 		}
 
-		$this->code = str_replace("\r\n", "\n", $code);
+		$this->code = Nette\Utils\Strings::normalizeNewlines($code);
 		$lexer = new PhpParser\Lexer\Emulative(['usedAttributes' => ['startFilePos', 'endFilePos', 'comments']]);
 		$parser = (new ParserFactory)->create(ParserFactory::ONLY_PHP7, $lexer);
 		$stmts = $parser->parse($this->code);

src/PhpGenerator/Helpers.php

@@ -84,7 +84,8 @@ public static function formatDocComment(string $content): string
 		if ($s === '') {
 			return '';
 		} elseif (str_contains($content, "\n")) {
-			return str_replace("\n", "\n * ", "/**\n$s") . "\n */\n";
+			$s = str_replace("\n", "\n * ", "/**\n$s") . "\n */";
+			return Nette\Utils\Strings::normalize($s) . "\n";
 		} else {
 			return "/** $s */\n";
 		}

src/PhpGenerator/Printer.php

@@ -44,13 +44,14 @@ public function printFunction(GlobalFunction $function, ?PhpNamespace $namespace
 			. $function->getName();
 		$returnType = $this->printReturnType($function);
 		$body = Helpers::simplifyTaggedNames($function->getBody(), $this->namespace);
+		$body = ltrim(rtrim(Strings::normalize($body)) . "\n");
 
 		return Helpers::formatDocComment($function->getComment() . "\n")
 			. self::printAttributes($function->getAttributes())
 			. $line
 			. $this->printParameters($function, strlen($line) + strlen($returnType) + 2) // 2 = parentheses
 			. $returnType
-			. "\n{\n" . $this->indent(ltrim(rtrim($body) . "\n")) . "}\n";
+			. "\n{\n" . $this->indent($body) . "}\n";
 	}
 
 
@@ -66,14 +67,15 @@ public function printClosure(Closure $closure, ?PhpNamespace $namespace = null):
 			? "\n" . $this->indentation . implode(",\n" . $this->indentation, $uses) . ",\n"
 			: $tmp;
 		$body = Helpers::simplifyTaggedNames($closure->getBody(), $this->namespace);
+		$body = ltrim(rtrim(Strings::normalize($body)) . "\n");
 
 		return self::printAttributes($closure->getAttributes(), inline: true)
 			. 'function '
 			. ($closure->getReturnReference() ? '&' : '')
 			. $this->printParameters($closure)
 			. ($uses ? " use ($useStr)" : '')
 			. $this->printReturnType($closure)
-			. " {\n" . $this->indent(ltrim(rtrim($body) . "\n")) . '}';
+			. " {\n" . $this->indent($body) . '}';
 	}
 
 
@@ -93,7 +95,7 @@ public function printArrowFunction(Closure $closure, ?PhpNamespace $namespace =
 			. ($closure->getReturnReference() ? '&' : '')
 			. $this->printParameters($closure)
 			. $this->printReturnType($closure)
-			. ' => ' . trim($body) . ';';
+			. ' => ' . trim(Strings::normalize($body)) . ';';
 	}
 
 
@@ -110,7 +112,8 @@ public function printMethod(Method $method, ?PhpNamespace $namespace = null, boo
 			. $method->getName();
 		$returnType = $this->printReturnType($method);
 		$params = $this->printParameters($method, strlen($line) + strlen($returnType) + strlen($this->indentation) + 2);
-		$body = Helpers::simplifyTaggedNames((string) $method->getBody(), $this->namespace);
+		$body = Helpers::simplifyTaggedNames($method->getBody(), $this->namespace);
+		$body = ltrim(rtrim(Strings::normalize($body)) . "\n");
 
 		return Helpers::formatDocComment($method->getComment() . "\n")
 			. self::printAttributes($method->getAttributes())
@@ -119,10 +122,7 @@ public function printMethod(Method $method, ?PhpNamespace $namespace = null, boo
 			. $returnType
 			. ($method->isAbstract() || $isInterface
 				? ";\n"
-				: (str_contains($params, "\n") ? ' ' : "\n")
-					. "{\n"
-					. $this->indent(ltrim(rtrim($body) . "\n"))
-					. "}\n");
+				: (str_contains($params, "\n") ? ' ' : "\n") . "{\n" . $this->indent($body) . "}\n");
 	}
 
 

tests/PhpGenerator/Dumper.dump().phpt

@@ -49,6 +49,7 @@ Assert::same('\'He\ll\\\\\o \\\'wor\\\\\\\'ld\\\\\'', $dumper->dump('He\ll\\\o \
 // literal
 Assert::same('[$s]', $dumper->dump([new Literal('$s')]));
 Assert::same("[strlen('hello')]", $dumper->dump([new Literal('strlen(?)', ['hello'])]));
+Assert::same("a\nb", $dumper->dump(new Literal("a\r\nb")));
 
 
 // arrays

tests/PhpGenerator/Helpers.comments.phpt

@@ -17,6 +17,8 @@ Assert::same('', Helpers::formatDocComment(' '));
 Assert::same("/** @var string */\n", Helpers::formatDocComment('@var string'));
 Assert::same("/**\n * @var string\n */\n", Helpers::formatDocComment("@var string\n"));
 Assert::same("/**\n * A\n * B\n * C\n */\n", Helpers::formatDocComment("A\nB\nC\n"));
+Assert::same("/**\n * @var string\n */\n", Helpers::formatDocComment("@var string \r\n"));
+Assert::same("/**\n * A\n *\n * B\n */\n", Helpers::formatDocComment("A\n\nB"));
 
 Assert::same('', Helpers::unformatDocComment(''));
 Assert::same('', Helpers::unformatDocComment("/**  */\n\r\t"));

tests/PhpGenerator/Printer.phpt

@@ -45,7 +45,7 @@ $class->addMethod('first')
 	->addComment('@return resource')
 	->setFinal(true)
 	->setReturnType('stdClass')
-	->setBody("func();\nreturn ?;", [['aaaaaaaaaaaa' => 1, 'bbbbbbbbbbb' => 2, 'cccccccccccccc' => 3, 'dddddddddddd' => 4, 'eeeeeeeeeeee' => 5, 'ffffffff' => 6]])
+	->setBody("func(); \r\nreturn ?;", [['aaaaaaaaaaaa' => 1, 'bbbbbbbbbbb' => 2, 'cccccccccccccc' => 3, 'dddddddddddd' => 4, 'eeeeeeeeeeee' => 5, 'ffffffff' => 6]])
 	->addParameter('var')
 		->setType('stdClass');
 
@@ -67,7 +67,7 @@ sameFile(__DIR__ . '/expected/Printer.class-alt.expect', $printer->printClass($c
 $function = new Nette\PhpGenerator\GlobalFunction('func');
 $function
 	->setReturnType('stdClass')
-	->setBody("func();\nreturn 123;")
+	->setBody("func(); \r\nreturn 123;")
 	->addParameter('var')
 		->setType('stdClass');
 
@@ -77,7 +77,7 @@ sameFile(__DIR__ . '/expected/Printer.function.expect', $printer->printFunction(
 $closure = new Nette\PhpGenerator\Closure;
 $closure
 	->setReturnType('stdClass')
-	->setBody("func();\nreturn 123;")
+	->setBody("func(); \r\nreturn 123;")
 	->addParameter('var')
 		->setType('stdClass');