From 632ead3a8254479320c8d54e121d5cd27ca6704f Mon Sep 17 00:00:00 2001
From: Shalvah <shalvah@users.noreply.github.com>
Date: Sun, 12 Sep 2021 20:51:25 +0100
Subject: [PATCH] Print comma before comments for new array item (#805)

Print comma before rather than after comments. Also switch to multiline mode if inserting an item with comments.

Fixes #804.
---
 lib/PhpParser/PrettyPrinterAbstract.php       |  10 +-
 .../arrayInsertionWithComments.test           | 106 ++++++++++++++++++
 2 files changed, 113 insertions(+), 3 deletions(-)
 create mode 100644 test/code/formatPreservation/arrayInsertionWithComments.test

diff --git a/lib/PhpParser/PrettyPrinterAbstract.php b/lib/PhpParser/PrettyPrinterAbstract.php
index 5fc3653..70873ae 100644
--- a/lib/PhpParser/PrettyPrinterAbstract.php
+++ b/lib/PhpParser/PrettyPrinterAbstract.php
@@ -824,7 +824,11 @@ abstract class PrettyPrinterAbstract
                     return null;
                 }
 
-                if ($insertStr === ', ' && $this->isMultiline($origNodes)) {
+                // We go multiline if the original code was multiline,
+                // or if it's an array item with a comment above it.
+                if ($insertStr === ', ' && (
+                        $this->isMultiline($origNodes) || !empty($arrItem->getAttribute('comments')))
+                ) {
                     $insertStr = ',';
                     $insertNewline = true;
                 }
@@ -842,11 +846,11 @@ abstract class PrettyPrinterAbstract
                 $this->setIndentLevel($lastElemIndentLevel);
 
                 if ($insertNewline) {
+                    $result .= $insertStr . $this->nl;
                     $comments = $arrItem->getComments();
                     if ($comments) {
-                        $result .= $this->nl . $this->pComments($comments);
+                        $result .= $this->pComments($comments) . $this->nl;
                     }
-                    $result .= $insertStr . $this->nl;
                 } else {
                     $result .= $insertStr;
                 }
diff --git a/test/code/formatPreservation/arrayInsertionWithComments.test b/test/code/formatPreservation/arrayInsertionWithComments.test
new file mode 100644
index 0000000..adde626
--- /dev/null
+++ b/test/code/formatPreservation/arrayInsertionWithComments.test
@@ -0,0 +1,106 @@
+Inserting array item with comment
+-----
+<?php
+
+$items = [
+    'a' => 'foo',
+    'b' => 'bar',
+];
+-----
+$node = new Expr\ArrayItem(new Scalar\String_('baz'), new Scalar\String_('c'));
+$node->setAttribute('comments', [new Comment\Doc(<<<COMMENT
+/**
+ * A doc comment
+ */
+COMMENT
+)]);
+$array = $stmts[0]->expr->expr;
+$array->items[] = $node;
+-----
+<?php
+
+$items = [
+    'a' => 'foo',
+    'b' => 'bar',
+    /**
+     * A doc comment
+     */
+    'c' => 'baz',
+];
+-----
+<?php
+
+$items = [
+    'a' => 'foo',
+    'b' => 'bar',
+];
+-----
+$node = new Expr\ArrayItem(new Scalar\String_('baz'), new Scalar\String_('c'));
+$node->setAttribute('comments', [new Comment("/* Block comment */")]);
+$array = $stmts[0]->expr->expr;
+$array->items[] = $node;
+-----
+<?php
+
+$items = [
+    'a' => 'foo',
+    'b' => 'bar',
+    /* Block comment */
+    'c' => 'baz',
+];
+-----
+<?php
+
+$items = [
+    'a' => 'foo',
+    'b' => 'bar',
+];
+-----
+$node = new Expr\ArrayItem(new Scalar\String_('baz'), new Scalar\String_('c'));
+$node->setAttribute('comments', [new Comment("// Line comment")]);
+$array = $stmts[0]->expr->expr;
+$array->items[] = $node;
+-----
+<?php
+
+$items = [
+    'a' => 'foo',
+    'b' => 'bar',
+    // Line comment
+    'c' => 'baz',
+];
+-----
+<?php
+
+$items = [
+    'a' => 'foo',
+];
+-----
+$node = new Expr\ArrayItem(new Scalar\String_('bar'), new Scalar\String_('b'));
+$node->setAttribute('comments', [new Comment("// Line comment")]);
+$array = $stmts[0]->expr->expr;
+$array->items[] = $node;
+-----
+<?php
+
+$items = [
+    'a' => 'foo',
+    // Line comment
+    'b' => 'bar',
+];
+-----
+<?php
+
+$items = [];
+-----
+$node = new Expr\ArrayItem(new Scalar\String_('foo'), new Scalar\String_('a'));
+$node->setAttribute('comments', [new Comment("// Line comment")]);
+$array = $stmts[0]->expr->expr;
+$array->items[] = $node;
+-----
+<?php
+
+$items = [
+    // Line comment
+    'a' => 'foo',
+];
\ No newline at end of file