Complete tests for all VOs; minor renaming & validation

Author: afilina

composer.lock

@@ -34,7 +34,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
 
         foreach ($this->handler->handle($sniffPath) as $message) {
             $output->writeln($message);
-        };
+        }
 
         return Command::SUCCESS;
     }

src/Command/GenerateCommand.php

@@ -7,7 +7,7 @@
 use App\Value\Property;
 use App\Value\Sniff;
 use App\Value\Url;
-use App\Value\Urls;
+use App\Value\UrlList;
 use App\Value\Violation;
 use Stringy\Stringy;
 use function Stringy\create as s;
@@ -23,7 +23,7 @@ public function createSniffDoc(Sniff $sniff): string
         {$this->getDocblock($sniff)}
         {$this->getComparisons($sniff->getDiffs())}
         {$this->getPublicProperties($sniff->getProperties())}
-        {$this->getSeeAlso($sniff->getLinks())}
+        {$this->getSeeAlso($sniff->getUrls())}
         {$this->getViolations($sniff->getViolations())}
         MD;
 
@@ -134,13 +134,13 @@ private function getPublicPropertyLines(array $properties): array
     /**
      * @return string
      */
-    private function getSeeAlso(Urls $links): string
+    private function getSeeAlso(UrlList $urls): string
     {
-        if ($links->getUrls() === []) {
+        if ($urls->toArray() === []) {
             return '';
         }
 
-        $linkLines = implode("\n", $this->getLinkLines($links));
+        $linkLines = implode("\n", $this->getLinkLines($urls));
 
         return <<<MD
         ## See Also
@@ -153,11 +153,11 @@ private function getSeeAlso(Urls $links): string
     /**
      * @return string[]
      */
-    private function getLinkLines(Urls $links): array
+    private function getLinkLines(UrlList $urls): array
     {
         return array_map(function (Url $url) {
             return "- [$url]($url)";
-        }, $links->getUrls());
+        }, $urls->toArray());
     }
 
     /**
@@ -205,7 +205,7 @@ public function createViolationDoc(Violation $doc): string
         
         {$this->getComparisons($doc->getDiffs())}
         
-        {$this->getSeeAlso($doc->getLinks())}
+        {$this->getSeeAlso($doc->getUrls())}
         MD;
     }
 }

src/Generator/MarkdownGenerator.php

@@ -8,7 +8,7 @@
 use App\Value\Property;
 use App\Value\Sniff;
 use App\Value\Url;
-use App\Value\Urls;
+use App\Value\UrlList;
 use GlobIterator;
 use phpDocumentor\Reflection\DocBlock\Tags\Var_;
 use phpDocumentor\Reflection\DocBlockFactory;
@@ -58,26 +58,47 @@ public function parse(string $phpFilePath, SourceLocator $projectSourceLocator):
             $this->getCode($phpFilePath),
             $this->getDocBlock($classInfo->getDocComment()),
             $this->getProperties($classInfo),
-            $this->getLinks($classInfo, $xmlUrls),
+            $this->getUrls($classInfo, $xmlUrls),
             $description,
             $diffs,
             $violations
         );
     }
 
+    private function getSniffClassName(string $phpFilePath): string
+    {
+        $parts = $this->getSniffFileParts($phpFilePath);
+
+        return "{$parts[0]}\\Sniffs\\{$parts[1]}\\{$parts[2]}Sniff";
+    }
+
+    /**
+     * @return string[]
+     */
+    private function getSniffFileParts(string $filePath): array
+    {
+        $part = '([^\/]*)';
+        preg_match("/$part\/Sniffs\/$part\/{$part}Sniff\.php/", $filePath, $matches);
+        if ($matches === []) {
+            throw NotASniffPath::fromPath($filePath);
+        }
+
+        return array_slice($matches, 1, 3);
+    }
+
     /**
      * @return Url[]
      */
     private function getXmlUrls(SimpleXMLElement $xml): array
     {
-        $links = [];
+        $urls = [];
         foreach ($xml->link as $link) {
-            $links[] = new Url(
+            $urls[] = new Url(
                 (string)s((string)$link)->trim()
             );
         }
 
-        return $links;
+        return $urls;
     }
 
     private function getDescription(SimpleXMLElement $xml): string
@@ -174,10 +195,10 @@ private function getPropertyDescription(Roave\ReflectionProperty $property): str
     /**
      * @param Url[] $xmlUrls
      */
-    private function getLinks(ReflectionClass $classInfo, array $xmlUrls): Urls
+    private function getUrls(ReflectionClass $classInfo, array $xmlUrls): UrlList
     {
         if ($classInfo->getDocComment() === '') {
-            return new Urls([]);
+            return new UrlList([]);
         }
 
         $links = DocBlockFactory::createInstance()
@@ -188,27 +209,6 @@ private function getLinks(ReflectionClass $classInfo, array $xmlUrls): Urls
             return new Url($url);
         }, $links);
 
