Bump test coverage for markdown generator; fix bugs in process

Author: afilina

src/Generator/MarkdownGenerator.php

@@ -16,7 +16,7 @@ class MarkdownGenerator implements Generator
 {
     public function createSniffDoc(Sniff $sniff): string
     {
-        return <<<MD
+        $sniffDoc = <<<MD
         # {$sniff->getCode()}
         
         {$this->getDescription($sniff)}
@@ -26,26 +26,35 @@ public function createSniffDoc(Sniff $sniff): string
         {$this->getSeeAlso($sniff->getLinks())}
         {$this->getViolations($sniff->getViolations())}
         MD;
+
+        $sniffDoc = preg_replace('/\n{3,}/', "\n\n",$sniffDoc);
+        return preg_replace('/\n{2,}$/', "\n",$sniffDoc);
     }
 
     private function getDescription(Sniff $sniff): string
     {
+        $description = $sniff->getDescription();
+        if ($description === '') {
+            return '';
+        }
+
         return <<<MD
-        {$sniff->getDescription()}
+        {$description}
         
         MD;
     }
 
     private function getDocblock(Sniff $sniff): string
     {
-        if ($sniff->getDocblock() === '') {
+        $docblock = $sniff->getDocblock();
+        if ($docblock === '') {
             return '';
         }
 
         return <<<MD
         ## Docblock
         
-        {$sniff->getDocblock()}
+        {$docblock}
         MD;
     }
 
@@ -127,7 +136,7 @@ private function getPublicPropertyLines(array $properties): array
      */
     private function getSeeAlso(Urls $links): string
     {
-        if ($links === []) {
+        if ($links->getUrls() === []) {
             return '';
         }
 

tests/Generator/MarkdownGeneratorTest.php

@@ -18,10 +18,32 @@ class MarkdownGeneratorTest extends TestCase
     private MarkdownGenerator $generator;
 
     /** @test */
-    public function fromSniff()
+    public function fromSniff_WithMinimalData_WriteMinimalDetails()
     {
         $doc = new Sniff(
-            'Generic.MySniff',
+            'Standard.Category.My',
+            '',
+            [],
+            new Urls([]),
+            '',
+            [],
+            []
+        );
+
+        self::assertEquals(
+            <<<MD
+            # Standard.Category.My
+            
+            MD,
+            $this->generator->createSniffDoc($doc)
+        );
+    }
+
+    /** @test */
+    public function fromSniff_WithCompleteData_WriteAllDetails()
+    {
+        $doc = new Sniff(
+            'Standard.Category.My',
             'DocBlock',
             [
                 new Property('a', 'string', 'DescriptionA'),
@@ -35,7 +57,7 @@ public function fromSniff()
             [],
             [
                 new Violation(
-                    'Generic.MySniff.ErrorCode',
+                    'Standard.Category.My.ErrorCode',
                     'Description',
                     [
                         new Diff('a();', 'b();'),
@@ -51,7 +73,7 @@ public function fromSniff()
 
         self::assertEquals(
             <<<MD
-            # Generic.MySniff
+            # Standard.Category.My
             
             Description
             
@@ -73,7 +95,7 @@ public function fromSniff()
             
             ```
             <details>
-            <summary>Generic.MySniff.ErrorCode</summary>
+            <summary>Standard.Category.My.ErrorCode</summary>
             Description
             
             ## Comparisons