Bump dev tools and CI workflows (#89)

derrabus · web-flow · commit 16d01f999916 · 2022-03-02T22:43:16.000+01:00
diff --git a/.github/workflows/coding-standards.yml b/.github/workflows/coding-standards.yml
@@ -12,6 +12,7 @@ on:
 jobs:
   coding-standards:
     name: "Coding Standards"
-    uses: "doctrine/.github/.github/workflows/coding-standards.yml@1.2.0"
+    uses: "doctrine/.github/.github/workflows/coding-standards.yml@1.4.1"
     with:
       composer-root-version: "1.4"
+      php-version: "8.1"
diff --git a/.github/workflows/continuous-integration.yml b/.github/workflows/continuous-integration.yml
@@ -12,7 +12,7 @@ on:
 jobs:
   phpunit:
     name: "PHPUnit"
-    uses: "doctrine/.github/.github/workflows/continuous-integration.yml@1.2.0"
+    uses: "doctrine/.github/.github/workflows/continuous-integration.yml@1.4.1"
     with:
-      php-versions: '["7.1", "7.2", "7.3", "7.4", "8.0"]'
+      php-versions: '["7.1", "7.2", "7.3", "7.4", "8.0", "8.1"]'
       composer-root-version: "1.4"
diff --git a/.github/workflows/phpbench.yml b/.github/workflows/phpbench.yml
@@ -21,7 +21,7 @@ jobs:
     strategy:
       matrix:
         php-version:
-          - "7.4"
+          - "8.1"
 
     steps:
       - name: "Checkout"
diff --git a/.github/workflows/release-on-milestone-closed.yml b/.github/workflows/release-on-milestone-closed.yml
@@ -8,9 +8,8 @@ on:
 jobs:
   release:
     name: "Git tag, release & create merge-up PR"
-    uses: "doctrine/.github/.github/workflows/release-on-milestone-closed.yml@1.2.0"
+    uses: "doctrine/.github/.github/workflows/release-on-milestone-closed.yml@1.4.1"
     secrets:
-      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       GIT_AUTHOR_EMAIL: ${{ secrets.GIT_AUTHOR_EMAIL }}
       GIT_AUTHOR_NAME: ${{ secrets.GIT_AUTHOR_NAME }}
       ORGANIZATION_ADMIN_TOKEN: ${{ secrets.ORGANIZATION_ADMIN_TOKEN }}
diff --git a/.github/workflows/static-analysis.yml b/.github/workflows/static-analysis.yml
@@ -12,7 +12,7 @@ on:
 jobs:
   static-analysis:
     name: "Static Analysis"
-    uses: "doctrine/.github/.github/workflows/static-analysis.yml@1.2.0"
+    uses: "doctrine/.github/.github/workflows/static-analysis.yml@1.4.1"
     with:
       composer-root-version: "1.4"
-      php-version: "7.4"
+      php-version: "8.1"
diff --git a/composer.json b/composer.json
@@ -21,12 +21,12 @@
     "require-dev": {
         "ext-phar":                  "*",
         "ext-pdo":                   "*",
-        "doctrine/coding-standard":  "^8.0",
-        "phpbench/phpbench":         "^0.13 || 1.0.0-alpha2",
-        "phpstan/phpstan":           "^0.12",
-        "phpstan/phpstan-phpunit":   "^0.12",
-        "phpunit/phpunit":           "^7.0 || ^8.0 || ^9.0",
-        "vimeo/psalm": "^4.11"
+        "doctrine/coding-standard":  "^9",
+        "phpbench/phpbench":         "^0.16 || ^1",
+        "phpstan/phpstan":           "^1.4",
+        "phpstan/phpstan-phpunit":   "^1",
+        "phpunit/phpunit":           "^7.5 || ^8.5 || ^9.5",
+        "vimeo/psalm": "^4.22"
     },
     "autoload": {
         "psr-4": {
@@ -39,5 +39,10 @@
             "DoctrineTest\\InstantiatorTest\\": "tests",
             "DoctrineTest\\InstantiatorTestAsset\\": "tests"
         }
+    },
+    "config": {
+        "allow-plugins": {
+            "dealerdirect/phpcodesniffer-composer-installer": true
+        }
     }
 }
