Merge branch 'wildcards' into 3.x

Author: calebdw

docs/custom-config-parameters.md

@@ -11,23 +11,26 @@ These parameters are related to the `NoUnnecessaryCollectionCall` rule. You can
 By default, the default Laravel database migration path (`database/migrations`) is used to scan migration files to understand the table structure and model properties. If you have database migrations in other place than the default, you can use this config parameter to tell Larastan where the database migrations are stored.
 
 You can give absolute paths, or paths relative to the PHPStan config file.
+Paths with wildcards are also supported (passed to `glob` function).
 
 #### Example
+
 ```neon
 parameters:
     databaseMigrationsPath:
-        - app/Domain/DomainA/migrations
-        - app/Domain/DomainB/migrations
+        - app/Domain/*/migrations
 ```
 
 **Note:** If your migrations are using `if` statements to conditionally alter database structure (ex: create table only if it's not there, add column only if table exists and column does not etc...) Larastan will assume those if statements evaluate to true and will consider everything from the `if` body.
 
 ## `disableMigrationScan`
+
 **default**: `false`
 
 You can disable use this config to disable migration scanning.
 
 #### Example
+
 ```neon
 parameters:
     disableMigrationScan: true
@@ -37,12 +40,14 @@ parameters:
 
 By default, Larastan will check `database/schema` directory to find schema dumps. If you have them in other locations or if you have multiple folders, you can use this config option to add them.
 
+Paths with wildcards are also supported (passed to `glob` function).
+
 #### Example
+
 ```neon
 parameters:
     squashedMigrationsPath:
-        - app/Domain/DomainA/schema
-        - app/Domain/DomainB/schema
+        - app/Domain/*/schema
 ```
 
 #### PostgreSQL
@@ -51,21 +56,25 @@ The package used to parse the schema dumps, [phpmyadmin/sql-parser](https://gith
 It can read (or rather, try to read) PostgreSQL dumps provided they are in the *plain text (and not the 'custom') format*, but the mileage may vary as problems have been noted with timestamp columns and lengthy parse time on more complicated dumps.
 
 The viable options for PostgreSQL at the moment are:
-1. Use the [laravel-ide-helper](https://github.com/barryvdh/laravel-ide-helper) package to write PHPDocs directly to the Models. 
+
+1. Use the [laravel-ide-helper](https://github.com/barryvdh/laravel-ide-helper) package to write PHPDocs directly to the Models.
 2. Use the [laravel-migrations-generator](https://github.com/kitloong/laravel-migrations-generator) to generate migration files (or a singular squashed migration file) for Larastan to scan with the `databaseMigrationsPath` setting.
 
 ## `disableSchemaScan`
+
 **default**: `false`
 
 You can disable use this config to disable schema scanning.
 
 #### Example
+
 ```neon
 parameters:
     disableSchemaScan: true
 ```
 
 ## `checkModelProperties`
+
 **default**: `false`
 
 This config parameter enables the checks for model properties that are passed to methods. You can read the details [here](rules.md#modelpropertyrule).
@@ -78,6 +87,7 @@ parameters:
 ```
 
 ## `checkModelAppends`
+
 **default**: `false`
 
 This config parameter enables the checks the model's $appends property for computed properties. You can read the details [here](rules.md#modelappendsrule).

extension.neon

@@ -564,6 +564,9 @@ services:
     -
         class: Larastan\Larastan\Internal\ConsoleApplicationHelper
 
+    -
+        class: Larastan\Larastan\Internal\FileHelper
+
     -
         class: Larastan\Larastan\Support\HigherOrderCollectionProxyHelper
 

src/Internal/FileHelper.php

@@ -0,0 +1,80 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Larastan\Larastan\Internal;
+
+use PHPStan\File\FileHelper as PHPStanFileHelper;
+use RecursiveDirectoryIterator;
+use RecursiveIteratorIterator;
+use RegexIterator;
+use SplFileInfo;
+
+use function array_reduce;
+use function glob;
+use function is_dir;
+use function is_string;
+use function iterator_to_array;
+use function preg_match;
+
+use const GLOB_ONLYDIR;
+
+/** @internal */
+final class FileHelper
+{
+    public function __construct(
+        private PHPStanFileHelper $fileHelper,
+    ) {
+    }
+
+    /**
+     * @param  array<array-key, string> $directories
+     *
+     * @return array<string, SplFileInfo>
+     */
+    public function getFiles(array $directories, string|null $filter = null): array
+    {
+        return array_reduce(
+            $directories,
+            function (array $carry, string $path) use ($filter): array {
+                $absolutePath = $this->fileHelper->absolutizePath($path);
+
+                if ($this->isGlobPattern($absolutePath)) {
+                    $glob = glob($absolutePath, GLOB_ONLYDIR);
+
+                    if ($glob === false) {
+                        return $carry;
+                    }
+
+                    $directories = $glob;
+                } else {
+                    if (! is_dir($absolutePath)) {
+                        return $carry;
+                    }
+
+                    $directories = [$absolutePath];
+                }
+
+                foreach ($directories as $directory) {
+                    $iterator = new RecursiveIteratorIterator(
+                        new RecursiveDirectoryIterator($directory),
+                    );
+
+                    if (is_string($filter)) {
+                        $iterator = new RegexIterator($iterator, $filter);
+                    }
+
+                    $carry += iterator_to_array($iterator);
+                }
+
+                return $carry;
+            },
+            [],
+        );
+    }
+
+    private function isGlobPattern(string $path): bool
+    {
+        return preg_match('~[*?[\]]~', $path) > 0;
+    }
+}

src/Properties/MigrationHelper.php

@@ -4,18 +4,13 @@
 
 namespace Larastan\Larastan\Properties;
 
-use PHPStan\File\FileHelper;
+use Larastan\Larastan\Internal\FileHelper;
 use PHPStan\Parser\Parser;
 use PHPStan\Parser\ParserErrorsException;
-use RecursiveDirectoryIterator;
-use RecursiveIteratorIterator;
-use RegexIterator;
 use SplFileInfo;
 
 use function count;
 use function database_path;
-use function is_dir;
-use function iterator_to_array;
 use function uasort;
 
 class MigrationHelper
@@ -40,7 +35,7 @@ public function parseMigrations(ModelDatabaseHelper &$modelDatabaseHelper): void
         }
 
         $schemaAggregator = new SchemaAggregator($modelDatabaseHelper);
