Merge pull request #19 from kirschbaum-development/phpstan-max

Brings `phpstan` to level `max`
kirschbaum-development · Oct 22, 2024 · 3897980 · 3897980
2 parents a15b7d4 + 5933851
commit 3897980
Show file tree

Hide file tree

Showing 7 changed files with 141 additions and 54 deletions.
diff --git a/.github/workflows/run-tests.yml b/.github/workflows/run-tests.yml
@@ -42,3 +42,61 @@ jobs:
 
       - name: Execute tests
         run: composer pest
+
+  pint:
+    runs-on: ubuntu-24.04
+    timeout-minutes: 5
+
+    name: Pint Style Check
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Cache dependencies
+        uses: actions/cache@v1
+        with:
+          path: ~/.composer/cache/files
+          key: dependencies-composer-${{ hashFiles('composer.json') }}
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: 8.3
+          tools: composer:v2
+
+      - name: Install dependencies
+        run: |
+          composer install --no-interaction --no-suggest --dev
+          composer dump
+
+      - name: Execute Pint
+        run: composer pint-check
+
+  larastan:
+    runs-on: ubuntu-24.04
+    timeout-minutes: 5
+
+    name: Static Analysis
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Cache dependencies
+        uses: actions/cache@v1
+        with:
+          path: ~/.composer/cache/files
+          key: dependencies-composer-${{ hashFiles('composer.json') }}
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: 8.3
+          tools: composer:v2
+
+      - name: Install dependencies
+        run: |
+          composer install --no-interaction --no-suggest --dev
+          composer dump
+
+      - name: Execute Larastan
+        run: composer larastan
diff --git a/phpstan.neon.dist b/phpstan.neon.dist
@@ -3,10 +3,10 @@ includes:
 
 parameters:
     paths:
-        - config/
-        - src/
+        - config
+        - src
 
-    level: 8
+    level: max
 
