Use PHPStan (#88)

* wip Signed-off-by: Mior Muhammad Zaki <crynobone@gmail.com> * wip Signed-off-by: Mior Muhammad Zaki <crynobone@gmail.com> * wip Signed-off-by: Mior Muhammad Zaki <crynobone@gmail.com> * wip Signed-off-by: Mior Muhammad Zaki <crynobone@gmail.com> * wip Signed-off-by: Mior Muhammad Zaki <crynobone@gmail.com> * wip Signed-off-by: Mior Muhammad Zaki <crynobone@gmail.com> * wip Signed-off-by: Mior Muhammad Zaki <crynobone@gmail.com> * wip Signed-off-by: Mior Muhammad Zaki <crynobone@gmail.com> Signed-off-by: Mior Muhammad Zaki <crynobone@gmail.com>
orchestral · Oct 28, 2022 · a1e38b2 · a1e38b2
1 parent 68ef457
commit a1e38b2
Show file tree

Hide file tree

Showing 13 changed files with 121 additions and 23 deletions.
diff --git a/.gitattributes b/.gitattributes
@@ -10,6 +10,8 @@
 /.scrutinizer.yml export-ignore
 /.travis.yml export-ignore
 /canvas.yaml export-ignore
+/phpstan-baseline.neon export-ignore
+/phpstan.neon.dist export-ignore
 /phpunit.xml export-ignore
 /sync.sh export-ignore
 /testbench.yaml export-ignore

diff --git a/.github/workflows/analyse.yml b/.github/workflows/analyse.yml
@@ -0,0 +1,43 @@
+name: analyse
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  analyse:
+    runs-on: ${{ matrix.os }}
+    continue-on-error: ${{ matrix.experimental }}
+    strategy:
+      matrix:
+        os:
+          - "ubuntu-latest"
+        php:
+          - "8.0"
+        experimental:
+          - true
+
+    name: PHP${{ matrix.php }} on ${{ matrix.os }}
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php }}
+          extensions: dom, curl, libxml, mbstring, zip, pcntl, pdo, sqlite, pdo_sqlite, mysql, mysqli, pdo_mysql, bcmath, intl, fileinfo
+          coverage: none
+
+      - name: Install dependencies
+        uses: "ramsey/composer-install@v2"
+        with:
+          dependency-versions: "highest"
+          composer-options: "--prefer-dist --prefer-stable --no-cache"
+
+      - name: Installed dependencies
+        run: composer show -D
+
+      - name: Execute Static Code Analysis
+        run: vendor/bin/phpstan analyse
diff --git a/composer.json b/composer.json
@@ -41,6 +41,7 @@
         "laravel/pint": "^1.1",
         "mockery/mockery": "^1.5.1",
         "orchestra/canvas": "^7.0",
+        "phpstan/phpstan": "^1.8",
         "phpunit/phpunit": "^9.5.10",
         "symfony/process": "^6.0.9",
         "symfony/yaml": "^6.0.9",

diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -0,0 +1,6 @@
+parameters:
+	ignoreErrors:
+		-
+			message: "#^Instanceof between Illuminate\\\\Http\\\\Response and Illuminate\\\\Http\\\\RedirectResponse will always evaluate to false\\.$#"
+			count: 1
+			path: src/TestCase.php
diff --git a/phpstan.neon.dist b/phpstan.neon.dist
@@ -0,0 +1,19 @@
+includes:
+  - ./phpstan-baseline.neon
+
+parameters:
+  paths:
+    - src
+
+  # The level 8 is the highest level
+  level: 6
+
+  ignoreErrors:
+    - '#Unsafe usage of new static#'
+
+  excludePaths:
+    - src/Foundation/Console/TestCommand.php
+
+  checkGenericClassInNonGenericObjectType: false
+  checkMissingIterableValueType: false
+  treatPhpDocTypesAsCertain: false
diff --git a/src/Concerns/HandlesAnnotations.php b/src/Concerns/HandlesAnnotations.php
@@ -24,24 +24,26 @@ protected function parseTestMethodAnnotations($app, string $name): void
         }
 
         if (class_exists(Version::class) && version_compare(Version::id(), '10', '>=')) {
+            /** @phpstan-ignore-next-line */
             $registry = \PHPUnit\Metadata\Annotation\Parser\Registry::getInstance();
         } else {
+            /** @phpstan-ignore-next-line */
             $registry = \PHPUnit\Util\Annotation\Registry::getInstance();
         }
 
