refactor(support)!: improve architecture of support utilities (#940)

Co-authored-by: brendt <[email protected]>

Author: innocenzi

composer.json

@@ -122,6 +122,13 @@
             "src/Tempest/Mapper/src/functions.php",
             "src/Tempest/Reflection/src/functions.php",
             "src/Tempest/Router/src/functions.php",
+            "src/Tempest/Support/src/Arr/functions.php",
+            "src/Tempest/Support/src/Html/functions.php",
+            "src/Tempest/Support/src/Language/functions.php",
+            "src/Tempest/Support/src/Namespace/functions.php",
+            "src/Tempest/Support/src/Random/functions.php",
+            "src/Tempest/Support/src/Regex/functions.php",
+            "src/Tempest/Support/src/Str/functions.php",
             "src/Tempest/Support/src/functions.php",
             "src/Tempest/View/src/functions.php",
             "src/Tempest/Vite/src/functions.php"

src/Tempest/Cache/src/ProjectCache.php

@@ -6,7 +6,7 @@
 
 use Psr\Cache\CacheItemPoolInterface;
 use Symfony\Component\Cache\Adapter\FilesystemAdapter;
-use function Tempest\path;
+use function Tempest\Support\path;
 
 final class ProjectCache implements Cache
 {

src/Tempest/Console/src/Components/Concerns/RendersControls.php

@@ -7,8 +7,8 @@
 use Tempest\Console\Components\ComponentState;
 use Tempest\Console\InteractiveConsoleComponent;
 use Tempest\Console\Terminal\Terminal;
-use Tempest\Support\StringHelper;
 use function Tempest\Support\arr;
+use function Tempest\Support\str;
 
 /**
  * @mixin InteractiveConsoleComponent
@@ -48,7 +48,7 @@ private function renderControls(array $controls, int $maxWidth): string
 
         if ($render->stripTags()->length() >= $maxWidth) {
             $prefix = $marginLeft . '<style="fg-gray">·</style>';
-            $render = new StringHelper($prefix)
+            $render = str($prefix)
                 ->append($render)
                 ->explode($separator)
                 ->implode("\n" . $prefix . $marginLeft);

src/Tempest/Console/src/Components/Interactive/SearchComponent.php

@@ -21,7 +21,7 @@
 use Tempest\Console\Point;
 use Tempest\Console\StaticConsoleComponent;
 use Tempest\Console\Terminal\Terminal;
-use Tempest\Support\ArrayHelper;
+use function Tempest\Support\Arr\wrap;
 
 final class SearchComponent implements InteractiveConsoleComponent, HasCursor, HasStaticComponent
 {
@@ -48,7 +48,7 @@ public function __construct(
         $this->options = new OptionCollection([]);
 
         if ($this->multiple) {
-            $this->default = ArrayHelper::wrap($this->default);
+            $this->default = wrap($this->default);
         }
 
         $this->updateQuery();

src/Tempest/Console/src/Components/OptionCollection.php

@@ -7,7 +7,7 @@
 use Countable;
 use Iterator;
 use Stringable;
-use Tempest\Support\ArrayHelper;
+use Tempest\Support\Arr\ImmutableArray;
 use UnitEnum;
 use function Tempest\Support\arr;
 
@@ -35,7 +35,7 @@ public function setCollection(iterable $options): void
     {
         $options = arr($options);
 
-        $this->preserveKeys = $options->isAssoc();
+        $this->preserveKeys = $options->isAssociative();
         $this->options = $options
             ->map(fn (mixed $value, string|int $key) => new Option($key, $value))
             ->toArray();
@@ -93,8 +93,8 @@ public function toggleCurrent(): void
         }
     }
 
-    /** @return ArrayHelper<Option> */
-    public function getOptions(): ArrayHelper
+    /** @return ImmutableArray<Option> */
+    public function getOptions(): ImmutableArray
     {
         return arr($this->filteredOptions)->values();
     }
@@ -121,7 +121,6 @@ public function getRawSelectedOptions(array $default = []): array
             return $default;
         }
 
-        // TODO: PR `tap` to `ArrayHelper`
         if (! $this->preserveKeys) {
             return array_values($selected);
         }

src/Tempest/Console/src/Components/Renderers/InstructionsRenderer.php

@@ -4,7 +4,6 @@
 
 namespace Tempest\Console\Components\Renderers;
 
-use Tempest\Support\StringHelper;
 use function Tempest\Support\arr;
 use function Tempest\Support\str;
 
@@ -16,10 +15,10 @@ public function render(string|array $lines): string
     {
         $lines = arr($lines)
             ->filter()
-            ->flatMap(fn (string $string) => str($string)->split(self::MAX_WIDTH)->toArray())
+            ->flatMap(fn (string $string) => str($string)->chunk(self::MAX_WIDTH)->toArray())
             ->toArray();
 
-        $text = new StringHelper(PHP_EOL);
+        $text = str(PHP_EOL);
 
         foreach ($lines as $line) {
             $text = $text->append('  ', '<style="bold fg-green">│</style>', ' ', trim($line), PHP_EOL);

src/Tempest/Console/src/Components/Renderers/KeyValueRenderer.php

@@ -5,7 +5,7 @@
 namespace Tempest\Console\Components\Renderers;
 
 use Stringable;
-use Tempest\Support\StringHelper;
+use Tempest\Support\Str\MutableString;
 use function Tempest\root_path;
 use function Tempest\Support\str;
 
@@ -32,18 +32,18 @@ public function render(Stringable|string $key, null|Stringable|string $value = n
             ->toString();
     }
 
-    private function cleanText(null|Stringable|string $text): StringHelper
+    private function cleanText(null|Stringable|string $text): MutableString
     {
-        $text = str($text)->trim();
+        $text = new MutableString($text)->trim();
 
         if ($text->length() === 0) {
-            return str();
+            return new MutableString();
         }
 
         return $text
             ->replaceRegex('/\[([^]]+)]/', '<em>[$1]</em>')
             ->when(fn ($s) => $s->endsWith(['.', '?', '!', ':']), fn ($s) => $s->replaceAt(-1, 1, ''))
-            ->replace(root_path(), '')
+            ->erase(root_path())
             ->trim();
     }
 }

src/Tempest/Console/src/Components/Renderers/MessageRenderer.php

@@ -4,7 +4,7 @@
 
 namespace Tempest\Console\Components\Renderers;
 
-use Tempest\Support\ArrayHelper;
+use Tempest\Support\Arr\ImmutableArray;
 use function Tempest\Support\str;
 
 final readonly class MessageRenderer
@@ -18,7 +18,7 @@ public function __construct(
     public function render(string $contents, ?string $title = null): string
     {
         $title = str($title ?? $this->label)->toString();
-        $lines = ArrayHelper::explode($contents, "\n")
+        $lines = ImmutableArray::explode($contents, "\n")
             ->map(fn ($s, $i) => str_repeat(' ', ($i === 0 ? 1 : strlen($title) + 4)) . $s)
             ->implode("\n");
 

src/Tempest/Console/src/Components/Renderers/RendersInput.php

@@ -7,7 +7,7 @@
 use Stringable;
 use Tempest\Console\Components\ComponentState;
 use Tempest\Console\Terminal\Terminal;
-use Tempest\Support\StringHelper;
+use Tempest\Support\Str\ImmutableString;
 
 trait RendersInput
 {
@@ -17,7 +17,7 @@ trait RendersInput
 
     public const int MARGIN_TOP = 1;
 
-    private StringHelper $frame;
+    private ImmutableString $frame;
 
     private Terminal $terminal;
 
@@ -46,7 +46,7 @@ private function prepareRender(Terminal $terminal, ComponentState $state): self
         $this->leftBorder = "<style=\"dim {$this->getStyle()}\">│</style>";
         $this->maxLineCharacters = $this->terminal->width - mb_strlen($this->marginX . ' ' . $this->paddingX) - self::MARGIN_X;
 
-        $this->frame = new StringHelper(str_repeat("\n", self::MARGIN_TOP));
+        $this->frame = new ImmutableString(str_repeat("\n", self::MARGIN_TOP));
 
         return $this;
     }
@@ -66,7 +66,7 @@ private function truncate(?string $string = null, int $maxLineOffset = 0): strin
             return '';
         }
 
-        return new StringHelper($string)
+        return new ImmutableString($string)
             ->truncate($this->maxLineCharacters - 1 - $maxLineOffset, end: '…') // -1 is for the ellipsis
             ->toString();
     }

src/Tempest/Console/src/Components/Renderers/TextInputRenderer.php

@@ -41,7 +41,7 @@ public function render(
         // splits the text to an array so we can work with individual lines
         $lines = str(($buffer->text ?: $placeholder) ?: '')
             ->explode("\n")
-            ->flatMap(fn (string $line) => str($line)->split($this->maxLineCharacters)->toArray())
+            ->flatMap(fn (string $line) => str($line)->chunk($this->maxLineCharacters)->toArray())
             ->map(static fn (string $line) => str($line)->replaceEnd("\n", ' '));
 
         // calculates scroll offset based on cursor position