YamlEncoder handle yml format

Kevin Grenier · Kevin Grenier · commit 0bfb101f9a4e · 2018-10-11T14:13:16.000+02:00
diff --git a/src/Symfony/Component/Serializer/CHANGELOG.md b/src/Symfony/Component/Serializer/CHANGELOG.md
@@ -5,6 +5,7 @@ CHANGELOG
 -----
 
 * `AbstractNormalizer::handleCircularReference` is now final, and receives two optional extra arguments: the format and the context
+* `YamlEncoder` now handle the `yml` format too
 
 4.1.0
 -----
diff --git a/src/Symfony/Component/Serializer/Encoder/YamlEncoder.php b/src/Symfony/Component/Serializer/Encoder/YamlEncoder.php
@@ -16,13 +16,16 @@
 use Symfony\Component\Yaml\Parser;
 
 /**
- * Encodes YAML data.
+ * Encodes YAML/YML data.
  *
  * @author Kévin Dunglas <dunglas@gmail.com>
  */
 class YamlEncoder implements EncoderInterface, DecoderInterface
 {
-    const FORMAT = 'yaml';
+    const FORMAT = self::YAML_FORMAT;
+    const YAML_FORMAT = 'yaml';
+    const YML_FORMAT = 'yml';
+    const VALID_FORMAT = [self::YAML_FORMAT, self::YML_FORMAT];
 
     private $dumper;
     private $parser;
@@ -54,7 +57,7 @@ public function encode($data, $format, array $context = array())
      */
     public function supportsEncoding($format)
     {
-        return self::FORMAT === $format;
+        return \in_array($format, self::VALID_FORMAT, true);
     }
 
     /**
@@ -72,6 +75,6 @@ public function decode($data, $format, array $context = array())
      */
     public function supportsDecoding($format)
     {
-        return self::FORMAT === $format;
+        return \in_array($format, self::VALID_FORMAT, true);
     }
 }
diff --git a/src/Symfony/Component/Serializer/Tests/Encoder/YamlEncoderTest.php b/src/Symfony/Component/Serializer/Tests/Encoder/YamlEncoderTest.php
@@ -35,6 +35,7 @@ public function testSupportsEncoding()
         $encoder = new YamlEncoder();
 
         $this->assertTrue($encoder->supportsEncoding('yaml'));
+        $this->assertTrue($encoder->supportsEncoding('yml'));
         $this->assertFalse($encoder->supportsEncoding('json'));
     }
 
@@ -51,6 +52,7 @@ public function testSupportsDecoding()
         $encoder = new YamlEncoder();
 
         $this->assertTrue($encoder->supportsDecoding('yaml'));
+        $this->assertTrue($encoder->supportsDecoding('yml'));
         $this->assertFalse($encoder->supportsDecoding('json'));
     }
 

Original file line number	Diff line number	Diff line change
`@@ -16,13 +16,16 @@`
`16`	`16`	`use Symfony\Component\Yaml\Parser;`
`17`	`17`
`18`	`18`	`/**`
`19`		`- * Encodes YAML data.`
	`19`	`+ * Encodes YAML/YML data.`
`20`	`20`	`*`
`21`	`21`	`* @author Kévin Dunglas <[email protected]>`
`22`	`22`	`*/`
`23`	`23`	`class YamlEncoder implements EncoderInterface, DecoderInterface`
`24`	`24`	`{`
`25`		`- const FORMAT = 'yaml';`
	`25`	`+ const FORMAT = self::YAML_FORMAT;`
	`26`	`+ const YAML_FORMAT = 'yaml';`
	`27`	`+ const YML_FORMAT = 'yml';`
	`28`	`+ const VALID_FORMAT = [self::YAML_FORMAT, self::YML_FORMAT];`
`26`	`29`
`27`	`30`	`private $dumper;`
`28`	`31`	`private $parser;`
`@@ -54,7 +57,7 @@ public function encode($data, $format, array $context = array())`
`54`	`57`	`*/`
`55`	`58`	`public function supportsEncoding($format)`
`56`	`59`	`{`
`57`		`- return self::FORMAT === $format;`
	`60`	`+ return \in_array($format, self::VALID_FORMAT, true);`
`58`	`61`	`}`
`59`	`62`
`60`	`63`	`/**`
`@@ -72,6 +75,6 @@ public function decode($data, $format, array $context = array())`
`72`	`75`	`*/`
`73`	`76`	`public function supportsDecoding($format)`
`74`	`77`	`{`
`75`		`- return self::FORMAT === $format;`
	`78`	`+ return \in_array($format, self::VALID_FORMAT, true);`
`76`	`79`	`}`
`77`	`80`	`}`
Original file line number	Diff line number	Diff line change
`@@ -35,6 +35,7 @@ public function testSupportsEncoding()`
`35`	`35`	`$encoder = new YamlEncoder();`
`36`	`36`
`37`	`37`	`$this->assertTrue($encoder->supportsEncoding('yaml'));`
	`38`	`+ $this->assertTrue($encoder->supportsEncoding('yml'));`
`38`	`39`	`$this->assertFalse($encoder->supportsEncoding('json'));`
`39`	`40`	`}`
`40`	`41`
`@@ -51,6 +52,7 @@ public function testSupportsDecoding()`
`51`	`52`	`$encoder = new YamlEncoder();`
`52`	`53`
`53`	`54`	`$this->assertTrue($encoder->supportsDecoding('yaml'));`
	`55`	`+ $this->assertTrue($encoder->supportsDecoding('yml'));`
`54`	`56`	`$this->assertFalse($encoder->supportsDecoding('json'));`
`55`	`57`	`}`
`56`	`58`