Remove RequireAssertConfigureValueObjectRectorRule as depends on context and common sense

Author: TomasVotruba

.github/workflows/code_analysis.yaml

@@ -44,7 +44,7 @@ jobs:
             # see https://github.com/shivammathur/setup-php
             -   uses: shivammathur/setup-php@v2
                 with:
-                    php-version: 8.1
+                    php-version: 8.2
                     coverage: none
 
             # composer install cache - https://github.com/ramsey/composer-install

.github/workflows/downgraded_release.yaml

@@ -20,7 +20,7 @@ jobs:
             -
                 uses: "shivammathur/setup-php@v2"
                 with:
-                    php-version: 8.1
+                    php-version: 8.2
                     coverage: none
 
             # invoke patches

composer.json

@@ -16,7 +16,8 @@
         "symplify/easy-coding-standard": "^12.5",
         "tomasvotruba/class-leak": "^1.2",
         "rector/rector": "^2.0",
-        "phpstan/extension-installer": "^1.4"
+        "phpstan/extension-installer": "^1.4",
+        "symplify/phpstan-extensions": "^12.0"
     },
     "autoload": {
         "psr-4": {

config/rector-rules.neon

@@ -1,7 +1,6 @@
 rules:
     - Symplify\PHPStanRules\Rules\Rector\PhpUpgradeDowngradeRegisteredInSetRule
     - Symplify\PHPStanRules\Rules\Rector\PhpUpgradeImplementsMinPhpVersionInterfaceRule
-    - Symplify\PHPStanRules\Rules\Rector\RequireAssertConfigureValueObjectRectorRule
     - Symplify\PHPStanRules\Rules\Rector\NoInstanceOfStaticReflectionRule
     - Symplify\PHPStanRules\Rules\Rector\NoLeadingBackslashInNameRule
     - Symplify\PHPStanRules\Rules\Rector\NoClassReflectionStaticReflectionRule

phpstan.neon

@@ -4,6 +4,7 @@ includes:
 
 parameters:
     treatPhpDocTypesAsCertain: false
+    errorFormat: symplify
 
     level: 8
 
@@ -50,28 +51,13 @@ parameters:
         # overly detailed
         - '#Class Symplify\\PHPStanRules\\Collector\\(.*?) implements generic interface PHPStan\\Collectors\\Collector but does not specify its types\: TNodeType, TValue#'
 
-#        -
-#            identifier: argument.type
-#
         # useful to have IDE know the types
         - identifier: phpstanApi.instanceofType
-#
-#        -
-#            identifier: return.type
 
         -
             identifier: class.notFound
             path: tests/Rules/Rector/PhpUpgradeImplementsMinPhpVersionInterfaceRule/PhpUpgradeImplementsMinPhpVersionInterfaceRuleTest.php
 
-#        -
-#            identifier: phpstanApi.runtimeReflection
-#
-#        -
-#            identifier: phpstanApi.instanceofAssumption
-#
-#        -
-#            identifier: method.childReturnType
-
         # overly detailed
         -
             message: '#Parameter \#2 \$expectedErrors of method PHPStan\\Testing\\RuleTestCase<(.*?)>::analyse\(\) expects list<array\{0: string, 1: int, 2\?: string\|null\}>, (.*?) given#'
@@ -81,3 +67,6 @@ parameters:
         -
             message: '#Function is_a\(\) is a runtime reflection concept that might not work in PHPStan because it uses fully static reflection engine#'
             path: src/Rules/SeeAnnotationToTestRule.php
+
+        # handle next
+        - '#Method Symplify\\PHPStanRules\\Rules\\AbstractSymplifyRule\:\:processNode\(\) should return list<PHPStan\\Rules\\IdentifierRuleError> but returns array<PHPStan\\Rules\\RuleError\|string>#'

src/Enum/ClassName.php

@@ -50,4 +50,124 @@ final class RuleIdentifier
      * @var string
      */
     public const NO_RETURN_ARRAY_VARIABLE_LIST = 'symplify.noReturnArrayVariableList';
+
+    /**
+     * @var string
+     */
+    public const RECTOR_NO_INSTANCE_OF_STATIC_REFLECTION = 'rector.noInstanceOfStaticReflection';
+
+    /**
+     * @var string
+     */
+    public const RECTOR_NO_CLASS_REFLECTION_STATIC_REFLECTION = 'rector.noClassReflectionStaticReflection';
+
+    /**
+     * @var string
+     */
+    public const PARENT_METHOD_VISIBILITY_OVERRIDE = 'symplify.parentMethodVisibilityOverride';
+
+    /**
+     * @var string
+     */
+    public const CLASS_CONSTANT_REGEX = 'symplify.classConstantRegex';
+
+    /**
+     * @var string
+     */
+    public const NO_RETURN_SETTER_METHOD = 'symplify.noReturnSetterMethod';
+
+    /**
+     * @var string
+     */
+    public const FORBIDDEN_STATIC_CLASS_CONST_FETCH = 'symplify.forbiddenStaticClassConstFetch';
+
+    /**
+     * @var string
+     */
+    public const PREFERRED_CLASS = 'symplify.preferredClass';
+
+    /**
+     * @var string
+     */
+    public const NO_TEST_MOCKS = 'symplify.noTestMocks';
+
+    /**
+     * @var string
+     */
+    public const NO_GLOBAL_CONST = 'symplify.noGlobalConst';
+
+    /**
+     * @var string
+     */
+    public const NO_ENTITY_OUTSIDE_ENTITY_NAMESPACE = 'symplify.noEntityOutsideEntityNamespace';
+
+    /**
+     * @var string
+     */
+    public const FORBIDDEN_NODE = 'symplify.forbiddenNode';
+
+    /**
+     * @var string
+     */
+    public const MULTIPLE_CLASS_LIKE_IN_FILE = 'symplify.multipleClassLikeInFile';
+
+    /**
+     * @var string
+     */
+    public const FORBIDDEN_FUNC_CALL = 'symplify.forbiddenFuncCall';
+
+    /**
+     * @var string
+     */
+    public const REQUIRE_ATTRIBUTE_NAMESPACE = 'symplify.requireAttributeNamespace';
+
+    /**
+     * @var string
+     */
+    public const FORBIDDEN_ARRAY_METHOD_CALL = 'symplify.forbiddenArrayMethodCall';
+
+    /**
+     * @var string
+     */
+    public const REGEX_ANNOTATE_CLASS_CONST = 'symplify.regexAnnotateClassConst';
+
+    /**
+     * @var string
+     */
+    public const FORBIDDEN_EXTEND_OF_NON_ABSTRACT_CLASS = 'symplify.forbiddenExtendOfNonAbstractClass';
+
+    /**
+     * @var string
+     */
+    public const EXPLICIT_ABSTRACT_PREFIX_NAME = 'symplify.explicitAbstractPrefixName';
+
+    /**
+     * @var string
+     */
+    public const EXPLICIT_INTERFACE_SUFFIX_NAME = 'symplify.explicitInterfaceSuffixName';
+
+    /**
+     * @var string
+     */
+    public const EXPLICIT_TRAIT_SUFFIX_NAME = 'symplify.explicitTraitSuffixName';
+
+    /**
+     * @var string
+     */
+    public const REQUIRE_UNIQUE_ENUM_CONSTANT = 'symplify.requireUniqueEnumConstant';
+
+    /**
+     * @var string
+     */
+    public const REQUIRE_EXCEPTION_NAMESPACE = 'symplify.requireExceptionNamespace';
+
+    /**
+     * @var string
+     */
+    public const CLASS_NAME_RESPECTS_PARENT_SUFFIX = 'symplify.classNameRespectsParentSuffix';
+
+    /**
+     * @var string
+     */
+    public const REQUIRED_INTERFACE_CONTRACT_NAMESPACE = 'symplify.requiredInterfaceContractNamespace';
 }

src/Enum/RuleIdentifier.php

@@ -12,6 +12,7 @@
 use PHPStan\Analyser\Scope;
 use PHPStan\Rules\Rule;
 use PHPStan\Rules\RuleErrorBuilder;
+use Symplify\PHPStanRules\Enum\RuleIdentifier;
 use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
 use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
 
@@ -66,29 +67,9 @@ public function processNode(Node $node, Scope $scope): array
             return [];
         }
 
