refactor(testing): add ApplicationContract and Router type hints

binaryfire · binaryfire · commit 78f73d3e4792 · 2026-01-16T16:16:12.000Z
Add proper type hints following existing codebase conventions:
- Use `ApplicationContract` alias for contract type hints
- Use `Router` type hints for route definition methods
- Update all contracts, attributes, traits, and test files

This improves type safety while maintaining consistency with the
existing codebase pattern where 20+ files use the ApplicationContract
alias convention.
diff --git a/src/foundation/src/Testing/Attributes/DefineDatabase.php b/src/foundation/src/Testing/Attributes/DefineDatabase.php
@@ -6,6 +6,7 @@
 
 use Attribute;
 use Closure;
+use Hypervel\Foundation\Contracts\Application as ApplicationContract;
 use Hypervel\Foundation\Testing\Contracts\Attributes\Actionable;
 use Hypervel\Foundation\Testing\Contracts\Attributes\AfterEach;
 use Hypervel\Foundation\Testing\Contracts\Attributes\BeforeEach;
@@ -26,31 +27,26 @@ public function __construct(
 
     /**
      * Handle the attribute before each test.
-     *
-     * @param \Hypervel\Foundation\Contracts\Application $app
      */
-    public function beforeEach($app): void
+    public function beforeEach(ApplicationContract $app): void
     {
         ResetRefreshDatabaseState::run();
     }
 
     /**
      * Handle the attribute after each test.
-     *
-     * @param \Hypervel\Foundation\Contracts\Application $app
      */
-    public function afterEach($app): void
+    public function afterEach(ApplicationContract $app): void
     {
         ResetRefreshDatabaseState::run();
     }
 
     /**
      * Handle the attribute.
      *
-     * @param \Hypervel\Foundation\Contracts\Application $app
      * @param Closure(string, array<int, mixed>):void $action
      */
-    public function handle($app, Closure $action): ?Closure
+    public function handle(ApplicationContract $app, Closure $action): ?Closure
     {
         $resolver = function () use ($app, $action) {
             \call_user_func($action, $this->method, [$app]);
diff --git a/src/foundation/src/Testing/Attributes/DefineEnvironment.php b/src/foundation/src/Testing/Attributes/DefineEnvironment.php
@@ -6,6 +6,7 @@
 
 use Attribute;
 use Closure;
+use Hypervel\Foundation\Contracts\Application as ApplicationContract;
 use Hypervel\Foundation\Testing\Contracts\Attributes\Actionable;
 
 /**
@@ -22,10 +23,9 @@ public function __construct(
     /**
      * Handle the attribute.
      *
-     * @param \Hypervel\Foundation\Contracts\Application $app
      * @param Closure(string, array<int, mixed>):void $action
      */
-    public function handle($app, Closure $action): mixed
+    public function handle(ApplicationContract $app, Closure $action): mixed
     {
         \call_user_func($action, $this->method, [$app]);
 
diff --git a/src/foundation/src/Testing/Attributes/DefineRoute.php b/src/foundation/src/Testing/Attributes/DefineRoute.php
@@ -6,6 +6,7 @@
 
 use Attribute;
 use Closure;
+use Hypervel\Foundation\Contracts\Application as ApplicationContract;
 use Hypervel\Foundation\Testing\Contracts\Attributes\Actionable;
 use Hypervel\Router\Router;
 
@@ -23,10 +24,9 @@ public function __construct(
     /**
      * Handle the attribute.
      *
-     * @param \Hypervel\Foundation\Contracts\Application $app
      * @param Closure(string, array<int, mixed>):void $action
      */
-    public function handle($app, Closure $action): mixed
+    public function handle(ApplicationContract $app, Closure $action): mixed
     {
         $router = $app->get(Router::class);
 
diff --git a/src/foundation/src/Testing/Attributes/RequiresEnv.php b/src/foundation/src/Testing/Attributes/RequiresEnv.php
@@ -6,6 +6,7 @@
 
 use Attribute;
 use Closure;
+use Hypervel\Foundation\Contracts\Application as ApplicationContract;
 use Hypervel\Foundation\Testing\Contracts\Attributes\Actionable;
 
 /**
@@ -23,10 +24,9 @@ public function __construct(
     /**
      * Handle the attribute.
      *
-     * @param \Hypervel\Foundation\Contracts\Application $app
      * @param Closure(string, array<int, mixed>):void $action
      */
-    public function handle($app, Closure $action): mixed
+    public function handle(ApplicationContract $app, Closure $action): mixed
     {
         $message = $this->message ?? "Missing required environment variable `{$this->key}`";
 
diff --git a/src/foundation/src/Testing/Attributes/WithConfig.php b/src/foundation/src/Testing/Attributes/WithConfig.php
@@ -5,6 +5,7 @@
 namespace Hypervel\Foundation\Testing\Attributes;
 
 use Attribute;
+use Hypervel\Foundation\Contracts\Application as ApplicationContract;
 use Hypervel\Foundation\Testing\Contracts\Attributes\Invokable;
 
 /**
@@ -21,10 +22,8 @@ public function __construct(
 
     /**
      * Handle the attribute.
-     *
-     * @param \Hypervel\Foundation\Contracts\Application $app
      */
-    public function __invoke($app): mixed
+    public function __invoke(ApplicationContract $app): mixed
     {
         $app->get('config')->set($this->key, $this->value);
 
diff --git a/src/foundation/src/Testing/Attributes/WithMigration.php b/src/foundation/src/Testing/Attributes/WithMigration.php
@@ -6,6 +6,7 @@
 
 use Attribute;
 use Hyperf\Database\Migrations\Migrator;
+use Hypervel\Foundation\Contracts\Application as ApplicationContract;
 use Hypervel\Foundation\Testing\Contracts\Attributes\Invokable;
 
 /**
@@ -29,10 +30,8 @@ public function __construct(string ...$paths)
 
     /**
      * Handle the attribute.
-     *
-     * @param \Hypervel\Foundation\Contracts\Application $app
      */
-    public function __invoke($app): mixed
+    public function __invoke(ApplicationContract $app): mixed
     {
         $app->afterResolving(Migrator::class, function (Migrator $migrator) {
             foreach ($this->paths as $path) {
diff --git a/src/foundation/src/Testing/Concerns/HandlesAttributes.php b/src/foundation/src/Testing/Concerns/HandlesAttributes.php
@@ -4,6 +4,7 @@
 
 namespace Hypervel\Foundation\Testing\Concerns;
 
+use Hypervel\Foundation\Contracts\Application as ApplicationContract;
 use Hypervel\Foundation\Testing\Contracts\Attributes\Actionable;
 use Hypervel\Foundation\Testing\Contracts\Attributes\Invokable;
 use Hypervel\Foundation\Testing\Features\FeaturesCollection;
@@ -22,10 +23,9 @@ trait HandlesAttributes
      *
      * @internal
      *
-     * @param \Hypervel\Foundation\Contracts\Application $app
      * @param class-string $attribute
      */
-    protected function parseTestMethodAttributes($app, string $attribute): FeaturesCollection
+    protected function parseTestMethodAttributes(ApplicationContract $app, string $attribute): FeaturesCollection
     {
         $attributes = $this->resolvePhpUnitAttributes()
             ->filter(static fn ($attributes, string $key) => $key === $attribute && ! empty($attributes))
diff --git a/src/foundation/src/Testing/Concerns/InteractsWithContainer.php b/src/foundation/src/Testing/Concerns/InteractsWithContainer.php
@@ -98,10 +98,8 @@ protected function refreshApplication(): void
 
     /**
      * Define environment setup.
-     *
-     * @param \Hypervel\Foundation\Contracts\Application $app
      */
-    protected function defineEnvironment($app): void
+    protected function defineEnvironment(ApplicationContract $app): void
     {
         // Override in subclass.
     }
diff --git a/src/foundation/src/Testing/Contracts/Attributes/Actionable.php b/src/foundation/src/Testing/Contracts/Attributes/Actionable.php
@@ -5,6 +5,7 @@
 namespace Hypervel\Foundation\Testing\Contracts\Attributes;
 
 use Closure;
+use Hypervel\Foundation\Contracts\Application as ApplicationContract;
 
 /**
  * Interface for attributes that handle actions via a callback.
@@ -14,8 +15,7 @@ interface Actionable extends TestingFeature
     /**
      * Handle the attribute.
      *
-     * @param \Hypervel\Foundation\Contracts\Application $app
      * @param Closure(string, array<int, mixed>):void $action
      */
-    public function handle($app, Closure $action): mixed;
+    public function handle(ApplicationContract $app, Closure $action): mixed;
 }
diff --git a/src/foundation/src/Testing/Contracts/Attributes/AfterEach.php b/src/foundation/src/Testing/Contracts/Attributes/AfterEach.php
@@ -4,15 +4,15 @@
 
 namespace Hypervel\Foundation\Testing\Contracts\Attributes;
 
+use Hypervel\Foundation\Contracts\Application as ApplicationContract;
+
 /**
  * Interface for attributes that run after each test.
  */
 interface AfterEach extends TestingFeature
 {
     /**
      * Handle the attribute.
-     *
-     * @param \Hypervel\Foundation\Contracts\Application $app
      */
-    public function afterEach($app): void;
+    public function afterEach(ApplicationContract $app): void;
 }
diff --git a/src/foundation/src/Testing/Contracts/Attributes/BeforeEach.php b/src/foundation/src/Testing/Contracts/Attributes/BeforeEach.php
@@ -4,15 +4,15 @@
 
 namespace Hypervel\Foundation\Testing\Contracts\Attributes;
 
+use Hypervel\Foundation\Contracts\Application as ApplicationContract;
+
 /**
  * Interface for attributes that run before each test.
  */
 interface BeforeEach extends TestingFeature
 {
     /**
      * Handle the attribute.
-     *
-     * @param \Hypervel\Foundation\Contracts\Application $app
      */
-    public function beforeEach($app): void;
+    public function beforeEach(ApplicationContract $app): void;
 }
diff --git a/src/foundation/src/Testing/Contracts/Attributes/Invokable.php b/src/foundation/src/Testing/Contracts/Attributes/Invokable.php
@@ -4,15 +4,15 @@
 
 namespace Hypervel\Foundation\Testing\Contracts\Attributes;
 
+use Hypervel\Foundation\Contracts\Application as ApplicationContract;
+
 /**
  * Interface for attributes that are directly invokable.
  */
 interface Invokable extends TestingFeature
 {
     /**
      * Handle the attribute.
-     *
-     * @param \Hypervel\Foundation\Contracts\Application $app
      */
-    public function __invoke($app): mixed;
+    public function __invoke(ApplicationContract $app): mixed;
 }
diff --git a/src/testbench/src/Concerns/CreatesApplication.php b/src/testbench/src/Concerns/CreatesApplication.php
@@ -4,6 +4,8 @@
 
 namespace Hypervel\Testbench\Concerns;
 
+use Hypervel\Foundation\Contracts\Application as ApplicationContract;
+
 /**
  * Provides hooks for registering package service providers and aliases.
  */
@@ -12,31 +14,27 @@ trait CreatesApplication
     /**
      * Get package providers.
      *
-     * @param \Hypervel\Foundation\Contracts\Application $app
      * @return array<int, class-string>
      */
-    protected function getPackageProviders($app): array
+    protected function getPackageProviders(ApplicationContract $app): array
     {
         return [];
     }
 
     /**
      * Get package aliases.
      *
-     * @param \Hypervel\Foundation\Contracts\Application $app
      * @return array<string, class-string>
      */
-    protected function getPackageAliases($app): array
+    protected function getPackageAliases(ApplicationContract $app): array
     {
         return [];
     }
 
     /**
      * Register package providers.
-     *
-     * @param \Hypervel\Foundation\Contracts\Application $app
      */
-    protected function registerPackageProviders($app): void
+    protected function registerPackageProviders(ApplicationContract $app): void
     {
         foreach ($this->getPackageProviders($app) as $provider) {
             $app->register($provider);
@@ -45,10 +43,8 @@ protected function registerPackageProviders($app): void
 
     /**
      * Register package aliases.
-     *
-     * @param \Hypervel\Foundation\Contracts\Application $app
      */
-    protected function registerPackageAliases($app): void
+    protected function registerPackageAliases(ApplicationContract $app): void
     {
         $aliases = $this->getPackageAliases($app);
 
diff --git a/src/testbench/src/Concerns/HandlesRoutes.php b/src/testbench/src/Concerns/HandlesRoutes.php
@@ -4,6 +4,7 @@
 
 namespace Hypervel\Testbench\Concerns;
 
+use Hypervel\Foundation\Contracts\Application as ApplicationContract;
 use Hypervel\Router\Router;
 use ReflectionMethod;
 
@@ -14,30 +15,24 @@ trait HandlesRoutes
 {
     /**
      * Define routes setup.
-     *
-     * @param \Hypervel\Router\Router $router
      */
-    protected function defineRoutes($router): void
+    protected function defineRoutes(Router $router): void
     {
         // Define routes.
     }
 
     /**
      * Define web routes setup.
-     *
-     * @param \Hypervel\Router\Router $router
      */
-    protected function defineWebRoutes($router): void
+    protected function defineWebRoutes(Router $router): void
     {
         // Define web routes.
     }
 
     /**
      * Setup application routes.
-     *
-     * @param \Hypervel\Foundation\Contracts\Application $app
      */
-    protected function setUpApplicationRoutes($app): void
+    protected function setUpApplicationRoutes(ApplicationContract $app): void
     {
         $router = $app->get(Router::class);
 
diff --git a/src/testbench/src/TestCase.php b/src/testbench/src/TestCase.php
@@ -59,10 +59,8 @@ protected function setUp(): void
 
     /**
      * Define environment setup.
-     *
-     * @param \Hypervel\Foundation\Contracts\Application $app
      */
-    protected function defineEnvironment($app): void
+    protected function defineEnvironment(ApplicationContract $app): void
     {
         $this->registerPackageProviders($app);
         $this->registerPackageAliases($app);
diff --git a/tests/Foundation/Testing/Concerns/DefineEnvironmentTest.php b/tests/Foundation/Testing/Concerns/DefineEnvironmentTest.php
@@ -4,7 +4,7 @@
 
 namespace Hypervel\Tests\Foundation\Testing\Concerns;
 
-use Hypervel\Foundation\Contracts\Application;
+use Hypervel\Foundation\Contracts\Application as ApplicationContract;
 use Hypervel\Testbench\TestCase;
 
 /**
@@ -15,9 +15,9 @@ class DefineEnvironmentTest extends TestCase
 {
     protected bool $defineEnvironmentCalled = false;
 
-    protected ?Application $passedApp = null;
+    protected ?ApplicationContract $passedApp = null;
 
-    protected function defineEnvironment($app): void
+    protected function defineEnvironment(ApplicationContract $app): void
     {
         $this->defineEnvironmentCalled = true;
         $this->passedApp = $app;
@@ -34,7 +34,7 @@ public function testDefineEnvironmentIsCalledDuringSetUp(): void
     public function testAppInstanceIsPassed(): void
     {
         $this->assertNotNull($this->passedApp);
-        $this->assertInstanceOf(Application::class, $this->passedApp);
+        $this->assertInstanceOf(ApplicationContract::class, $this->passedApp);
         $this->assertSame($this->app, $this->passedApp);
     }
 
diff --git a/tests/Sanctum/AuthenticateRequestsTest.php b/tests/Sanctum/AuthenticateRequestsTest.php
diff --git a/tests/Sentry/Features/LogFeatureTest.php b/tests/Sentry/Features/LogFeatureTest.php
diff --git a/tests/Testbench/Concerns/CreatesApplicationTest.php b/tests/Testbench/Concerns/CreatesApplicationTest.php
diff --git a/tests/Testbench/Concerns/HandlesRoutesTest.php b/tests/Testbench/Concerns/HandlesRoutesTest.php
diff --git a/tests/Testbench/Concerns/HandlesRoutesWithoutWebRoutesTest.php b/tests/Testbench/Concerns/HandlesRoutesWithoutWebRoutesTest.php
diff --git a/tests/Testbench/TestCaseTest.php b/tests/Testbench/TestCaseTest.php

Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,7 @@`
`4`	`4`
`5`	`5`	`namespace Hypervel\Foundation\Testing\Concerns;`
`6`	`6`
	`7`	`+use Hypervel\Foundation\Contracts\Application as ApplicationContract;`
`7`	`8`	`use Hypervel\Foundation\Testing\Contracts\Attributes\Actionable;`
`8`	`9`	`use Hypervel\Foundation\Testing\Contracts\Attributes\Invokable;`
`9`	`10`	`use Hypervel\Foundation\Testing\Features\FeaturesCollection;`
`@@ -22,10 +23,9 @@ trait HandlesAttributes`
`22`	`23`	`*`
`23`	`24`	`* @internal`
`24`	`25`	`*`
`25`		`- * @param \Hypervel\Foundation\Contracts\Application $app`
`26`	`26`	`* @param class-string $attribute`
`27`	`27`	`*/`
`28`		`- protected function parseTestMethodAttributes($app, string $attribute): FeaturesCollection`
	`28`	`+ protected function parseTestMethodAttributes(ApplicationContract $app, string $attribute): FeaturesCollection`
`29`	`29`	`{`
`30`	`30`	`$attributes = $this->resolvePhpUnitAttributes()`
`31`	`31`	`->filter(static fn ($attributes, string $key) => $key === $attribute && ! empty($attributes))`
Original file line number	Diff line number	Diff line change
`@@ -98,10 +98,8 @@ protected function refreshApplication(): void`
`98`	`98`
`99`	`99`	`/**`
`100`	`100`	`* Define environment setup.`
`101`		`- *`
`102`		`- * @param \Hypervel\Foundation\Contracts\Application $app`
`103`	`101`	`*/`
`104`		`- protected function defineEnvironment($app): void`
	`102`	`+ protected function defineEnvironment(ApplicationContract $app): void`
`105`	`103`	`{`
`106`	`104`	`// Override in subclass.`
`107`	`105`	`}`