Merge pull request #24 from wsssoftware/personal-name-stringable

Personal name stringable formatation
wsssoftware · Nov 4, 2024 · a08e186 · a08e186
2 parents ebdfa1a + c1b564f
commit a08e186
Show file tree

Hide file tree

Showing 2 changed files with 40 additions and 0 deletions.
diff --git a/src/Macros/StrMacro.php b/src/Macros/StrMacro.php
@@ -10,6 +10,7 @@ class StrMacro
     public function __invoke(): void
     {
         $this->applyMask();
+        $this->personalName();
     }
 
     public function applyMask(): void
@@ -65,4 +66,32 @@ public function applyMask(): void
             return new Stringable(Str::applyMask($this->value, $mask));
         });
     }
+
+    public function personalName(): void
+    {
+        Str::macro('personalName', function (string $name): string {
+            $toIgnore = [
+                'da', 'de', 'di', 'do', 'du',
+                'das', 'des', 'dis', 'dos', 'dus',
+                'a', 'e', 'i', 'o', 'u',
+                'as', 'es', 'is', 'os', 'us',
+                'd’',
+            ];
+            $words = str($name)->deduplicate()
+                ->explode(' ')
+                ->map(function (string $word) use ($toIgnore) {
+                    $word = mb_strtolower($word);
+                    if (! in_array($word, $toIgnore)) {
+                        $word = mb_strtoupper(mb_substr($word, 0, 1)).mb_substr($word, 1);
+                    }
+
+                    return $word;
+                });
+
+            return $words->implode(' ');
+        });
+        Stringable::macro('personalName', function (): Stringable {
+            return new Stringable(Str::personalName($this->value));
+        });
+    }
 }
diff --git a/tests/Macros/StrTest.php b/tests/Macros/StrTest.php
@@ -13,3 +13,14 @@
         ->toEqual('12');
 
 });
+
+it('can format personal name', function () {
+    expect(Str::personalName('ALLAN MARIUCCI DE CARVALHO'))
+        ->toEqual('Allan Mariucci de Carvalho')
+        ->and(str('ALLAN MARIUCCI DE CARVALHO')->personalName())
+        ->toEqual('Allan Mariucci de Carvalho')
+        ->and(Str::personalName('luiz ap. de carvalho'))
+        ->toEqual('Luiz Ap. de Carvalho')
+        ->and(str('Luiz ap. De Carvalho')->personalName())
+        ->toEqual('Luiz Ap. de Carvalho');
+});