-    ignoreErrors:
-        - '#Access to an undefined property UnitEnum::\$value.#'
+    checkMissingIterableValueType: true
+    treatPhpDocTypesAsCertain: false
diff --git a/src/Commands/GenerateEnumsCommand.php b/src/Commands/GenerateEnumsCommand.php
@@ -37,21 +37,22 @@ public function handle(): int
     /**
      * Gather all enum namespaces for searching.
      *
-     * @return Collection<int, class-string>
+     * @return Collection<int,class-string<\UnitEnum>>
      */
     protected function enums(): Collection
     {
-        return DiscoverEnums::within(app_path(config('paragon.enums.paths.php')))
+        return DiscoverEnums::within(app_path(config()->string('paragon.enums.paths.php')))
             ->reject(function ($enum) {
                 if (! enum_exists($enum)) {
                     return true;
                 }
 
                 $reflector = new ReflectionEnum($enum);
 
-                $paths = Arr::map(Arr::wrap(config('paragon.enums.paths.ignore')), function ($path) {
-                    return Str::finish(app_path($path), '/');
-                });
+                $paths = Arr::map(
+                    Arr::wrap(config('paragon.enums.paths.ignore')),
+                    fn (string $path): string => Str::finish(app_path($path), '/'),
+                );
 
                 return $reflector->getAttributes(IgnoreParagon::class)
                     || Str::startsWith((string) $reflector->getFileName(), $paths);

diff --git a/src/Commands/MakeEnumMethodCommand.php b/src/Commands/MakeEnumMethodCommand.php
@@ -70,6 +70,8 @@ protected function promptForMissingArgumentsUsing(): array
     /**
      * Build the file with the given name.
      *
+     * @param  string  $name
+     *
      * @throws Exception
      * @throws FileNotFoundException
      */
@@ -87,7 +89,7 @@ protected function buildClass($name): string
      */
     protected function getPath($name): string
     {
-        return resource_path(config('paragon.enums.paths.methods')) . "/{$this->name()}.ts";
+        return resource_path(config()->string('paragon.enums.paths.methods')) . "/{$this->name()}.ts";
     }
 
     /**

diff --git a/src/Concerns/DiscoverEnums.php b/src/Concerns/DiscoverEnums.php
@@ -3,7 +3,6 @@
 namespace Kirschbaum\Paragon\Concerns;
 
 use Illuminate\Support\Collection;
-use Illuminate\Support\Str;
 use ReflectionClass;
 use ReflectionException;
 use SplFileInfo;
@@ -14,9 +13,9 @@ class DiscoverEnums
     /**
      * Get all the enums by searching the given directory.
      *
-     * @param  array<int, string>|string  $path
+     * @param  array<int,string>|string  $path
      *
-     * @return Collection<class-string, class-string>
+     * @return Collection<class-string<\UnitEnum>,class-string<\UnitEnum>>
      */
     public static function within(array|string $path): Collection
     {
@@ -26,12 +25,17 @@ public static function within(array|string $path): Collection
     /**
      * Filter the files down to only enums.
      *
-     * @return Collection<class-string, class-string>
+     * @param  Finder<string,SplFileInfo>  $files
+     *
+     * @return Collection<class-string<\UnitEnum>,class-string<\UnitEnum>>
      */
     protected static function getEnums(Finder $files): Collection
     {
-        return collect($files)
-            ->mapWithKeys(function ($file) {
+        /** @var Collection<int, SplFileInfo> $fileCollection */
+        $fileCollection = collect($files);
+
+        return $fileCollection
+            ->mapWithKeys(function (SplFileInfo $file) {
                 try {
                     if (! class_exists($enum = static::classFromFile($file))) {
                         return [];
@@ -51,15 +55,21 @@ protected static function getEnums(Finder $files): Collection
 
     /**
      * Extract the class name from the given file path.
+     *
+     * @return class-string<\UnitEnum>
      */
     protected static function classFromFile(SplFileInfo $file): string
     {
-        $class = trim(Str::replaceFirst(base_path(), '', $file->getRealPath()), DIRECTORY_SEPARATOR);
-
-        return str_replace(
-            [DIRECTORY_SEPARATOR, ucfirst(basename(app()->path())) . '\\'],
-            ['\\', app()->getNamespace()],
-            ucfirst(Str::replaceLast('.php', '', $class))
-        );
+        /** @var class-string<\UnitEnum> */
+        return str($file->getRealPath())
+            ->replaceFirst(base_path(), '')
+            ->trim(DIRECTORY_SEPARATOR)
+            ->replaceLast('.php', '')
+            ->ucfirst()
+            ->replace(
+                search: [DIRECTORY_SEPARATOR, ucfirst(basename(app()->path())) . '\\'],
+                replace: ['\\', app()->getNamespace()]
+            )
+            ->toString();
     }
 }
diff --git a/src/Generators/AbstractEnumGenerator.php b/src/Generators/AbstractEnumGenerator.php
@@ -5,6 +5,7 @@
 use Illuminate\Contracts\Filesystem\Filesystem;
 use Illuminate\Support\Collection;
 use Illuminate\Support\Facades\Storage;
+use SplFileInfo;
 use Symfony\Component\Filesystem\Filesystem as FileUtility;
 use Symfony\Component\Finder\Exception\DirectoryNotFoundException;
 use Symfony\Component\Finder\Finder;
@@ -16,7 +17,7 @@ class AbstractEnumGenerator
     public function __construct()
     {
         $this->files = Storage::createLocalDriver([
-            'root' => resource_path(config('paragon.enums.paths.generated')),
+            'root' => resource_path(config()->string('paragon.enums.paths.generated')),
         ]);
     }
 
@@ -34,7 +35,7 @@ protected function contents(): string
         $suffix = $imports->count() ? PHP_EOL : '';
 
         return str((string) file_get_contents($this->stubPath()))
-            ->replace('{{ Abstract }}', config('paragon.enums.abstract-class'))
+            ->replace('{{ Abstract }}', config()->string('paragon.enums.abstract-class'))
             ->replace('{{ Imports }}', "{$imports->join('')}{$suffix}")
             ->replace('{{ Methods }}', "{$this->methods($imports->keys())}{$suffix}");
     }
@@ -57,22 +58,26 @@ protected function imports(): Collection
         try {
             $files = Finder::create()
                 ->files()
-                ->in(resource_path(config('paragon.enums.paths.methods')));
+                ->in(resource_path(config()->string('paragon.enums.paths.methods')));
         } catch (DirectoryNotFoundException) {
             return collect();
         }
 
-        return collect($files)
-            ->mapWithKeys(function ($file) {
+        /** @var Collection<int, SplFileInfo> $fileCollection */
+        $fileCollection = collect($files);
+
+        return $fileCollection
+            ->mapWithKeys(function (SplFileInfo $file): array {
                 $filesystem = new FileUtility();
 
                 $relativeFilePath = $filesystem->makePathRelative(
                     $file->getPath(),
-                    resource_path(config('paragon.enums.paths.generated'))
+                    resource_path(config()->string('paragon.enums.paths.generated'))
                 );
 
                 $name = (string) str($file->getFileName())->before('.');
 
+                /** @var array<string,string> */
                 return [$name => "import {$name} from '{$relativeFilePath}{$file->getFilename()}';" . PHP_EOL];
             })
             ->sort();
@@ -85,7 +90,8 @@ protected function imports(): Collection
      */
     protected function methods(Collection $methods): string
     {
-        return $methods->map(fn ($method) => PHP_EOL . "Enum.{$method} = {$method};")
+        return $methods
+            ->map(fn (string $method): string => PHP_EOL . "Enum.{$method} = {$method};")
             ->join('');
     }