fix rector rule test

TomasVotruba · TomasVotruba · commit a350e628bd1b · 2024-12-16T00:45:29.000+01:00
diff --git a/build/target-repository/composer.json b/build/target-repository/composer.json
@@ -6,7 +6,7 @@
     "require": {
         "php": "^7.4|^8.0",
         "phpstan/phpstan": "^2.0",
-        "nette/utils": "^3.1|^4.0",
+        "nette/utils": "^3.2|^4.0",
         "webmozart/assert": "^1.11"
     },
     "autoload": {
diff --git a/composer-dependency-analyser.php b/composer-dependency-analyser.php
@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+use ShipMonk\ComposerDependencyAnalyser\Config\Configuration;
+use ShipMonk\ComposerDependencyAnalyser\Config\ErrorType;
+
+return (new Configuration())->addPathToScan(__DIR__ . '/src', false)
+    // already in phpstan/phpstan
+    ->ignoreErrorsOnPackage('nikic/php-parser', [ErrorType::DEV_DEPENDENCY_IN_PROD]);
+// ->ignoreErrorsOnPath('/Fixture/', [\ShipMonk\ComposerDependencyAnalyser\Config\ErrorType::UNKNOWN_CLASS]);
diff --git a/composer.json b/composer.json
@@ -7,7 +7,8 @@
         "php": ">=8.2",
         "webmozart/assert": "^1.11",
         "phpstan/phpstan": "^2.0",
-        "nette/utils": "^3.1|^4.0"
+        "nette/utils": "^3.2|^4.0",
+        "phpstan/phpdoc-parser": "^2.0"
     },
     "require-dev": {
         "nikic/php-parser": "^5.3",
@@ -18,7 +19,9 @@
         "rector/rector": "^2.0",
         "phpstan/extension-installer": "^1.4",
         "symplify/phpstan-extensions": "^12.0",
-        "tomasvotruba/unused-public": "^2.0"
+        "tomasvotruba/unused-public": "^2.0",
+        "tomasvotruba/type-coverage": "^2.0",
+        "shipmonk/composer-dependency-analyser": "^1.8"
     },
     "autoload": {
         "psr-4": {
diff --git a/phpstan.neon b/phpstan.neon
@@ -28,17 +28,15 @@ parameters:
         properties: true
         constants: true
 
-    # type_coverage:
-    #     return: 99
-    #     param: 99
-    #     property: 99
+    type_coverage:
+        return: 99
+        param: 99
+        property: 99
 
     ignoreErrors:
         # needless generics
         - '#Class Symplify\\PHPStanRules\\(.*?)Rule implements generic interface PHPStan\\Rules\\Rule but does not specify its types\: TNodeType#'
 
-        - '#Class PHP_CodeSniffer\\Sniffs\\Sniff not found#'
-
         - '#Method Symplify\\PHPStanRules\\Reflection\\ReflectionParser\:\:parseNativeClassReflection\(\) has parameter \$reflectionClass with generic class ReflectionClass but does not specify its types\: T#'
 
         # overly detailed
diff --git a/phpunit.xml b/phpunit.xml
@@ -1,5 +1,11 @@
 <?xml version="1.0"?>
-<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" bootstrap="vendor/autoload.php" colors="true" xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd" cacheDirectory=".phpunit.cache">
+<phpunit
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    bootstrap="vendor/autoload.php"
+    colors="true"
+    xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd"
+    displayDetailsOnIncompleteTests="true"
+    cacheDirectory=".phpunit.cache">
     <testsuite name="all">
         <directory>tests</directory>
         <exclude>tests/Rules/ClassNameRespectsParentSuffixRule/Fixture/</exclude>
diff --git a/phpunit.xml.bak b/phpunit.xml.bak
diff --git a/src/Composer/ComposerAutoloadResolver.php b/src/Composer/ComposerAutoloadResolver.php
@@ -4,6 +4,8 @@
 
 namespace Symplify\PHPStanRules\Composer;
 
+use Symplify\PHPStanRules\FileSystem\FileSystem;
+
 final class ComposerAutoloadResolver
 {
     /**
@@ -20,7 +22,7 @@ public function getPsr4Autoload(): array
             return [];
         }
 
-        $fileContent = \Symplify\PHPStanRules\FileSystem\FileSystem::read(self::COMPOSER_JSON_FILE);
+        $fileContent = FileSystem::read(self::COMPOSER_JSON_FILE);
         $composerJsonContent = json_decode($fileContent, true, 512, JSON_THROW_ON_ERROR);
 
         $autoloadPsr4 = $composerJsonContent['autoload']['psr-4'] ?? [];
diff --git a/src/Enum/ClassName.php b/src/Enum/ClassName.php
@@ -15,4 +15,39 @@ final class ClassName
      * @var string
      */
     public const NETTE_STRINGS = 'Nette\Utils\Strings';
+
+    /**
+     * @var string
+     */
+    public const SYMFONY_ABSTRACT_CONTROLLER = 'Symfony\Bundle\FrameworkBundle\Controller\AbstractController';
+
+    /**
+     * @var string
+     */
+    public const PHPUNIT_TEST_CASE = 'PHPUnit\Framework\TestCase';
+
+    /**
+     * @var string
+     */
+    public const EVENT_DISPATCHER_INTERFACE = 'Symfony\Component\EventDispatcher\EventSubscriberInterface';
+
+    /**
+     * @var string
+     */
+    public const SNIFF = 'PHP_CodeSniffer\Sniffs\Sniff';
+
+    /**
+     * @var string
+     */
+    public const RECTOR = 'Rector\Contract\Rector\RectorInterface';
+
+    /**
+     * @var string
+     */
+    public const ABSTRACT_RECTOR = 'Rector\Rector\AbstractRector';
+
+    /**
+     * @var string
+     */
+    public const CONFIGURABLE_RECTOR = 'Rector\Contract\Rector\ConfigurableRectorInterface';
 }
diff --git a/src/Naming/ClassToSuffixResolver.php b/src/Naming/ClassToSuffixResolver.php
@@ -40,7 +40,7 @@ private function removeAbstractInterfacePrefixSuffix(string $parentType): string
         }
 
         if (\str_starts_with($parentType, 'Abstract')) {
-            return substr($parentType, (int) strlen('Abstract'));
+            return substr($parentType, strlen('Abstract'));
         }
 
         return $parentType;
diff --git a/src/Reflection/Nested/Some.php b/src/Reflection/Nested/Some.php
@@ -0,0 +1,7 @@
+<?php
+
+namespace Symplify\PHPStanRules\Reflection;
+
+class Some
+{
+}
diff --git a/src/Reflection/ReflectionParser.php b/src/Reflection/ReflectionParser.php
@@ -14,6 +14,7 @@
 use PHPStan\Reflection\MethodReflection;
 use ReflectionClass;
 use ReflectionMethod;
+use Symplify\PHPStanRules\FileSystem\FileSystem;
 use Symplify\PHPStanRules\NodeFinder\TypeAwareNodeFinder;
 use Throwable;
 
@@ -77,7 +78,7 @@ private function parseFilenameToClass(string $fileName): ClassLike|null
         }
 
         try {
-            $stmts = $this->parser->parse(\Symplify\PHPStanRules\FileSystem\FileSystem::read($fileName));
+            $stmts = $this->parser->parse(FileSystem::read($fileName));
             if (! is_array($stmts)) {
                 return null;
             }
diff --git a/src/Rules/AnnotateRegexClassConstWithRegexLinkRule.php b/src/Rules/AnnotateRegexClassConstWithRegexLinkRule.php
@@ -4,7 +4,6 @@
 
 namespace Symplify\PHPStanRules\Rules;
 
-use Nette\Utils\Strings;
 use PhpParser\Comment\Doc;
 use PhpParser\Node;
 use PhpParser\Node\Scalar\String_;
@@ -89,7 +88,8 @@ private function isNonSingleCharRegexPattern(string $value): bool
             return false;
         }
 