diff --git a/phpbench.json b/phpbench.json
@@ -1,4 +1,4 @@
 {
-    "bootstrap": "vendor/autoload.php",
-    "path": "tests/DoctrineTest/InstantiatorPerformance"
+    "runner.bootstrap": "vendor/autoload.php",
+    "runner.path": "tests/DoctrineTest/InstantiatorPerformance"
 }
diff --git a/phpcs.xml.dist b/phpcs.xml.dist
@@ -9,6 +9,8 @@
     <!-- Ignore warnings, show progress of the run and show sniff names -->
     <arg value="nps"/>
 
+    <config name="php_version" value="70100"/>
+
     <file>src</file>
     <file>tests</file>
 
@@ -27,7 +29,9 @@
     </rule>
 
     <rule ref="SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint">
-        <exclude-pattern>*/src/*</exclude-pattern>
+        <exclude-pattern>src/*</exclude-pattern>
+        <exclude-pattern>tests/DoctrineTest/InstantiatorTestAsset/SerializableArrayObjectAsset.php</exclude-pattern>
+        <exclude-pattern>tests/DoctrineTest/InstantiatorTestAsset/SimpleSerializableAsset.php</exclude-pattern>
     </rule>
 
     <rule ref="SlevomatCodingStandard.TypeHints.ReturnTypeHint.MissingNativeTypeHint">
diff --git a/phpstan.neon.dist b/phpstan.neon.dist
@@ -4,12 +4,18 @@ includes:
 
 parameters:
     level: max
+    phpVersion: 80103
     paths:
         - src
         - tests
 
     ignoreErrors:
+        # PHPStan is unable to infer the return type of unserialize() in this case.
+        -
+            message: '#Method Doctrine\\Instantiator\\Instantiator\:\:buildFactory\(\) should return callable\(\): T of object but returns Closure\(\): mixed\.#'
+            path: 'src/Doctrine/Instantiator/Instantiator.php'
+
         # dynamic properties confuse static analysis
         -
             message: '#Access to an undefined property object::\$foo\.#'
-            path: '*/tests/DoctrineTest/InstantiatorTest/InstantiatorTest.php'
+            path: 'tests/DoctrineTest/InstantiatorTest/InstantiatorTest.php'
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -1,15 +1,21 @@
 <?xml version="1.0"?>
-<phpunit
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd"
     bootstrap="./vendor/autoload.php"
     colors="true"
     convertErrorsToExceptions="true"
     convertNoticesToExceptions="true"
     convertWarningsToExceptions="true"
+    convertDeprecationsToExceptions="true"
     verbose="true"
     stopOnFailure="false"
     processIsolation="false"
     backupGlobals="false"
 >
+    <php>
+        <ini name="error_reporting" value="-1" />
+    </php>
+
     <testsuite name="Doctrine\Instantiator tests">
         <directory>./tests/DoctrineTest/InstantiatorTest</directory>
     </testsuite>
diff --git a/psalm.xml b/psalm.xml
@@ -1,6 +1,7 @@
 <?xml version="1.0"?>
 <psalm
     errorLevel="7"
