From 2f0dad8ec6428f1ba9912d72e5cd1fb1e530344b Mon Sep 17 00:00:00 2001
From: Ivan Yivoff <yivi@users.noreply.github.com>
Date: Mon, 18 Oct 2021 16:10:47 +0200
Subject: [PATCH] feat(str): add a new `reverse()` function (#238)

---
 docs/component/str.md          |  1 +
 src/Psl/Internal/Loader.php    |  1 +
 src/Psl/Str/reverse.php        | 20 ++++++++++++++++++++
 tests/unit/Str/ReverseTest.php | 33 +++++++++++++++++++++++++++++++++
 4 files changed, 55 insertions(+)
 create mode 100644 src/Psl/Str/reverse.php
 create mode 100644 tests/unit/Str/ReverseTest.php

diff --git a/docs/component/str.md b/docs/component/str.md
index 5aaa4daf..3cc4a69e 100644
--- a/docs/component/str.md
+++ b/docs/component/str.md
@@ -55,6 +55,7 @@
 - [replace_ci](./../../src/Psl/Str/replace_ci.php#L20)
 - [replace_every](./../../src/Psl/Str/replace_every.php#L19)
 - [replace_every_ci](./../../src/Psl/Str/replace_every_ci.php#L19)
+- [reverse](./../../src/Psl/Str/reverse.php#L14)
 - [search](./../../src/Psl/Str/search.php#L25)
 - [search_ci](./../../src/Psl/Str/search_ci.php#L25)
 - [search_last](./../../src/Psl/Str/search_last.php#L25)
diff --git a/src/Psl/Internal/Loader.php b/src/Psl/Internal/Loader.php
index d6fa543e..398d7f09 100644
--- a/src/Psl/Internal/Loader.php
+++ b/src/Psl/Internal/Loader.php
@@ -353,6 +353,7 @@ final class Loader
         'Psl\Str\replace_ci',
         'Psl\Str\replace_every',
         'Psl\Str\replace_every_ci',
+        'Psl\Str\reverse',
         'Psl\Str\search',
         'Psl\Str\search_ci',
         'Psl\Str\search_last',
diff --git a/src/Psl/Str/reverse.php b/src/Psl/Str/reverse.php
new file mode 100644
index 00000000..41be85f0
--- /dev/null
+++ b/src/Psl/Str/reverse.php
@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Psl\Str;
+
+use Psl\Vec;
+
+/**
+ * Returns the given string reversed.
+ *
+ * @psalm-pure
+ */
+function reverse(string $string, ?string $encoding = null): string
+{
+        $chunks = chunk($string, encoding: $encoding);
+
+        /** @psalm-suppress ImpureFunctionCall */
+        return join(Vec\reverse($chunks), '');
+}
diff --git a/tests/unit/Str/ReverseTest.php b/tests/unit/Str/ReverseTest.php
new file mode 100644
index 00000000..3b99f9f7
--- /dev/null
+++ b/tests/unit/Str/ReverseTest.php
@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Psl\Tests\Unit\Str;
+
+use PHPUnit\Framework\TestCase;
+use Psl\Str;
+
+final class ReverseTest extends TestCase
+{
+
+    public function provideData(): array
+    {
+        return [
+            ['Hello World', 'dlroW olleH'],
+            ['héllö wôrld', 'dlrôw ölléh'],
+            ['Iñigo Montoya', 'ayotnoM ogiñI'],
+            ['某物', '物某' ],
+            ['что-то', 'от-отч'],
+            ['🙂😟', '😟🙂'],
+            ['مرحبا', 'ابحرم'],
+        ];
+    }
+
+    /**
+     * @dataProvider provideData
+     */
+    public function testReverse(string $string, string $expected): void
+    {
+        static::assertSame(Str\reverse($string), $expected);
+    }
+}