-        return new Urls(array_merge($urls, $xmlUrls));
-    }
-
-    private function getSniffClassName(string $phpFilePath): string
-    {
-        $parts = $this->getSniffFileParts($phpFilePath);
-
-        return "{$parts[0]}\\Sniffs\\{$parts[1]}\\{$parts[2]}Sniff";
-    }
-
-    /**
-     * @return string[]
-     */
-    private function getSniffFileParts(string $filePath): array
-    {
-        $part = '([^\/]*)';
-        preg_match("/$part\/Sniffs\/$part\/{$part}Sniff\.php/", $filePath, $matches);
-        if ($matches === []) {
-            throw NotASniffPath::fromPath($filePath);
-        }
-
-        return array_slice($matches, 1, 3);
+        return new UrlList(array_merge($urls, $xmlUrls));
     }
 }

src/Parser/SniffParser.php

@@ -6,7 +6,7 @@
 use App\Parser\Exception\NotAViolationPath;
 use App\Value\Diff;
 use App\Value\Url;
-use App\Value\Urls;
+use App\Value\UrlList;
 use App\Value\Violation;
 use SimpleXMLElement;
 use function Stringy\create as s;
@@ -21,7 +21,7 @@ public function parse(string $xmlFilePath): Violation
             $this->getErrorCode($xmlFilePath),
             $this->getDescription($xml),
             $this->getDiffs($xml),
-            $this->getLinks($xml)
+            $this->getUrls($xml)
         );
     }
 
@@ -57,15 +57,15 @@ private function getDiffs(SimpleXMLElement $xml): array
         return $comparisons;
     }
 
-    private function getLinks(SimpleXMLElement $xml): Urls
+    private function getUrls(SimpleXMLElement $xml): UrlList
     {
-        $links = [];
+        $urls = [];
         foreach ($xml->link as $link) {
-            $links[] = new Url(
+            $urls[] = new Url(
                 (string)s((string)$link)->trim()
             );
         }
 
-        return new Urls($links);
+        return new UrlList($urls);
     }
 }

src/Parser/ViolationParser.php

@@ -3,6 +3,8 @@
 
 namespace App\Value;
 
+use Assert\Assert;
+
 class Sniff
 {
     private string $code;
@@ -11,7 +13,7 @@ class Sniff
      * @var Property[]
      */
     private array $properties;
-    private Urls $links;
+    private UrlList $urls;
     private string $description;
     /**
      * @var Diff[]
@@ -31,16 +33,28 @@ public function __construct(
         string $code,
         string $docblock,
         array $properties,
-        Urls $links,
+        UrlList $urls,
         string $description,
         array $diffs,
         array $violations
     )
     {
+        Assert::that($code)
+            ->notBlank();
+
+        Assert::thatAll($properties)
+            ->isInstanceOf(Property::class);
+
+        Assert::thatAll($diffs)
+            ->isInstanceOf(Diff::class);
+
+        Assert::thatAll($violations)
+            ->isInstanceOf(Violation::class);
+
         $this->code = $code;
         $this->docblock = $docblock;
         $this->properties = array_values($properties);
-        $this->links = $links;
+        $this->urls = $urls;
         $this->description = $description;
         $this->diffs = $diffs;
         $this->violations = $violations;
@@ -64,9 +78,9 @@ public function getProperties(): array
         return $this->properties;
     }
 
-    public function getLinks(): Urls
+    public function getUrls(): UrlList
     {
-        return $this->links;
+        return $this->urls;
     }
 
     public function getDescription(): string

src/Value/Sniff.php

@@ -3,12 +3,17 @@
 
 namespace App\Value;
 
+use Assert\Assert;
+
 class Url
 {
     private string $url;
 
     public function __construct(string $url)
     {
+        Assert::that($url)
+            ->url();
+
         $this->url = $url;
     }
 

src/Value/Url.php

@@ -6,7 +6,7 @@
 /**
  * Collection of unique URLs.
  */
-class Urls
+class UrlList
 {
     /**
      * @var Url[]
@@ -32,7 +32,7 @@ public function __construct(array $urls)
     /**
      * @return Url[]
      */
-    public function getUrls(): array
+    public function toArray(): array
     {
         return $this->urls;
     }

src/Value/Urls.php src/Value/UrlList.phpsrc/Value/Urls.php renamed to src/Value/UrlList.php

@@ -3,6 +3,8 @@
 
 namespace App\Value;
 
+use Assert\Assert;
+
 class Violation
 {
     private string $code;
@@ -11,17 +13,23 @@ class Violation
      * @var Diff[]
      */
     private array $diffs;
-    private Urls $links;
+    private UrlList $urls;
 
     /**
      * @param Diff[] $diffs
      */
-    public function __construct(string $code, string $description, array $diffs, Urls $links)
+    public function __construct(string $code, string $description, array $diffs, UrlList $urls)
     {
+        Assert::that($code)
+            ->notBlank();
+
+        Assert::thatAll($diffs)
+            ->isInstanceOf(Diff::class);
+
         $this->code = $code;
         $this->description = $description;
         $this->diffs = $diffs;
-        $this->links = $links;
+        $this->urls = $urls;
     }
 
     public function getCode(): string
@@ -42,8 +50,8 @@ public function getDiffs(): array
         return $this->diffs;
     }
 
-    public function getLinks(): Urls
+    public function getUrls(): UrlList
     {
-        return $this->links;
+        return $this->urls;
     }
 }