feature #38269 [String] allow passing null to string functions (kbond)

fabpot · fabpot · commit aa5d0ea829a1 · 2020-09-24T11:57:29.000+02:00
This PR was submitted for the 5.1 branch but it was merged into the 5.2-dev branch instead. Discussion ---------- [String] allow passing null to string functions | Q | A | ------------- | --- | Branch? | 5.1 | Bug fix? | no | New feature? | yes | Deprecations? | no | Tickets | Fix #38260 | License | MIT | Doc PR | n/a I also added a default value for `s` to match the other functions. Commits ------- f20a318 [String] allow passing null to string functions
diff --git a/src/Symfony/Component/String/Resources/functions.php b/src/Symfony/Component/String/Resources/functions.php
@@ -11,20 +11,22 @@
 
 namespace Symfony\Component\String;
 
-function u(string $string = ''): UnicodeString
+function u(?string $string = ''): UnicodeString
 {
-    return new UnicodeString($string);
+    return new UnicodeString($string ?? '');
 }
 
-function b(string $string = ''): ByteString
+function b(?string $string = ''): ByteString
 {
-    return new ByteString($string);
+    return new ByteString($string ?? '');
 }
 
 /**
  * @return UnicodeString|ByteString
  */
-function s(string $string): AbstractString
+function s(?string $string = ''): AbstractString
 {
+    $string = $string ?? '';
+
     return preg_match('//u', $string) ? new UnicodeString($string) : new ByteString($string);
 }
diff --git a/src/Symfony/Component/String/Tests/FunctionsTest.php b/src/Symfony/Component/String/Tests/FunctionsTest.php
@@ -13,27 +13,67 @@
 
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\String\AbstractString;
+use function Symfony\Component\String\b;
 use Symfony\Component\String\ByteString;
 use function Symfony\Component\String\s;
+use function Symfony\Component\String\u;
 use Symfony\Component\String\UnicodeString;
 
 final class FunctionsTest extends TestCase
 {
     /**
-     * @dataProvider provideStrings
+     * @dataProvider provideSStrings
      */
-    public function testS(AbstractString $expected, string $input)
+    public function testS(AbstractString $expected, ?string $input)
     {
         $this->assertEquals($expected, s($input));
     }
 
-    public function provideStrings(): array
+    public function provideSStrings(): array
     {
         return [
+            [new UnicodeString(''), ''],
+            [new UnicodeString(''), null],
             [new UnicodeString('foo'), 'foo'],
             [new UnicodeString('अनुच्छेद'), 'अनुच्छेद'],
             [new ByteString("b\x80ar"), "b\x80ar"],
             [new ByteString("\xfe\xff"), "\xfe\xff"],
         ];
     }
+
+    /**
+     * @dataProvider provideUStrings
+     */
+    public function testU(UnicodeString $expected, ?string $input)
+    {
+        $this->assertEquals($expected, u($input));
+    }
+
+    public function provideUStrings(): array
+    {
+        return [
+            [new UnicodeString(''), ''],
+            [new UnicodeString(''), null],
+            [new UnicodeString('foo'), 'foo'],
+            [new UnicodeString('अनुच्छेद'), 'अनुच्छेद'],
+        ];
+    }
+
+    /**
+     * @dataProvider provideBStrings
+     */
+    public function testB(ByteString $expected, ?string $input)
+    {
+        $this->assertEquals($expected, b($input));
+    }
+
+    public function provideBStrings(): array
+    {
+        return [
+            [new ByteString(''), ''],
+            [new ByteString(''), null],
+            [new ByteString("b\x80ar"), "b\x80ar"],
+            [new ByteString("\xfe\xff"), "\xfe\xff"],
+        ];
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -11,20 +11,22 @@`
`11`	`11`
`12`	`12`	`namespace Symfony\Component\String;`
`13`	`13`
`14`		`-function u(string $string = ''): UnicodeString`
	`14`	`+function u(?string $string = ''): UnicodeString`
`15`	`15`	`{`
`16`		`- return new UnicodeString($string);`
	`16`	`+ return new UnicodeString($string ?? '');`
`17`	`17`	`}`
`18`	`18`
`19`		`-function b(string $string = ''): ByteString`
	`19`	`+function b(?string $string = ''): ByteString`
`20`	`20`	`{`
`21`		`- return new ByteString($string);`
	`21`	`+ return new ByteString($string ?? '');`
`22`	`22`	`}`
`23`	`23`
`24`	`24`	`/**`
`25`	`25`	`* @return UnicodeString\|ByteString`
`26`	`26`	`*/`
`27`		`-function s(string $string): AbstractString`
	`27`	`+function s(?string $string = ''): AbstractString`
`28`	`28`	`{`
	`29`	`+ $string = $string ?? '';`
	`30`	`+`
`29`	`31`	`return preg_match('//u', $string) ? new UnicodeString($string) : new ByteString($string);`
`30`	`32`	`}`