add comment analyze as visitor

Author: savinmikhail

comments_density.php

@@ -24,7 +24,5 @@
         'src',
     ],
     docblockConfigDTO: new MissingDocblockConfigDTO(),
-    disable: [
-        'missingDocBlock',
-    ]
+    disable: []
 );

src/AnalyzeComments/Analyzer/CommentFinder.php

@@ -4,40 +4,58 @@
 
 namespace SavinMikhail\CommentsDensity\AnalyzeComments\Analyzer;
 
-use PhpToken;
+use PhpParser\NodeTraverser;
+use PhpParser\Parser;
+use PhpParser\ParserFactory;
 use SavinMikhail\CommentsDensity\AnalyzeComments\Analyzer\DTO\Output\CommentDTO;
+use SavinMikhail\CommentsDensity\AnalyzeComments\Analyzer\Visitors\Checkers\NodeNeedsDocblockChecker;
+use SavinMikhail\CommentsDensity\AnalyzeComments\Analyzer\Visitors\CommentVisitor;
+use SavinMikhail\CommentsDensity\AnalyzeComments\Analyzer\Visitors\MissingDocBlockVisitor;
 use SavinMikhail\CommentsDensity\AnalyzeComments\Comments\CommentTypeFactory;
 use SavinMikhail\CommentsDensity\AnalyzeComments\Config\DTO\ConfigDTO;
 use SavinMikhail\CommentsDensity\AnalyzeComments\MissingDocblock\MissingDocBlockAnalyzer;
-
-use function array_merge;
 use function in_array;
 
-use const T_COMMENT;
-use const T_DOC_COMMENT;
-
 final readonly class CommentFinder
 {
+    private Parser $parser;
+
     public function __construct(
         private CommentTypeFactory $commentFactory,
         private ConfigDTO $configDTO,
         private MissingDocBlockAnalyzer $missingDocBlockAnalyzer,
-    ) {}
+        ?Parser $parser = null,
+    ) {
+        $this->parser = $parser ?? (new ParserFactory())->createForHostVersion();
+    }
 
     /**
      * @return CommentDTO[]
      */
     public function run(string $content, string $filename): array
     {
-        $tokens = PhpToken::tokenize($content);
+        $traverser = new NodeTraverser();
 
-        $comments = $this->getCommentsFromFile($tokens, $filename);
+//        $nameResolverVisitor = new NameResolver();
+//        $traverser->addVisitor($nameResolverVisitor);
+
+        $missingDocBlockVisitor = new MissingDocBlockVisitor(
+            $filename,
+            new NodeNeedsDocblockChecker($this->configDTO->docblockConfigDTO),
+        );
         if ($this->shouldAnalyzeMissingDocBlocks()) {
-            $missingDocBlocks = $this->missingDocBlockAnalyzer->getMissingDocblocks($content, $filename);
-            $comments = array_merge($missingDocBlocks, $comments);
+            $traverser->addVisitor($missingDocBlockVisitor);
         }
 
-        return $comments;
+        $commentVisitor = new CommentVisitor(
+            $filename,
+            $this->commentFactory,
+        );
+        $traverser->addVisitor($commentVisitor);
+
+        $traverser->traverse($this->parser->parse($content));
+
+        return [...$missingDocBlockVisitor->missingDocBlocks, ...$commentVisitor->comments];
     }
 
     private function shouldAnalyzeMissingDocBlocks(): bool
@@ -50,31 +68,4 @@ private function shouldAnalyzeMissingDocBlocks(): bool
                 true,
             );
     }
-
-    /**
-     * @param PhpToken[] $tokens
-     * @return CommentDTO[]
-     */
-    private function getCommentsFromFile(array $tokens, string $filename): array
-    {
-        $comments = [];
-        foreach ($tokens as $token) {
-            if ($token->is([T_COMMENT, T_DOC_COMMENT])) {
-                continue;
-            }
-            $commentType = $this->commentFactory->classifyComment($token->text);
-            if ($commentType) {
-                $comments[] =
-                    new CommentDTO(
-                        $commentType->getName(),
-                        $commentType->getColor(),
-                        $filename,
-                        $token->line,
-                        $token->text,
-                    );
-            }
-        }
-
-        return $comments;
-    }
 }

