add ClassNames to open to handling parent class names

TomasVotruba · Nov 8, 2023 · beb5e6e · beb5e6e
1 parent ed4843a
commit beb5e6e
Show file tree

Hide file tree

Showing 13 changed files with 204 additions and 37 deletions.
diff --git a/app/ClassNameResolver.php b/app/ClassNameResolver.php
@@ -8,6 +8,7 @@
 use PhpParser\Parser;
 use TomasVotruba\ClassLeak\NodeDecorator\FullyQualifiedNameNodeDecorator;
 use TomasVotruba\ClassLeak\NodeVisitor\ClassNameNodeVisitor;
+use TomasVotruba\ClassLeak\ValueObject\ClassNames;
 
 /**
  * @see \TomasVotruba\ClassLeak\Tests\ClassNameResolver\ClassNameResolverTest
@@ -20,7 +21,7 @@ public function __construct(
     ) {
     }
 
-    public function resolveFromFromFilePath(string $filePath): ?string
+    public function resolveFromFromFilePath(string $filePath): ?ClassNames
     {
         /** @var string $fileContents */
         $fileContents = file_get_contents($filePath);
@@ -37,6 +38,11 @@ public function resolveFromFromFilePath(string $filePath): ?string
         $nodeTraverser->addVisitor($classNameNodeVisitor);
         $nodeTraverser->traverse($stmts);
 
-        return $classNameNodeVisitor->getClassName();
+        $className = $classNameNodeVisitor->getClassName();
+        if (! is_string($className)) {
+            return null;
+        }
+
+        return new ClassNames($className, $classNameNodeVisitor->hasParentClassOrInterface());
     }
 }
diff --git a/app/Commands/CheckCommand.php b/app/Commands/CheckCommand.php
@@ -14,6 +14,7 @@
 use TomasVotruba\ClassLeak\Filtering\PossiblyUnusedClassesFilter;
 use TomasVotruba\ClassLeak\Finder\ClassNamesFinder;
 use TomasVotruba\ClassLeak\Finder\PhpFilesFinder;
+use TomasVotruba\ClassLeak\Reporting\UnusedClassesResultFactory;
 use TomasVotruba\ClassLeak\Reporting\UnusedClassReporter;
 use TomasVotruba\ClassLeak\UseImportsResolver;
 
@@ -26,6 +27,7 @@ public function __construct(
         private readonly UnusedClassReporter $unusedClassReporter,
         private readonly SymfonyStyle $symfonyStyle,
         private readonly PhpFilesFinder $phpFilesFinder,
+        private readonly UnusedClassesResultFactory $unusedClassesResultFactory,
     ) {
         parent::__construct();
     }
@@ -84,10 +86,9 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             $suffixesToSkip
         );
 
