feat(discovery): allow exceptions on DoNotDiscover classes (#521)

Author: innocenzi

src/Tempest/Core/src/DoNotDiscover.php

@@ -9,4 +9,12 @@
 #[Attribute(Attribute::TARGET_CLASS)]
 final class DoNotDiscover
 {
+    public function __construct(
+        /**
+         * Allows the specified `Discovery` classes to still discover this class.
+         * @var array<class-string<\Tempest\Core\Discovery>>
+         */
+        public readonly array $except = [],
+    ) {
+    }
 }

src/Tempest/Core/src/Kernel/LoadDiscoveryClasses.php

@@ -95,12 +95,10 @@ public function __invoke(): void
                         }
                     }
 
-                    if ($input instanceof ClassReflector && $input->hasAttribute(DoNotDiscover::class)) {
-                        continue;
-                    }
-
                     if ($input instanceof ClassReflector) {
-                        $discovery->discover($input);
+                        if ($this->shouldDiscover($discovery, $input)) {
+                            $discovery->discover($input);
+                        }
                     } elseif ($discovery instanceof DiscoversPath) {
                         $discovery->discoverPath($input);
                     }
@@ -114,4 +112,13 @@ public function __invoke(): void
             }
         }
     }
+
+    private function shouldDiscover(Discovery $discovery, ClassReflector $input): bool
+    {
+        if (is_null($attribute = $input->getAttribute(DoNotDiscover::class))) {
+            return true;
+        }
+
+        return in_array($discovery::class, $attribute->except, strict: true);
+    }
 }

tests/Fixtures/Discovery/HiddenMigratableMigration.php

@@ -0,0 +1,29 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Tempest\Fixtures\Discovery;
+
+use Tempest\Core\DoNotDiscover;
+use Tempest\Database\Migration;
+use Tempest\Database\MigrationDiscovery;
+use Tempest\Database\QueryStatement;
+
+#[DoNotDiscover(except: [MigrationDiscovery::class])]
+final class HiddenMigratableMigration implements Migration
+{
+    public function getName(): string
+    {
+        return 'hidden-migratable-migration';
+    }
+
+    public function up(): ?QueryStatement
+    {
+        return null;
+    }
+
+    public function down(): ?QueryStatement
+    {
+        return null;
+    }
+}

tests/Integration/Core/LoadDiscoveryClassesTest.php

@@ -4,11 +4,12 @@
 
 namespace Tests\Tempest\Integration\Core;
 
-use function PHPUnit\Framework\assertNotContains;
+use PHPUnit\Framework\Attributes\Test;
 use Tempest\Core\Kernel\LoadDiscoveryClasses;
 use Tempest\Database\DatabaseConfig;
 use Tempest\Database\MigrationDiscovery;
 use function Tempest\get;
+use Tests\Tempest\Fixtures\Discovery\HiddenMigratableMigration;
 use Tests\Tempest\Fixtures\Discovery\HiddenMigration;
 use Tests\Tempest\Integration\FrameworkIntegrationTestCase;
 
@@ -17,7 +18,8 @@
  */
 final class LoadDiscoveryClassesTest extends FrameworkIntegrationTestCase
 {
-    public function test_hidden_from_discovery(): void
+    #[Test]
+    public function do_not_discover(): void
     {
         $this->kernel->discoveryClasses = [
             MigrationDiscovery::class,
@@ -31,6 +33,25 @@ public function test_hidden_from_discovery(): void
 
         $migrations = get(DatabaseConfig::class)->getMigrations();
 
-        assertNotContains(HiddenMigration::class, $migrations);
+        $this->assertNotContains(HiddenMigration::class, $migrations);
+    }
+
+    #[Test]
+    public function do_not_discover_except(): void
+    {
+        $this->kernel->discoveryClasses = [
+            MigrationDiscovery::class,
+            // TODO: update tests to add `PublishDiscovery` when it's merged
+        ];
+
+        $this->kernel->discoveryLocations = [
+            realpath(__DIR__.'../../Fixtures/Discovery'),
+        ];
+
+        (new LoadDiscoveryClasses($this->kernel, $this->container));
+
+        $migrations = get(DatabaseConfig::class)->getMigrations();
+
+        $this->assertContains(HiddenMigratableMigration::class, $migrations);
     }
 }