Refactor to account for multiple violations per sniff

Author: afilina

composer.lock

@@ -3,9 +3,12 @@
 
 namespace App\Generator;
 
-use App\Value\UserDoc;
+use App\Value\Sniff;
+use App\Value\Violation;
 
 interface Generator
 {
-    public function createUserDoc(UserDoc $doc): string;
+    public function getViolation(Violation $doc): string;
+
+    public function fromSniff(Sniff $doc): string;
 }

src/Generator/Generator.php

@@ -4,8 +4,10 @@
 namespace App\Generator;
 
 use App\Value\Diff;
+use App\Value\Property;
+use App\Value\Sniff;
 use App\Value\Url;
-use App\Value\UserDoc;
+use App\Value\Violation;
 use Stringy\Stringy;
 use function Stringy\create as s;
 
@@ -15,63 +17,149 @@ public function __construct()
     {
     }
 
-    public function createUserDoc(UserDoc $doc): string
+    public function fromSniff(Sniff $doc): string
     {
         return <<<MD
-        # {$doc->getRuleCode()}
+        # {$doc->getCode()}
         
-        {$doc->getDescription()}
+        {$doc->getDocblock()}
         
-        {$this->getComparisons($doc)}
-        {$this->getSeeAlso($doc)}
+        {$this->getPublicProperties($doc->getProperties())}
+        {$this->getSeeAlso($doc->getLinks())}
+        {$this->getViolations($doc->getViolations())}
         MD;
     }
 
-    private function getComparisons(UserDoc $doc): string
+    /**
+     * @param Property[] $properties
+     */
+    private function getPublicProperties(array $properties): string
     {
-        if ($doc->getDiffs() === []) {
+        if ($properties === []) {
             return '';
         }
 
-        $diffBlocks = implode("\n\n", $this->createDiffBlocks($doc));
+        $propertyLines = implode("\n", $this->getPublicPropertyLines($properties));
 
         return <<<MD
-        ## Comparisons
+        ## Public Properties
         
-        {$diffBlocks}
+        {$propertyLines}
         
         MD;
     }
 
-    private function getSeeAlso(UserDoc $doc): string
+    /**
+     * @param Property[] $properties
+     * @return string[]
+     */
+    private function getPublicPropertyLines(array $properties): array
+    {
+        return array_map(function (Property $property) {
+            return "- \${$property->getName()} : {$property->getType()} {$property->getDescription()}";
+        }, $properties);
+    }
+
+    /**
+     * @param Url[] $links
+     * @return string
+     */
+    private function getSeeAlso(array $links): string
     {
-        if ($doc->getLinks() === []) {
+        if ($links === []) {
             return '';
         }
 
-        $links = implode("\n", $this->createLinks($doc));
+        $linkLines = implode("\n", $this->getLinkLines($links));
 
         return <<<MD
         ## See Also
         
-        {$links}
+        {$linkLines}
         
         MD;
     }
 
-    private function prependLinesWith(string $prefix, string $lines): string
+    /**
+     * @param Url[] $links
+     * @return string[]
+     */
+    private function getLinkLines(array $links): array
     {
-        $prependedLines = array_map(function (Stringy $line) use ($prefix) {
-            return (string)$line->prepend($prefix);
-        }, s($lines)->lines());
+        return array_map(function (Url $url) {
+            return "- [$url]($url)";
+        }, $links);
+    }
 
-        return implode("\n", $prependedLines);
+    /**
+     * @param Violation[] $violations
+     * @return string
+     */
+    private function getViolations(array $violations): string
+    {
+        if ($violations === []) {
+            return '';
+        }
+
+        $violations = implode("\n", $this->getViolationBlocks($violations));
+
+        return <<<MD
+        ## Troubleshooting
+        
+        {$violations}
+        
+        MD;
+    }
+
+    /**
+     * @param Violation[] $violations
+     * @return string[]
+     */
+    private function getViolationBlocks(array $violations): array
+    {
+        return array_map(function (Violation $violation): string {
+            return <<<MD
+            ```
+            <details>
+            <summary>{$violation->getCode()}</summary>
+            {$this->getViolation($violation)}
+            </details>
+            ```
+            MD;
+        }, $violations);
+    }
+
+    public function getViolation(Violation $doc): string
+    {
+        return <<<MD
+        {$doc->getDescription()}
+        
+        {$this->getComparisons($doc)}
+        {$this->getSeeAlso($doc->getLinks())}
+        MD;
+    }
+
+    private function getComparisons(Violation $doc): string
+    {
+        if ($doc->getDiffs() === []) {
+            return '';
+        }
+
+        $diffBlocks = implode("\n\n", $this->getDiffBlocks($doc->getDiffs()));
+
+        return <<<MD
+        ## Comparisons
+        
+        {$diffBlocks}
+        
+        MD;
     }
 
     /**
+     * @param Diff[] $diffs
      * @return string[]
      */
-    private function createDiffBlocks(UserDoc $doc): array
+    private function getDiffBlocks(array $diffs): array
     {
         return array_map(function (Diff $diff): string {
             return <<<MD
@@ -80,16 +168,15 @@ private function createDiffBlocks(UserDoc $doc): array
             {$this->prependLinesWith('+', $diff->getAfter())}
             ```
             MD;
-        }, $doc->getDiffs());
+        }, $diffs);
     }
 
-    /**
-     * @return string[]
-     */
-    private function createLinks(UserDoc $doc): array
+    private function prependLinesWith(string $prefix, string $lines): string
     {
-        return array_map(function (Url $url) {
-            return "- [$url]($url)";
-        }, $doc->getLinks());
+        $prependedLines = array_map(function (Stringy $line) use ($prefix) {
+            return (string)$line->prepend($prefix);
+        }, s($lines)->lines());
+
+        return implode("\n", $prependedLines);
     }
 }