[DX] Try unused public const PHPStan rule (#2595)

* remove unused TEAR_DOWN const * make CLASS_NAME_REGEX private * remove unused FOLLOW_SYMLINKS * make TREAT_AS_NON_EMPTY api * remove deprecated ENABLE_EDITORCONFIG * remove unused OUTPUT_FORMAT_SHORT const * make SetList part of API * more API * remove unused RELEASE_DATE * more API * make use of Name constants in FileDiff * remove unused FILE const * remove deprecated and unused PREVIOUS_STATEMENT and CURRENT_STATEMENT * remove unused SPACE_OR_ASTERISK_REGEX * make CLOSING_DOCBLOCK_REGEX private * cleanup * make DOC_INDENTATION an api
rectorphp · Jun 30, 2022 · ed92724 · ed92724
1 parent 143f743
commit ed92724
Show file tree

Hide file tree

Showing 22 changed files with 48 additions and 92 deletions.
diff --git a/composer.json b/composer.json
@@ -70,7 +70,7 @@
         "symplify/easy-coding-standard": "^11.0",
         "symplify/monorepo-builder": "^11.0",
         "symplify/phpstan-extensions": "^11.0",
-        "symplify/phpstan-rules": "^11.0",
+        "symplify/phpstan-rules": "dev-main",
         "symplify/rule-doc-generator": "^11.0",
         "symplify/vendor-patches": "^11.0"
     },
@@ -183,5 +183,7 @@
             "rector/extension-installer": true,
             "cweagans/composer-patches": true
         }
-    }
+    },
+    "minimum-stability": "dev",
+    "prefer-stable": true
 }
diff --git a/packages/BetterPhpDocParser/Printer/PhpDocInfoPrinter.php b/packages/BetterPhpDocParser/Printer/PhpDocInfoPrinter.php
@@ -33,7 +33,7 @@ final class PhpDocInfoPrinter
      * @var string
      * @see https://regex101.com/r/Ab0Vey/1
      */
-    public const CLOSING_DOCBLOCK_REGEX = '#\*\/(\s+)?$#';
+    private const CLOSING_DOCBLOCK_REGEX = '#\*\/(\s+)?$#';
 
     /**
      * @var string

diff --git a/packages/Comments/NodeDocBlock/DocBlockUpdater.php b/packages/Comments/NodeDocBlock/DocBlockUpdater.php
@@ -12,12 +12,6 @@
 
 final class DocBlockUpdater
 {
-    /**
-     * @var string
-     * @see https://regex101.com/r/VdaVGL/1
-     */
-    public const SPACE_OR_ASTERISK_REGEX = '#(\s|\*)+#';
-
     public function __construct(
         private readonly PhpDocInfoPrinter $phpDocInfoPrinter
     ) {

diff --git a/packages/NodeTypeResolver/Node/AttributeKey.php b/packages/NodeTypeResolver/Node/AttributeKey.php
@@ -78,21 +78,6 @@ final class AttributeKey
      */
     public const NEXT_NODE = 'next';
 
-    /**
-     * @deprecated Instead of tree climbing without context, hook into parent node that contains the stmts directly.
-     * E.g. FunctionLike, If_, While_ etc.
-     * @var string
-     */
-    public const PREVIOUS_STATEMENT = 'previousExpression';
-
-    /**
-     * @deprecated Instead of tree climbing without context, hook into parent node that contains the stmts directly.
-     * E.g. FunctionLike, If_, While_ etc.
-     * Use @see \Rector\Core\PhpParser\Node\BetterNodeFinder::resolveCurrentStatement() instead if actually needed
-     * @var string
-     */
-    public const CURRENT_STATEMENT = 'currentExpression';
-
     /**
      * Internal php-parser name.
      * Do not change this even if you want!
@@ -102,6 +87,8 @@ final class AttributeKey
     public const NAMESPACED_NAME = 'namespacedName';
 
     /**
+     * @api
+     *
      * Internal php-parser name.
      * Do not change this even if you want!
      *
@@ -150,14 +137,6 @@ final class AttributeKey
      */
     public const FUNC_ARGS_TRAILING_COMMA = 'trailing_comma';
 
-    /**
-     * Contains current file object
-     * @see \Rector\Core\ValueObject\Application\File
-     *
-     * @var string
-     */
-    public const FILE = 'file';
-
     /**
      * Helps with infinite loop detection
      * @var string

diff --git a/packages/Parallel/ValueObject/Name.php b/packages/Parallel/ValueObject/Name.php
@@ -5,6 +5,7 @@
 namespace Rector\Parallel\ValueObject;
 
 /**
+ * @api
  * Helpers constant for passing constant names around
  */
 final class Name
@@ -43,4 +44,9 @@ final class Name
      * @var string
      */
     public const RECTOR_CLASS = 'rector_class';
+
+    /**
+     * @var string
+     */
+    public const RECTORS_WITH_LINE_CHANGES = 'rectors_with_line_changes';
 }