+    phpVersion="8.1"
     resolveFromConfigFile="true"
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xmlns="https://getpsalm.org/schema/config"
diff --git a/src/Doctrine/Instantiator/Exception/InvalidArgumentException.php b/src/Doctrine/Instantiator/Exception/InvalidArgumentException.php
@@ -28,8 +28,9 @@ public static function fromNonExistingClass(string $className): self
     }
 
     /**
-     * @template T of object
      * @phpstan-param ReflectionClass<T> $reflectionClass
+     *
+     * @template T of object
      */
     public static function fromAbstractClass(ReflectionClass $reflectionClass): self
     {
diff --git a/src/Doctrine/Instantiator/Exception/UnexpectedValueException.php b/src/Doctrine/Instantiator/Exception/UnexpectedValueException.php
@@ -14,8 +14,9 @@
 class UnexpectedValueException extends BaseUnexpectedValueException implements ExceptionInterface
 {
     /**
-     * @template T of object
      * @phpstan-param ReflectionClass<T> $reflectionClass
+     *
+     * @template T of object
      */
     public static function fromSerializationTriggeredException(
         ReflectionClass $reflectionClass,
@@ -32,8 +33,9 @@ public static function fromSerializationTriggeredException(
     }
 
     /**
-     * @template T of object
      * @phpstan-param ReflectionClass<T> $reflectionClass
+     *
+     * @template T of object
      */
     public static function fromUncleanUnSerialization(
         ReflectionClass $reflectionClass,
diff --git a/src/Doctrine/Instantiator/Instantiator.php b/src/Doctrine/Instantiator/Instantiator.php
@@ -45,15 +45,14 @@ final class Instantiator implements InstantiatorInterface
 
     /**
      * @param string $className
+     * @phpstan-param class-string<T> $className
      *
      * @return object
+     * @phpstan-return T
      *
      * @throws ExceptionInterface
      *
      * @template T of object
-     * @phpstan-param class-string<T> $className
-     *
-     * @phpstan-return T
      */
     public function instantiate($className)
     {
@@ -78,12 +77,12 @@ public function instantiate($className)
     /**
      * Builds the requested object and caches it in static properties for performance
      *
-     * @return object
-     *
-     * @template T of object
      * @phpstan-param class-string<T> $className
      *
+     * @return object
      * @phpstan-return T
+     *
+     * @template T of object
      */
     private function buildAndCacheFromFactory(string $className)
     {
@@ -101,14 +100,15 @@ private function buildAndCacheFromFactory(string $className)
      * Builds a callable capable of instantiating the given $className without
      * invoking its constructor.
      *
+     * @phpstan-param class-string<T> $className
+     *
+     * @phpstan-return callable(): T
+     *
      * @throws InvalidArgumentException
      * @throws UnexpectedValueException
      * @throws ReflectionException
      *
      * @template T of object
-     * @phpstan-param class-string<T> $className
-     *
-     * @phpstan-return callable(): T
      */
     private function buildFactory(string $className): callable
     {
@@ -133,13 +133,14 @@ private function buildFactory(string $className): callable
     }
 
     /**
+     * @phpstan-param class-string<T> $className
+     *
+     * @phpstan-return ReflectionClass<T>
+     *
      * @throws InvalidArgumentException
      * @throws ReflectionException
      *
      * @template T of object
-     * @phpstan-param class-string<T> $className
-     *
-     * @phpstan-return ReflectionClass<T>
      */
     private function getReflectionClass(string $className): ReflectionClass
     {
@@ -157,10 +158,11 @@ private function getReflectionClass(string $className): ReflectionClass
     }
 
     /**
+     * @phpstan-param ReflectionClass<T> $reflectionClass
+     *
      * @throws UnexpectedValueException
      *
      * @template T of object
-     * @phpstan-param ReflectionClass<T> $reflectionClass
      */
     private function checkIfUnSerializationIsSupported(ReflectionClass $reflectionClass, string $serializedString): void
     {
@@ -188,10 +190,11 @@ private function checkIfUnSerializationIsSupported(ReflectionClass $reflectionCl
     }
 
     /**
+     * @phpstan-param ReflectionClass<T> $reflectionClass
+     *
      * @throws UnexpectedValueException
      *
      * @template T of object
-     * @phpstan-param ReflectionClass<T> $reflectionClass
      */
     private function attemptInstantiationViaUnSerialization(ReflectionClass $reflectionClass, string $serializedString): void
     {
@@ -203,8 +206,9 @@ private function attemptInstantiationViaUnSerialization(ReflectionClass $reflect
     }
 
     /**
-     * @template T of object
      * @phpstan-param ReflectionClass<T> $reflectionClass
+     *
+     * @template T of object
      */
     private function isInstantiableViaReflection(ReflectionClass $reflectionClass): bool
     {
@@ -214,8 +218,9 @@ private function isInstantiableViaReflection(ReflectionClass $reflectionClass):
     /**
      * Verifies whether the given class is to be considered internal
      *
-     * @template T of object
      * @phpstan-param ReflectionClass<T> $reflectionClass
+     *
+     * @template T of object
      */
     private function hasInternalAncestors(ReflectionClass $reflectionClass): bool
     {
@@ -235,8 +240,9 @@ private function hasInternalAncestors(ReflectionClass $reflectionClass): bool
      *
      * Classes implementing `__clone` cannot be safely cloned, as that may cause side-effects.
      *
-     * @template T of object
      * @phpstan-param ReflectionClass<T> $reflectionClass
+     *
+     * @template T of object
      */
     private function isSafeToClone(ReflectionClass $reflectionClass): bool
     {
diff --git a/src/Doctrine/Instantiator/InstantiatorInterface.php b/src/Doctrine/Instantiator/InstantiatorInterface.php
@@ -11,15 +11,14 @@ interface InstantiatorInterface
 {
     /**
      * @param string $className
+     * @phpstan-param class-string<T> $className
      *
      * @return object
+     * @phpstan-return T
      *
      * @throws ExceptionInterface
      *
      * @template T of object
-     * @phpstan-param class-string<T> $className
-     *
-     * @phpstan-return T
      */
     public function instantiate($className);
 }
diff --git a/tests/DoctrineTest/InstantiatorPerformance/InstantiatorPerformanceBench.php b/tests/DoctrineTest/InstantiatorPerformance/InstantiatorPerformanceBench.php
@@ -15,7 +15,7 @@
  *
  * @BeforeMethods({"init"})
  */
-class InstantiatorPerformanceEvent
+class InstantiatorPerformanceBench
 {
     /** @var Instantiator */
     private $instantiator;
diff --git a/tests/DoctrineTest/InstantiatorTest/InstantiatorTest.php b/tests/DoctrineTest/InstantiatorTest/InstantiatorTest.php
@@ -47,17 +47,19 @@ protected function setUp(): void
     }
 
     /**
-     * @dataProvider getInstantiableClasses
      * @phpstan-param class-string $className
+     *
+     * @dataProvider getInstantiableClasses
      */
     public function testCanInstantiate(string $className): void
     {
         self::assertInstanceOf($className, $this->instantiator->instantiate($className));
     }
 
     /**
-     * @dataProvider getInstantiableClasses
      * @phpstan-param class-string $className
+     *
+     * @dataProvider getInstantiableClasses
      */
     public function testInstantiatesSeparateInstances(string $className): void
     {
@@ -76,8 +78,9 @@ public function testExceptionOnUnSerializationException(): void
     }
 
     /**
-     * @dataProvider getInvalidClassNames
      * @phpstan-param class-string $invalidClassName
+     *
+     * @dataProvider getInvalidClassNames
      */
     public function testInstantiationFromNonExistingClass(string $invalidClassName): void
     {
@@ -110,7 +113,6 @@ public function testInstancesAreNotCloned(): void
      * Provides a list of instantiable classes (existing)
      *
      * @return string[][]
-     *
      * @phpstan-return list<array{class-string}>
      */
     public function getInstantiableClasses(): array
diff --git a/tests/DoctrineTest/InstantiatorTestAsset/SerializableArrayObjectAsset.php b/tests/DoctrineTest/InstantiatorTestAsset/SerializableArrayObjectAsset.php
diff --git a/tests/DoctrineTest/InstantiatorTestAsset/SimpleSerializableAsset.php b/tests/DoctrineTest/InstantiatorTestAsset/SimpleSerializableAsset.php

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`	`1`	`{`
`2`		`- "bootstrap": "vendor/autoload.php",`
`3`		`- "path": "tests/DoctrineTest/InstantiatorPerformance"`
	`2`	`+ "runner.bootstrap": "vendor/autoload.php",`
	`3`	`+ "runner.path": "tests/DoctrineTest/InstantiatorPerformance"`
`4`	`4`	`}`