-        return [RuleErrorBuilder::message(self::ERROR_MESSAGE)->build()];
-    }
-
-    public function getRuleDefinition(): RuleDefinition
-    {
-        return new RuleDefinition(self::ERROR_MESSAGE, [new CodeSample(
-            <<<'CODE_SAMPLE'
-class SomeClass
-{
-    private const COMPLICATED_REGEX = '#some_complicated_stu|ff#';
-}
-CODE_SAMPLE
-            ,
-            <<<'CODE_SAMPLE'
-class SomeClass
-{
-    /**
-     * @see https://regex101.com/r/SZr0X5/12
-     */
-    private const COMPLICATED_REGEX = '#some_complicated_stu|ff#';
-}
-CODE_SAMPLE
-        )]);
+        return [RuleErrorBuilder::message(self::ERROR_MESSAGE)
+            ->identifier(RuleIdentifier::REGEX_ANNOTATE_CLASS_CONST)
+            ->build()];
     }
 
     private function isNonSingleCharRegexPattern(string $value): bool

src/Rules/AnnotateRegexClassConstWithRegexLinkRule.php

@@ -10,6 +10,7 @@
 use PHPStan\Analyser\Scope;
 use PHPStan\Rules\Rule;
 use PHPStan\Rules\RuleErrorBuilder;