diff --git a/packages/Set/ValueObject/LevelSetList.php b/packages/Set/ValueObject/LevelSetList.php
@@ -6,6 +6,9 @@
 
 use Rector\Set\Contract\SetListInterface;
 
+/**
+ * @api
+ */
 final class LevelSetList implements SetListInterface
 {
     /**

diff --git a/packages/Set/ValueObject/SetList.php b/packages/Set/ValueObject/SetList.php
@@ -6,6 +6,9 @@
 
 use Rector\Set\Contract\SetListInterface;
 
+/**
+ * @api
+ */
 final class SetList implements SetListInterface
 {
     /**

diff --git a/rules/Arguments/NodeAnalyzer/ArgumentAddingScope.php b/rules/Arguments/NodeAnalyzer/ArgumentAddingScope.php
@@ -14,16 +14,19 @@
 final class ArgumentAddingScope
 {
     /**
+     * @api
      * @var string
      */
     public const SCOPE_PARENT_CALL = 'parent_call';
 
     /**
+     * @api
      * @var string
      */
     public const SCOPE_METHOD_CALL = 'method_call';
 
     /**
+     * @api
      * @var string
      */
     public const SCOPE_CLASS_METHOD = 'class_method';

diff --git a/rules/CodingStyle/Rector/ClassMethod/OrderAttributesRector.php b/rules/CodingStyle/Rector/ClassMethod/OrderAttributesRector.php
@@ -25,6 +25,7 @@
 final class OrderAttributesRector extends AbstractRector implements ConfigurableRectorInterface
 {
     /**
+     * @api
      * @var string
      */
     public const ALPHABETICALLY = 'alphabetically';

diff --git a/rules/DeadCode/Rector/Property/RemoveUnusedPrivatePropertyRector.php b/rules/DeadCode/Rector/Property/RemoveUnusedPrivatePropertyRector.php
@@ -20,6 +20,7 @@
 final class RemoveUnusedPrivatePropertyRector extends AbstractRector implements AllowEmptyConfigurableRectorInterface
 {
     /**
+     * @api
      * @var string
      */
     public const REMOVE_ASSIGN_SIDE_EFFECT = 'remove_assign_side_effect';

diff --git a/rules/DeadCode/Rector/StmtsAwareInterface/RemoveJustPropertyFetchRector.php b/rules/DeadCode/Rector/StmtsAwareInterface/RemoveJustPropertyFetchRector.php
@@ -144,10 +144,13 @@ public function refactor(Node $node): ?Node
     /**
      * @param Stmt[] $followingStmts
      */
-    public function isFollowingStatementStaticClosure(array $followingStmts): bool
+    private function isFollowingStatementStaticClosure(array $followingStmts): bool
     {
-        return count($followingStmts) > 0
-            && $followingStmts[0] instanceof Expression
+        if ($followingStmts === []) {
+            return false;
+        }
+
+        return $followingStmts[0] instanceof Expression
             && $followingStmts[0]->expr instanceof Closure
             && $followingStmts[0]->expr->static;
     }

diff --git a/rules/Php74/Rector/Property/TypedPropertyRector.php b/rules/Php74/Rector/Property/TypedPropertyRector.php
@@ -42,6 +42,7 @@
 final class TypedPropertyRector extends AbstractScopeAwareRector implements AllowEmptyConfigurableRectorInterface, MinPhpVersionInterface
 {
     /**
+     * @api
      * @var string
      */
     public const INLINE_PUBLIC = 'inline_public';

diff --git a/rules/Php80/Rector/Class_/DoctrineAnnotationClassToAttributeRector.php b/rules/Php80/Rector/Class_/DoctrineAnnotationClassToAttributeRector.php
@@ -38,6 +38,7 @@
 final class DoctrineAnnotationClassToAttributeRector extends AbstractRector implements ConfigurableRectorInterface, MinPhpVersionInterface
 {
     /**
+     * @api
      * @var string
      */
     public const REMOVE_ANNOTATIONS = 'remove_annotations';

diff --git a/rules/Strict/Rector/AbstractFalsyScalarRuleFixerRector.php b/rules/Strict/Rector/AbstractFalsyScalarRuleFixerRector.php
@@ -14,6 +14,7 @@
 abstract class AbstractFalsyScalarRuleFixerRector extends AbstractRector implements ConfigurableRectorInterface
 {
     /**
+     * @api
      * @var string
      */
     final public const TREAT_AS_NON_EMPTY = 'treat_as_non_empty';

diff --git a/rules/TypeDeclaration/Rector/ClassMethod/AddVoidReturnTypeWhereNoReturnRector.php b/rules/TypeDeclaration/Rector/ClassMethod/AddVoidReturnTypeWhereNoReturnRector.php
@@ -30,6 +30,7 @@
 final class AddVoidReturnTypeWhereNoReturnRector extends AbstractRector implements MinPhpVersionInterface, AllowEmptyConfigurableRectorInterface
 {
     /**
+     * @api
      * @var string using phpdoc instead of a native void type can ease the migration path for consumers of code being processed.
      */
     public const USE_PHPDOC = 'use_phpdoc';

diff --git a/rules/TypeDeclaration/Rector/Property/TypedPropertyFromAssignsRector.php b/rules/TypeDeclaration/Rector/Property/TypedPropertyFromAssignsRector.php
@@ -30,6 +30,7 @@
 final class TypedPropertyFromAssignsRector extends AbstractRector implements AllowEmptyConfigurableRectorInterface
 {
     /**
+     * @api
      * @var string
      */
     public const INLINE_PUBLIC = 'inline_public';

diff --git a/src/Application/VersionResolver.php b/src/Application/VersionResolver.php
@@ -20,11 +20,6 @@ final class VersionResolver
      */
     public const PACKAGE_VERSION = '@package_version@';
 
-    /**
-     * @var string
-     */
-    public const RELEASE_DATE = '@release_date@';
-
     /**
      * @var int
      */

diff --git a/src/Configuration/Option.php b/src/Configuration/Option.php
@@ -170,22 +170,11 @@ final class Option
      */
     public const TEMPLATE_TYPE = 'template-type';
 
-    /**
-     * @deprecated
-     * @var string
-     */
-    public const ENABLE_EDITORCONFIG = 'enable_editorconfig';
-
     /**
      * @var string
      */
     public const AUTOLOAD_FILE_SHORT = 'a';
 
-    /**
-     * @var string
-     */
-    public const OUTPUT_FORMAT_SHORT = 'o';
-
     /**
      * @var string
      */
@@ -219,12 +208,6 @@ final class Option
      */
     public const PARALLEL_TIMEOUT_IN_SECONDS = 'parallel-timeout-in-seconds';
 
-    /**
-     * @deprecated Rector should not run on external unknown sources, as PHPStan needs to know about paths to reflect on those. Instead, provide the path directly.
-     * @var string
-     */
-    public const FOLLOW_SYMLINKS = 'follow-symlinks';
-
     /**
      * @var string
      */

diff --git a/src/Validation/RectorAssert.php b/src/Validation/RectorAssert.php
@@ -17,7 +17,7 @@ final class RectorAssert
      * @see https://regex101.com/r/PYQaPF/1
      * @var string
      */
-    public const CLASS_NAME_REGEX = '#^[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*(\\\\[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*)*$#';
+    private const CLASS_NAME_REGEX = '#^[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*(\\\\[a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*)*$#';
 
     /**
      * Assert value is valid class name

diff --git a/src/ValueObject/MethodName.php b/src/ValueObject/MethodName.php
@@ -41,12 +41,6 @@ final class MethodName
      */
     public const SET_UP = 'setUp';
 
-    /**
-     * Mostly used in unit tests
-     * @var string
-     */
-    public const TEAR_DOWN = 'tearDown';
-
     /**
      * @var string
      */

diff --git a/src/ValueObject/PhpVersionFeature.php b/src/ValueObject/PhpVersionFeature.php
@@ -4,6 +4,9 @@
 
 namespace Rector\Core\ValueObject;
 
+/**
+ * @api
+ */
 final class PhpVersionFeature
 {
     /**

diff --git a/src/ValueObject/Reporting/FileDiff.php b/src/ValueObject/Reporting/FileDiff.php
@@ -7,6 +7,7 @@
 use Nette\Utils\Strings;
 use Rector\ChangesReporting\ValueObject\RectorWithLineChange;
 use Rector\Core\Contract\Rector\RectorInterface;
+use Rector\Parallel\ValueObject\Name;
 use Symplify\EasyParallel\Contract\SerializableInterface;
 use Webmozart\Assert\Assert;
 
@@ -23,26 +24,6 @@ final class FileDiff implements SerializableInterface
      */
     private const FIRST_LINE_KEY = 'first_line';
 
-    /**
-     * @var string
-     */
-    private const KEY_RELATIVE_FILE_PATH = 'relative_file_path';
-
-    /**
-     * @var string
-     */
-    private const KEY_DIFF = 'diff';
-
-    /**
-     * @var string
-     */
-    private const KEY_DIFF_CONSOLE_FORMATTED = 'diff_console_formatted';
-
-    /**
-     * @var string
-     */
-    private const KEY_RECTORS_WITH_LINE_CHANGES = 'rectors_with_line_changes';
-
     /**
      * @param RectorWithLineChange[] $rectorsWithLineChanges
      */
@@ -110,10 +91,10 @@ public function getFirstLineNumber(): ?int
     public function jsonSerialize(): array
     {
         return [
-            self::KEY_RELATIVE_FILE_PATH => $this->relativeFilePath,
-            self::KEY_DIFF => $this->diff,
-            self::KEY_DIFF_CONSOLE_FORMATTED => $this->diffConsoleFormatted,
-            self::KEY_RECTORS_WITH_LINE_CHANGES => $this->rectorsWithLineChanges,
+            Name::RELATIVE_FILE_PATH => $this->relativeFilePath,
+            Name::DIFF => $this->diff,
+            Name::DIFF_CONSOLE_FORMATTED => $this->diffConsoleFormatted,
+            Name::RECTORS_WITH_LINE_CHANGES => $this->rectorsWithLineChanges,
         ];
     }
 
@@ -124,14 +105,14 @@ public static function decode(array $json): SerializableInterface
     {
         $rectorWithLineChanges = [];
 
-        foreach ($json[self::KEY_RECTORS_WITH_LINE_CHANGES] as $rectorWithLineChangesJson) {
+        foreach ($json[Name::RECTORS_WITH_LINE_CHANGES] as $rectorWithLineChangesJson) {
             $rectorWithLineChanges[] = RectorWithLineChange::decode($rectorWithLineChangesJson);
         }
 
         return new self(
-            $json[self::KEY_RELATIVE_FILE_PATH],
-            $json[self::KEY_DIFF],
-            $json[self::KEY_DIFF_CONSOLE_FORMATTED],
+            $json[Name::RELATIVE_FILE_PATH],
+            $json[Name::DIFF],
+            $json[Name::DIFF_CONSOLE_FORMATTED],
             $rectorWithLineChanges,
         );
     }