feat: upgrade to core v4

Add `phpDocHeader` option.

BREAKING CHANGE: PHP 8.0 is no more supported.

.github/workflows/main.yml

@@ -13,7 +13,7 @@ jobs:
 
     strategy:
       matrix:
-        php: [ 8.0, 8.1, 8.2 ]
+        php: [ 8.1, 8.2 ]
         os: [ ubuntu-latest, windows-latest ]
 
     name: PHP${{ matrix.php }} - ${{ matrix.os }}

.gitignore

@@ -11,4 +11,5 @@
 # Cache and coverage.
 /\.coverage/
 /\.phpunit\.result\.cache
+/\.phpunit\.cache/
 \.scannerwork/

CHANGELOG.md

@@ -1,5 +1,15 @@
 # Change Log
 
+## 6.0.0
+
+**Added**
+
+- Add `phpHeaderDoc` option to generate a documentation block in generated file header.
+
+**Changed**
+
+- **BREAKING** Drop support for PHP 8.0.
+
 ## 5.0.0
 
 **Added**

composer.json

@@ -26,21 +26,21 @@
     "bin/phpunitgen"
   ],
   "require": {
-    "php": "~8.0.12 || ~8.1.0 || ~8.2.0",
+    "php": "~8.1.0 || ~8.2.0",
     "ext-json": "*",
     "league/container": "^3.3",
     "league/flysystem": "^3.0",
-    "phpunitgen/core": "^3.0",
-    "symfony/console": "^4.4 || ^5.0 || ^6.0",
-    "symfony/stopwatch": "^4.3 || ^5.0 || ^6.0",
-    "symfony/yaml": "^4.3 || ^5.0 || ^6.0",
+    "phpunitgen/core": "^4.0",
+    "symfony/console": "^4.4 || ^5.0 || ^6.0 || ^7.0",
+    "symfony/stopwatch": "^4.3 || ^5.0 || ^6.0 || ^7.0",
+    "symfony/yaml": "^4.3 || ^5.0 || ^6.0 || ^7.0",
     "tightenco/collect": "^8.0 || ^9.0"
   },
   "require-dev": {
     "laravel/framework": "^9.0",
     "mockery/mockery": "^1.3",
     "orchestra/testbench": "^7.0",
-    "phpunit/phpunit": "^9.1"
+    "phpunit/phpunit": "^9.0"
   },
   "autoload": {
     "psr-4": {

config/phpunitgen.json

@@ -27,6 +27,7 @@
     "version"
   ],
   "phpDoc": [],
+  "phpHeaderDoc": "",
   "options": {
     "context": "laravel"
   }

config/phpunitgen.php

@@ -171,6 +171,17 @@
      */
     'phpDoc'                   => [],
 
+    /*
+     |--------------------------------------------------------------------------
+     | PHP header documentation lines.
+     |
+     | The documentation header to append to generated files.
+     | Should be a full documentation content (with lines breaks, opening tags,
+     | etc.) or an empty string to disable printing a documentation header.
+     |--------------------------------------------------------------------------
+     */
+    'phpHeaderDoc'             => '',
+
     /*
      |--------------------------------------------------------------------------
      | Options.

config/phpunitgen.yml

@@ -22,5 +22,6 @@ mergedPhpDoc:
   - license
   - version
 phpDoc: []
+phpHeaderDoc:
 options:
   context: laravel

src/Config/ConsoleConfig.php

@@ -32,6 +32,7 @@ class ConsoleConfig extends Config implements ConsoleConfigContract
         'excludedMethods'          => self::TYPE_ARRAY,
         'mergedPhpDoc'             => self::TYPE_ARRAY,
         'phpDoc'                   => self::TYPE_ARRAY,
+        'phpHeaderDoc'             => self::TYPE_STRING,
         'options'                  => self::TYPE_ARRAY,
         'overwriteFiles'           => self::TYPE_BOOL,
         'excludedFiles'            => self::TYPE_ARRAY,

tests/Feature/CommandFinishedListenerTest.php

@@ -469,7 +469,7 @@ public function testItRunsWithClass(string $expectedPath, string $makeName): voi
         $this->assertSame(1, $this->commandFinishedListener->handle($event));
     }
 
-    public function runWithClassDataProvider(): array
+    public static function runWithClassDataProvider(): array
     {
         return [
             ['Broadcasting', 'channel'],

tests/Feature/CommandsTest.php

@@ -100,7 +100,7 @@ public function testItRunsWithExistingConfig(string $commandClass): void
         $this->assertStringContainsString('Memory usage:', $output);
     }
 
-    public function commandsDataProvider(): array
+    public static function commandsDataProvider(): array
     {
         return [
             [RunCommand::class],

tests/Feature/LaravelIntegrationTest.php

@@ -57,6 +57,14 @@ protected function deleteAffectedDirectories(): void
         }
     }
 
+    /**
+     * {@inheritdoc}
+     */
+    protected function defineEnvironment($app)
+    {
+        $app['env'] = 'local';
+    }
+
     /**
      * {@inheritdoc}
      */

tests/Unit/Config/ConsoleConfigTest.php

@@ -44,6 +44,7 @@ public function testWhenDefaultConfiguration(): void
                 'version',
             ],
             'phpDoc'                   => [],
+            'phpHeaderDoc'             => '',
             'options'                  => [
                 'context' => 'laravel',
             ],
@@ -73,6 +74,7 @@ public function testWhenCompleteConfiguration(): void
             'excludedMethods'          => [],
             'mergedPhpDoc'             => [],
             'phpDoc'                   => ['@author John Doe'],
+            'phpHeaderDoc'             => '/* Some header */',
             'options'                  => ['custom' => 'option'],
         ], ConsoleConfig::make([
             'overwriteFiles'           => true,
@@ -95,6 +97,7 @@ public function testWhenCompleteConfiguration(): void
             'excludedMethods'          => [],
             'mergedPhpDoc'             => [],
             'phpDoc'                   => ['@author John Doe'],
+            'phpHeaderDoc'             => '/* Some header */',
             'options'                  => ['custom' => 'option'],
         ])->toArray());
     }
@@ -122,6 +125,7 @@ public function testGetters(): void
             'excludedMethods'     => [],
             'mergedPhpDoc'        => [],
             'phpDoc'              => ['@author John Doe'],
+            'phpHeaderDoc'        => '/* Some header */',
             'options'             => ['custom' => 'option'],
         ]);
 
@@ -145,6 +149,7 @@ public function testGetters(): void
         $this->assertSame([], $config->excludedMethods());
         $this->assertSame([], $config->mergedPhpDoc());
         $this->assertSame(['@author John Doe'], $config->phpDoc());
+        $this->assertSame('/* Some header */', $config->phpHeaderDoc());
         $this->assertSame(['custom' => 'option'], $config->options());
         $this->assertSame('option', $config->getOption('custom'));
         $this->assertSame(null, $config->getOption('unknown'));

tests/Unit/Files/TargetResolverTest.php

@@ -65,7 +65,7 @@ public function testItResolvesTargetPath(
         $this->assertSame($expected, $this->targetResolver->resolve($classFactory, $sourcePath, $targetPath));
     }
 
-    public function targetResolverDataProvider(): array
+    public static function targetResolverDataProvider(): array
     {
         return [
             ['tests/Models/PostTest.php', '', 'john/app/Models/Post.php', 'tests'],