…rs/Checkers/NodeNeedsDocblockChecker.php …rs/Checkers/NodeNeedsDocblockChecker.phpsrc/AnalyzeComments/MissingDocblock/Visitors/Checkers/NodeNeedsDocblockChecker.php renamed to src/AnalyzeComments/Analyzer/Visitors/Checkers/NodeNeedsDocblockChecker.php src/AnalyzeComments/MissingDocblock/Visitors/Checkers/NodeNeedsDocblockChecker.php renamed to src/AnalyzeComments/Analyzer/Visitors/Checkers/NodeNeedsDocblockChecker.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace SavinMikhail\CommentsDensity\AnalyzeComments\MissingDocblock\Visitors\Checkers;
+namespace SavinMikhail\CommentsDensity\AnalyzeComments\Analyzer\Visitors\Checkers;
 
 use PhpParser\Node;
 use PhpParser\Node\Stmt\Class_;

src/AnalyzeComments/Analyzer/Visitors/CommentVisitor.php

@@ -0,0 +1,41 @@
+<?php
+
+namespace SavinMikhail\CommentsDensity\AnalyzeComments\Analyzer\Visitors;
+
+use PhpParser\Node;
+use PhpParser\NodeVisitorAbstract;
+use SavinMikhail\CommentsDensity\AnalyzeComments\Analyzer\DTO\Output\CommentDTO;
+use SavinMikhail\CommentsDensity\AnalyzeComments\Comments\CommentTypeFactory;
+use SavinMikhail\CommentsDensity\AnalyzeComments\MissingDocblock\MissingDocBlockAnalyzer;
+
+final class CommentVisitor extends NodeVisitorAbstract
+{
+    /** @var CommentDTO[] */
+    public array $comments = [];
+
+    public function __construct(
+        private readonly string $filename,
+        private readonly CommentTypeFactory $commentFactory,
+    ) {}
+
+    public function enterNode(Node $node): null
+    {
+        $comments = array_filter([$node->getDocComment(), ...$node->getComments()]);
+        foreach ($comments as $comment) {
+            $commentType = $this->commentFactory->classifyComment($comment->getText());
+            if ($commentType === null) {
+                continue;
+            }
+            $this->comments[] =
+                new CommentDTO(
+                    $commentType->getName(),
+                    $commentType->getColor(),
+                    $this->filename,
+                    $comment->getStartLine(),
+                    $comment->getText(),
+                );
+        }
+
+        return null;
+    }
+}

…lock/Visitors/MissingDocBlockVisitor.php …yzer/Visitors/MissingDocBlockVisitor.phpsrc/AnalyzeComments/MissingDocblock/Visitors/MissingDocBlockVisitor.php renamed to src/AnalyzeComments/Analyzer/Visitors/MissingDocBlockVisitor.php src/AnalyzeComments/MissingDocblock/Visitors/MissingDocBlockVisitor.php renamed to src/AnalyzeComments/Analyzer/Visitors/MissingDocBlockVisitor.php

@@ -2,13 +2,13 @@
 
 declare(strict_types=1);
 
-namespace SavinMikhail\CommentsDensity\AnalyzeComments\MissingDocblock\Visitors;
+namespace SavinMikhail\CommentsDensity\AnalyzeComments\Analyzer\Visitors;
 
 use PhpParser\Node;
 use PhpParser\NodeVisitorAbstract;
 use SavinMikhail\CommentsDensity\AnalyzeComments\Analyzer\DTO\Output\CommentDTO;
+use SavinMikhail\CommentsDensity\AnalyzeComments\Analyzer\Visitors\Checkers\NodeNeedsDocblockChecker;
 use SavinMikhail\CommentsDensity\AnalyzeComments\MissingDocblock\MissingDocBlockAnalyzer;
-use SavinMikhail\CommentsDensity\AnalyzeComments\MissingDocblock\Visitors\Checkers\NodeNeedsDocblockChecker;
 
 final class MissingDocBlockVisitor extends NodeVisitorAbstract
 {
@@ -32,7 +32,7 @@ public function enterNode(Node $node): null
 
         $this->missingDocBlocks[] =
             new CommentDTO(
-                MissingDocBlockAnalyzer::NAME, // todo
+                MissingDocBlockAnalyzer::NAME,
                 MissingDocBlockAnalyzer::COLOR,
                 $this->filename,
                 $node->getLine(),