Switch to PHPStan 2.0 | Merge pull request #11 from ebln/phpstan2

### Addded
- Support for PHPStan 2
### Removed
- Dropped support for PHPStan < 2

c.f. #10

Author: ebln

CHANGELOG.md

@@ -17,9 +17,17 @@ Intended to follow [«Keep a Changelog»](https://keepachangelog.com/en/)
 		}
 	}
 	```
+ - consider updating [getClassNames](https://github.com/phpstan/phpstan-src/blob/e6d9f0c3ec251ea6fad604d3f97e02bedb4d7f42/src/Rules/Classes/InstantiationRule.php#L235)
 
 ----
 
+## [2.0.0]
+
+### Addded
+- Support for PHPStan 2
+### Removed
+- Dropped support for PHPStan < 2
+
 ## [1.0.1]
 
 ### Fixed

composer.json

@@ -12,7 +12,7 @@
     "require": {
         "php": "7.4 - 8.4",
         "ebln/phpstan-factory-mark": "^1.1",
-        "phpstan/phpstan": "^1.11"
+        "phpstan/phpstan": "^2.0"
     },
     "require-dev": {
         "ergebnis/composer-normalize": "^2.15",

composer.lock

@@ -1,13 +1,37 @@
 parameters:
 	ignoreErrors:
 		-
-			message: "#^Call to an undefined method ReflectionClass\\:\\:getAttributes\\(\\)\\.$#"
+			message: '#^Argument of an invalid type mixed supplied for foreach, only iterables are supported\.$#'
+			identifier: foreach.nonIterable
+			count: 1
 			path: src/ForceFactoryRule.php
 
 		-
-			message: "#^Method Ebln\\\\PHPStan\\\\EnforceFactory\\\\ForceFactoryRule\\:\\:getFactoriesFromAttributeByClass\\(\\) has parameter \\$reflection with generic class ReflectionClass but does not specify its types\\: T$#"
+			message: '#^Call to an undefined method ReflectionClass\:\:getAttributes\(\)\.$#'
+			identifier: method.notFound
+			count: 1
 			path: src/ForceFactoryRule.php
 
 		-
-			message: "#^PHPDoc tag @param for parameter \\$reflection with type PHPStan\\\\BetterReflection\\\\Reflection\\\\Adapter\\\\ReflectionClass\\|PHPStan\\\\BetterReflection\\\\Reflection\\\\Adapter\\\\ReflectionEnum is not subtype of native type ReflectionClass\\.$#"
+			message: '#^Cannot call method getName\(\) on mixed\.$#'
+			identifier: method.nonObject
+			count: 1
+			path: src/ForceFactoryRule.php
+
+		-
+			message: '#^Cannot call method newInstance\(\) on mixed\.$#'
+			identifier: method.nonObject
+			count: 1
+			path: src/ForceFactoryRule.php
+
+		-
+			message: '#^Method Ebln\\PHPStan\\EnforceFactory\\ForceFactoryRule\:\:getFactoriesFromAttributeByClass\(\) has parameter \$reflection with generic class ReflectionClass but does not specify its types\: T$#'
+			identifier: missingType.generics
+			count: 1
+			path: src/ForceFactoryRule.php
+
+		-
+			message: '#^PHPDoc tag @param for parameter \$reflection with type PHPStan\\BetterReflection\\Reflection\\Adapter\\ReflectionClass\|PHPStan\\BetterReflection\\Reflection\\Adapter\\ReflectionEnum is not subtype of native type ReflectionClass\.$#'
+			identifier: parameter.phpDocType
+			count: 1
 			path: src/ForceFactoryRule.php

phpstan-baseline-7.4.neon

@@ -44,23 +44,28 @@ public function processNode(Node $node, Scope $scope): array
             if ([] === $allowedFactories) {
                 $errors[] = RuleErrorBuilder::message(
                     ltrim($class, '\\') . ' has either no factories defined or a conflict between interface and attribute!'
-                )->build();
+                )->identifier('ebln.forceFactory.bogusDefinition')
+                    ->build()
+                ;
 
                 continue; // bogus configuration
             }
 
             /** @psalm-suppress PossiblyNullReference | sad that even phpstan cannot infer that from isInClass */
             if (
                 $scope->isInClass()
-                && null !== $scope->getClassReflection()
+                && null !== $scope->getClassReflection() /** @phpstan-ignore notIdentical.alwaysTrue */
                 && in_array($scope->getClassReflection()->getName(), $allowedFactories, true)
             ) {
                 continue; // happy case: ForceFactoryInterface got created within an allowed class
             }
 
             $errors[] = RuleErrorBuilder::message(
                 ltrim($class, '\\') . ' must be instantiated by ' . implode(' or ', $allowedFactories) . '!'
-            )->build();
+            )->identifier('ebln.forceFactory.outOfFactoryInstanciation')
+                ->tip('Only use ' . implode(' or ', $allowedFactories) . ' to create an instance of ' . ltrim($class, '\\') . '!')
+                ->build()
+            ;
         }
 
         return $errors;
@@ -76,6 +81,7 @@ public function processNode(Node $node, Scope $scope): array
     private function getAllowedFactories(string $className): ?array
     {
         $allowedFactories = $this->getFactoriesFromAttribute($className);
+        /** @phpstan-ignore-next-line phpstanApi.runtimeReflection (seems okay for now) */
         if (is_a($className, ForceFactoryInterface::class, true)) {
             /* phpstan-var class-string<ForceFactoryInterface> $className */
             $interfaceFactories = $className::getFactories();
@@ -93,7 +99,7 @@ private function getAllowedFactories(string $className): ?array
     /**
      * @phpstan-param class-string $className
      *
-     * @return array<class-string>
+     * @return null|array<class-string>
      */
     private function getFactoriesFromAttribute(string $className): ?array
     {

src/ForceFactoryRule.php

@@ -14,7 +14,7 @@
  */
 class AttribForceFactoryRuleTest extends RuleTestCase
 {
-    private const ERROR_MESSAGE = 'Test\Ebln\PHPStan\EnforceFactory\dataAttrib\code\ForcedFactoryProduct must be instantiated by Test\Ebln\PHPStan\EnforceFactory\dataAttrib\ForcedFactory or Test\Ebln\PHPStan\EnforceFactory\dataAttrib\TraitFactory!';
+    private const ERROR_MESSAGE = 'Test\Ebln\PHPStan\EnforceFactory\dataAttrib\code\ForcedFactoryProduct must be instantiated by Test\Ebln\PHPStan\EnforceFactory\dataAttrib\ForcedFactory or Test\Ebln\PHPStan\EnforceFactory\dataAttrib\TraitFactory!' . "\n    💡 Only use Test\Ebln\PHPStan\EnforceFactory\dataAttrib\ForcedFactory or Test\Ebln\PHPStan\EnforceFactory\dataAttrib\TraitFactory to create an instance of Test\Ebln\PHPStan\EnforceFactory\dataAttrib\code\ForcedFactoryProduct!";
 
     // Sadly this remains a vector, as phpstan fails to infer the created class name
     public function testLoopholeFactory(): void
@@ -49,9 +49,9 @@ public function testRogueFactory(): void
             [self::ERROR_MESSAGE, 40 + $offset],
             [self::ERROR_MESSAGE, 51 + $offset],
             [self::ERROR_MESSAGE, 56 + $offset],
-            ['Test\Ebln\PHPStan\EnforceFactory\dataAttrib\code\ExtendedProduct must be instantiated by Test\Ebln\PHPStan\EnforceFactory\dataAttrib\ForcedFactory or Test\Ebln\PHPStan\EnforceFactory\dataAttrib\TraitFactory!', 69 + $offset],
+            ['Test\Ebln\PHPStan\EnforceFactory\dataAttrib\code\ExtendedProduct must be instantiated by Test\Ebln\PHPStan\EnforceFactory\dataAttrib\ForcedFactory or Test\Ebln\PHPStan\EnforceFactory\dataAttrib\TraitFactory!' . "\n    💡 Only use Test\Ebln\PHPStan\EnforceFactory\dataAttrib\ForcedFactory or Test\Ebln\PHPStan\EnforceFactory\dataAttrib\TraitFactory to create an instance of Test\Ebln\PHPStan\EnforceFactory\dataAttrib\code\ExtendedProduct!", 69 + $offset],
             [self::ERROR_MESSAGE, 95 + $offset],
-            ['Test\Ebln\PHPStan\EnforceFactory\dataAttrib\code\IndependentForcedFactoryProduct must be instantiated by Test\Ebln\PHPStan\EnforceFactory\dataAttrib\IndependentFactory!', 100 + $offset],
+            ['Test\Ebln\PHPStan\EnforceFactory\dataAttrib\code\IndependentForcedFactoryProduct must be instantiated by Test\Ebln\PHPStan\EnforceFactory\dataAttrib\IndependentFactory!' . "\n    💡 Only use Test\Ebln\PHPStan\EnforceFactory\dataAttrib\IndependentFactory to create an instance of Test\Ebln\PHPStan\EnforceFactory\dataAttrib\code\IndependentForcedFactoryProduct!", 100 + $offset],
         ]);
     }
 

tests/AttribForceFactoryRuleTest.php

@@ -13,7 +13,8 @@
  */
 class ForceFactoryRuleTest extends RuleTestCase
 {
-    private const ERROR_MESSAGE = 'Test\Ebln\PHPStan\EnforceFactory\data\code\ForcedFactoryProduct must be instantiated by Test\Ebln\PHPStan\EnforceFactory\data\ForcedFactory or Test\Ebln\PHPStan\EnforceFactory\data\TraitFactory!';
+    private const ERROR_MESSAGE = 'Test\Ebln\PHPStan\EnforceFactory\data\code\ForcedFactoryProduct must be instantiated by Test\Ebln\PHPStan\EnforceFactory\data\ForcedFactory or Test\Ebln\PHPStan\EnforceFactory\data\TraitFactory!'
+    . "\n    💡 Only use Test\Ebln\PHPStan\EnforceFactory\data\ForcedFactory or Test\Ebln\PHPStan\EnforceFactory\data\TraitFactory to create an instance of Test\Ebln\PHPStan\EnforceFactory\data\code\ForcedFactoryProduct!";
 
     // Sadly this remains a vector, as phpstan fails to infer the created class name
     public function testLoopholeFactory(): void
@@ -41,7 +42,7 @@ public function testRogueFactory(): void
             [self::ERROR_MESSAGE, 40],
             [self::ERROR_MESSAGE, 51],
             [self::ERROR_MESSAGE, 56],
-            ['Test\Ebln\PHPStan\EnforceFactory\data\code\ExtendedProduct must be instantiated by Test\Ebln\PHPStan\EnforceFactory\data\ForcedFactory or Test\Ebln\PHPStan\EnforceFactory\data\TraitFactory!', 69],
+            ['Test\Ebln\PHPStan\EnforceFactory\data\code\ExtendedProduct must be instantiated by Test\Ebln\PHPStan\EnforceFactory\data\ForcedFactory or Test\Ebln\PHPStan\EnforceFactory\data\TraitFactory!' . "\n    💡 Only use Test\Ebln\PHPStan\EnforceFactory\data\ForcedFactory or Test\Ebln\PHPStan\EnforceFactory\data\TraitFactory to create an instance of Test\Ebln\PHPStan\EnforceFactory\data\code\ExtendedProduct!", 69],
             [self::ERROR_MESSAGE, 95],
         ]);
     }

tests/ForceFactoryRuleTest.php

@@ -28,8 +28,8 @@ public function testAttributeFactory(): void
     public function testRogueAttributeFactory(): void
     {
         $this->analyse([__DIR__ . '/dataMixed/RogueAttributeFactory.php'], [
-            ['Test\Ebln\PHPStan\EnforceFactory\dataMixed\code\AttributeProduct must be instantiated by Test\Ebln\PHPStan\EnforceFactory\dataMixed\AttributeFactory!', 14],
-            ['Test\Ebln\PHPStan\EnforceFactory\dataMixed\code\MixedProduct must be instantiated by Test\Ebln\PHPStan\EnforceFactory\dataMixed\AttributeFactory or Test\Ebln\PHPStan\EnforceFactory\dataMixed\ForcedFactory!', 19],
+            ['Test\Ebln\PHPStan\EnforceFactory\dataMixed\code\AttributeProduct must be instantiated by Test\Ebln\PHPStan\EnforceFactory\dataMixed\AttributeFactory!' . "\n    💡 Only use Test\Ebln\PHPStan\EnforceFactory\dataMixed\AttributeFactory to create an instance of Test\Ebln\PHPStan\EnforceFactory\dataMixed\code\AttributeProduct!", 14],
+            ['Test\Ebln\PHPStan\EnforceFactory\dataMixed\code\MixedProduct must be instantiated by Test\Ebln\PHPStan\EnforceFactory\dataMixed\AttributeFactory or Test\Ebln\PHPStan\EnforceFactory\dataMixed\ForcedFactory!' . "\n    💡 Only use Test\Ebln\PHPStan\EnforceFactory\dataMixed\AttributeFactory or Test\Ebln\PHPStan\EnforceFactory\dataMixed\ForcedFactory to create an instance of Test\Ebln\PHPStan\EnforceFactory\dataMixed\code\MixedProduct!", 19],
 
         ]);
     }