Add regex search command for easy quick stats

rectorphp · Jan 7, 2025 · bf913bf · bf913bf
1 parent 4002e0e
commit bf913bf
Show file tree

Hide file tree

Showing 17 changed files with 133 additions and 55 deletions.
diff --git a/src/Behastan/Behastan.php b/src/Behastan/Behastan.php
@@ -17,12 +17,12 @@
 /**
  * @see \Rector\SwissKnife\Tests\Behastan\Behastan\BehastanTest
  */
-final class Behastan
+final readonly class Behastan
 {
     public function __construct(
-        private readonly SymfonyStyle $symfonyStyle,
-        private readonly DefinitionMasksResolver $definitionMasksResolver,
-        private readonly UsedInstructionResolver $usedInstructionResolver
+        private SymfonyStyle $symfonyStyle,
+        private DefinitionMasksResolver $definitionMasksResolver,
+        private UsedInstructionResolver $usedInstructionResolver
     ) {
     }
 

diff --git a/src/Behastan/Command/BehastanCommand.php b/src/Behastan/Command/BehastanCommand.php
@@ -43,13 +43,13 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         Assert::allDirectory($testDirectories);
 
         $featureFiles = $this->behatMetafilesFinder->findFeatureFiles($testDirectories);
-        if (count($featureFiles) === 0) {
+        if ($featureFiles === []) {
             $this->symfonyStyle->error('No *.feature files found. Please provide correct test directory');
             return self::FAILURE;
         }
 
         $contextFiles = $this->behatMetafilesFinder->findContextFiles($testDirectories);
-        if (count($contextFiles) === 0) {
+        if ($contextFiles === []) {
             $this->symfonyStyle->error('No *Context.php files found. Please provide correct test directory');
             return self::FAILURE;
         }

diff --git a/src/Behastan/Finder/BehatMetafilesFinder.php b/src/Behastan/Finder/BehatMetafilesFinder.php
@@ -19,13 +19,12 @@ public function findContextFiles(array $directories): array
         Assert::allString($directories);
         Assert::allDirectory($directories);
 
-        $phpFilesFinder = Finder::create()
+        $filesFinder = Finder::create()
             ->files()
             ->name('*Context.php')
-            ->in($directories)
-            ->getIterator();
+            ->in($directories);
 
-        return iterator_to_array($phpFilesFinder);
+        return iterator_to_array($filesFinder->getIterator());
     }
 
     /**
@@ -38,12 +37,11 @@ public function findFeatureFiles(array $directories): array
         Assert::allString($directories);
         Assert::allDirectory($directories);
 
-        $featureFilesFinder = Finder::create()
+        $filesFinder = Finder::create()
             ->files()
             ->name('*.feature')
-            ->in($directories)
-            ->getIterator();
+            ->in($directories);
 
-        return iterator_to_array($featureFilesFinder);
+        return iterator_to_array($filesFinder->getIterator());
     }
 }
diff --git a/src/Behastan/ValueObject/MaskCollection.php b/src/Behastan/ValueObject/MaskCollection.php
@@ -4,13 +4,13 @@
 
 namespace Rector\SwissKnife\Behastan\ValueObject;
 
-final class MaskCollection
+final readonly class MaskCollection
 {
     /**
      * @param AbstractMask[] $masks
      */
     public function __construct(
-        private readonly array $masks
+        private array $masks
     ) {
     }
 

diff --git a/src/Command/SearchRegexCommand.php b/src/Command/SearchRegexCommand.php
@@ -0,0 +1,80 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\SwissKnife\Command;
+
+use Nette\Utils\Strings;
+use Rector\SwissKnife\Finder\PhpFilesFinder;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Console\Style\SymfonyStyle;
+use Webmozart\Assert\Assert;
+
+final class SearchRegexCommand extends Command
+{
+    public function __construct(
+        private readonly SymfonyStyle $symfonyStyle,
+    ) {
+        parent::__construct();
+    }
+
+    protected function configure(): void
+    {
+        $this->setName('search-regex');
+
+        $this->addArgument(
+            'regex',
+            InputArgument::REQUIRED,
+            'Code snippet to look in PHP files in the whole codebase'
+        );
+
+        $this->addOption('project-directory', null, InputOption::VALUE_REQUIRED, 'Project directory', getcwd());
+
+        $this->setDescription('Search for regex in PHP files of the whole codebase');
+    }
+
+    protected function execute(InputInterface $input, OutputInterface $output): int
+    {
+        $regex = (string) $input->getArgument('regex');
+
+        $projectDirectory = (string) $input->getOption('project-directory');
+        Assert::directory($projectDirectory);
+
+        $phpFileInfos = PhpFilesFinder::find([$projectDirectory]);
+
+        $message = sprintf('Going through %d *.php files', count($phpFileInfos));
+        $this->symfonyStyle->writeln($message);
+
+        $this->symfonyStyle->writeln('Searching for regex: ' . $regex);
+        $this->symfonyStyle->newLine();
+
+        $foundCasesCount = 0;
+        $markedFileCount = 0;
+
+        $progressBar = $this->symfonyStyle->createProgressBar(count($phpFileInfos));
+
+        foreach ($phpFileInfos as $phpFileInfo) {
+            $matches = Strings::matchAll($phpFileInfo->getContents(), $regex);
+            $currentMatchesCount = count($matches);
+            if ($currentMatchesCount === 0) {
+                continue;
+            }
+
+            $foundCasesCount += $currentMatchesCount;
+            ++$markedFileCount;
+
+            $progressBar->advance();
+        }
+
+        $progressBar->finish();
+
+        $this->symfonyStyle->newLine(2);
+        $this->symfonyStyle->success(sprintf('Found %d cases in %d files', $foundCasesCount, $markedFileCount));
+
+        return self::SUCCESS;
+    }
+}
diff --git a/src/DependencyInjection/ContainerFactory.php b/src/DependencyInjection/ContainerFactory.php
@@ -16,6 +16,7 @@
 use Rector\SwissKnife\Command\NamespaceToPSR4Command;
 use Rector\SwissKnife\Command\PrettyJsonCommand;
 use Rector\SwissKnife\Command\PrivatizeConstantsCommand;
+use Rector\SwissKnife\Command\SearchRegexCommand;
 use Rector\SwissKnife\Testing\Command\DetectUnitTestsCommand;
 use Symfony\Component\Console\Application;
 use Symfony\Component\Console\Input\ArrayInput;
@@ -48,6 +49,7 @@ public function create(): Container
                 $container->make(PrivatizeConstantsCommand::class),
 
                 $container->make(BehastanCommand::class),
+                $container->make(SearchRegexCommand::class),
             ];
 
             $application->addCommands($commands);

diff --git a/src/Finder/PhpFilesFinder.php b/src/Finder/PhpFilesFinder.php
@@ -40,6 +40,9 @@ private static function createFinderForPathsAndExcludedPaths(array $paths, array
             ->in($paths)
             ->name('*.php')
             ->notPath('vendor')
+            ->notPath('var')
+            ->notPath('data-fixtures')
+            ->notPath('node_modules')
             // exclude paths, as notPaths() does no work
             ->filter(static function (SplFileInfo $splFileInfo) use ($excludedPaths): bool {
                 foreach ($excludedPaths as $excludedPath) {

diff --git a/src/PhpParser/CachedPhpParser.php b/src/PhpParser/CachedPhpParser.php
@@ -8,6 +8,8 @@
 use PhpParser\Node\Stmt;
 use PhpParser\NodeVisitor\NameResolver;
 use PhpParser\Parser;
+use RuntimeException;
+use Throwable;
 
 /**
  * Parse file just once
@@ -36,8 +38,8 @@ public function parseFile(string $filePath): array
         $fileContents = FileSystem::read($filePath);
         try {
             $stmts = $this->phpParser->parse($fileContents);
-        } catch (\Throwable $throwable) {
-            throw new \RuntimeException(sprintf(
+        } catch (Throwable $throwable) {
+            throw new RuntimeException(sprintf(
                 'Could not parse file "%s": %s',
                 $filePath,
                 $throwable->getMessage()

diff --git a/src/PhpParser/Finder/ClassConstFinder.php b/src/PhpParser/Finder/ClassConstFinder.php
@@ -12,7 +12,7 @@
 /**
  * @see \Rector\SwissKnife\Tests\PhpParser\Finder\ClassConstFinder\ClassConstFinderTest
  */
-final class ClassConstFinder
+final readonly class ClassConstFinder
 {
     public function __construct(
         private CachedPhpParser $cachedPhpParser

diff --git a/src/PhpParser/Finder/ClassConstantFetchFinder.php b/src/PhpParser/Finder/ClassConstantFetchFinder.php
@@ -17,7 +17,7 @@
 /**
  * @see \Rector\SwissKnife\Tests\PhpParser\ClassConstantFetchFinder\ClassConstantFetchFinderTest
  */
-final class ClassConstantFetchFinder
+final readonly class ClassConstantFetchFinder
 {
     public function __construct(
         private CachedPhpParser $cachedPhpParser,

diff --git a/src/PhpParser/NodeVisitor/FindClassConstFetchNodeVisitor.php b/src/PhpParser/NodeVisitor/FindClassConstFetchNodeVisitor.php
@@ -81,13 +81,15 @@ public function enterNode(Node $node): Node|int|null
                 $this->classConstantFetches[] = new CurrentClassConstantFetch($currentClassName, $constantName);
                 return $node;
             }
+
             // check if parent class is vendor
             if ($this->currentClass->extends instanceof Name) {
                 $parentClassName = $this->currentClass->extends->toString();
                 if ($this->isVendorClassName($parentClassName)) {
                     return null;
                 }
             }
+
             $this->classConstantFetches[] = new ParentClassConstantFetch($currentClassName, $constantName);
             return $node;
         }

diff --git a/src/PhpParser/NodeVisitor/MockedClassNameCollectingNodeVisitor.php b/src/PhpParser/NodeVisitor/MockedClassNameCollectingNodeVisitor.php
@@ -32,13 +32,7 @@ public function enterNode(Node $node): ?Node
         }
 
         $methodName = $node->name->toString();
-        $mockMethodNames = [
-            'createMock',
-            'createPartialMock',
-            'getMock',
-            'getMockBuilder',
-            'mock',
-        ];
+        $mockMethodNames = ['createMock', 'createPartialMock', 'getMock', 'getMockBuilder', 'mock'];
         if (! in_array($methodName, $mockMethodNames, true)) {
             return null;
         }

diff --git a/src/Testing/MockWire.php b/src/Testing/MockWire.php
@@ -6,7 +6,9 @@
 
 use InvalidArgumentException;
 use PHPUnit\Framework\MockObject\MockObject;
+use PHPUnit\Framework\TestCase;
 use ReflectionClass;
+use ReflectionMethod;
 use ReflectionNamedType;
 use ReflectionParameter;
 
@@ -60,10 +62,10 @@ public static function create(string $class, array $constructorDependencies = []
             ));
         }
 
-        $classReflection = new ReflectionClass($class);
-        $constructorClassMethod = $classReflection->getConstructor();
+        $reflectionClass = new ReflectionClass($class);
+        $constructorClassMethod = $reflectionClass->getConstructor();
 
-        if (! $constructorClassMethod instanceof \ReflectionMethod) {
+        if (! $constructorClassMethod instanceof ReflectionMethod) {
             // no dependencies, create it directly
             return new $class();
         }
@@ -79,14 +81,13 @@ public static function create(string $class, array $constructorDependencies = []
 
     /**
      * @param object[] $constructorDependencies
-     * @return object|MockObject
      */
     private static function matchPassedMockOrCreate(
         array $constructorDependencies,
         ReflectionParameter $reflectionParameter
     ): object {
         if (! $reflectionParameter->getType() instanceof ReflectionNamedType) {
-            throw new \InvalidArgumentException(sprintf(
+            throw new InvalidArgumentException(sprintf(
                 'Only typed parameters can be automocked. Provide the typehint for "%s" param',
                 $reflectionParameter->getName()
             ));
@@ -106,16 +107,16 @@ private static function matchPassedMockOrCreate(
             }
 
             // is bare object type equal to reflection type?
-            if (get_class($constructorDependency) === $parameterType) {
+            if ($constructorDependency::class === $parameterType) {
                 return $constructorDependency;
             }
         }
 
         // fallback to directly created mock
         // support for PHPUnit 10 and 9
-        $testCaseReflectionClass = new ReflectionClass('PHPUnit\Framework\TestCase');
+        $testCaseReflectionClass = new ReflectionClass(TestCase::class);
         $testCaseConstructor = $testCaseReflectionClass->getConstructor();
-        if ($testCaseConstructor instanceof \ReflectionMethod && $testCaseConstructor->getNumberOfRequiredParameters() > 0) {
+        if ($testCaseConstructor instanceof ReflectionMethod && $testCaseConstructor->getNumberOfRequiredParameters() > 0) {
             $phpunitMocker = new PHPUnitMocker('testName');
         } else {
             $phpunitMocker = new PHPUnitMocker();

diff --git a/src/Twig/TwigTemplateConstantExtractor.php b/src/Twig/TwigTemplateConstantExtractor.php
@@ -47,11 +47,11 @@ private function findClassConstantFetchesInFile(string $filePath): array
             $constantMatchValue = $constantMatch['constant'];
 
             // global constant → skip
-            if (! str_contains($constantMatchValue, '::')) {
+            if (! str_contains((string) $constantMatchValue, '::')) {
                 continue;
             }
 
-            [$className, $constantName] = explode('::', $constantMatchValue);
+            [$className, $constantName] = explode('::', (string) $constantMatchValue);
             $className = str_replace('\\\\', '\\', $className);
 
             $externalClassAccessConstantFetches[] = new ExternalClassAccessConstantFetch($className, $constantName);

diff --git a/tests/PhpParser/Finder/ClassConstantFetchFinder/ClassConstantFetchFinderTest.php b/tests/PhpParser/Finder/ClassConstantFetchFinder/ClassConstantFetchFinderTest.php
@@ -10,18 +10,19 @@
 use Rector\SwissKnife\Tests\AbstractTestCase;
 use Rector\SwissKnife\ValueObject\ClassConstantFetch\CurrentClassConstantFetch;
 use Rector\SwissKnife\ValueObject\ClassConstantFetch\ExternalClassAccessConstantFetch;
+use RuntimeException;
 use Symfony\Component\Console\Helper\ProgressBar;
 use Symfony\Component\Console\Output\NullOutput;
 
 final class ClassConstantFetchFinderTest extends AbstractTestCase
 {
-    private ClassConstantFetchFinder $classConstantsFetchFinder;
+    private ClassConstantFetchFinder $classConstantFetchFinder;
 
     protected function setUp(): void
     {
         parent::setUp();
 
-        $this->classConstantsFetchFinder = $this->make(ClassConstantFetchFinder::class);
+        $this->classConstantFetchFinder = $this->make(ClassConstantFetchFinder::class);
     }
 
     public function testSkipInterfaceTraitAndEnum(): void
@@ -44,15 +45,15 @@ public function test(): void
 
     public function testParseError(): void
     {
-        $this->expectException(\RuntimeException::class);
+        $this->expectException(RuntimeException::class);
         $this->expectExceptionMessage(
             'Could not parse file "' . __DIR__ . '/Fixture/Error/ParseError.php": Syntax error, unexpected T_STRING on line 6'
         );
 
         $directory = __DIR__ . '/Fixture/Error';
         $progressBar = new ProgressBar(new NullOutput());
         $fileInfos = PhpFilesFinder::find([$directory]);
-        $this->classConstantsFetchFinder->find($fileInfos, $progressBar, false);
+        $this->classConstantFetchFinder->find($fileInfos, $progressBar, false);
     }
 
     /**
@@ -63,6 +64,6 @@ private function findInDirectory(string $directory): array
         $progressBar = new ProgressBar(new NullOutput());
         $fileInfos = PhpFilesFinder::find([$directory]);
 
-        return $this->classConstantsFetchFinder->find($fileInfos, $progressBar, false);
+        return $this->classConstantFetchFinder->find($fileInfos, $progressBar, false);
     }
 }