tv misc

src/Command/PrivatizeConstantsCommand.php

@@ -6,13 +6,10 @@
 
 use Nette\Utils\FileSystem;
 use Nette\Utils\Strings;
-use PhpParser\NodeTraverser;
 use Rector\SwissKnife\Contract\ClassConstantFetchInterface;
 use Rector\SwissKnife\Finder\PhpFilesFinder;
-use Rector\SwissKnife\PhpParser\CachedPhpParser;
-use Rector\SwissKnife\PhpParser\ClassConstantFetchFinder;
-use Rector\SwissKnife\PhpParser\NodeTraverserFactory;
-use Rector\SwissKnife\PhpParser\NodeVisitor\FindNonPrivateClassConstNodeVisitor;
+use Rector\SwissKnife\PhpParser\Finder\ClassConstantFetchFinder;
+use Rector\SwissKnife\PhpParser\Finder\ClassConstFinder;
 use Rector\SwissKnife\ValueObject\ClassConstant;
 use Rector\SwissKnife\ValueObject\ClassConstantFetch\CurrentClassConstantFetch;
 use Symfony\Component\Console\Command\Command;
@@ -27,8 +24,8 @@ final class PrivatizeConstantsCommand extends Command
 {
     public function __construct(
         private readonly SymfonyStyle $symfonyStyle,
-        private readonly CachedPhpParser $cachedPhpParser,
         private readonly ClassConstantFetchFinder $classConstantFetchFinder,
+        private readonly ClassConstFinder $classConstFinder,
     ) {
         parent::__construct();
     }
@@ -87,28 +84,17 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         return self::SUCCESS;
     }
 