-        return $this->unusedClassReporter->reportResult(
-            $possiblyUnusedFilesWithClasses,
-            $existingFilesWithClasses
-        );
+        $unusedClassesResult = $this->unusedClassesResultFactory->create($possiblyUnusedFilesWithClasses);
+
+        return $this->unusedClassReporter->reportResult($unusedClassesResult, count($existingFilesWithClasses));
     }
 
     /**
@@ -100,7 +101,7 @@ private function resolveUsedClassNames(array $phpFilePaths, Closure $progressClo
 
         foreach ($phpFilePaths as $phpFilePath) {
             $currentUsedNames = $this->useImportsResolver->resolve($phpFilePath);
-            $usedNames = array_merge($usedNames, $currentUsedNames);
+            $usedNames = [...$usedNames, ...$currentUsedNames];
 
             $progressClosure();
         }

diff --git a/app/DependencyInjection/ContainerFactory.php b/app/DependencyInjection/ContainerFactory.php
@@ -14,6 +14,9 @@
 use Symfony\Component\Console\Style\SymfonyStyle;
 use TomasVotruba\ClassLeak\Commands\CheckCommand;
 
+/**
+ * @api
+ */
 final class ContainerFactory
 {
     /**

diff --git a/app/Filtering/PossiblyUnusedClassesFilter.php b/app/Filtering/PossiblyUnusedClassesFilter.php
@@ -61,7 +61,7 @@ public function filter(
 
         $possiblyUnusedFilesWithClasses = [];
 
-        $typesToSkip = array_merge($typesToSkip, self::DEFAULT_TYPES_TO_SKIP);
+        $typesToSkip = [...$typesToSkip, ...self::DEFAULT_TYPES_TO_SKIP];
 
         foreach ($filesWithClasses as $fileWithClass) {
             if (in_array($fileWithClass->getClassName(), $usedClassNames, true)) {

diff --git a/app/Finder/ClassNamesFinder.php b/app/Finder/ClassNamesFinder.php
@@ -5,6 +5,7 @@
 namespace TomasVotruba\ClassLeak\Finder;
 
 use TomasVotruba\ClassLeak\ClassNameResolver;
+use TomasVotruba\ClassLeak\ValueObject\ClassNames;
 use TomasVotruba\ClassLeak\ValueObject\FileWithClass;
 
 final class ClassNamesFinder
@@ -23,12 +24,16 @@ public function resolveClassNamesToCheck(array $filePaths): array
         $filesWithClasses = [];
 
         foreach ($filePaths as $filePath) {
-            $className = $this->classNameResolver->resolveFromFromFilePath($filePath);
-            if ($className === null) {
+            $classNames = $this->classNameResolver->resolveFromFromFilePath($filePath);
+            if (! $classNames instanceof ClassNames) {
                 continue;
             }
 
-            $filesWithClasses[] = new FileWithClass($filePath, $className);
+            $filesWithClasses[] = new FileWithClass(
+                $filePath,
+                $classNames->getClassName(),
+                $classNames->hasParentClassOrInterface()
+            );
         }
 
         return $filesWithClasses;

diff --git a/app/Finder/PhpFilesFinder.php b/app/Finder/PhpFilesFinder.php
@@ -27,7 +27,7 @@ public function findPhpFiles(array $paths): array
                 $filePaths[] = $path;
             } else {
                 $currentFilePaths = $this->findFilesUsingGlob($path);
-                $filePaths = array_merge($filePaths, $currentFilePaths);
+                $filePaths = [...$filePaths, ...$currentFilePaths];
             }
         }
 

diff --git a/app/NodeVisitor/ClassNameNodeVisitor.php b/app/NodeVisitor/ClassNameNodeVisitor.php
@@ -8,7 +8,9 @@
 use PhpParser\Node;
 use PhpParser\Node\Identifier;
 use PhpParser\Node\Name;
+use PhpParser\Node\Stmt\Class_;
 use PhpParser\Node\Stmt\ClassLike;
+use PhpParser\Node\Stmt\Interface_;
 use PhpParser\NodeTraverser;
 use PhpParser\NodeVisitorAbstract;
 
@@ -22,13 +24,17 @@ final class ClassNameNodeVisitor extends NodeVisitorAbstract
 
     private string|null $className = null;
 
+    private bool $hasParentClassOrInterface = false;
+
     /**
      * @param Node\Stmt[] $nodes
      * @return Node\Stmt[]
      */
     public function beforeTraverse(array $nodes): array
     {
         $this->className = null;
+        $this->hasParentClassOrInterface = false;
+
         return $nodes;
     }
 
@@ -51,6 +57,19 @@ public function enterNode(Node $node): ?int
         }
 
         $this->className = $node->namespacedName->toString();
+        if ($node instanceof Class_) {
+            if ($node->extends instanceof Name) {
+                $this->hasParentClassOrInterface = true;
+            }
+
+            if ($node->implements !== []) {
+                $this->hasParentClassOrInterface = true;
+            }
+        }
+
+        if ($node instanceof Interface_ && $node->extends !== []) {
+            $this->hasParentClassOrInterface = true;
+        }
 
         return NodeTraverser::DONT_TRAVERSE_CURRENT_AND_CHILDREN;
     }
