Add support for validators on service providers (#831)

* Add support for validators on service providers

* Ignore unreleated phpstan

Author: srtfisher

CHANGELOG.md

@@ -11,6 +11,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Added `laravel/serializable-closure` as a dependency to `mantle-framework/support` to
   support serialization of closures.
+- Added support for `Mantle\Types\Validator` attributes on service providers to
+  conditionally boot them based on custom logic.
 - Added `Mantle\Types\Attributes\Admin` and `Mantle\Types\Attributes\Request`
   validator attributes.
 

src/mantle/support/class-service-provider.php

@@ -11,6 +11,7 @@
 use Mantle\Console\Command;
 use Mantle\Contracts\Application;
 use Mantle\Support\Traits\Hookable;
+use Mantle\Types\Validator;
 use Psr\Log\{LoggerAwareInterface, LoggerAwareTrait};
 use Symfony\Component\Console\Command\Command as Symfony_Command;
 
@@ -81,8 +82,10 @@ public function boot_provider(): void {
 			$this->setLogger( $this->app['log']->driver() );
 		}
 
-		$this->register_hooks();
-		$this->boot();
+		if ( $this->should_boot_provider() ) {
+			$this->register_hooks();
+			$this->boot();
+		}
 	}
 
 	/**
@@ -216,4 +219,27 @@ public static function paths_to_publish( array|string|null $providers = null, ar
 			default => [],
 		};
 	}
+
+	/**
+	 * Determine if the provider should be booted.
+	 *
+	 * Checks for any Validator attributes on the class and runs them.
+	 */
+	protected function should_boot_provider(): bool {
+		$validator = Reflector::get_attributes_for_class( $this, Validator::class, \ReflectionAttribute::IS_INSTANCEOF );
+
+		if ( empty( $validator ) ) {
+			return true;
+		}
+
+		foreach ( $validator as $attribute ) {
+			$instance = $attribute->newInstance();
+
+			if ( ! $instance->validate() ) {
+				return false;
+			}
+		}
+
+		return true;
+	}
 }

tests/Support/ServiceProviderTest.php

@@ -1,13 +1,15 @@
 <?php
 namespace Mantle\Tests\Support;
 
+use Attribute;
 use Mantle\Application\Application;
 use Mantle\Console\Command;
 use Mantle\Contracts\Providers as ProviderContracts;
 use Mantle\Events\Dispatcher;
 use Mantle\Support\Service_Provider;
 use Mantle\Support\Attributes\Action;
 use Mantle\Support\Attributes\Filter;
+use Mantle\Types\Validator;
 use Mockery as m;
 
 class ServiceProviderTest extends \Mockery\Adapter\Phpunit\MockeryTestCase {
@@ -276,6 +278,30 @@ function ( $resolved ) {
 
 		$this->assertEquals( 'one', $_SERVER['__after_resolving'] );
 	}
+
+	public function test_service_provider_with_passing_validator(): void {
+		$_SERVER['__service_provider_booted'] = false;
+
+		$app = m::mock( Application::class )->makePartial();
+
+		$app->register( PassingValidatorServiceProvider::class );
+
+		$this->assertFalse( $_SERVER['__service_provider_booted'] );
+		$app->boot();
+		$this->assertTrue( $_SERVER['__service_provider_booted'] );
+	}
+
+	public function test_service_provider_with_failing_validator(): void {
+		$_SERVER['__service_provider_booted'] = false;
+
+		$app = m::mock( Application::class )->makePartial();
+
+		$app->register( FailingValidatorServiceProvider::class );
+
+		$this->assertFalse( $_SERVER['__service_provider_booted'] );
+		$app->boot();
+		$this->assertFalse( $_SERVER['__service_provider_booted'] );
+	}
 }
 
 class Provider_Test_Hook extends Service_Provider {
@@ -331,6 +357,40 @@ public function boot() {
 	}
 }
 
-class Example_Service_Provider_Event {
+class Example_Service_Provider_Event {}
+
+#[Attribute]
+class PassingValidator implements Validator {
+	public function validate(): bool {
+		return true;
+	}
+}
+
+#[PassingValidator]
+class PassingValidatorServiceProvider extends Service_Provider {
+	public function register() {
+		$_SERVER['__service_provider_registered'] = true;
+	}
+
+	public function boot() {
+		$_SERVER['__service_provider_booted'] = true;
+	}
+}
 
+#[Attribute]
+class FailingValidator implements Validator {
+	public function validate(): bool {
+		return false;
+	}
+}
+
+#[FailingValidator]
+class FailingValidatorServiceProvider extends Service_Provider {
+	public function register() {
+		$_SERVER['__service_provider_registered'] = true;
+	}
+
+	public function boot() {
+		$_SERVER['__service_provider_booted'] = true;
+	}
 }