+use Symplify\PHPStanRules\Enum\RuleIdentifier;
 
 /**
  * @see \Symplify\PHPStanRules\Tests\Rules\CheckRequiredInterfaceInContractNamespaceRule\CheckRequiredInterfaceInContractNamespaceRuleTest
@@ -47,6 +48,8 @@ public function processNode(Node $node, Scope $scope): array
             return [];
         }
 
-        return [RuleErrorBuilder::message(self::ERROR_MESSAGE)->build()];
+        return [RuleErrorBuilder::message(self::ERROR_MESSAGE)
+            ->identifier(RuleIdentifier::REQUIRED_INTERFACE_CONTRACT_NAMESPACE)
+            ->build()];
     }
 }

src/Rules/CheckRequiredInterfaceInContractNamespaceRule.php

@@ -11,13 +11,15 @@
 use PHPStan\Analyser\Scope;
 use PHPStan\Node\InClassNode;
 use PHPStan\Reflection\ClassReflection;
+use PHPStan\Rules\IdentifierRuleError;
 use PHPStan\Rules\Rule;
 use PHPStan\Rules\RuleError;
 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\RuleIdentifier;
 use Symplify\PHPStanRules\Naming\ClassToSuffixResolver;
 
 /**
@@ -89,7 +91,7 @@ public function processNode(Node $node, Scope $scope): array
     }
 
     /**
-     * @return list<RuleError>
+     * @return list<IdentifierRuleError>
      */
     private function processClassNameAndShort(ClassReflection $classReflection): array
     {
@@ -104,7 +106,9 @@ private function processClassNameAndShort(ClassReflection $classReflection): arr
             }
 
             $errorMessage = sprintf(self::ERROR_MESSAGE, $expectedSuffix);
-            return [RuleErrorBuilder::message($errorMessage)->build()];
+            return [RuleErrorBuilder::message($errorMessage)
+                ->identifier(RuleIdentifier::CLASS_NAME_RESPECTS_PARENT_SUFFIX)
+                ->build()];
         }
 
         return [];