Create markdown generator for UserDoc

Author: afilina

src/Generator/Generator.php

@@ -0,0 +1,11 @@
+<?php
+declare(strict_types=1);
+
+namespace App\Generator;
+
+use App\Value\UserDoc;
+
+interface Generator
+{
+    public function createUserDoc(UserDoc $doc): string;
+}

src/Generator/MarkdownGenerator.php

@@ -0,0 +1,95 @@
+<?php
+declare(strict_types=1);
+
+namespace App\Generator;
+
+use App\Value\Diff;
+use App\Value\Url;
+use App\Value\UserDoc;
+use Stringy\Stringy;
+use function Stringy\create as s;
+
+class MarkdownGenerator implements Generator
+{
+    public function __construct()
+    {
+    }
+
+    public function createUserDoc(UserDoc $doc): string
+    {
+        return <<<MD
+        # {$doc->getRuleCode()}
+        
+        {$doc->getDescription()}
+        
+        {$this->getComparisons($doc)}
+        {$this->getSeeAlso($doc)}
+        MD;
+    }
+
+    private function getComparisons(UserDoc $doc): string
+    {
+        if ($doc->getDiffs() === []) {
+            return '';
+        }
+
+        $diffBlocks = implode("\n\n", $this->createDiffBlocks($doc));
+
+        return <<<MD
+        ## Comparisons
+        
+        {$diffBlocks}
+        
+        MD;
+    }
+
+    private function getSeeAlso(UserDoc $doc): string
+    {
+        if ($doc->getLinks() === []) {
+            return '';
+        }
+
+        $links = implode("\n", $this->createLinks($doc));
+
+        return <<<MD
+        ## See Also
+        
+        {$links}
+        
+        MD;
+    }
+
+    private function prependLinesWith(string $prefix, string $lines): string
+    {
+        $prependedLines = array_map(function (Stringy $line) use ($prefix) {
+            return (string)$line->prepend($prefix);
+        }, s($lines)->lines());
+
+        return implode("\n", $prependedLines);
+    }
+
+    /**
+     * @return string[]
+     */
+    private function createDiffBlocks(UserDoc $doc): array
+    {
+        return array_map(function (Diff $diff): string {
+            return <<<MD
+            ```diff
+            {$this->prependLinesWith('-', $diff->getBefore())}
+            {$this->prependLinesWith('+', $diff->getAfter())}
+            ```
+            MD;
+        }, $doc->getDiffs());
+    }
+
+    /**
+     * @return string[]
+     */
+    private function createLinks(UserDoc $doc): array
+    {
+        return array_map(function (Url $url) {
+            return "- [$url]($url)";
+        }, $doc->getLinks());
+    }
+}

tests/Generator/MarkdownGeneratorTest.php

@@ -0,0 +1,65 @@
+<?php
+declare(strict_types=1);
+
+namespace App\Tests\Generator;
+
+use App\Generator\MarkdownGenerator;
+use App\Value\Diff;
+use App\Value\Url;
+use App\Value\UserDoc;
+use PHPUnit\Framework\TestCase;
+
+/** @covers \App\Generator\MarkdownGenerator */
+class MarkdownGeneratorTest extends TestCase
+{
+    private MarkdownGenerator $generator;
+
+    protected function setUp(): void
+    {
+        $this->generator = new MarkdownGenerator();
+    }
+
+    /** @test */
+    public function createUserDoc()
+    {
+        $doc = new UserDoc(
+            'Rule.Code',
+            'Description',
+            [
+                new Diff('a();', 'b();'),
+                new Diff('a();', 'b();')
+            ],
+            [
+                new Url('http://link1.com'),
+                new Url('http://link2.com')
+            ]
+        );
+
+        self::assertEquals(
+            <<<MD
+            # Rule.Code
+            
+            Description
+            
+            ## Comparisons
+            
+            ```diff
+            -a();
+            +b();
+            ```
+            
+            ```diff
+            -a();
+            +b();
+            ```
+            
+            ## See Also
+            
+            - [http://link1.com](http://link1.com)
+            - [http://link2.com](http://link2.com)
+            
+            MD,
+            $this->generator->createUserDoc($doc)
+        );
+    }
+}

tests/Parser/UserDocParserTest.php

@@ -52,29 +52,29 @@ public function getUserDoc_WithCodeComparisons_AddTrimmedDiffs()
             <code_comparison>
                 <code>
                 <![CDATA[
-        function a() {
+        function b() {
         }
                 ]]>
                 </code>
                 <code>
                 <![CDATA[
-        function b() {
+        function a() {
         }
                 ]]>
                 </code>
             </code_comparison>
             <code_comparison>
-                <code>a();</code>
                 <code>b();</code>
+                <code>a();</code>
             </code_comparison>
         </documentation>
         XML;
         file_put_contents(self::XML_FILE_PATH, $content);
         $doc = $this->parser->getUserDoc(self::XML_FILE_PATH);
         self::assertEquals(
             [
-                new Diff("function b() {\n}", "function a() {\n}"),
-                new Diff('b();', 'a();'),
+                new Diff("function a() {\n}", "function b() {\n}"),
+                new Diff('a();', 'b();'),
             ],
             $doc->getDiffs()
         );