bug PHP-CS-Fixer#813 MultilineArrayTrailingCommaFixer - do not move a…

…rray end to new line (keradus)

This PR was merged into the 1.4-dev branch.

Discussion
----------

MultilineArrayTrailingCommaFixer - do not move array end to new line

Currently
```php
<?php
    $var = array(
        "string",
        /* foo */);
```

is changed:
```diff
 <?php
     $var = array(
-        "string"
-        /* foo */);
+        "string",
+        /* foo */
+);
```
First, this fixer is not supposed to move end of array, and next, the end of array is wrongly placed (no indent)

The fixer should only add a comma, like:
```diff
 <?php
     $var = array(
-        "string"
+        "string",
         /* foo */);
```

Commits
-------

31c3e76 MultilineArrayTrailingCommaFixer - do not move array end to new line

Symfony/CS/Fixer/Symfony/MultilineArrayTrailingCommaFixer.php

@@ -67,9 +67,9 @@ private function fixArray(Tokens $tokens, $index)
         if ($startIndex !== $beforeEndIndex && !$beforeEndToken->equalsAny(array(',', array(T_END_HEREDOC)))) {
             $tokens->insertAt($beforeEndIndex + 1, new Token(','));
 
-            if ($tokens[$endIndex]->isComment()) {
-                $tokens->ensureWhitespaceAtIndex($endIndex, 1, "\n");
-            } elseif (!$tokens[$endIndex]->isWhitespace()) {
+            $endToken = $tokens[$endIndex];
+
+            if (!$endToken->isComment() && !$endToken->isWhitespace()) {
                 $tokens->ensureWhitespaceAtIndex($endIndex, 1, ' ');
             }
         }

Symfony/CS/Tests/Fixer/Symfony/MultilineArrayTrailingCommaFixerTest.php

@@ -229,6 +229,26 @@ function foo(array $a)
         //comment
     );',
             ),
+            array(
+                '<?php
+    $var = array(
+        "string",
+        /* foo */);',
+                '<?php
+    $var = array(
+        "string"
+        /* foo */);',
+            ),
+            array(
+                '<?php
+    $var = [
+        "string",
+        /* foo */];',
+                '<?php
+    $var = [
+        "string"
+        /* foo */];',
+            ),
         );
     }
 }