Refactor so that only one markdown file is written per rule

Author: afilina

config/di.php

@@ -0,0 +1,15 @@
+<?php
+declare(strict_types=1);
+
+use App\CodeRepository\CodeRepository;
+use App\CodeRepository\GithubCodeRepository;
+use App\Generator\Generator as DocGenerator;
+use App\Generator\MarkdownGenerator;
+use App\SniffFinder\FilesystemSniffFinder;
+use App\SniffFinder\SniffFinder;
+
+return [
+    CodeRepository::class => DI\autowire(GithubCodeRepository::class),
+    DocGenerator::class => DI\autowire(MarkdownGenerator::class),
+    SniffFinder::class => DI\autowire(FilesystemSniffFinder::class),
+];

src/CodeRepository/CodeRepository.php

@@ -3,9 +3,11 @@
 
 namespace App\CodeRepository;
 
+use App\Value\Folder;
+
 interface CodeRepository
 {
     public const CODE_DOWNLOAD_PATH = 'var/repos/';
 
-    public function downloadCode(string $repoName): string;
+    public function downloadCode(string $repoName): Folder;
 }

src/CodeRepository/GithubCodeRepository.php

@@ -3,14 +3,15 @@
 
 namespace App\CodeRepository;
 
+use App\Value\Folder;
 use Symfony\Component\Process\Exception\ProcessFailedException;
 use Symfony\Component\Process\Process;
 
 class GithubCodeRepository implements CodeRepository
 {
-    public function downloadCode(string $repoName): string
+    public function downloadCode(string $repoName): Folder
     {
-        $repoPath = self::CODE_DOWNLOAD_PATH . '/' . $repoName;
+        $repoPath = new Folder(self::CODE_DOWNLOAD_PATH . '/' . $repoName . '/');
 
         $process = $this->cloneOrPull($repoPath, $repoName);
         $process->run();
@@ -22,9 +23,9 @@ public function downloadCode(string $repoName): string
         return $repoPath;
     }
 
-    private function cloneOrPull(string $repoPath, string $repoName): Process
+    private function cloneOrPull(Folder $repoPath, string $repoName): Process
     {
-        if (!is_dir($repoPath)) {
+        if (!is_dir((string)$repoPath)) {
             return new Process([
                 'git',
                 'clone',

src/Handler/GenerateHandler.php

@@ -0,0 +1,48 @@
+<?php
+declare(strict_types=1);
+
+namespace App\Handler;
+
+use App\CodeRepository\CodeRepository;
+use App\Generator\Generator;
+use App\SniffFinder\SniffFinder;
+use App\Value\Folder;
+use Symfony\Component\Filesystem\Filesystem;
+
+class GenerateHandler
+{
+    private CodeRepository $codeRepository;
+    private Generator $generator;
+    private SniffFinder $sniffFinder;
+
+    public function __construct(CodeRepository $codeRepository, Generator $generator, SniffFinder $sniffFinder)
+    {
+        $this->codeRepository = $codeRepository;
+        $this->generator = $generator;
+        $this->sniffFinder = $sniffFinder;
+    }
+
+    public function handle()
+    {
+        $repoName = 'PHPCompatibility/PHPCompatibility';
+        $repoPath = $this->codeRepository->downloadCode($repoName);
+        $filesystem = new Filesystem();
+
+        $standardPath = new Folder($repoPath . 'PHPCompatibility/');
+
+        foreach ($this->sniffFinder->getSniffs($standardPath) as $sniff) {
+            $filesystem->dumpFile(
+            // TODO: perhaps we can move this logic to the the sniff class
+                $this->sniffCodeToMarkdownPath($sniff->getCode()),
+                $this->generator->createSniffDoc($sniff)
+            );
+        }
+    }
+
+    private function sniffCodeToMarkdownPath(string $code): string
+    {
+        [$standard, $category, $sniff] = explode('.', $code);
+
+        return "var/markdown/$standard/$category/$sniff.md";
+    }
+}

src/Parser/SniffParser.php

@@ -9,6 +9,7 @@
 use App\Value\Sniff;
 use App\Value\Url;
 use App\Value\Urls;
+use GlobIterator;
 use phpDocumentor\Reflection\DocBlock\Tags\Var_;
 use phpDocumentor\Reflection\DocBlockFactory;
 use ReflectionProperty;
@@ -31,22 +32,29 @@ public function parse(string $phpFilePath): Sniff
         $xmlUrls = [];
         $description = '';
         $diffs = [];
-        $xmlFilePath = str_replace(['/Sniffs/', 'Sniff.php'], ['/Docs/', 'Standard.xml'], $phpFilePath);
-        if (file_exists($xmlFilePath)) {
-            $xml = new SimpleXMLElement(file_get_contents($xmlFilePath));
+        $xmlStandardPath = str_replace(['/Sniffs/', 'Sniff.php'], ['/Docs/', 'Standard.xml'], $phpFilePath);
+        if (file_exists($xmlStandardPath)) {
+            $xml = new SimpleXMLElement(file_get_contents($xmlStandardPath));
             $xmlUrls = $this->getXmlUrls($xml);
             $description = $this->getDescription($xml);
             $diffs = $this->getDiffs($xml);
         }
 
+        $xmlErrorGlob = new GlobIterator(
+            str_replace(['/Sniffs/', 'Sniff.php'], ['/Docs/', 'Standard/*.xml'], $phpFilePath)
+        );
+        $violations = [];
+        foreach ($xmlErrorGlob as $fileInfo) {
+            $violations[] = (new ViolationParser)->parse($fileInfo->getPathname());
+        }
         return new Sniff(
             $this->getCode($phpFilePath),
             $this->getDocBlock($classInfo->getDocComment()),
             $this->getProperties($classInfo),
             $this->getLinks($classInfo, $xmlUrls),
             $description,
             $diffs,
-            []
+            $violations
         );
     }
 

src/SniffFinder/FilesystemSniffFinder.php

@@ -4,27 +4,17 @@
 namespace App\SniffFinder;
 
 use App\Parser\SniffParser;
-use App\Parser\ViolationParser;
-use App\Value\Standard;
+use App\Value\Folder;
 use GlobIterator;
 use Traversable;
 
 class FilesystemSniffFinder implements SniffFinder
 {
-    public function getSniffs(Standard $standard): Traversable
+    public function getSniffs(Folder $folder): Traversable
     {
         $parser = new SniffParser();
-        $glob = new GlobIterator($standard->getCodeLocation() . 'Sniffs/*/*Sniff.php');
-        foreach ($glob as $fileInfo) {
-            yield $parser->parse($fileInfo->getPathname());
-        }
-    }
-
-    public function getViolations(Standard $standard): Traversable
-    {
-        $parser = new ViolationParser();
-        $glob = new GlobIterator($standard->getCodeLocation() . 'Docs/*/*Standard/*.xml');
-        foreach ($glob as $fileInfo) {
+        $globSniffs = new GlobIterator($folder->getPath() . 'Sniffs/*/*Sniff.php');
+        foreach ($globSniffs as $fileInfo) {
             yield $parser->parse($fileInfo->getPathname());
         }
     }

src/SniffFinder/SniffFinder.php

@@ -3,20 +3,14 @@
 
 namespace App\SniffFinder;
 
+use App\Value\Folder;
 use App\Value\Sniff;
-use App\Value\Standard;
-use App\Value\Violation;
 use Traversable;
 
 interface SniffFinder
 {
     /**
      * @return Traversable<Sniff>
      */
-    public function getSniffs(Standard $standard): Traversable;
-
-    /**
-     * @return Traversable<Violation>
-     */
-    public function getViolations(Standard $standard): Traversable;
+    public function getSniffs(Folder $folder): Traversable;
 }

src/Value/Folder.php

@@ -0,0 +1,29 @@
+<?php
+declare(strict_types=1);
+
+namespace App\Value;
+
+use Assert\Assert;
+
+class Folder
+{
+    private string $path;
+
+    public function __construct(string $path)
+    {
+        Assert::that($path)
+            ->endsWith('/');
+
+        $this->path = $path;
+    }
+
+    public function getPath(): string
+    {
+        return $this->path;
+    }
+
+    public function __toString()
+    {
+        return $this->getPath();
+    }
+}

src/Value/Standard.php

@@ -0,0 +1,81 @@
+<?php
+declare(strict_types=1);
+
+namespace App\Tests\Handler;
+
+use App\CodeRepository\CodeRepository;
+use App\Generator\Generator;
+use App\Handler\GenerateHandler;
+use App\SniffFinder\SniffFinder;
+use App\Value\Folder;
+use App\Value\Sniff;
+use App\Value\Urls;
+use App\Value\Violation;
+use PHPUnit\Framework\MockObject\MockObject;
+use PHPUnit\Framework\TestCase;
+
+/** @covers \App\Handler\GenerateHandler */
+class GenerateHandlerTest extends TestCase
+{
+    /**
+     * @var GenerateHandler
+     */
+    private GenerateHandler $handler;
+    /**
+     * @var CodeRepository|MockObject
+     */
+    private $codeRepository;
+    /**
+     * @var Generator|MockObject
+     */
+    private $generator;
+    /**
+     * @var SniffFinder|MockObject
+     */
+    private $sniffFinder;
+
+    protected function setUp(): void
+    {
+        $this->codeRepository = $this->createMock(CodeRepository::class);
+        $this->generator = $this->createMock(Generator::class);
+        $this->sniffFinder = $this->createMock(SniffFinder::class);
+
+        $this->handler = new GenerateHandler(
+            $this->codeRepository,
+            $this->generator,
+            $this->sniffFinder
+        );
+    }
+
+    /** @test */
+    public function handle()
+    {
+        $this->codeRepository->method('downloadCode')->willReturn(new Folder('var/tests/src/'));
+        $this->sniffFinder->method('getSniffs')->willReturn($this->createSniffs());
+
+        $this->handler->handle();
+
+        self::assertFileExists('var/markdown/Standard/Category/My.md');
+        self::assertFileExists('var/markdown/Standard/Category/My/ErrorCode.md');
+    }
+
+    private function createSniffs()
+    {
+        yield new Sniff(
+            'Standard.Category.My',
+            '',
+            [],
+            new Urls([]),
+            'Description',
+            [],
+            [
+                new Violation(
+                    'Standard.Category.My.ErrorCode',
+                    'Description',
+                    [],
+                    new Urls([])
+                )
+            ]
+        );
+    }
+}