Enhancement: Synchronize with ergebnis/php-package-template

ergebnis · Jun 28, 2023 · d09aff5 · d09aff5
1 parent c9815dc
commit d09aff5
Show file tree

Hide file tree

Showing 21 changed files with 129 additions and 76 deletions.
diff --git a/.github/SECURITY.md b/.github/SECURITY.md
@@ -10,7 +10,7 @@ The following versions of `ergebnis/classy` have active support:
 
 The following versions of `ergebnis/classy` have reached their end of life:
 
-- `<=1.3.0`
+- `<1.4.0`
 
 ## Reporting a Vulnerability
 

diff --git a/.github/settings.yml b/.github/settings.yml
@@ -82,6 +82,7 @@ repository:
   has_pages: false
   has_projects: false
   has_wiki: false
+  is_template: false
   name: "classy"
   private: false
 

diff --git a/.github/workflows/integrate.yaml b/.github/workflows/integrate.yaml
@@ -263,7 +263,7 @@ jobs:
         uses: "shivammathur/setup-php@2.25.4"
         with:
           coverage: "none"
-          extensions: "none, ctype, curl, dom, intl, json, mbstring, phar, simplexml, tokenizer, xml, xmlwriter"
+          extensions: "none, ctype, curl, dom, json, mbstring, phar, simplexml, tokenizer, xml, xmlwriter"
           php-version: "${{ matrix.php-version }}"
 
       - name: "Set up problem matchers for PHP"
@@ -323,7 +323,7 @@ jobs:
         uses: "shivammathur/setup-php@2.25.4"
         with:
           coverage: "none"
-          extensions: "none, ctype, dom, json, mbstring, phar, simplexml, tokenizer, xml, xmlwriter"
+          extensions: "none, ctype, curl, dom, json, mbstring, phar, simplexml, tokenizer, xml, xmlwriter"
           php-version: "${{ matrix.php-version }}"
 
       - name: "Set up problem matchers for PHP"

diff --git a/.phive/phars.xml b/.phive/phars.xml
@@ -1,4 +1,4 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <phive xmlns="https://phar.io/phive">
-  <phar name="composer-require-checker" version="^4.4.0" installed="4.4.0" location="./.phive/composer-require-checker" copy="false"/>
+  <phar name="composer-require-checker" version="^4.6.0" installed="4.6.0" location="./.phive/composer-require-checker" copy="false"/>
 </phive>
diff --git a/.php-cs-fixer.php b/.php-cs-fixer.php
@@ -36,8 +36,7 @@
         'test/Fixture/',
     ])
     ->ignoreDotFiles(false)
-    ->in(__DIR__)
-    ->name('.php-cs-fixer.php');
+    ->in(__DIR__);
 
 $config->setCacheFile(__DIR__ . '/.build/php-cs-fixer/.php-cs-fixer.cache');
 

diff --git a/composer-require-checker.json b/composer-require-checker.json
@@ -1,5 +1,3 @@
 {
-  "symbol-whitelist": [
-    "T_ENUM"
-  ]
+  "symbol-whitelist": []
 }
diff --git a/composer.json b/composer.json
@@ -30,6 +30,7 @@
     "ergebnis/composer-normalize": "^2.31.0",
     "ergebnis/license": "^2.1.0",
     "ergebnis/php-cs-fixer-config": "^5.9.2",
+    "ergebnis/phpunit-slow-test-detector": "^2.3.0",
     "fakerphp/faker": "^1.23.0",
     "infection/infection": "~0.27.0",
     "phpunit/phpunit": "^10.2.2",

diff --git a/composer.lock b/composer.lock
diff --git a/psalm-baseline.xml b/psalm-baseline.xml
@@ -25,6 +25,13 @@
         }]]></code>
     </TooManyArguments>
   </file>
+  <file src="test/Unit/ConstructsTest.php">
+    <PossiblyUnusedMethod>
+      <code>provideScenarioWithClassyConstructsBeforePhp81</code>
+      <code>provideScenarioWithClassyConstructsOnPhp81</code>
+      <code>provideScenarioWithoutClassyConstructs</code>
+    </PossiblyUnusedMethod>
+  </file>
   <file src="test/Util/PhpVersion.php">
     <PossiblyUnusedMethod>
       <code>toInt</code>

diff --git a/rector.php b/rector.php
@@ -13,6 +13,7 @@
 
 use Rector\Config;
 use Rector\Core;
+use Rector\Php81;
 use Rector\PHPUnit;
 
 return static function (Config\RectorConfig $rectorConfig): void {
@@ -27,7 +28,11 @@
 
     $rectorConfig->phpVersion(Core\ValueObject\PhpVersion::PHP_81);
 
+    $rectorConfig->rules([
+        Php81\Rector\Property\ReadOnlyPropertyRector::class,
+    ]);
+
     $rectorConfig->sets([
-        PHPUnit\Set\PHPUnitSetList::PHPUNIT_91,
+        PHPUnit\Set\PHPUnitSetList::PHPUNIT_100,
     ]);
 };
