Merge pull request #7 from mfn/preserve-new-line

converter: preserve new lines when inserting return type declarations

Author: dunglas

src/Converter.php

@@ -105,7 +105,15 @@ public function convert(Project $project, File $file): string
                             $return = $this->getReturn($project, $objectType, $namespace, $object, $function);
 
                             if ($return && $return[0] && !$return[1]) {
+                                if ($endsInNewLine = $this->endsInNewLine($output)) {
+                                    $output = substr($output, 0, -strlen($endsInNewLine));
+                                }
+
                                 $output .= sprintf(': %s', $return[0]);
+
+                                if ($endsInNewLine) {
+                                    $output .= $endsInNewLine;
+                                }
                             }
 
                             $function = null;
@@ -475,4 +483,26 @@ private function getType(Tag $tag): array
 
         return [$type->__toString(), false];
     }
+
+    /**
+     * Determines if the string ends in a new line and returns it.
+     *
+     * Will also include additional space/tab character if present, i.e. the
+     * indentation into the next line.
+     *
+     * Returns an empty string if no match was found.
+     *
+     * @param string $output
+     * @return string
+     */
+    private function endsInNewLine(string $output): string
+    {
+        $result = preg_match('/((?:\r\n|\r|\n)[ \t]*)$/', $output, $matches);
+
+        if (0 === $result) {
+            return '';
+        }
+
+        return $matches[1];
+    }
 }

tests/test.php

@@ -57,8 +57,8 @@ function foo()
  *
  * @return float
  */
-function bar(\DateTime $a = null, array $b, int $c = null, string $d, bool $e, callable $f = null)
-: float{
+function bar(\DateTime $a = null, array $b, int $c = null, string $d, bool $e, callable $f = null): float
+{
     return 0.0;
 }
 
@@ -98,8 +98,8 @@ function bat(int $a): string
  *
  * @return int
  */
-function test(string $a = null)
-: int{
+function test(string $a = null): int
+{
 }
 
 PHP
@@ -178,8 +178,8 @@ trait BazTrait
      *
      * @return \DateTime
      */
-    protected function inTrait(int $a)
-    : \DateTime{
+    protected function inTrait(int $a): \DateTime
+    {
     }
 }
 
@@ -210,8 +210,8 @@ public function test(float $a)
     /**
      * {@inheritdoc}
      */
-    public function baz(array $a, int $b)
-    : float{
+    public function baz(array $a, int $b): float
+    {
     }
 }