improve error message for multiple documents

The YAML parser doesn't support multiple documents. This pull requests improves the error message when the parser detects multiple YAML documents.
symfony · Nov 1, 2014 · c77fdcb · c77fdcb
1 parent 97bb22c
commit c77fdcb
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 0 deletions.
diff --git a/src/Symfony/Component/Yaml/Parser.php b/src/Symfony/Component/Yaml/Parser.php
@@ -193,6 +193,11 @@ public function parse($value, $exceptionOnInvalidType = false, $objectSupport =
                     }
                 }
             } else {
+                // multiple documents are not supported
+                if ('---' === $this->currentLine) {
+                    throw new ParseException('Multiple documents are not supported.');
+                }
+
                 // 1-liner optionally followed by newline
                 $lineCount = count($this->lines);
                 if (1 === $lineCount || (2 === $lineCount && empty($this->lines[1]))) {

diff --git a/src/Symfony/Component/Yaml/Tests/ParserTest.php b/src/Symfony/Component/Yaml/Tests/ParserTest.php
@@ -482,6 +482,27 @@ public function testUnindentedCollectionException()
         $this->parser->parse($yaml);
     }
 
+    /**
+     * @expectedException \Symfony\Component\Yaml\Exception\ParseException
+     * @expectedExceptionMessage Multiple documents are not supported.
+     */
+    public function testMultipleDocumentsNotSupportedException()
+    {
+        Yaml::parse(<<<EOL
+# Ranking of 1998 home runs
+---
+- Mark McGwire
+- Sammy Sosa
+- Ken Griffey
+
+# Team ranking
+---
+- Chicago Cubs
+- St Louis Cardinals
+EOL
+        );
+    }
+
     /**
      * @expectedException \Symfony\Component\Yaml\Exception\ParseException
      */