Added support for return having a nl prefix if one was there previously (#11)

* Added support for return having a nl prefix if one was there previously
* Added negative test case

Author: jaxwilko

src/Printer/ArrayPrinter.php

@@ -26,6 +26,7 @@ class ArrayPrinter extends Standard
      */
 
     public const T_PAREN_OPEN = 40;
+
     /**
      * @var int T_PAREN_CLOSE represents the token id for `)`
      */
@@ -133,6 +134,33 @@ protected function pCommaSeparatedMultiline(array $nodes, bool $trailingComma):
         return $result;
     }
 
+    /**
+     * Render a return statement
+     *
+     * @param Stmt\Return_ $node Return statement node
+     *
+     * @return string Return followed by the return value
+     */
+    protected function pStmt_Return(Stmt\Return_ $node): string
+    {
+        // Get tokens from parser
+        $tokens = $this->parser->getTokens();
+
+        // Get the previous 2 tokens before the current node
+        $previousTokens = array_splice($tokens, $node->getAttribute('startTokenPos') - 2, 2);
+
+        // If the last token was whitespace and the token before that was not whitespace and the
+        // whitespace token was a double return, then prefix a \n
+        $prefix = (
+            count($previousTokens) > 1
+            && $previousTokens[1]->id === T_WHITESPACE
+            && $previousTokens[0]->id !== T_WHITESPACE
+            && $previousTokens[1]->text === PHP_EOL . PHP_EOL
+        ) ? "\n" : '';
+
+        return $prefix . 'return' . (null !== $node->expr ? ' ' . $this->p($node->expr) : '') . ';';
+    }
+
     /**
      * Render an array expression
      *

tests/ArrayFileTest.php

@@ -245,11 +245,51 @@ public function testConfigImports()
 <?php
 
 use Symfony\Component\HttpFoundation\Response;
+
 return [
     'foo' => Response::HTTP_OK,
     'bar' => Response::HTTP_I_AM_A_TEAPOT,
 ];
 
+PHP;
+
+        $this->assertEquals(str_replace("\r", '', $expected), $arrayFile->render());
+    }
+
+    public function testConfigImportComplex()
+    {
+        $arrayFile = ArrayFile::open(__DIR__ . '/fixtures/array/import-complex.php');
+
+        $expected = <<<PHP
+<?php
+
+use Symfony\Component\HttpFoundation\Response;
+use Example\EnumExample;
+
+return [
+    'foo' => Response::HTTP_OK,
+    'bar' => EnumExample::Value->value,
+];
+
+PHP;
+
+        $this->assertEquals(str_replace("\r", '', $expected), $arrayFile->render());
+    }
+
+    public function testConfigImportCompact()
+    {
+        $arrayFile = ArrayFile::open(__DIR__ . '/fixtures/array/import-compact.php');
+
+        $expected = <<<PHP
+<?php
+
+use Symfony\Component\HttpFoundation\Response;
+use Example\EnumExample;
+return [
+    'foo' => Response::HTTP_OK,
+    'bar' => EnumExample::Value->value,
+];
+
 PHP;
 
         $this->assertEquals(str_replace("\r", '', $expected), $arrayFile->render());
@@ -264,6 +304,7 @@ public function testConfigImportsUpdating()
 <?php
 
 use Symfony\Component\HttpFoundation\Response;
+
 return [
     'foo' => Response::HTTP_CONFLICT,
     'bar' => Response::HTTP_I_AM_A_TEAPOT,
@@ -282,6 +323,7 @@ public function testConfigExpression()
 <?php
 
 \$bar = nl2br("Hello\\nWorld");
+
 return [
     'foo' => \$bar,
 ];
@@ -792,6 +834,7 @@ public function testIncludeFormatting()
 include_once(__DIR__ . '/sample-array-file.php');
 require(__DIR__ . '/sample-array-file.php');
 require_once(__DIR__ . '/sample-array-file.php');
+
 return [
     'foo' => array_merge(include(__DIR__ . '/sample-array-file.php'), [
         'bar' => 'foo',

tests/fixtures/array/import-compact.php

@@ -0,0 +1,7 @@
+<?php
+use Symfony\Component\HttpFoundation\Response;
+use Example\EnumExample;
+return [
+    'foo' => Response::HTTP_OK,
+    'bar' => EnumExample::Value->value
+];

tests/fixtures/array/import-complex.php

@@ -0,0 +1,10 @@
+<?php
+
+use Symfony\Component\HttpFoundation\Response;
+
+use Example\EnumExample;
+
+return [
+    'foo' => Response::HTTP_OK,
+    'bar' => EnumExample::Value->value
+];