refactor(support): move LanguageHelper#join to ArrayHelper and StringHelper (#612)

Author: innocenzi

src/Tempest/Support/src/ArrayHelper.php

@@ -631,6 +631,28 @@ public function unwrap(): self
         return new self($array);
     }
 
+    /**
+     * Joins all values using the specified `$glue`. The last item of the string is separated by `$finalGlue`.
+     */
+    public function join(string $glue = ', ', ?string $finalGlue = ' and '): StringHelper
+    {
+        if ($finalGlue === '' || is_null($finalGlue)) {
+            return $this->implode($glue);
+        }
+
+        if ($this->isEmpty()) {
+            return str('');
+        }
+
+        $parts = $this->pop($last);
+
+        if ($parts->isNotEmpty()) {
+            return $parts->implode($glue)->append($finalGlue, $last);
+        }
+
+        return str($last);
+    }
+
     public function dump(mixed ...$dumps): self
     {
         lw($this->array, ...$dumps);

src/Tempest/Support/src/LanguageHelper.php

@@ -10,20 +10,6 @@
 
 final class LanguageHelper
 {
-    /**
-     * @param string[] $parts
-     */
-    public static function join(array|ArrayHelper $parts): string
-    {
-        $parts = arr($parts)->pop($last);
-
-        if ($parts->isNotEmpty()) {
-            return $parts->implode(', ') . ' ' . 'and' . ' ' . $last;
-        }
-
-        return $last;
-    }
-
     public static function pluralize(string $value, int|array|Countable $count = 2): string
     {
         return get(Pluralizer::class)->pluralize($value, $count);

src/Tempest/Support/src/StringHelper.php

@@ -480,17 +480,21 @@ public function explode(string $separator = ' '): ArrayHelper
     /**
      * Implode the array into a string by a separator.
      *
-     * @param array|ArrayHelper $array The array to implode.
-     * @param string $separator The separator to implode the array by.
+     * @param array|ArrayHelper $parts The array to implode.
+     * @param string $glue The separator to implode the array by.
      *
      * @return self The imploded string.
      */
-    public static function implode(array|ArrayHelper $array, string $separator = ' '): self
+    public static function implode(array|ArrayHelper $parts, string $glue = ' '): self
     {
-        $array = ($array instanceof ArrayHelper)
-            ? $array->toArray()
-            : $array;
+        return arr($parts)->implode($glue);
+    }
 
-        return new self(implode($separator, $array));
+    /**
+     * Joins all values using the specified `$glue`. The last item of the string is separated by `$finalGlue`.
+     */
+    public static function join(array|ArrayHelper $parts, string $glue = ', ', ?string $finalGlue = ' and '): self
+    {
+        return arr($parts)->join($glue, $finalGlue);
     }
 }

src/Tempest/Support/tests/ArrayHelperTest.php

@@ -5,6 +5,7 @@
 namespace Tempest\Support\Tests;
 
 use InvalidArgumentException;
+use PHPUnit\Framework\Attributes\TestWith;
 use PHPUnit\Framework\TestCase;
 use function Tempest\Support\arr;
 use Tempest\Support\ArrayHelper;
@@ -144,6 +145,21 @@ public function test_implode(): void
         $this->assertEquals(str('a,b,c'), arr(['a', 'b', 'c'])->implode(','));
     }
 
+    #[TestWith([['Jon', 'Jane'], 'Jon and Jane'])]
+    #[TestWith([['Jon', 'Jane', 'Jill'], 'Jon, Jane and Jill'])]
+    public function test_join(array $initial, string $expected): void
+    {
+        $this->assertEquals($expected, arr($initial)->join());
+    }
+
+    #[TestWith([['Jon', 'Jane'], ', ', ' and maybe ', 'Jon and maybe Jane'])]
+    #[TestWith([['Jon', 'Jane', 'Jill'], ' + ', ' and ', 'Jon + Jane and Jill'])]
+    #[TestWith([['Jon', 'Jane', 'Jill'], ' + ', null, 'Jon + Jane + Jill'])]
+    public function test_join_with_glues(array $initial, string $glue, ?string $finalGlue, string $expected): void
+    {
+        $this->assertTrue(arr($initial)->join($glue, $finalGlue)->equals($expected));
+    }
+
     public function test_pop(): void
     {
         $array = arr(['a', 'b', 'c'])->pop($value);

src/Tempest/Support/tests/LanguageHelperTest.php

@@ -420,6 +420,21 @@ public function test_implode(): void
         $this->assertSame('john doe', StringHelper::implode(arr(['john', 'doe']))->toString());
     }
 
+    #[TestWith([['Jon', 'Jane'], 'Jon and Jane'])]
+    #[TestWith([['Jon', 'Jane', 'Jill'], 'Jon, Jane and Jill'])]
+    public function test_join(array $initial, string $expected): void
+    {
+        $this->assertEquals($expected, StringHelper::join($initial));
+    }
+
+    #[TestWith([['Jon', 'Jane'], ', ', ' and maybe ', 'Jon and maybe Jane'])]
+    #[TestWith([['Jon', 'Jane', 'Jill'], ' + ', ' and ', 'Jon + Jane and Jill'])]
+    #[TestWith([['Jon', 'Jane', 'Jill'], ' + ', null, 'Jon + Jane + Jill'])]
+    public function test_join_with_glues(array $initial, string $glue, ?string $finalGlue, string $expected): void
+    {
+        $this->assertTrue(StringHelper::join($initial, $glue, $finalGlue)->equals($expected));
+    }
+
     public function test_excerpt(): void
     {
         $content = str('a

src/Tempest/Support/tests/StringHelperTest.php

@@ -6,7 +6,6 @@
 
 use Exception;
 use function Tempest\Support\arr;
-use Tempest\Support\LanguageHelper;
 use Tempest\Validation\Rule;
 
 final class ValidationException extends Exception
@@ -18,7 +17,7 @@ public function __construct(object $object, public readonly array $failingRules)
         foreach ($this->failingRules as $field => $failingRulesForField) {
             /** @var Rule $failingRuleForField */
             foreach ($failingRulesForField as $failingRuleForField) {
-                $messages[$field][] = LanguageHelper::join(arr($failingRuleForField->message()));
+                $messages[$field][] = arr($failingRuleForField->message())->join()->toString();
             }
         }