-    private function parseAndTraverseFile(SplFileInfo $phpFileInfo, NodeTraverser $nodeTraverser): void
-    {
-        $fileStmts = $this->cachedPhpParser->parseFile($phpFileInfo->getRealPath());
-        $nodeTraverser->traverse($fileStmts);
-    }
-
     /**
      * @param ClassConstantFetchInterface[] $classConstantFetches
      */
     private function processFileInfo(SplFileInfo $phpFileInfo, array $classConstantFetches): void
     {
-        $findNonPrivateClassConstNodeVisitor = new FindNonPrivateClassConstNodeVisitor();
-        $nodeTraverser = NodeTraverserFactory::create($findNonPrivateClassConstNodeVisitor);
-
-        $this->parseAndTraverseFile($phpFileInfo, $nodeTraverser);
-
-        // nothing found
-        if ($findNonPrivateClassConstNodeVisitor->getClassConstants() === []) {
+        $classConstants = $this->classConstFinder->find($phpFileInfo->getRealPath());
+        if ($classConstants === []) {
             return;
         }
 
-        foreach ($findNonPrivateClassConstNodeVisitor->getClassConstants() as $classConstant) {
+        foreach ($classConstants as $classConstant) {
             if ($this->isClassConstantUsedPublicly($classConstantFetches, $classConstant)) {
                 $changedFileContents = Strings::replace(
                     $phpFileInfo->getContents(),

src/PhpParser/Finder/ClassConstFinder.php

@@ -0,0 +1,35 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\SwissKnife\PhpParser\Finder;
+
+use Rector\SwissKnife\PhpParser\CachedPhpParser;
+use Rector\SwissKnife\PhpParser\NodeTraverserFactory;
+use Rector\SwissKnife\PhpParser\NodeVisitor\FindNonPrivateClassConstNodeVisitor;
+use Rector\SwissKnife\ValueObject\ClassConstant;
+
+/**
+ * @see \Rector\SwissKnife\Tests\PhpParser\Finder\ClassConstFinder\ClassConstFinderTest
+ */
+final class ClassConstFinder
+{
+    public function __construct(
+        private CachedPhpParser $cachedPhpParser
+    ) {
+    }
+
+    /**
+     * @return ClassConstant[]
+     */
+    public function find(string $filePath): array
+    {
+        $findNonPrivateClassConstNodeVisitor = new FindNonPrivateClassConstNodeVisitor();
+        $nodeTraverser = NodeTraverserFactory::create($findNonPrivateClassConstNodeVisitor);
+
+        $fileStmts = $this->cachedPhpParser->parseFile($filePath);
+        $nodeTraverser->traverse($fileStmts);
+
+        return $findNonPrivateClassConstNodeVisitor->getClassConstants();
+    }
+}

src/PhpParser/ClassConstantFetchFinder.php → src/PhpParser/Finder/ClassConstantFetchFinder.php

@@ -2,11 +2,13 @@
 
 declare(strict_types=1);
 
-namespace Rector\SwissKnife\PhpParser;
+namespace Rector\SwissKnife\PhpParser\Finder;
 
 use Rector\SwissKnife\Contract\ClassConstantFetchInterface;
 use Rector\SwissKnife\Exception\NotImplementedYetException;
 use Rector\SwissKnife\Exception\ShouldNotHappenException;
+use Rector\SwissKnife\PhpParser\CachedPhpParser;
+use Rector\SwissKnife\PhpParser\NodeTraverserFactory;
 use Rector\SwissKnife\PhpParser\NodeVisitor\FindClassConstFetchNodeVisitor;
 use Symfony\Component\Console\Helper\ProgressBar;
 use Symfony\Component\Console\Style\SymfonyStyle;

src/PhpParser/NodeVisitor/FindNonPrivateClassConstNodeVisitor.php

@@ -9,6 +9,7 @@
 use PhpParser\Node\Stmt\Class_;
 use PhpParser\NodeVisitorAbstract;
 use Rector\SwissKnife\ValueObject\ClassConstant;
+use ReflectionClass;
 use Webmozart\Assert\Assert;
 
 final class FindNonPrivateClassConstNodeVisitor extends NodeVisitorAbstract
@@ -24,14 +25,13 @@ public function enterNode(Node $node): ?Node
             return null;
         }
 
-        if ($node->isAnonymous()) {
+        if ($node->isAnonymous() || $node->isAbstract()) {
             return null;
         }
 
         Assert::isInstanceOf($node->namespacedName, Name::class);
 
         $className = $node->namespacedName->toString();
-
         foreach ($node->getConstants() as $classConst) {
             foreach ($classConst->consts as $constConst) {
                 $constantName = $constConst->name->toString();
@@ -41,6 +41,10 @@ public function enterNode(Node $node): ?Node
                     continue;
                 }
 
+                if ($this->isConstantDefinedInParentClassAlso($node, $constantName)) {
+                    continue;
+                }
+
                 $this->classConstants[] = new ClassConstant($className, $constantName, $classConst->getLine());
             }
         }
@@ -55,4 +59,21 @@ public function getClassConstants(): array
     {
         return $this->classConstants;
     }
+
+    private function isConstantDefinedInParentClassAlso(Class_ $class, string $constantName): bool
+    {
+        if (! $class->extends instanceof Node) {
+            return false;
+        }
+
+        $parentClassName = $class->extends->toString();
+        if (! class_exists($parentClassName)) {
+            return false;
+        }
+
+        $parentReflectionClass = new ReflectionClass($parentClassName);
+        $parentClassConstantNames = array_keys($parentReflectionClass->getConstants());
+
+        return in_array($constantName, $parentClassConstantNames);
+    }
 }

tests/PhpParser/Finder/ClassConstFinder/ClassConstFinderTest.php

@@ -0,0 +1,34 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\SwissKnife\Tests\PhpParser\Finder\ClassConstFinder;
+
+use Rector\SwissKnife\PhpParser\Finder\ClassConstFinder;
+use Rector\SwissKnife\Tests\AbstractTestCase;
+
+final class ClassConstFinderTest extends AbstractTestCase
+{
+    private ClassConstFinder $classConstFinder;
+
+    protected function setUp(): void
+    {
+        parent::setUp();
+
+        $this->classConstFinder = $this->make(ClassConstFinder::class);
+    }
+
+    public function testSkipParentConstant(): void
+    {
+        $classConstants = $this->classConstFinder->find(__DIR__ . '/Fixture/SomeClassWithConstants.php');
+
+        $this->assertCount(1, $classConstants);
+    }
+
+    public function testSkipAbstract(): void
+    {
+        $classConstants = $this->classConstFinder->find(__DIR__ . '/Fixture/AbstractParentClass.php');
+
+        $this->assertCount(0, $classConstants);
+    }
+}

tests/PhpParser/Finder/ClassConstFinder/Fixture/AbstractParentClass.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace Rector\SwissKnife\Tests\PhpParser\Finder\ClassConstFinder\Fixture;
+
+abstract class AbstractParentClass
+{
+    public const NAME = 'some name';
+}

tests/PhpParser/Finder/ClassConstFinder/Fixture/SomeClassWithConstants.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Rector\SwissKnife\Tests\PhpParser\Finder\ClassConstFinder\Fixture;
+
+final class SomeClassWithConstants extends AbstractParentClass
+{
+    public const NAME = 'som_value';
+
+    public const SOME_CONST = 'som_value';
+}

tests/PhpParser/ClassConstantFetchFinder/ClassConstantFetchFinderTest.php → tests/PhpParser/Finder/ClassConstantFetchFinder/ClassConstantFetchFinderTest.php

@@ -2,11 +2,11 @@
 
 declare(strict_types=1);
 
-namespace Rector\SwissKnife\Tests\PhpParser\ClassConstantFetchFinder;
+namespace Rector\SwissKnife\Tests\PhpParser\Finder\ClassConstantFetchFinder;
 
 use Rector\SwissKnife\Contract\ClassConstantFetchInterface;
 use Rector\SwissKnife\Finder\PhpFilesFinder;
-use Rector\SwissKnife\PhpParser\ClassConstantFetchFinder;
+use Rector\SwissKnife\PhpParser\Finder\ClassConstantFetchFinder;
 use Rector\SwissKnife\Tests\AbstractTestCase;
 use Rector\SwissKnife\ValueObject\ClassConstantFetch\CurrentClassConstantFetch;
 use Rector\SwissKnife\ValueObject\ClassConstantFetch\ExternalClassAccessConstantFetch;

tests/PhpParser/ClassConstantFetchFinder/Fixture/Skip/SomeEnum.php → tests/PhpParser/Finder/ClassConstantFetchFinder/Fixture/Skip/SomeEnum.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Rector\SwissKnife\Tests\PhpParser\ClassConstantFetchFinder\Fixture\Skip;
+namespace Rector\SwissKnife\Tests\PhpParser\Finder\ClassConstantFetchFinder\Fixture\Skip;
 
 enum SomeEnum
 {

tests/PhpParser/ClassConstantFetchFinder/Fixture/Skip/SomeInterface.php → tests/PhpParser/Finder/ClassConstantFetchFinder/Fixture/Skip/SomeInterface.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Rector\SwissKnife\Tests\PhpParser\ClassConstantFetchFinder\Fixture\Skip;
+namespace Rector\SwissKnife\Tests\PhpParser\Finder\ClassConstantFetchFinder\Fixture\Skip;
 
 interface SomeInterface
 {

tests/PhpParser/ClassConstantFetchFinder/Fixture/Skip/SomeTrait.php → tests/PhpParser/Finder/ClassConstantFetchFinder/Fixture/Skip/SomeTrait.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Rector\SwissKnife\Tests\PhpParser\ClassConstantFetchFinder\Fixture\Skip;
+namespace Rector\SwissKnife\Tests\PhpParser\Finder\ClassConstantFetchFinder\Fixture\Skip;
 
 trait SomeTrait
 {

tests/PhpParser/ClassConstantFetchFinder/Fixture/Standard/AnotherClassWithConstant.php → tests/PhpParser/Finder/ClassConstantFetchFinder/Fixture/Standard/AnotherClassWithConstant.php

@@ -1,6 +1,6 @@
 <?php
 
-namespace Rector\SwissKnife\Tests\PhpParser\ClassConstantFetchFinder\Fixture\Standard;
+namespace Rector\SwissKnife\Tests\PhpParser\Finder\ClassConstantFetchFinder\Fixture\Standard;
 
 final class AnotherClassWithConstant
 {

tests/PhpParser/ClassConstantFetchFinder/Fixture/Standard/SomeFileWithConstants.php → tests/PhpParser/Finder/ClassConstantFetchFinder/Fixture/Standard/SomeFileWithConstants.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace Rector\SwissKnife\Tests\PhpParser\ClassConstantFetchFinder\Fixture\Standard;
+namespace Rector\SwissKnife\Tests\PhpParser\Finder\ClassConstantFetchFinder\Fixture\Standard;
 
 final class SomeFileWithConstants
 {