misc

Author: TomasVotruba

bin/dump-nodes.php

@@ -2,8 +2,6 @@
 
 declare(strict_types=1);
 
-use PhpParser\PrettyPrinter\Standard;
-use Rector\PhpParserNodesDocs\Finder\PhpFilesFinder;
 use Rector\PhpParserNodesDocs\NodeCodeSampleProvider;
 use Rector\PhpParserNodesDocs\NodeInfosFactory;
 use Rector\PhpParserNodesDocs\Printer\MarkdownNodeInfosPrinter;
@@ -12,17 +10,15 @@
 require_once __DIR__ . '/../vendor/autoload.php';
 
 $markdownNodeInfosPrinter = new MarkdownNodeInfosPrinter();
-$nodeInfosFactory = new NodeInfosFactory(
-    new NodeCodeSampleProvider(new Standard(), new PhpFilesFinder()),
-    new NodeInfoSorter()
-);
+
+$nodeInfosFactory = new NodeInfosFactory(new NodeCodeSampleProvider(), new NodeInfoSorter());
 
 $nodeInfos = $nodeInfosFactory->create();
 $printedContent = $markdownNodeInfosPrinter->print($nodeInfos);
 
 file_put_contents(getcwd() . '/README.md', $printedContent);
 
-echo sprintf('<info>Documentation for %d nodes was generated to README.md</info>' . PHP_EOL, count($nodeInfos));
+echo sprintf('Documentation for %d nodes was generated to README.md' . PHP_EOL . PHP_EOL, count($nodeInfos));
 
 // success
 exit(0);

composer.json

@@ -9,7 +9,8 @@
     "require": {
         "php": "^8.3",
         "nikic/php-parser": "^5.6",
-        "webmozart/assert": "^1.11"
+        "webmozart/assert": "^1.11",
+        "symfony/finder": "^7.3"
     },
     "require-dev": {
         "symplify/easy-coding-standard": "^12.6",

phpstan.neon

@@ -5,10 +5,4 @@ parameters:
         - bin
         - src
         - tests
-
     treatPhpDocTypesAsCertain: false
-
-    ignoreErrors:
-        -
-            path: src/Finder/PhpFilesFinder.php
-            identifier: varTag.nativeType

src/Finder/PhpFilesFinder.php

@@ -4,57 +4,25 @@
 
 namespace Rector\PhpParserNodesDocs\Finder;
 
+use Symfony\Component\Finder\Finder;
+use Symfony\Component\Finder\SplFileInfo;
 use Webmozart\Assert\Assert;
 
 final class PhpFilesFinder
 {
     /**
      * @param string[] $paths
-     * @return string[]
+     * @return SplFileInfo[]
      */
-    public function findPhpFiles(array $paths): array
+    public static function find(array $paths): array
     {
-        Assert::allFileExists($paths);
+        Assert::allString($paths);
 
-        // fallback to config paths
-        $filePaths = [];
+        $finder = Finder::create()
+            ->name('*.php')
+            ->sortByName()
+            ->in($paths);
 
-        foreach ($paths as $path) {
-            if (is_file($path)) {
-                $filePaths[] = $path;
-            } else {
-                $currentFilePaths = $this->findFilesUsingGlob($path);
-                $filePaths = array_merge($filePaths, $currentFilePaths);
-            }
-        }
-
-        sort($filePaths);
-
-        Assert::allString($filePaths);
-        Assert::allFileExists($filePaths);
-
-        return $filePaths;
-    }
-
-    /**
-     * @return string[]
-     */
-    private function findFilesUsingGlob(string $directory): array
-    {
-        // Search for php files in the current directory
-        /** @var list<string> $phpFiles */
-        $phpFiles = glob($directory . '/*.php');
-
-        // recursively search in subdirectories
-
-        /** @var string[] $subdirectories */
-        $subdirectories = glob($directory . '/*', GLOB_ONLYDIR);
-
-        foreach ($subdirectories as $subdirectory) {
-            // Merge the results from subdirectories
-            $phpFiles = array_merge($phpFiles, $this->findFilesUsingGlob($subdirectory));
-        }
-
-        return $phpFiles;
+        return iterator_to_array($finder->getIterator());
     }
 }

src/NodeCodeSampleProvider.php

@@ -12,34 +12,35 @@
 
 final class NodeCodeSampleProvider
 {
+    private Standard $standardPrinter;
+
     public function __construct(
-        private readonly Standard $standard,
-        private readonly PhpFilesFinder $phpFilesFinder,
     ) {
+        $this->standardPrinter = new Standard();
     }
 
     /**
      * @return array<class-string<Node>, array<int, NodeCodeSample>>
      */
     public function provide(): array
     {
-        $phpFilePaths = $this->phpFilesFinder->findPhpFiles([__DIR__ . '/../snippet']);
+        $phpFileInfos = PhpFilesFinder::find([__DIR__ . '/../snippet']);
 
         $nodeCodeSamplesByNodeClass = [];
 
-        foreach ($phpFilePaths as $phpFilePath) {
+        foreach ($phpFileInfos as $phpFileInfo) {
             /** @var Node $node */
-            $node = include $phpFilePath;
-
-            /** @var string $fileContents */
-            $fileContents = file_get_contents($phpFilePath);
+            $node = include $phpFileInfo->getRealPath();
 
-            $errorMessage = sprintf('The "%s" file must return "%s" instance ', $phpFilePath, Node::class);
+            $errorMessage = sprintf('The "%s" file must return "%s" instance ', $phpFileInfo, Node::class);
             Assert::isInstanceOf($node, Node::class, $errorMessage);
 
+            /** @var string $fileContents */
+            $fileContents = $phpFileInfo->getContents();
+
             $nodeClass = $node::class;
 
-            $printedContent = $this->standard->prettyPrint([$node]);
+            $printedContent = $this->standardPrinter->prettyPrint([$node]);
 
             $nodeCodeSamplesByNodeClass[$nodeClass][] = new NodeCodeSample($fileContents, $printedContent);
         }

tests/NodeInfosFactoryTest.php

@@ -4,9 +4,7 @@
 
 namespace Rector\PhpParserNodesDocs\Tests;
 
-use PhpParser\PrettyPrinter\Standard;
 use PHPUnit\Framework\TestCase;
-use Rector\PhpParserNodesDocs\Finder\PhpFilesFinder;
 use Rector\PhpParserNodesDocs\NodeCodeSampleProvider;
 use Rector\PhpParserNodesDocs\NodeInfosFactory;
 use Rector\PhpParserNodesDocs\Sorter\NodeInfoSorter;
@@ -15,10 +13,7 @@ final class NodeInfosFactoryTest extends TestCase
 {
     public function test(): void
     {
-        $nodeInfosFactory = new NodeInfosFactory(
-            new NodeCodeSampleProvider(new Standard(), new PhpFilesFinder()),
-            new NodeInfoSorter()
-        );
+        $nodeInfosFactory = new NodeInfosFactory(new NodeCodeSampleProvider(), new NodeInfoSorter());
 
         $nodeInfos = $nodeInfosFactory->create();