[Yaml] Improve YAML boolean escaping

petert82 · petert82 · commit 3760e67cb234 · 2015-01-05T12:50:08.000+01:00
- Moves dumping single-quoting logic into Yaml\Escaper
- Ensures that PHP values which would be interpreted as booleans in
  older versions of the YAML spec are escaped with single quotes when
  dumped by the Dumper.
diff --git a/src/Symfony/Component/Yaml/Escaper.php b/src/Symfony/Component/Yaml/Escaper.php
@@ -72,7 +72,7 @@ public static function escapeWithDoubleQuotes($value)
      */
     public static function requiresSingleQuoting($value)
     {
-        return preg_match('/[ \s \' " \: \{ \} \[ \] , & \* \# \?] | \A[ \- ? | < > = ! % @ ` ]/x', $value);
+        return self::containsCharRequiresSingleQuoting($value) || self::isValueRequiresSingleQuoting($value);
     }
 
     /**
@@ -86,4 +86,28 @@ public static function escapeWithSingleQuotes($value)
     {
         return sprintf("'%s'", str_replace('\'', '\'\'', $value));
     }
+
+    /**
+     * Determines if a PHP value contains any single characters that would cause
+     * the value to require single quoting in YAML.
+     *
+     * @param  string $value A PHP value
+     * @return bool          True if the value would require single quotes.
+     */
+    private static function containsCharRequiresSingleQuoting($value)
+    {
+        return preg_match('/[ \s \' " \: \{ \} \[ \] , & \* \# \?] | \A[ \- ? | < > = ! % @ ` ]/x', $value);
+    }
+
+    /**
+     * Determines if a PHP value is entirely composed of a value that would
+     * require require single quoting in YAML.
+     *
+     * @param  string $value A PHP value
+     * @return bool          True if the value would require single quotes.
+     */
+    private static function isValueRequiresSingleQuoting($value)
+    {
+        return in_array(strtolower($value), array('null', '~', 'true', 'false', 'y', 'n', 'yes', 'no', 'on', 'off'));
+    }
 }
diff --git a/src/Symfony/Component/Yaml/Inline.php b/src/Symfony/Component/Yaml/Inline.php
@@ -135,12 +135,10 @@ public static function dump($value, $exceptionOnInvalidType = false, $objectSupp
             case Escaper::requiresDoubleQuoting($value):
                 return Escaper::escapeWithDoubleQuotes($value);
             case Escaper::requiresSingleQuoting($value):
+            case preg_match(self::getTimestampRegex(), $value):
                 return Escaper::escapeWithSingleQuotes($value);
             case '' == $value:
                 return "''";
-            case preg_match(self::getTimestampRegex(), $value):
-            case in_array(strtolower($value), array('null', '~', 'true', 'false')):
-                return "'$value'";
             default:
                 return $value;
         }
diff --git a/src/Symfony/Component/Yaml/Tests/InlineTest.php b/src/Symfony/Component/Yaml/Tests/InlineTest.php
@@ -190,6 +190,14 @@ protected function getTestsForParse()
             "'#cfcfcf'" => '#cfcfcf',
             '::form_base.html.twig' => '::form_base.html.twig',
 
+            // Pre-YAML-1.2 booleans
+            "'y'" => 'y',
+            "'n'" => 'n',
+            "'yes'" => 'yes',
+            "'no'" => 'no',
+            "'on'" => 'on',
+            "'off'" => 'off',
+
             '2007-10-30' => mktime(0, 0, 0, 10, 30, 2007),
             '2007-10-30T02:59:43Z' => gmmktime(2, 59, 43, 10, 30, 2007),
             '2007-10-30 02:59:43 Z' => gmmktime(2, 59, 43, 10, 30, 2007),
@@ -257,6 +265,14 @@ protected function getTestsForDump()
             "'-dash'" => '-dash',
             "'-'" => '-',
 
+            // Pre-YAML-1.2 booleans
+            "'y'" => 'y',
+            "'n'" => 'n',
+            "'yes'" => 'yes',
+            "'no'" => 'no',
+            "'on'" => 'on',
+            "'off'" => 'off',
+
             // sequences
             '[foo, bar, false, null, 12]' => array('foo', 'bar', false, null, 12),
             '[\'foo,bar\', \'foo bar\']' => array('foo,bar', 'foo bar'),