-        Collection::make(
-            rescue(function () use ($registry) {
-                return $registry->forMethod(static::class, $this->getName(false))->symbolAnnotations();
-            }, [], false)
-        )->filter(static function ($actions, $key) use ($name) {
-            return $key === $name;
-        })->each(function ($actions) use ($app) {
-            Collection::make($actions ?? [])
-                ->filter(function ($method) {
-                    return ! \is_null($method) && method_exists($this, $method);
-                })->each(function ($method) use ($app) {
-                    $this->{$method}($app);
-                });
-        });
+        /** @var array<string, mixed> $annotations */
+        $annotations = rescue(
+            fn () => $registry->forMethod(static::class, $this->getName(false))->symbolAnnotations(), [], false
+        );
+
+        Collection::make($annotations)
+            ->filter(fn ($actions, $key) => $key === $name)
+            ->each(function ($actions) use ($app) {
+                (new Collection($actions ?? []))
+                    ->filter(fn ($method) => is_string($method) && method_exists($this, $method))
+                    ->each(function ($method) use ($app) {
+                        $this->{$method}($app);
+                    });
+            });
     }
 }
diff --git a/src/Concerns/Testing.php b/src/Concerns/Testing.php
@@ -33,7 +33,7 @@ trait Testing
     /**
      * The Illuminate application instance.
      *
-     * @var \Illuminate\Foundation\Application
+     * @var \Illuminate\Foundation\Application|null
      */
     protected $app;
 
@@ -61,7 +61,7 @@ trait Testing
     /**
      * The exception thrown while running an application destruction callback.
      *
-     * @var \Throwable
+     * @var \Throwable|null
      */
     protected $callbackException;
 