diff --git a/src/Construct.php b/src/Construct.php
@@ -18,16 +18,13 @@
  */
 final class Construct
 {
-    private string $name;
-
     /**
      * @var array<int, string>
      */
     private array $fileNames = [];
 
-    private function __construct(string $name)
+    private function __construct(private readonly string $name)
     {
-        $this->name = $name;
     }
 
     /**

diff --git a/src/Constructs.php b/src/Constructs.php
@@ -194,8 +194,11 @@ public static function fromDirectory(string $directory): array
      *
      * @param array<int, array{0: int, 1: string, 2: int}|string> $sequence
      */
-    private static function significantAfter(int $index, array $sequence, int $count): int
-    {
+    private static function significantAfter(
+        int $index,
+        array $sequence,
+        int $count,
+    ): int {
         for ($current = $index + 1; $current < $count; ++$current) {
             $token = $sequence[$current];
 

diff --git a/test/Unit/ConstructTest.php b/test/Unit/ConstructTest.php
@@ -17,11 +17,7 @@
 use Ergebnis\Classy\Test;
 use PHPUnit\Framework;
 
-/**
- * @internal
- *
- * @covers \Ergebnis\Classy\Construct
- */
+#[Framework\Attributes\CoversClass(Construct::class)]
 final class ConstructTest extends Framework\TestCase
 {
     use Test\Util\Helper;

diff --git a/test/Unit/ConstructsTest.php b/test/Unit/ConstructsTest.php
@@ -19,16 +19,11 @@
 use Ergebnis\Classy\Test;
 use PHPUnit\Framework;
 
-/**
- * @internal
- *
- * @covers \Ergebnis\Classy\Constructs
- *
- * @uses \Ergebnis\Classy\Construct
- * @uses \Ergebnis\Classy\Exception\DirectoryDoesNotExist
- * @uses \Ergebnis\Classy\Exception\MultipleDefinitionsFound
- * @uses \Ergebnis\Classy\Exception\ParseError
- */
+#[Framework\Attributes\CoversClass(Constructs::class)]
+#[Framework\Attributes\UsesClass(Construct::class)]
+#[Framework\Attributes\UsesClass(Exception\DirectoryDoesNotExist::class)]
+#[Framework\Attributes\UsesClass(Exception\MultipleDefinitionsFound::class)]
+#[Framework\Attributes\UsesClass(Exception\ParseError::class)]
 final class ConstructsTest extends Framework\TestCase
 {
     private string $fileWithParseError = __DIR__ . '/../Fixture/ParseError/MessedUp.php';
@@ -52,9 +47,7 @@ public function testFromSourceThrowsParseErrorWhenParseErrorIsThrownDuringParsin
         Constructs::fromSource($source);
     }
 
-    /**
-     * @dataProvider provideScenarioWithoutClassyConstructs
-     */
+    #[Framework\Attributes\DataProvider('provideScenarioWithoutClassyConstructs')]
     public function testFromSourceReturnsEmptyArrayWhenNoClassyConstructsHaveBeenFound(Test\Util\Scenario $scenario): void
     {
         $constructs = Constructs::fromSource($scenario->source());
@@ -112,9 +105,7 @@ public static function provideScenarioWithoutClassyConstructs(): \Generator
         }
     }
 
-    /**
-     * @dataProvider provideScenarioWithClassyConstructsBeforePhp81
-     */
+    #[Framework\Attributes\DataProvider('provideScenarioWithClassyConstructsBeforePhp81')]
     public function testFromSourceReturnsArrayOfClassyConstructsWithoutFileNamesWhenClassyConstructsHaveBeenFoundBeforePhp81(Test\Util\Scenario $scenario): void
     {
         $constructs = Constructs::fromSource($scenario->source());
@@ -128,9 +119,8 @@ public function testFromSourceReturnsArrayOfClassyConstructsWithoutFileNamesWhen
 
     /**
      * @requires PHP 8.1
-     *
-     * @dataProvider provideScenarioWithClassyConstructsOnPhp81
      */
+    #[Framework\Attributes\DataProvider('provideScenarioWithClassyConstructsOnPhp81')]
     public function testFromSourceReturnsArrayOfClassyConstructsWithoutFileNamesWhenClassyConstructsHaveBeenFoundOnPhp81(Test\Util\Scenario $scenario): void
     {
         $constructs = Constructs::fromSource($scenario->source());
@@ -156,19 +146,15 @@ public function testFromDirectoryThrowsParseErrorIfParseErrorIsThrownDuringParsi
         Constructs::fromDirectory(__DIR__ . '/../Fixture/ParseError');
     }
 
-    /**
-     * @dataProvider provideScenarioWithoutClassyConstructs
-     */
+    #[Framework\Attributes\DataProvider('provideScenarioWithoutClassyConstructs')]
     public function testFromDirectoryReturnsEmptyArrayWhenNoClassyConstructsHaveBeenFound(Test\Util\Scenario $scenario): void
     {
         $constructs = Constructs::fromDirectory($scenario->directory());
 
         self::assertSame([], $constructs);
     }
 
-    /**
-     * @dataProvider provideScenarioWithClassyConstructsBeforePhp81
-     */
+    #[Framework\Attributes\DataProvider('provideScenarioWithClassyConstructsBeforePhp81')]
     public function testFromDirectoryReturnsArrayOfClassyConstructsSortedByNameWhenClassyConstructsHaveBeenFoundBeforePhp81(Test\Util\Scenario $scenario): void
     {
         $constructs = Constructs::fromDirectory($scenario->directory());
@@ -196,9 +182,8 @@ public static function provideScenarioWithClassyConstructsBeforePhp81(): \Genera
 
     /**
      * @requires PHP 8.1
-     *
-     * @dataProvider provideScenarioWithClassyConstructsOnPhp81
      */
+    #[Framework\Attributes\DataProvider('provideScenarioWithClassyConstructsOnPhp81')]
     public function testFromDirectoryReturnsArrayOfClassyConstructsSortedByNameWhenClassyConstructsHaveBeenFoundOnPhp81(Test\Util\Scenario $scenario): void
     {
         $constructs = Constructs::fromDirectory($scenario->directory());

diff --git a/test/Unit/Exception/DirectoryDoesNotExistTest.php b/test/Unit/Exception/DirectoryDoesNotExistTest.php
@@ -17,11 +17,7 @@
 use Ergebnis\Classy\Test;
 use PHPUnit\Framework;
 
-/**
- * @internal
- *
- * @covers \Ergebnis\Classy\Exception\DirectoryDoesNotExist
- */
+#[Framework\Attributes\CoversClass(Exception\DirectoryDoesNotExist::class)]
 final class DirectoryDoesNotExistTest extends Framework\TestCase
 {
     use Test\Util\Helper;

diff --git a/test/Unit/Exception/MultipleDefinitionsFoundTest.php b/test/Unit/Exception/MultipleDefinitionsFoundTest.php
@@ -18,13 +18,8 @@
 use Ergebnis\Classy\Test;
 use PHPUnit\Framework;
 
-/**
- * @internal
- *
- * @covers \Ergebnis\Classy\Exception\MultipleDefinitionsFound
- *
- * @uses \Ergebnis\Classy\Construct
- */
+#[Framework\Attributes\CoversClass(Exception\MultipleDefinitionsFound::class)]
+#[Framework\Attributes\UsesClass(Construct::class)]
 final class MultipleDefinitionsFoundTest extends Framework\TestCase
 {
     use Test\Util\Helper;

diff --git a/test/Unit/Exception/ParseErrorTest.php b/test/Unit/Exception/ParseErrorTest.php
@@ -17,11 +17,7 @@
 use Ergebnis\Classy\Test;
 use PHPUnit\Framework;
 
-/**
- * @internal
- *
- * @covers \Ergebnis\Classy\Exception\ParseError
- */
+#[Framework\Attributes\CoversClass(Exception\ParseError::class)]
 final class ParseErrorTest extends Framework\TestCase
 {
     use Test\Util\Helper;

diff --git a/test/Unit/Exception/ShouldNotHappenTest.php b/test/Unit/Exception/ShouldNotHappenTest.php
@@ -16,11 +16,7 @@
 use Ergebnis\Classy\Exception;
 use PHPUnit\Framework;
 
-/**
- * @internal
- *
- * @covers \Ergebnis\Classy\Exception\ShouldNotHappen
- */
+#[Framework\Attributes\CoversClass(Exception\ShouldNotHappen::class)]
 final class ShouldNotHappenTest extends Framework\TestCase
 {
     public function testCreateReturnsException(): void

diff --git a/test/Unit/phpunit.xml b/test/Unit/phpunit.xml
@@ -11,13 +11,23 @@
     cacheResult="true"
     colors="true"
     columns="max"
+    displayDetailsOnIncompleteTests="true"
+    displayDetailsOnSkippedTests="true"
+    displayDetailsOnTestsThatTriggerDeprecations="true"
+    displayDetailsOnTestsThatTriggerErrors="true"
+    displayDetailsOnTestsThatTriggerNotices="true"
+    displayDetailsOnTestsThatTriggerWarnings="true"
     executionOrder="random"
+    requireCoverageMetadata="true"
     stopOnError="false"
     stopOnFailure="false"
     stopOnIncomplete="false"
     stopOnSkipped="false"
 >
     <coverage includeUncoveredFiles="true"/>
+    <extensions>
+        <bootstrap class="Ergebnis\PHPUnit\SlowTestDetector\Extension"/>
+    </extensions>
     <source>
         <include>
             <directory suffix=".php">../../src/</directory>