Added util classes

Author: WalterWoshid

src/Util/Finder.php

@@ -0,0 +1,64 @@
+<?php
+
+namespace Okapi\CodeTransformer\Util;
+
+use Okapi\Wildcards\Regex;
+
+/**
+ * # Finder
+ *
+ * The `Finder` class is used to match classes against a list of patterns.
+ */
+class Finder
+{
+    /**
+     * The classes that should be included in the search.
+     *
+     * @var string[] List with regex patterns
+     */
+    private array $classesToMatch = [];
+
+    /**
+     * Include a class or an array of classes in the search.
+     * Can also be a wildcard pattern.
+     *
+     * @param class-string|class-string[] $path
+     *
+     * @return $this
+     */
+    public function includeClass(string|array $path): self
+    {
+        $path = (array)$path;
+
+        // Convert wildcard patterns to regex
+        foreach ($path as &$class) {
+            $class = Regex::fromWildcard($class)->getRegex();
+        }
+
+        $this->classesToMatch = array_merge(
+            $this->classesToMatch,
+            $path,
+        );
+
+        return $this;
+    }
+
+    /**
+     * Check if a class exists in the search paths.
+     *
+     * @param class-string $class
+     *
+     * @return bool
+     */
+    public function hasClass(string $class): bool
+    {
+        // Check if the class matches any of the patterns
+        return array_reduce(
+            $this->classesToMatch,
+            function (bool $carry, string $pattern) use ($class): bool {
+                return $carry || preg_match($pattern, $class) === 1;
+            },
+            false,
+        );
+    }
+}

src/Util/StringMutator.php

@@ -0,0 +1,76 @@
+<?php
+
+namespace Okapi\CodeTransformer\Util;
+
+/**
+ * A utility class for mutating strings.
+ *
+ * This class is used to mutate strings in a way that preserves the positions of
+ * edits. This is useful for transforming code, where edits to the code may
+ * change the positions of other edits.
+ */
+class StringMutator
+{
+    /**
+     * The string to mutate.
+     *
+     * @var string
+     */
+    private string $string;
+
+    /**
+     * The edits to apply to the string.
+     *
+     * @var array{int, int, string}[] Start position, length, replacement
+     */
+    public array $edits = [];
+
+    /**
+     * StringMutator constructor.
+     *
+     * @param string $string
+     */
+    public function __construct(string $string)
+    {
+        $this->string = $string;
+    }
+
+    /**
+     * Add an edit to the string.
+     *
+     * @param int    $start
+     * @param int    $length
+     * @param string $replacement
+     *
+     * @return $this
+     */
+    public function edit(int $start, int $length, string $replacement): self
+    {
+        $this->edits[] = [$start, $length, $replacement];
+        return $this;
+    }
+
+    /**
+     * Get the mutated string.
+     *
+     * @return string
+     */
+    public function getMutatedString(): string
+    {
+        // Sort the edits by start position.
+        usort($this->edits, function ($a, $b) {
+            return $a[0] <=> $b[0];
+        });
+
+        // Apply the edits.
+        $result = $this->string;
+        $offset = 0;
+        foreach ($this->edits as $edit) {
+            [$start, $length, $replacement] = $edit;
+            $start += $offset;
+            $result = substr_replace($result, $replacement, $start, $length);
+            $offset += strlen($replacement) - $length;
+        }
+        return $result;
+    }
+}