[Yaml] support parsing files

xabbuh · xabbuh · commit c7e8dce0ae41 · 2017-09-19T10:22:03.000+01:00
diff --git a/src/Symfony/Component/Yaml/CHANGELOG.md b/src/Symfony/Component/Yaml/CHANGELOG.md
@@ -4,6 +4,9 @@ CHANGELOG
 3.4.0
 -----
 
+ * added support for passing filenames to `Yaml::parse()` and `Parser::parse()` when using the
+   `Yaml::PARSE_FILE` flag
+
  * the `Dumper`, `Parser`, and `Yaml` classes are marked as final
 
  * Deprecated the `!php/object:` tag which will be replaced by the
diff --git a/src/Symfony/Component/Yaml/Parser.php b/src/Symfony/Component/Yaml/Parser.php
@@ -92,6 +92,18 @@ public function parse($value, $flags = 0)
             @trigger_error('Using the Yaml::PARSE_KEYS_AS_STRINGS flag is deprecated since version 3.4 as it will be removed in 4.0. Quote your keys when they are evaluable instead.', E_USER_DEPRECATED);
         }
 
+        if ((bool) (Yaml::PARSE_FILE & $flags)) {
+            if (!is_file($value)) {
+                throw new ParseException(sprintf('File "%s" does not exist.', $value));
+            }
+
+            if (!is_readable($value)) {
+                throw new ParseException(sprintf('File "%s" cannot be read.', $value));
+            }
+
+            $value = file_get_contents($value);
+        }
+
         if (false === preg_match('//u', $value)) {
             throw new ParseException('The YAML value does not appear to be valid UTF-8.');
         }
diff --git a/src/Symfony/Component/Yaml/Tests/Fixtures/not_readable.yml b/src/Symfony/Component/Yaml/Tests/Fixtures/not_readable.yml
@@ -0,0 +1,18 @@
+- escapedCharacters
+- sfComments
+- sfCompact
+- sfTests
+- sfObjects
+- sfMergeKey
+- sfQuotes
+- YtsAnchorAlias
+- YtsBasicTests
+- YtsBlockMapping
+- YtsDocumentSeparator
+- YtsErrorTests
+- YtsFlowCollections
+- YtsFoldedScalars
+- YtsNullsAndEmpties
+- YtsSpecificationExamples
+- YtsTypeTransfers
+- unindentedCollections
diff --git a/src/Symfony/Component/Yaml/Tests/ParserTest.php b/src/Symfony/Component/Yaml/Tests/ParserTest.php
@@ -30,6 +30,8 @@ protected function setUp()
     protected function tearDown()
     {
         $this->parser = null;
+
+        chmod(__DIR__.'/Fixtures/not_readable.yml', 0600);
     }
 
     /**
@@ -1903,6 +1905,43 @@ public function testPhpConstantTagMappingKeyWithKeysCastToStrings()
 
         $this->assertSame($expected, $this->parser->parse($yaml, Yaml::PARSE_CONSTANT | Yaml::PARSE_KEYS_AS_STRINGS));
     }
+
+    public function testFilenamesAreParsedAsStringsWithoutFlag()
+    {
+        $file = __DIR__.'/Fixtures/index.yml';
+
+        $this->assertSame($file, $this->parser->parse($file));
+    }
+
+    public function testFilesAreParsedWhenPassingTheFlag()
+    {
+        $this->assertInternalType('array', $this->parser->parse(__DIR__.'/Fixtures/index.yml', Yaml::PARSE_FILE));
+    }
+
+    /**
+     * @expectedException \Symfony\Component\Yaml\Exception\ParseException
+     * @expectedExceptionMessageRegExp #^File ".+/Fixtures/nonexistent.yml" does not exist\.$#
+     */
+    public function testParsingNonExistentFilesThrowsException()
+    {
+        $this->parser->parse(__DIR__.'/Fixtures/nonexistent.yml', Yaml::PARSE_FILE);
+    }
+
+    /**
+     * @expectedException \Symfony\Component\Yaml\Exception\ParseException
+     * @expectedExceptionMessageRegExp #^File ".+/Fixtures/not_readable.yml" cannot be read\.$#
+     */
+    public function testParsingNotReadableFilesThrowsException()
+    {
+        if ('\\' === DIRECTORY_SEPARATOR) {
+            $this->markTestSkipped('chmod is not supported on Windows');
+        }
+
+        $file = __DIR__.'/Fixtures/not_readable.yml';
+        chmod($file, 0200);
+
+        $this->parser->parse($file, Yaml::PARSE_FILE);
+    }
 }
 
 class B
diff --git a/src/Symfony/Component/Yaml/Yaml.php b/src/Symfony/Component/Yaml/Yaml.php
@@ -33,6 +33,7 @@ class Yaml
     const PARSE_CONSTANT = 256;
     const PARSE_CUSTOM_TAGS = 512;
     const DUMP_EMPTY_ARRAY_AS_SEQUENCE = 1024;
+    const PARSE_FILE = 4096;
 
     /**
      * @deprecated since version 3.4, to be removed in 4.0. Quote your evaluable keys instead.
