bug #487 Yaml source manipulator - fix access control (weaverryan)

This PR was squashed before being merged into the 1.0-dev branch (closes #487).

Discussion
----------

Yaml source manipulator - fix access control

This helps #460 by fixing a few bugs with YamlSourceManipulator. But, it doesn't yet allow for the `access_control` array structure to be printed in an inline format (#460 (comment)).

Cheers!

Commits
-------

aa6c358 Fixing bug where a scalar value would become and array, but comment placement was wrong
1927d14 Fixing bug when a yaml key with no value ends a file

Author: weaverryan

src/Util/YamlSourceManipulator.php

@@ -217,7 +217,7 @@ private function updateData(array $newData)
             }
 
             // 3b) value DID change
-            $this->log('updating value');
+            $this->log(sprintf('updating value to {%s}', is_array($newVal) ? '<array>' : $newVal));
             $this->changeValueInYaml($newVal);
         }
 
@@ -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);
 
@@ -765,6 +783,12 @@ private function findEndPositionOfValue($value, $offset = null)
 
             $offset = null === $offset ? $this->currentPosition : $offset;
 
+            // a value like "foo:" can simply end a file
+            // this means the value is null
+            if ($offset === strlen($this->contents)) {
+                return $offset;
+            }
+
             preg_match(sprintf('#%s#', $pattern), $this->contents, $matches, PREG_OFFSET_CAPTURE, $offset);
             if (empty($matches)) {
                 throw new YamlManipulationFailedException(sprintf('Cannot find the original value "%s"', $value));

tests/Util/yaml_fixtures/last_value_is_blank.test

@@ -0,0 +1,7 @@
+security:
+    access_control:
+===
+$data['security']['access_control'] = 'foo';
+===
+security:
+    access_control: foo

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 }