@@ -60,6 +79,11 @@ public function getClassName(): ?string
         return $this->className;
     }
 
+    public function hasParentClassOrInterface(): bool
+    {
+        return $this->hasParentClassOrInterface;
+    }
+
     private function hasApiTag(ClassLike $classLike): bool
     {
         $doc = $classLike->getDocComment();

diff --git a/app/Reporting/UnusedClassReporter.php b/app/Reporting/UnusedClassReporter.php
@@ -7,6 +7,7 @@
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Style\SymfonyStyle;
 use TomasVotruba\ClassLeak\ValueObject\FileWithClass;
+use TomasVotruba\ClassLeak\ValueObject\UnusedClassesResult;
 
 final class UnusedClassReporter
 {
@@ -16,36 +17,51 @@ public function __construct(
     }
 
     /**
-     * @param FileWithClass[] $unusedFilesWithClasses
-     * @param FileWithClass[] $existingFilesWithClasses
      * @return Command::*
      */
-    public function reportResult(array $unusedFilesWithClasses, array $existingFilesWithClasses): int
+    public function reportResult(UnusedClassesResult $unusedClassesResult, int $classCount): int
     {
         $this->symfonyStyle->newLine(2);
 
-        if ($unusedFilesWithClasses === []) {
-            $successMessage = sprintf(
-                'All the %d services are used. Great job!',
-                count($existingFilesWithClasses),
-            );
-            $this->symfonyStyle->success($successMessage);
+        if ($unusedClassesResult->hasFilesWithClasses()) {
+            $this->symfonyStyle->success(sprintf('All the %d services are used. Great job!', $classCount));
+
             return Command::SUCCESS;
         }
 
-        foreach ($unusedFilesWithClasses as $unusedFileWithClass) {
-            $this->symfonyStyle->writeln(' * ' . $unusedFileWithClass->getClassName());
-            $this->symfonyStyle->writeln($unusedFileWithClass->getFilePath());
+        // separate with and without parent, as first one can be removed more easily
+
+        if ($unusedClassesResult->getWithParentsFileWithClasses() !== []) {
+            $this->symfonyStyle->title('Classes with a parent/interface - possibly used by type');
+            $this->reportFileWithClasses($unusedClassesResult->getWithParentsFileWithClasses());
+        }
+
+        if ($unusedClassesResult->getParentLessFileWithClasses() !== []) {
             $this->symfonyStyle->newLine();
+
+            $this->symfonyStyle->title('Classes without any parent/interface - easier to remove');
+            $this->reportFileWithClasses($unusedClassesResult->getParentLessFileWithClasses());
         }
 
-        $successMessage = sprintf(
-            'Found %d unused classes. Check them, remove them or correct the command.',
-            count($unusedFilesWithClasses)
-        );
+        $this->symfonyStyle->newLine();
 
-        $this->symfonyStyle->error($successMessage);
+        $this->symfonyStyle->error(sprintf(
+            'Found %d unused classes. Check and remove them or skip them using "--skip-type" option',
+            $unusedClassesResult->getCount()
+        ));
 
         return Command::FAILURE;
     }
+
+    /**
+     * @param FileWithClass[] $fileWithClasses
+     */
+    private function reportFileWithClasses(array $fileWithClasses): void
+    {
+        foreach ($fileWithClasses as $fileWithClass) {
+            $this->symfonyStyle->writeln(' * ' . $fileWithClass->getClassName());
+            $this->symfonyStyle->writeln($fileWithClass->getFilePath());
+            $this->symfonyStyle->newLine();
+        }
+    }
 }
diff --git a/app/Reporting/UnusedClassesResultFactory.php b/app/Reporting/UnusedClassesResultFactory.php
@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+namespace TomasVotruba\ClassLeak\Reporting;
+
+use TomasVotruba\ClassLeak\ValueObject\FileWithClass;
+use TomasVotruba\ClassLeak\ValueObject\UnusedClassesResult;
+
+final class UnusedClassesResultFactory
+{
+    /**
+     * @param FileWithClass[] $unusedFilesWithClasses
+     */
+    public function create(array $unusedFilesWithClasses): UnusedClassesResult
+    {
+        $parentLessFileWithClasses = [];
+        $withParentsFileWithClasses = [];
+
+        foreach ($unusedFilesWithClasses as $unusedFileWithClass) {
+            if ($unusedFileWithClass->hasParentClassOrInterface()) {
+                $withParentsFileWithClasses[] = $unusedFileWithClass;
+            } else {
+                $parentLessFileWithClasses[] = $unusedFileWithClass;
+            }
+        }
+
+        return new UnusedClassesResult($parentLessFileWithClasses, $withParentsFileWithClasses);
+    }
+}
diff --git a/app/ValueObject/ClassNames.php b/app/ValueObject/ClassNames.php
@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types=1);
+
+namespace TomasVotruba\ClassLeak\ValueObject;
+
+final class ClassNames
+{
+    public function __construct(
+        private readonly string $className,
+        private readonly bool $hasParentClassOrInterface
+    ) {
+    }
+
+    public function getClassName(): string
+    {
+        return $this->className;
+    }
+
+    public function hasParentClassOrInterface(): bool
+    {
+        return $this->hasParentClassOrInterface;
+    }
+}
diff --git a/app/ValueObject/FileWithClass.php b/app/ValueObject/FileWithClass.php
@@ -10,7 +10,8 @@ final class FileWithClass
 {
     public function __construct(
         private readonly string $filePath,
-        private readonly string $className
+        private readonly string $className,
+        private readonly bool $hasParentClassOrInterface
     ) {
     }
 
@@ -23,4 +24,9 @@ public function getFilePath(): string
     {
         return StaticRelativeFilePathHelper::resolveFromCwd($this->filePath);
     }
+
+    public function hasParentClassOrInterface(): bool
+    {
+        return $this->hasParentClassOrInterface;
+    }
 }
diff --git a/app/ValueObject/UnusedClassesResult.php b/app/ValueObject/UnusedClassesResult.php
@@ -0,0 +1,48 @@
+<?php
+
+declare(strict_types=1);
+
+namespace TomasVotruba\ClassLeak\ValueObject;
+
+final class UnusedClassesResult
+{
+    /**
+     * @param FileWithClass[] $withParentsFileWithClasses
+     * @param FileWithClass[] $parentLessFileWithClasses
+     */
+    public function __construct(
+        private readonly array $parentLessFileWithClasses,
+        private readonly array $withParentsFileWithClasses,
+    ) {
+    }
+
+    /**
+     * @return FileWithClass[]
+     */
+    public function getParentLessFileWithClasses(): array
+    {
+        return $this->parentLessFileWithClasses;
+    }
+
+    /**
+     * @return FileWithClass[]
+     */
+    public function getWithParentsFileWithClasses(): array
+    {
+        return $this->withParentsFileWithClasses;
+    }
+
+    public function hasFilesWithClasses(): bool
+    {
+        if ($this->parentLessFileWithClasses !== []) {
+            return false;
+        }
+
+        return $this->withParentsFileWithClasses !== [];
+    }
+
+    public function getCount(): int
+    {
+        return count($this->parentLessFileWithClasses) + count($this->withParentsFileWithClasses);
+    }
+}
-Original file line number
+Diff line change
@@ Expand Up / @@ -14,6 +14,9 @@ @@
     use Symfony\Component\Console\Style\SymfonyStyle;
     use TomasVotruba\ClassLeak\Commands\CheckCommand;
+    /**
+     * @api
+     */
     final class ContainerFactory
     {
         /**
@@ Expand Down @@