-        $filesArray       = $this->getMigrationFiles();
+        $filesArray       = $this->fileHelper->getFiles($this->databaseMigrationPath, '/\.php$/i');
 
         if (empty($filesArray)) {
             return;
@@ -58,28 +53,4 @@ public function parseMigrations(ModelDatabaseHelper &$modelDatabaseHelper): void
             }
         }
     }
-
-    /** @return SplFileInfo[] */
-    private function getMigrationFiles(): array
-    {
-        /** @var SplFileInfo[] $migrationFiles */
-        $migrationFiles = [];
-
-        foreach ($this->databaseMigrationPath as $additionalPath) {
-            $absolutePath = $this->fileHelper->absolutizePath($additionalPath);
-
-            if (! is_dir($absolutePath)) {
-                continue;
-            }
-
-            $migrationFiles += iterator_to_array(
-                new RegexIterator(
-                    new RecursiveIteratorIterator(new RecursiveDirectoryIterator($absolutePath)),
-                    '/\.php$/i',
-                ),
-            );
-        }
-
-        return $migrationFiles;
-    }
 }

src/Properties/SquashedMigrationHelper.php

@@ -4,26 +4,20 @@
 
 namespace Larastan\Larastan\Properties;
 
+use Larastan\Larastan\Internal\FileHelper;
 use Larastan\Larastan\Properties\Schema\PhpMyAdminDataTypeToPhpTypeConverter;
 use PhpMyAdmin\SqlParser\Components\CreateDefinition;
 use PhpMyAdmin\SqlParser\Exceptions\ParserException;
 use PhpMyAdmin\SqlParser\Parser;
 use PhpMyAdmin\SqlParser\Statement;
 use PhpMyAdmin\SqlParser\Statements\CreateStatement;
-use PHPStan\File\FileHelper;
-use RecursiveDirectoryIterator;
-use RecursiveIteratorIterator;
-use RegexIterator;
-use SplFileInfo;
 
 use function array_filter;
 use function array_key_exists;
 use function database_path;
 use function explode;
 use function file_get_contents;
 use function is_array;
-use function is_dir;
-use function iterator_to_array;
 use function ksort;
 
 final class SquashedMigrationHelper
@@ -47,7 +41,7 @@ public function parseSchemaDumps(ModelDatabaseHelper &$modelDatabaseHelper): voi
             $this->schemaPaths = [database_path('schema')];
         }
 
-        $filesArray = $this->getSchemaFiles();
+        $filesArray = $this->fileHelper->getFiles($this->schemaPaths, '/\.dump|\.sql/i');
 
         if (empty($filesArray)) {
             return;
@@ -105,30 +99,6 @@ public function parseSchemaDumps(ModelDatabaseHelper &$modelDatabaseHelper): voi
         }
     }
 
-    /** @return SplFileInfo[] */
-    private function getSchemaFiles(): array
-    {
-        /** @var SplFileInfo[] $schemaFiles */
-        $schemaFiles = [];
-
-        foreach ($this->schemaPaths as $additionalPath) {
-            $absolutePath = $this->fileHelper->absolutizePath($additionalPath);
-
-            if (! is_dir($absolutePath)) {
-                continue;
-            }
-
-            $schemaFiles += iterator_to_array(
-                new RegexIterator(
-                    new RecursiveIteratorIterator(new RecursiveDirectoryIterator($absolutePath)),
-                    '/\.dump|\.sql/i',
-                ),
-            );
-        }
-
-        return $schemaFiles;
-    }
-
     private function isNullable(CreateDefinition $definition): bool
     {
         return ! $definition->options?->has('NOT NULL');