[7.x] Add new ApplicationNotAvailableException::validate() method

Signed-off-by: Mior Muhammad Zaki <[email protected]>
orchestral · Dec 4, 2024 · c562e98 · c562e98
1 parent c588d05
commit c562e98
Show file tree

Hide file tree

Showing 5 changed files with 28 additions and 29 deletions.
diff --git a/src/Concerns/HandlesDatabases.php b/src/Concerns/HandlesDatabases.php
@@ -21,9 +21,7 @@ trait HandlesDatabases
      */
     protected function setUpDatabaseRequirements(Closure $callback): void
     {
-        if (\is_null($app = $this->app)) {
-            throw ApplicationNotAvailableException::make(__METHOD__);
-        }
+        ApplicationNotAvailableException::validate($app = $this->app, __METHOD__);
 
         $app['events']->listen(DatabaseRefreshed::class, function () {
             $this->defineDatabaseMigrationsAfterDatabaseRefreshed();
@@ -63,9 +61,7 @@ protected function setUpDatabaseRequirements(Closure $callback): void
      */
     protected function usesSqliteInMemoryDatabaseConnection(?string $connection = null): bool
     {
-        if (\is_null($app = $this->app)) {
-            throw ApplicationNotAvailableException::make(__METHOD__);
-        }
+        ApplicationNotAvailableException::validate($app = $this->app, __METHOD__);
 
         /** @var \Illuminate\Contracts\Config\Repository $config */
         $config = $app->make('config');

diff --git a/src/Concerns/InteractsWithMigrations.php b/src/Concerns/InteractsWithMigrations.php
@@ -68,9 +68,7 @@ protected function loadMigrationsFrom($paths): void
             && RefreshDatabaseState::$migrated === false
             && RefreshDatabaseState::$lazilyRefreshed === false
         ) {
-            if (\is_null($this->app)) {
-                throw ApplicationNotAvailableException::make(__METHOD__);
-            }
+            ApplicationNotAvailableException::validate($this->app, __METHOD__);
 
             /** @var array<int, string>|string $paths */
             load_migration_paths($this->app, $paths);
@@ -92,9 +90,7 @@ protected function loadMigrationsFrom($paths): void
      */
     protected function loadMigrationsWithoutRollbackFrom($paths): void
     {
-        if (\is_null($this->app)) {
-            throw ApplicationNotAvailableException::make(__METHOD__);
-        }
+        ApplicationNotAvailableException::validate($this->app, __METHOD__);
 
         $migrator = new MigrateProcessor($this, $this->resolvePackageMigrationsOptions($paths));
         $migrator->up();
@@ -146,9 +142,7 @@ protected function loadLaravelMigrations($database = []): void
      */
     protected function loadLaravelMigrationsWithoutRollback($database = []): void
     {
-        if (\is_null($this->app)) {
-            throw ApplicationNotAvailableException::make(__METHOD__);
-        }
+        ApplicationNotAvailableException::validate($this->app, __METHOD__);
 
         $options = $this->resolveLaravelMigrationsOptions($database);
         $options['--path'] = default_migration_path();
@@ -183,9 +177,7 @@ protected function runLaravelMigrations($database = []): void
      */
     protected function runLaravelMigrationsWithoutRollback($database = []): void
     {
-        if (\is_null($this->app)) {
-            throw ApplicationNotAvailableException::make(__METHOD__);
-        }
+        ApplicationNotAvailableException::validate($this->app, __METHOD__);
 
         $migrator = new MigrateProcessor($this, $this->resolveLaravelMigrationsOptions($database));
         $migrator->up();

diff --git a/src/Concerns/InteractsWithTestCase.php b/src/Concerns/InteractsWithTestCase.php
@@ -124,10 +124,7 @@ abstract protected static function resolvePhpUnitAttributesForMethod(string $cla
      */
     protected function setUpTheTestEnvironmentUsingTestCase(): void
     {
-        /** @phpstan-ignore-next-line */
-        if (\is_null($app = $this->app)) {
-            throw ApplicationNotAvailableException::make(__METHOD__);
-        }
+        ApplicationNotAvailableException::validate($app = $this->app, __METHOD__);
 
         $this->resolvePhpUnitAttributes()
             ->flatten()
@@ -145,10 +142,7 @@ protected function setUpTheTestEnvironmentUsingTestCase(): void
      */
     protected function tearDownTheTestEnvironmentUsingTestCase(): void
     {
-        /** @phpstan-ignore-next-line */
-        if (\is_null($app = $this->app)) {
-            throw ApplicationNotAvailableException::make(__METHOD__);
-        }
+        ApplicationNotAvailableException::validate($app = $this->app, __METHOD__);
 
         $this->resolvePhpUnitAttributes()
             ->flatten()

diff --git a/src/Concerns/WithFactories.php b/src/Concerns/WithFactories.php
@@ -25,9 +25,7 @@ trait WithFactories
      */
     protected function withFactories(string $path)
     {
-        if (\is_null($this->app)) {
-            throw ApplicationNotAvailableException::make(__METHOD__);
-        }
+        ApplicationNotAvailableException::validate($this->app, __METHOD__);
 
         return $this->loadFactoriesUsing($this->app, $path);
     }

diff --git a/src/Exceptions/ApplicationNotAvailableException.php b/src/Exceptions/ApplicationNotAvailableException.php
@@ -2,10 +2,29 @@
 
 namespace Orchestra\Testbench\Exceptions;
 
+use Illuminate\Contracts\Foundation\Application;
 use RuntimeException;
 
 class ApplicationNotAvailableException extends RuntimeException
 {
+    /**
+     * Determine if the application is available before throwing an exception.
+     *
+     * @param  \Illuminate\Contracts\Foundation\Application|null  $app
+     * @param  string  $method
+     * @return true
+     *
+     * @throws static
+     */
+    public static function validate($app, string $method)
+    {
+        if (! $app instanceof Application) {
+            throw static::make($method);
+        }
+
+        return true;
+    }
+
     /**
      * Make new RuntimeException when application is not available.
      *