@@ -130,6 +130,7 @@ final protected function tearDownTheTestEnvironment(): void
         }
 
         if (class_exists(Mockery::class)) {
+            /** @phpstan-ignore-next-line */
             if ($container = Mockery::getContainer()) {
                 $this->addToAssertionCount($container->mockery_getExpectationCount());
             }
@@ -176,27 +177,33 @@ final protected function setUpTheTestEnvironmentTraits(array $uses): array
     {
         $this->setUpDatabaseRequirements(function () use ($uses) {
             if (isset($uses[RefreshDatabase::class])) {
+                /** @phpstan-ignore-next-line */
                 $this->refreshDatabase();
             }
 
             if (isset($uses[DatabaseMigrations::class])) {
+                /** @phpstan-ignore-next-line */
                 $this->runDatabaseMigrations();
             }
         });
 
         if (isset($uses[DatabaseTransactions::class])) {
+            /** @phpstan-ignore-next-line */
             $this->beginDatabaseTransaction();
         }
 
         if (isset($uses[WithoutMiddleware::class])) {
+            /** @phpstan-ignore-next-line */
             $this->disableMiddlewareForAllTests();
         }
 
         if (isset($uses[WithoutEvents::class])) {
+            /** @phpstan-ignore-next-line */
             $this->disableEventsForAllTests();
         }
 
         if (isset($uses[WithFaker::class])) {
+            /** @phpstan-ignore-next-line */
             $this->setUpFaker();
         }
 
@@ -209,6 +216,7 @@ final protected function setUpTheTestEnvironmentTraits(array $uses): array
     protected function setUpParallelTestingCallbacks(): void
     {
         if (class_exists(ParallelTesting::class) && $this instanceof TestCase) {
+            /** @phpstan-ignore-next-line */
             ParallelTesting::callSetUpTestCaseCallbacks($this);
         }
     }
@@ -219,6 +227,7 @@ protected function setUpParallelTestingCallbacks(): void
     protected function tearDownParallelTestingCallbacks(): void
     {
         if (class_exists(ParallelTesting::class) && $this instanceof TestCase) {
+            /** @phpstan-ignore-next-line */
             ParallelTesting::callTearDownTestCaseCallbacks($this);
         }
     }

diff --git a/src/Console/Commander.php b/src/Console/Commander.php
@@ -17,6 +17,9 @@
 use Symfony\Component\Console\Output\OutputInterface;
 use Throwable;
 
+/**
+ * @phpstan-type TConfig array{laravel: string|null, env: array|null, providers: array|null, dont-discover: array|null}
+ */
 class Commander
 {
     /**
@@ -29,9 +32,14 @@ class Commander
     /**
      * List of configurations.
      *
-     * @var array{laravel: string|null, env: array, providers: array, dont-discover: array}
+     * @var TConfig
      */
-    protected $config = [];
+    protected $config = [
+        'laravel' => null,
+        'env' => [],
+        'providers' => [],
+        'dont-discover' => [],
+    ];
 
     /**
      * Working path.
@@ -43,7 +51,7 @@ class Commander
     /**
      * Construct a new Commander.
      *
-     * @param  array{laravel: string|null, env: array, providers: array, dont-discover: array}  $config
+     * @param  TConfig  $config
      * @param  string  $workingPath
      */
     public function __construct(array $config, string $workingPath)

diff --git a/src/Exceptions/Handler.php b/src/Exceptions/Handler.php
@@ -53,7 +53,7 @@ public function report(Throwable $e)
      *
      * @param  \Illuminate\Http\Request  $request
      * @param  \Throwable  $e
-     * @return \Illuminate\Http\Response
+     * @return \Symfony\Component\HttpFoundation\Response|\Illuminate\Http\Response
      */
     public function render($request, Throwable $e)
     {

diff --git a/src/Factories/UserFactory.php b/src/Factories/UserFactory.php
@@ -6,14 +6,16 @@
 use Illuminate\Support\Str;
 
 /**
- * @extends \Illuminate\Database\Eloquent\Factories\Factory<\Illuminate\Foundation\Auth\User>
+ * @phpstan-type TModel \Illuminate\Foundation\Auth\User
+ *
+ * @extends \Illuminate\Database\Eloquent\Factories\Factory<TModel>
  */
 class UserFactory extends Factory
 {
     /**
      * The name of the factory's corresponding model.
      *
-     * @var string
+     * @var class-string<TModel>
      */
     protected $model = \Illuminate\Foundation\Auth\User::class;
 

diff --git a/src/Foundation/Config.php b/src/Foundation/Config.php
@@ -6,12 +6,15 @@
 use Illuminate\Support\Fluent;
 use Symfony\Component\Yaml\Yaml;
 
+/**
+ * @phpstan-type TConfig array{laravel: string|null, env: array, providers: array, dont-discover: array}
+ */
 class Config extends Fluent
 {
     /**
      * All of the attributes set on the fluent instance.
      *
-     * @var array{laravel: string|null, env: array, providers: array, dont-discover: array}
+     * @var TConfig
      */
     protected $attributes = [
         'laravel' => null,
@@ -34,6 +37,7 @@ public static function loadFromYaml(string $workingPath, ?string $filename = 'te
         $config = $defaults;
 
         if (file_exists("{$workingPath}/{$filename}")) {
+            /** @var TConfig $config */
             $config = Yaml::parseFile("{$workingPath}/{$filename}");
 
             $config['laravel'] = transform(Arr::get($config, 'laravel'), function ($basePath) use ($workingPath) {

diff --git a/src/Foundation/Console/TestFallbackCommand.php b/src/Foundation/Console/TestFallbackCommand.php
@@ -97,6 +97,7 @@ protected function installCollisionDependencies()
      */
     protected function findComposer()
     {
+        /** @phpstan-ignore-next-line */
         $composerPath = TESTBENCH_WORKING_PATH.'/composer.phar';
 
         if (file_exists($composerPath)) {

diff --git a/src/Foundation/PackageManifest.php b/src/Foundation/PackageManifest.php
@@ -48,6 +48,7 @@ public function __construct(Filesystem $files, $basePath, $manifestPath, $testbe
      */
     public static function swap($app, $testbench = null)
     {
+        /** @var \Illuminate\Foundation\PackageManifest $base */
         $base = $app->make(IlluminatePackageManifest::class);
 
         $app->instance(