Fixing bug where a scalar value would become and array, but comment placement was wrong

Author: weaverryan

src/Util/YamlSourceManipulator.php

@@ -461,12 +461,30 @@ private function changeValueInYaml($value)
             // empty space between key & value
             $newYamlValue = ' '.$newYamlValue;
         }
+
+        $newPosition = $this->currentPosition + \strlen($newYamlValue);
+        $isNextContentComment = $this->isPreviousLineComment($newPosition);
+        if ($isNextContentComment) {
+            $newPosition++;
+        }
+
         $newContents = substr($this->contents, 0, $this->currentPosition)
             .$newYamlValue
+            /*
+             * If the next line is a comment, this means we probably had
+             * a structure that looks like this:
+             *     access_control:
+             *         # - { path: ^/admin, roles: ROLE_ADMIN }
+             *
+             * In this odd case, we need to know that the next line
+             * is a comment, so we can add an extra line break.
+             * Otherwise, the result is something like:
+             *     access_control:
+             *         - { path: /foo, roles: ROLE_USER }        # - { path: ^/admin, roles: ROLE_ADMIN }
+             */
+            .($isNextContentComment ? "\n" : '')
             .substr($this->contents, $endValuePosition);
 
-        $newPosition = $this->currentPosition + \strlen($newYamlValue);
-
         $newData = $this->currentData;
         $newData = $this->setValueAtCurrentPath($value, $newData);
 

tests/Util/yaml_fixtures/simple_sequence_add_array.test

@@ -0,0 +1,13 @@
+# https://symfony.com/doc/current/security.html#where-do-users-come-from-user-providers
+security:
+    access_control:
+===
+$data['security']['access_control'] = [];
+$data['security']['access_control'][] = ['path' => '^/login$', 'roles' => 'IS_AUTHENTICATED_ANONYMOUSLY'];
+===
+# https://symfony.com/doc/current/security.html#where-do-users-come-from-user-providers
+security:
+    access_control:
+        -
+            path: ^/login$
+            roles: IS_AUTHENTICATED_ANONYMOUSLY

tests/Util/yaml_fixtures/simple_sequence_add_array_with_comments.test

@@ -0,0 +1,17 @@
+# https://symfony.com/doc/current/security.html#where-do-users-come-from-user-providers
+security:
+    access_control:
+        # - { path: ^/admin, roles: ROLE_ADMIN }
+        # - { path: ^/profile, roles: ROLE_USER }
+===
+$data['security']['access_control'] = [];
+$data['security']['access_control'][] = ['path' => '^/login$', 'roles' => 'IS_AUTHENTICATED_ANONYMOUSLY'];
+===
+# https://symfony.com/doc/current/security.html#where-do-users-come-from-user-providers
+security:
+    access_control:
+        -
+            path: ^/login$
+            roles: IS_AUTHENTICATED_ANONYMOUSLY
+        # - { path: ^/admin, roles: ROLE_ADMIN }
+        # - { path: ^/profile, roles: ROLE_USER }