-        $lastChar = Strings::substring($patternWithoutModifiers, -1, 1);
+        $lastChar = substr($patternWithoutModifiers, -1, 1);
+
         // this is probably a regex
         return $firstChar === $lastChar;
     }
diff --git a/src/Rules/ClassNameRespectsParentSuffixRule.php b/src/Rules/ClassNameRespectsParentSuffixRule.php
@@ -5,7 +5,6 @@
 namespace Symplify\PHPStanRules\Rules;
 
 use Exception;
-use PHP_CodeSniffer\Sniffs\Sniff;
 use PhpParser\Node;
 use PhpParser\Node\Stmt\Class_;
 use PHPStan\Analyser\Scope;
@@ -14,10 +13,7 @@
 use PHPStan\Rules\IdentifierRuleError;
 use PHPStan\Rules\Rule;
 use PHPStan\Rules\RuleErrorBuilder;
-use PHPUnit\Framework\TestCase;
-use Rector\Rector\AbstractRector;
-use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
-use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+use Symplify\PHPStanRules\Enum\ClassName;
 use Symplify\PHPStanRules\Enum\RuleIdentifier;
 use Symplify\PHPStanRules\Naming\ClassToSuffixResolver;
 
@@ -37,14 +33,14 @@ final class ClassNameRespectsParentSuffixRule implements Rule
      */
     private const DEFAULT_PARENT_CLASSES = [
         'Symfony\Component\Console\Command\Command',
-        EventSubscriberInterface::class,
-        AbstractController::class,
-        Sniff::class,
-        TestCase::class,
+        ClassName::EVENT_DISPATCHER_INTERFACE,
+        ClassName::SYMFONY_ABSTRACT_CONTROLLER,
+        ClassName::SNIFF,
+        ClassName::PHPUNIT_TEST_CASE,
         Exception::class,
         'PhpCsFixer\Fixer\FixerInterface',
         Rule::class,
-        AbstractRector::class,
+        ClassName::ABSTRACT_RECTOR,
     ];
 
     /**
diff --git a/src/Rules/Rector/PhpUpgradeDowngradeRegisteredInSetRule.php b/src/Rules/Rector/PhpUpgradeDowngradeRegisteredInSetRule.php
@@ -11,13 +11,13 @@
 use PHPStan\Reflection\ClassReflection;
 use PHPStan\Rules\Rule;
 use PHPStan\Rules\RuleErrorBuilder;
-use Rector\Contract\Rector\ConfigurableRectorInterface;
-use Rector\Contract\Rector\RectorInterface;
 use Rector\Set\ValueObject\DowngradeSetList;
 use Rector\Set\ValueObject\SetList;
 use SplFileInfo;
+use Symplify\PHPStanRules\Enum\ClassName;
 use Symplify\PHPStanRules\Enum\RuleIdentifier;
 use Symplify\PHPStanRules\Exception\ShouldNotHappenException;
+use Symplify\PHPStanRules\FileSystem\FileSystem;
 
 /**
  * @see \Symplify\PHPStanRules\Tests\Rules\Rector\PhpUpgradeDowngradeRegisteredInSetRule\PhpUpgradeDowngradeRegisteredInSetRuleTest
@@ -57,7 +57,7 @@ public function processNode(Node $node, Scope $scope): array
             return [];
         }
 
-        $configContent = \Symplify\PHPStanRules\FileSystem\FileSystem::read($configFilePath);
+        $configContent = FileSystem::read($configFilePath);
 
         // is rule registered?
         if (str_contains($configContent, $className)) {
@@ -110,12 +110,12 @@ private function matchRectorClassName(Scope $scope): ?string
             return null;
         }
 
-        if (! $classReflection->isSubclassOf(RectorInterface::class)) {
+        if (! $classReflection->isSubclassOf(ClassName::RECTOR)) {
             return null;
         }
 
         // configurable Rector can be registered optionally
-        if ($classReflection->isSubclassOf(ConfigurableRectorInterface::class)) {
+        if ($classReflection->isSubclassOf(ClassName::CONFIGURABLE_RECTOR)) {
             return null;
         }
 
diff --git a/src/Rules/SeeAnnotationToTestRule.php b/src/Rules/SeeAnnotationToTestRule.php
@@ -15,7 +15,7 @@
 use PHPStan\Reflection\ClassReflection;
 use PHPStan\Rules\Rule;
 use PHPStan\Rules\RuleErrorBuilder;
-use PHPUnit\Framework\TestCase;
+use Symplify\PHPStanRules\Enum\ClassName;
 use Symplify\PHPStanRules\Enum\RuleIdentifier;
 use Symplify\PHPStanRules\PhpDoc\PhpDocResolver;
 use Symplify\PHPStanRules\PhpDoc\SeePhpDocTagNodesFinder;
@@ -113,7 +113,7 @@ private function hasSeeTestCaseAnnotation(array $seeTags): bool
                 continue;
             }
 
-            if (is_a($seeTag->value->value, TestCase::class, true)) {
+            if (is_a($seeTag->value->value, ClassName::PHPUNIT_TEST_CASE, true)) {
                 return true;
             }
         }
diff --git a/src/Symfony/Rules/RequireInvokableControllerRule.php b/src/Symfony/Rules/RequireInvokableControllerRule.php
@@ -9,7 +9,7 @@
 use PHPStan\Node\InClassNode;
 use PHPStan\Rules\Rule;
 use PHPStan\Rules\RuleErrorBuilder;
-use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
+use Symplify\PHPStanRules\Enum\ClassName;
 use Symplify\PHPStanRules\Enum\MethodName;
 use Symplify\PHPStanRules\Enum\RuleIdentifier;
 use Symplify\PHPStanRules\Symfony\NodeAnalyzer\SymfonyControllerAnalyzer;
@@ -39,7 +39,7 @@ public function processNode(Node $node, Scope $scope): array
     {
         $classReflection = $node->getClassReflection();
         if (
-            ! $classReflection->isSubclassOf(AbstractController::class) &&
+            ! $classReflection->isSubclassOf(ClassName::SYMFONY_ABSTRACT_CONTROLLER) &&
             ! $classReflection->isSubclassOf('Symfony\Bundle\FrameworkBundle\Controller\Controller')
         ) {
             return [];
diff --git a/tests/Rules/ForbiddenFuncCallRule/Fixture/CurlCall.php b/tests/Rules/ForbiddenFuncCallRule/Fixture/CurlCall.php
diff --git a/tests/Rules/ForbiddenFuncCallRule/ForbiddenFuncCallRuleTest.php b/tests/Rules/ForbiddenFuncCallRule/ForbiddenFuncCallRuleTest.php
@@ -29,9 +29,6 @@ public static function provideData(): Iterator
         $errorMessage = sprintf(ForbiddenFuncCallRule::ERROR_MESSAGE, 'extract');
         yield [__DIR__ . '/Fixture/ExtractCall.php', [[$errorMessage, 11]]];
 
-        $errorMessage = sprintf(ForbiddenFuncCallRule::ERROR_MESSAGE, 'curl_init');
-        yield [__DIR__ . '/Fixture/CurlCall.php', [[$errorMessage, 11]]];
-
         $errorMessage = sprintf(ForbiddenFuncCallRule::ERROR_MESSAGE, 'property_exists');
         yield [__DIR__ . '/Fixture/PropertyExists.php', [[$errorMessage, 11]]];
 
diff --git a/tests/Rules/ForbiddenFuncCallRule/ForbiddenFuncCallRuleWithDeprecationsTest.php b/tests/Rules/ForbiddenFuncCallRule/ForbiddenFuncCallRuleWithDeprecationsTest.php
@@ -33,10 +33,6 @@ public static function provideData(): Iterator
         $errorMessage .= ': you shouldn"t use this dynamic things';
         yield [__DIR__ . '/Fixture/ExtractCall.php', [[$errorMessage, 11]]];
 
-        $errorMessage = sprintf(ForbiddenFuncCallRule::ERROR_MESSAGE, 'curl_init');
-        $errorMessage .= ': we use a proper http client these days';
-        yield [__DIR__ . '/Fixture/CurlCall.php', [[$errorMessage, 11]]];
-
         // custom error defined as empty-string -> just prints the default message
         $errorMessage = sprintf(ForbiddenFuncCallRule::ERROR_MESSAGE, 'property_exists');
         yield [__DIR__ . '/Fixture/PropertyExists.php', [[$errorMessage, 11]]];
diff --git a/tests/Rules/Rector/NoInstanceOfStaticReflectionRule/Fixture/IsAWithType.php b/tests/Rules/Rector/NoInstanceOfStaticReflectionRule/Fixture/IsAWithType.php
@@ -4,12 +4,10 @@
 
 namespace Symplify\PHPStanRules\Tests\Rules\Rector\NoInstanceOfStaticReflectionRule\Fixture;
 
-use Hoa\Math\Sampler\Random;
-
 final class IsAWithType
 {
     public function check(object $object): bool
     {
-        return is_a($object, Random::class);
+        return is_a($object, 'Random');
     }
 }
diff --git a/tests/Rules/Rector/PhpUpgradeDowngradeRegisteredInSetRule/Fixture/DowngradePhp80/SomePhpFeature2Rector.php b/tests/Rules/Rector/PhpUpgradeDowngradeRegisteredInSetRule/Fixture/DowngradePhp80/SomePhpFeature2Rector.php
@@ -5,16 +5,10 @@
 namespace Symplify\PHPStanRules\Tests\Rules\Rector\PhpUpgradeDowngradeRegisteredInSetRule\Fixture\DowngradePhp80;
 
 use PhpParser\Node;
-use Rector\Contract\Rector\RectorInterface;
 use Rector\Rector\AbstractRector;
-use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
 
-final class SomePhpFeature2Rector extends AbstractRector implements RectorInterface
+final class SomePhpFeature2Rector extends AbstractRector
 {
-    public function getRuleDefinition(): RuleDefinition
-    {
-    }
-
     public function getNodeTypes(): array
     {
         return [];
diff --git a/tests/Rules/Rector/PhpUpgradeDowngradeRegisteredInSetRule/Fixture/Php80/SomePhpFeatureRector.php b/tests/Rules/Rector/PhpUpgradeDowngradeRegisteredInSetRule/Fixture/Php80/SomePhpFeatureRector.php
diff --git a/tests/Rules/Rector/PhpUpgradeDowngradeRegisteredInSetRule/PhpUpgradeDowngradeRegisteredInSetRuleTest.php b/tests/Rules/Rector/PhpUpgradeDowngradeRegisteredInSetRule/PhpUpgradeDowngradeRegisteredInSetRuleTest.php

Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,8 @@`
`4`	`4`
`5`	`5`	`namespace Symplify\PHPStanRules\Composer;`
`6`	`6`
	`7`	`+use Symplify\PHPStanRules\FileSystem\FileSystem;`
	`8`	`+`
`7`	`9`	`final class ComposerAutoloadResolver`
`8`	`10`	`{`
`9`	`11`	`/**`
`@@ -20,7 +22,7 @@ public function getPsr4Autoload(): array`
`20`	`22`	`return [];`
`21`	`23`	`}`
`22`	`24`
`23`		`- $fileContent = \Symplify\PHPStanRules\FileSystem\FileSystem::read(self::COMPOSER_JSON_FILE);`
	`25`	`+ $fileContent = FileSystem::read(self::COMPOSER_JSON_FILE);`
`24`	`26`	`$composerJsonContent = json_decode($fileContent, true, 512, JSON_THROW_ON_ERROR);`
`25`	`27`
`26`	`28`	`$autoloadPsr4 = $composerJsonContent['autoload']['psr-4'] ?? [];`
Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,7 @@ private function removeAbstractInterfacePrefixSuffix(string $parentType): string`
`40`	`40`	`}`
`41`	`41`
`42`	`42`	`if (\str_starts_with($parentType, 'Abstract')) {`
`43`		`- return substr($parentType, (int) strlen('Abstract'));`
	`43`	`+ return substr($parentType, strlen('Abstract'));`
`44`	`44`	`}`
`45`	`45`
`46`	`46`	`return $parentType;`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,7 @@ @@
 +<?php
++
 +namespace Symplify\PHPStanRules\Reflection;
++
 +class Some
 +{
 +}