add DiscoverSolutionProviders

spatie · Jun 12, 2024 · ab0cef4 · ab0cef4
1 parent 1370ac0
commit ab0cef4
Show file tree

Hide file tree

Showing 3 changed files with 105 additions and 7 deletions.
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -20,13 +20,6 @@
             <directory>tests</directory>
         </testsuite>
     </testsuites>
-    <coverage>
-        <report>
-            <html outputDirectory="build/coverage"/>
-            <text outputFile="build/coverage.txt"/>
-            <clover outputFile="build/logs/clover.xml"/>
-        </report>
-    </coverage>
     <logging>
         <junit outputFile="build/report.junit.xml"/>
     </logging>

diff --git a/src/DiscoverSolutionProviders.php b/src/DiscoverSolutionProviders.php
@@ -0,0 +1,85 @@
+<?php
+
+namespace Spatie\ErrorSolutions;
+
+use Spatie\ErrorSolutions\Contracts\HasSolutionsForThrowable;
+
+class DiscoverSolutionProviders
+{
+    protected array $config = [
+        'ai' => 'SolutionProviders/OpenAi',
+        'php' => 'SolutionProviders',
+        'laravel' => 'SolutionProviders/Laravel'
+    ];
+
+    /** @return array<HasSolutionsForThrowable */
+    public static function for(array $types): array
+    {
+        if (in_array('php', $types)) {
+            $types[] = 'ai';
+        }
+
+        return (new self($types))->get();
+    }
+
+    /**
+     * @param array<string> $types
+     */
+    public function __construct(protected array $types)
+    {
+
+    }
+
+    /** @return array<HasSolutionsForThrowable */
+    public function get(): array
+    {
+        $providers = [];
+
+        foreach ($this->types as $type) {
+            $providers = array_merge($providers, $this->getProviderClassesForType($type));
+        }
+
+        return $providers;
+    }
+
+    protected function getProviderClassesForType(string $type): array
+    {
+        $relativePath = $this->config[$type] ?? null;
+
+        if (! $relativePath) {
+            return [];
+        }
+
+        $namespace = $this->getNamespaceForPath($relativePath);
+
+        $globPattern = __DIR__ . '/'  . $relativePath . '/*.php';
+
+        $files = glob($globPattern);
+
+        if (!$files) {
+            return [];
+        }
+
+        $solutionProviders = array_map(function (string $solutionProviderFilePath) use ($namespace) {
+            $fileName = pathinfo($solutionProviderFilePath, PATHINFO_FILENAME);
+
+            $fqcn = $namespace . '\\' . $fileName;
+
+            $validClass = in_array(HasSolutionsForThrowable::class, class_implements($fqcn) ?: []);
+
+            return $validClass ? $fqcn : null;
+        }, $files);
+
+        return array_values(array_filter($solutionProviders));
+    }
+
+    protected function getNamespaceForPath(string $relativePath): string
+    {
+        $namespacePath = str_replace('/', '\\', $relativePath);
+
+        $namespace = 'Spatie\\ErrorSolutions\\' . $namespacePath;
+
+        return $namespace;
+
+    }
+}
diff --git a/tests/DiscoverSolutionProvidersTest.php b/tests/DiscoverSolutionProvidersTest.php
@@ -0,0 +1,20 @@
+<?php
+
+use Spatie\ErrorSolutions\Contracts\HasSolutionsForThrowable;
+use Spatie\ErrorSolutions\DiscoverSolutionProviders;
+
+it('can get all solution providers', function() {
+    $providers = DiscoverSolutionProviders::for(['php', 'laravel']);
+
+    expect($providers)
+        ->not()->toBeEmpty()
+        ->toImplement(HasSolutionsForThrowable::class);
+});
+
+it('will discover more solution providers for more types', function() {
+    $phpProviders = DiscoverSolutionProviders::for(['php']);
+
+    $laravelProviders = DiscoverSolutionProviders::for(['php', 'laravel']);
+
+    expect(count($laravelProviders))->toBeGreaterThan(count($phpProviders));
+});