[String] add $lastGlue argument to join() methods

nicolas-grekas · nicolas-grekas · commit 714d6290df57 · 2019-10-08T17:49:00.000+02:00
diff --git a/src/Symfony/Component/String/AbstractString.php b/src/Symfony/Component/String/AbstractString.php
@@ -387,7 +387,7 @@ public function isEmpty(): bool
     /**
      * @return static
      */
-    abstract public function join(array $strings): self;
+    abstract public function join(array $strings, string $lastGlue = null): self;
 
     public function jsonSerialize(): string
     {
diff --git a/src/Symfony/Component/String/AbstractUnicodeString.php b/src/Symfony/Component/String/AbstractUnicodeString.php
@@ -180,10 +180,12 @@ public function folded(bool $compat = true): parent
         return $str;
     }
 
-    public function join(array $strings): parent
+    public function join(array $strings, string $lastGlue = null): parent
     {
         $str = clone $this;
-        $str->string = implode($this->string, $strings);
+
+        $tail = null !== $lastGlue && 1 < \count($strings) ? $lastGlue.array_pop($strings) : '';
+        $str->string = implode($this->string, $strings).$tail;
 
         if (!preg_match('//u', $str->string)) {
             throw new InvalidArgumentException('Invalid UTF-8 string.');
diff --git a/src/Symfony/Component/String/ByteString.php b/src/Symfony/Component/String/ByteString.php
@@ -168,10 +168,12 @@ public function isUtf8(): bool
         return '' === $this->string || preg_match('//u', $this->string);
     }
 
-    public function join(array $strings): parent
+    public function join(array $strings, string $lastGlue = null): parent
     {
         $str = clone $this;
-        $str->string = implode($str->string, $strings);
+
+        $tail = null !== $lastGlue && 1 < \count($strings) ? $lastGlue.array_pop($strings) : '';
+        $str->string = implode($this->string, $strings).$tail;
 
         return $str;
     }
diff --git a/src/Symfony/Component/String/Tests/AbstractAsciiTestCase.php b/src/Symfony/Component/String/Tests/AbstractAsciiTestCase.php
@@ -1160,6 +1160,11 @@ public function testJoin(string $expected, string $origin, array $join)
         $this->assertEquals(static::createFromString($expected), $instance);
     }
 
+    public function testJoinWithLastGlue()
+    {
+        $this->assertSame('foo, bar and baz', (string) static::createFromString(', ')->join(['foo', 'bar', 'baz'], ' and '));
+    }
+
     public static function provideJoin()
     {
         return [
diff --git a/src/Symfony/Component/String/UnicodeString.php b/src/Symfony/Component/String/UnicodeString.php
@@ -178,9 +178,9 @@ public function indexOfLast($needle, int $offset = 0): ?int
         return false === $i ? null : $i;
     }
 
-    public function join(array $strings): AbstractString
+    public function join(array $strings, string $lastGlue = null): AbstractString
     {
-        $str = parent::join($strings);
+        $str = parent::join($strings, $lastGlue);
         normalizer_is_normalized($str->string) ?: $str->string = normalizer_normalize($str->string);
 
         return $str;

Original file line number	Diff line number	Diff line change
`@@ -387,7 +387,7 @@ public function isEmpty(): bool`
`387`	`387`	`/**`
`388`	`388`	`* @return static`
`389`	`389`	`*/`
`390`		`- abstract public function join(array $strings): self;`
	`390`	`+ abstract public function join(array $strings, string $lastGlue = null): self;`
`391`	`391`
`392`	`392`	`public function jsonSerialize(): string`
`393`	`393`	`{`
Original file line number	Diff line number	Diff line change
`@@ -180,10 +180,12 @@ public function folded(bool $compat = true): parent`
`180`	`180`	`return $str;`
`181`	`181`	`}`
`182`	`182`
`183`		`- public function join(array $strings): parent`
	`183`	`+ public function join(array $strings, string $lastGlue = null): parent`
`184`	`184`	`{`
`185`	`185`	`$str = clone $this;`
`186`		`- $str->string = implode($this->string, $strings);`
	`186`	`+`
	`187`	`+ $tail = null !== $lastGlue && 1 < \count($strings) ? $lastGlue.array_pop($strings) : '';`
	`188`	`+ $str->string = implode($this->string, $strings).$tail;`
`187`	`189`
`188`	`190`	`if (!preg_match('//u', $str->string)) {`
`189`	`191`	`throw new InvalidArgumentException('Invalid UTF-8 string.');`
Original file line number	Diff line number	Diff line change
`@@ -168,10 +168,12 @@ public function isUtf8(): bool`
`168`	`168`	`return '' === $this->string \|\| preg_match('//u', $this->string);`
`169`	`169`	`}`
`170`	`170`
`171`		`- public function join(array $strings): parent`
	`171`	`+ public function join(array $strings, string $lastGlue = null): parent`
`172`	`172`	`{`
`173`	`173`	`$str = clone $this;`
`174`		`- $str->string = implode($str->string, $strings);`
	`174`	`+`
	`175`	`+ $tail = null !== $lastGlue && 1 < \count($strings) ? $lastGlue.array_pop($strings) : '';`
	`176`	`+ $str->string = implode($this->string, $strings).$tail;`
`175`	`177`
`176`	`178`	`return $str;`
`177`	`179`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1160,6 +1160,11 @@ public function testJoin(string $expected, string $origin, array $join)`
`1160`	`1160`	`$this->assertEquals(static::createFromString($expected), $instance);`
`1161`	`1161`	`}`
`1162`	`1162`
	`1163`	`+ public function testJoinWithLastGlue()`
	`1164`	`+ {`
	`1165`	`+ $this->assertSame('foo, bar and baz', (string) static::createFromString(', ')->join(['foo', 'bar', 'baz'], ' and '));`
	`1166`	`+ }`
	`1167`	`+`
`1163`	`1168`	`public static function provideJoin()`
`1164`	`1169`	`{`
`1165`	`1170`	`return [`
Original file line number	Diff line number	Diff line change
`@@ -178,9 +178,9 @@ public function indexOfLast($needle, int $offset = 0): ?int`
`178`	`178`	`return false === $i ? null : $i;`
`179`	`179`	`}`
`180`	`180`
`181`		`- public function join(array $strings): AbstractString`
	`181`	`+ public function join(array $strings, string $lastGlue = null): AbstractString`
`182`	`182`	`{`
`183`		`- $str = parent::join($strings);`
	`183`	`+ $str = parent::join($strings, $lastGlue);`
`184`	`184`	`normalizer_is_normalized($str->string) ?: $str->string = normalizer_normalize($str->string);`
`185`	`185`
`186`	`186`	`return $str;`