[Yaml] Fix wrong line number when comments are inserted in the middle…

… of a block.
symfony · paradajozsef · Feb 8, 2016 · Feb 11, 2016 · Feb 12, 2016 · Feb 13, 2016
commit dac814cc2f45096af92476e910232ef33e8ec283
diff --git a/src/Symfony/Component/Yaml/Parser.php b/src/Symfony/Component/Yaml/Parser.php
@@ -28,7 +28,6 @@ class Parser
     private $currentLineNb = -1;
     private $currentLine = '';
     private $refs = array();
-    private $skippedCommentLines = 0;
 
     /**
      * Constructor.
@@ -155,7 +154,7 @@ public function parse($value, $flags = 0)
                 try {
                     $key = Inline::parseScalar($values['key']);
                 } catch (ParseException $e) {
-                    $e->setParsedLine($this->getRealCurrentLineNb() + $this->skippedCommentLines + 1);
+                    $e->setParsedLine($this->getRealCurrentLineNb() + 1);
                     $e->setSnippet($this->currentLine);
 
                     throw $e;
@@ -485,10 +484,18 @@ private function moveToNextLine()
 
     /**
      * Moves the parser to the previous line.
+     *
+     * @return bool
      */
     private function moveToPreviousLine()
     {
+        if ($this->currentLineNb < 1) {
+            return false;
+        }
+
         $this->currentLine = $this->lines[--$this->currentLineNb];
+
+        return true;
     }
 
     /**
@@ -805,4 +812,44 @@ private function isBlockScalarHeader()
     {
         return (bool) preg_match('~'.self::BLOCK_SCALAR_HEADER_PATTERN.'$~', $this->currentLine);
     }
+
+    /**
+     * Returns true if the current line is a collection item.
+     *
+     * @return bool Returns true if the current line is a collection item line, false otherwise.
+     */
+    private function isCurrentLineCollectionItem()
+    {
+        $ltrimmedLine = ltrim($this->currentLine, ' ');
+
+        return '' !== $ltrimmedLine && $ltrimmedLine[0] === '-';
+    }
+
+    /**
+     * Tests whether or not the current comment line is in a collection.
+     *
+     * @return bool
+     */
+    private function isPreviousNonCommentLineIsCollectionItem()
+    {
+        $isCollectionItem = false;
+        $moves = 0;
+        while($this->moveToPreviousLine()) {
+            ++$moves;
+            // If previous line is a comment, move back again.
+            if ($this->isCurrentLineComment()) {
+                continue;
+            }
+            $isCollectionItem = $this->isCurrentLineCollectionItem();
+            break;
+        }
+
+        // Move parser back to previous line.
+        while($moves > 0) {
+            $this->moveToNextLine();
+            --$moves;
+        }
+
+        return $isCollectionItem;
+    }
 }
diff --git a/src/Symfony/Component/Yaml/Tests/ParserTest.php b/src/Symfony/Component/Yaml/Tests/ParserTest.php
@@ -1250,6 +1250,21 @@ public function parserThrowsExceptionWithCorrectLineNumberProvider()
     -
         # bar
         bar: "123",
+YAML
+            ),
+            array(
+                10,
+                <<<YAML
+foo:
+    -
+        # foobar
+        # foobar
+        baz: 123
+bar:
+    -
+        # bar
+        # bar
+        bar: "123",
 YAML
             ),
         );