Merge pull request #196 from php-school/str-pluraliser

Pluraliser

Author: AydinHassan

src/Utils/StringUtils.php

@@ -8,6 +8,14 @@
 
 class StringUtils
 {
+    /**
+     * @var array<string,string>
+     */
+    private static $pluraliseSearchReplace = [
+        'Property "%s" was' => 'Properties "%s" were',
+        'Property' => 'Properties',
+    ];
+
     public static function canonicalisePath(string $filename): string
     {
         $path = [];
@@ -30,4 +38,27 @@ public static function canonicalisePath(string $filename): string
             ? '/' . implode('/', $path)
             : implode('/', $path);
     }
+
+
+    /**
+     * @param string $string
+     * @param array<mixed> $items
+     * @param string ...$args
+     * @return string
+     */
+    public static function pluralise(string $string, array $items, string ...$args): string
+    {
+        if (count($items) <= 1) {
+            return vsprintf($string, $args);
+        }
+
+        return vsprintf(
+            str_replace(
+                array_keys(static::$pluraliseSearchReplace),
+                array_values(static::$pluraliseSearchReplace),
+                $string
+            ),
+            $args
+        );
+    }
 }

src/functions.php

@@ -47,6 +47,20 @@ function canonicalise_path(string $path): string
     }
 }
 
+if (!function_exists('pluralise')) {
+
+    /**
+     * @param string $string
+     * @param array<mixed> $items
+     * @param string[] ...$args
+     * @return string
+     */
+    function pluralise(string $string, array $items, string ...$args): string
+    {
+        return StringUtils::pluralise($string, $items, ...$args);
+    }
+}
+
 if (!function_exists('collect')) {
 
     /**

test/Util/StringUtilsTest.php

@@ -29,4 +29,43 @@ public function testExceptionIsThrownIfTryingToTraverseUpPastRoom(): void
 
         StringUtils::canonicalisePath('/path/to/../../../');
     }
+
+    /**
+     * @dataProvider pluraliseMultipleProvider
+     */
+    public function testPluraliseWithMultipleValues(string $string, string $expected): void
+    {
+        $props = ['propOne', 'propTwo'];
+        $this->assertEquals($expected, StringUtils::pluralise($string, $props, implode('" & "', $props)));
+    }
+
+    public function pluraliseMultipleProvider(): array
+    {
+        return [
+            [
+                'Property "%s" should not have changed type',
+                'Properties "propOne" & "propTwo" should not have changed type'
+            ],
+            ['Property "%s" was not promoted', 'Properties "propOne" & "propTwo" were not promoted'],
+            ['Property "%s" was missing', 'Properties "propOne" & "propTwo" were missing'],
+        ];
+    }
+
+    /**
+     * @dataProvider pluraliseSingularProvider
+     */
+    public function testPluraliseWithSingularValues(string $string, string $expected): void
+    {
+        $props = ['propOne'];
+        $this->assertEquals($expected, StringUtils::pluralise($string, $props, implode('" & "', $props)));
+    }
+
+    public function pluraliseSingularProvider(): array
+    {
+        return [
+            ['Property "%s" should not have changed type', 'Property "propOne" should not have changed type'],
+            ['Property "%s" was not promoted', 'Property "propOne" was not promoted'],
+            ['Property "%s" was missing', 'Property "propOne" was missing'],
+        ];
+    }
 }