[YAML] Double escape strings with single quote marks

Author: Ostrzyciel

CHANGELOG.md

@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+6.1
+---
+
+ * In cases where it will likely improve readability, strings containing single quotes will be double-quoted.
+
 5.4
 ---
 

Inline.php

@@ -177,6 +177,14 @@ public static function dump(mixed $value, int $flags = 0): string
             case Escaper::requiresDoubleQuoting($value):
                 return Escaper::escapeWithDoubleQuotes($value);
             case Escaper::requiresSingleQuoting($value):
+                $singleQuoted = Escaper::escapeWithSingleQuotes($value);
+                if (!str_contains($value, "'")) {
+                    return $singleQuoted;
+                }
+                // Attempt double-quoting the string instead to see if it's more efficient.
+                $doubleQuoted = Escaper::escapeWithDoubleQuotes($value);
+
+                return \strlen($doubleQuoted) < \strlen($singleQuoted) ? $doubleQuoted : $singleQuoted;
             case Parser::preg_match('{^[0-9]+[_0-9]*$}', $value):
             case Parser::preg_match(self::getHexRegex(), $value):
             case Parser::preg_match(self::getTimestampRegex(), $value):

Tests/DumperTest.php

@@ -60,7 +60,7 @@ public function testIndentationInConstructor()
         $expected = <<<'EOF'
 '': bar
 foo: '#bar'
-'foo''bar': {  }
+"foo'bar": {  }
 bar:
        - 1
        - foo
@@ -107,15 +107,15 @@ public function testSpecifications()
     public function testInlineLevel()
     {
         $expected = <<<'EOF'
-{ '': bar, foo: '#bar', 'foo''bar': {  }, bar: [1, foo], foobar: { foo: bar, bar: [1, foo], foobar: { foo: bar, bar: [1, foo] } } }
+{ '': bar, foo: '#bar', "foo'bar": {  }, bar: [1, foo], foobar: { foo: bar, bar: [1, foo], foobar: { foo: bar, bar: [1, foo] } } }
 EOF;
         $this->assertEquals($expected, $this->dumper->dump($this->array, -10), '->dump() takes an inline level argument');
         $this->assertEquals($expected, $this->dumper->dump($this->array, 0), '->dump() takes an inline level argument');
 
         $expected = <<<'EOF'
 '': bar
 foo: '#bar'
-'foo''bar': {  }
+"foo'bar": {  }
 bar: [1, foo]
 foobar: { foo: bar, bar: [1, foo], foobar: { foo: bar, bar: [1, foo] } }
 
@@ -125,7 +125,7 @@ public function testInlineLevel()
         $expected = <<<'EOF'
 '': bar
 foo: '#bar'
-'foo''bar': {  }
+"foo'bar": {  }
 bar:
     - 1
     - foo
@@ -140,7 +140,7 @@ public function testInlineLevel()
         $expected = <<<'EOF'
 '': bar
 foo: '#bar'
-'foo''bar': {  }
+"foo'bar": {  }
 bar:
     - 1
     - foo
@@ -159,7 +159,7 @@ public function testInlineLevel()
         $expected = <<<'EOF'
 '': bar
 foo: '#bar'
-'foo''bar': {  }
+"foo'bar": {  }
 bar:
     - 1
     - foo

Tests/InlineTest.php

@@ -473,6 +473,10 @@ public function getTestsForDump()
             ["'foo # bar'", 'foo # bar'],
             ["'#cfcfcf'", '#cfcfcf'],
 
+            ["\"isn't it a nice single quote\"", "isn't it a nice single quote"],
+            ['\'this is "double quoted"\'', 'this is "double quoted"'],
+            ["\"one double, four single quotes: \\\"''''\"", 'one double, four single quotes: "\'\'\'\''],
+            ['\'four double, one single quote: """"\'\'\'', 'four double, one single quote: """"\''],
             ["'a \"string\" with ''quoted strings inside'''", 'a "string" with \'quoted strings inside\''],
 
             ["'-dash'", '-dash'],