Create SniffFinder for discovering sniff and violation files

Author: afilina

src/SniffFinder/FilesystemSniffFinder.php

@@ -0,0 +1,31 @@
+<?php
+declare(strict_types=1);
+
+namespace App\SniffFinder;
+
+use App\Parser\SniffParser;
+use App\Parser\ViolationParser;
+use App\Value\Standard;
+use GlobIterator;
+use Traversable;
+
+class FilesystemSniffFinder implements SniffFinder
+{
+    public function getSniffs(Standard $standard): 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) {
+            yield $parser->parse($fileInfo->getPathname());
+        }
+    }
+}

src/SniffFinder/SniffFinder.php

@@ -0,0 +1,22 @@
+<?php
+declare(strict_types=1);
+
+namespace App\SniffFinder;
+
+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;
+}

src/Value/Standard.php

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

tests/SniffFinder/FilesystemSniffFinderTest.php

@@ -0,0 +1,99 @@
+<?php
+declare(strict_types=1);
+
+namespace App\Tests\SniffFinder;
+
+use App\SniffFinder\FilesystemSniffFinder;
+use App\Value\Sniff;
+use App\Value\Standard;
+use App\Value\Urls;
+use App\Value\Violation;
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\Filesystem\Filesystem;
+
+/** @covers \App\SniffFinder\FilesystemSniffFinder */
+class FilesystemSniffFinderTest extends TestCase
+{
+    private const PHP_SNIFF_PATH = 'var/tests/src/Standard/Sniffs/Category/MySniff.php';
+    private const XML_SNIFF_PATH = 'var/tests/src/Standard/Docs/Category/MyStandard.xml';
+    private const XML_VIOLATION_PATH = 'var/tests/src/Standard/Docs/Category/MyStandard/ErrorCode.xml';
+
+    private FilesystemSniffFinder $finder;
+
+    protected function setUp(): void
+    {
+        $this->finder = new FilesystemSniffFinder();
+    }
+
+    /** @test */
+    public function getSniffs()
+    {
+        $this->writeSniffPhp();
+        $this->writeSniffXml();
+
+        self::assertEquals(
+            [
+                new Sniff(
+                    'Standard.Category.My',
+                    '',
+                    [],
+                    new Urls([]),
+                    'Description',
+                    [],
+                    []
+                )
+            ],
+            iterator_to_array($this->finder->getSniffs(new Standard(
+                'var/tests/src/Standard/'
+            )))
+        );
+    }
+
+    /** @test */
+    public function getViolations()
+    {
+        $this->writeViolationXml();
+
+        self::assertEquals(
+            [
+                new Violation(
+                    'Standard.Category.My.ErrorCode',
+                    'Description',
+                    [],
+                    new Urls([])
+                )
+            ],
+            iterator_to_array($this->finder->getViolations(new Standard(
+                'var/tests/src/Standard/'
+            )))
+        );
+    }
+
+    private function writeSniffPhp(): void
+    {
+        $content = '<?php
+        class SniffName {}
+        ';
+        (new Filesystem())->dumpFile(self::PHP_SNIFF_PATH, $content);
+    }
+
+    private function writeSniffXml(): void
+    {
+        $content = <<<XML
+        <documentation title="Title">
+            <standard>Description</standard>
+        </documentation>
+        XML;
+        (new Filesystem())->dumpFile(self::XML_SNIFF_PATH, $content);
+    }
+
+    private function writeViolationXml()
+    {
+        $content = <<<XML
+        <documentation title="Title">
+            <standard>Description</standard>
+        </documentation>
+        XML;
+        (new Filesystem())->dumpFile(self::XML_VIOLATION_PATH, $content);
+    }
+}