Allow running with single sniff

Author: afilina

bin/phpcsdocs

@@ -0,0 +1,18 @@
+#!/usr/bin/env php
+<?php
+declare(strict_types=1);
+
+require __DIR__.'/../vendor/autoload.php';
+
+use App\Command\GenerateCommand;
+use DI\ContainerBuilder;
+use Symfony\Component\Console\Application;
+
+$application = new Application();
+
+$containerBuilder = new ContainerBuilder;
+$containerBuilder->addDefinitions(__DIR__ . '/../config/di.php');
+$container = $containerBuilder->build();
+
+$application->add($container->get(GenerateCommand::class));
+$application->run();

src/Command/GenerateCommand.php

@@ -0,0 +1,41 @@
+<?php
+declare(strict_types=1);
+
+namespace App\Command;
+
+use App\Handler\GenerateHandler;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+
+class GenerateCommand extends Command
+{
+    protected static $defaultName = 'generate';
+    private GenerateHandler $handler;
+
+    public function __construct(GenerateHandler $handler)
+    {
+        parent::__construct(self::$defaultName);
+        $this->handler = $handler;
+    }
+
+    protected function configure()
+    {
+        $this->addArgument('sniff', InputArgument::OPTIONAL);
+    }
+
+    protected function execute(InputInterface $input, OutputInterface $output)
+    {
+        $sniffPath = null;
+        if ($input->hasArgument('sniff')) {
+            $sniffPath = $input->getArgument('sniff');
+        }
+
+        foreach ($this->handler->handle($sniffPath) as $message) {
+            $output->writeln($message);
+        };
+
+        return Command::SUCCESS;
+    }
+}

src/Handler/GenerateHandler.php

@@ -7,7 +7,6 @@
 use App\Generator\Generator;
 use App\SniffFinder\SniffFinder;
 use App\Value\Folder;
-use Iterator;
 use Symfony\Component\Filesystem\Filesystem;
 
 class GenerateHandler
@@ -24,17 +23,26 @@ public function __construct(CodeRepository $codeRepository, Generator $generator
     }
 
     /**
-     * @return Iterator<string>
+     * @return iterable<string>
      */
-    public function handle(): Iterator
+    public function handle(string $sniffPath = null): iterable
     {
         $repoName = 'PHPCompatibility/PHPCompatibility';
         $repoPath = $this->codeRepository->downloadCode($repoName);
         $filesystem = new Filesystem();
 
         $standardPath = new Folder($repoPath . 'PHPCompatibility/');
 
-        foreach ($this->sniffFinder->getSniffs($standardPath) as $sniff) {
+        if ($sniffPath !== null) {
+            $sniffs = [$this->sniffFinder->getSniff($standardPath, $sniffPath)];
+        } else {
+            $sniffs = $this->sniffFinder->getSniffs($standardPath);
+        }
+
+        $count = count($sniffs);
+        yield "Found {$count} sniff(s)";
+
+        foreach ($sniffs as $sniff) {
             $markdownPath = $this->sniffCodeToMarkdownPath($sniff->getCode());
             $filesystem->dumpFile(
             // TODO: perhaps we can move this logic to the the sniff class

src/SniffFinder/FilesystemSniffFinder.php

@@ -5,6 +5,7 @@
 
 use App\Parser\SniffParser;
 use App\Value\Folder;
+use App\Value\Sniff;
 use CallbackFilterIterator;
 use GlobIterator;
 use Iterator;
@@ -14,11 +15,17 @@
 use Roave\BetterReflection\SourceLocator\Type\FileIteratorSourceLocator;
 use Roave\BetterReflection\SourceLocator\Type\SourceLocator;
 use SplFileInfo;
-use Traversable;
 
 class FilesystemSniffFinder implements SniffFinder
 {
-    public function getSniffs(Folder $folder): Traversable
+    public function getSniff(Folder $folder, string $sniffPath): Sniff
+    {
+        $parser = new SniffParser();
+        $projectSourceLocator = $this->createProjectSourceLocator($folder);
+        return $parser->parse($sniffPath, $projectSourceLocator);
+    }
+
+    public function getSniffs(Folder $folder): iterable
     {
         $parser = new SniffParser();
         $globSniffs = new GlobIterator($folder->getPath() . 'Sniffs/*/*Sniff.php');

src/SniffFinder/SniffFinder.php

@@ -5,12 +5,13 @@
 
 use App\Value\Folder;
 use App\Value\Sniff;
-use Traversable;
 
 interface SniffFinder
 {
+    public function getSniff(Folder $folder, string $sniffPath): Sniff;
+
     /**
-     * @return Traversable<Sniff>
+     * @return iterable<Sniff>
      */
-    public function getSniffs(Folder $folder): Traversable;
+    public function getSniffs(Folder $folder): iterable;
 }

tests/Handler/GenerateHandlerTest.php

@@ -13,6 +13,7 @@
 use App\Value\Violation;
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
+use Symfony\Component\Filesystem\Filesystem;
 
 /** @covers \App\Handler\GenerateHandler */
 class GenerateHandlerTest extends TestCase
@@ -35,38 +36,58 @@ class GenerateHandlerTest extends TestCase
     private $sniffFinder;
 
     /** @test */
-    public function handle()
+    public function handle_WithoutArguments_CreatesFile()
     {
         $this->codeRepository->method('downloadCode')->willReturn(new Folder('var/tests/'));
-        $this->sniffFinder->method('getSniffs')->willReturn($this->createSniffs());
+        $sniffs = $this->createSniffs(['First', 'Second']);
+        $this->sniffFinder->method('getSniffs')->willReturn($sniffs);
+        $this->generator->method('createSniffDoc')->withConsecutive([$sniffs[0]], [$sniffs[1]]);
 
-        $this->handler->handle();
+        /** @var \Generator $messages */
+        $messages = $this->handler->handle();
 
-        self::assertFileExists('var/markdown/Standard/Category/My.md');
+        self::assertEquals(
+            [
+                'Found 2 sniff(s)',
+                'Created file: var/markdown/Standard/Category/First.md',
+                'Created file: var/markdown/Standard/Category/Second.md'
+            ],
+            iterator_to_array($messages)
+        );
     }
 
-    private function createSniffs()
+    /** @test */
+    public function handle_WithSniffPath_CreatesSingleFile()
     {
-        yield new Sniff(
-            'Standard.Category.My',
-            '',
-            [],
-            new Urls([]),
-            'Description',
-            [],
+        $this->codeRepository->method('downloadCode')->willReturn(new Folder('var/tests/'));
+        $this->sniffFinder->method('getSniff')->willReturn($this->createSniff('First'));
+
+        /** @var \Generator $messages */
+        $messages = $this->handler->handle('var/tests/Standard/Category/Sniffs/FirstSniff.php');
+
+        self::assertEquals(
             [
-                new Violation(
-                    'Standard.Category.My.ErrorCode',
-                    'Description',
-                    [],
-                    new Urls([])
-                )
-            ]
+                'Found 1 sniff(s)',
+                'Created file: var/markdown/Standard/Category/First.md',
+            ],
+            iterator_to_array($messages)
         );
     }
 
+    /**
+     * @param string[] $names
+     */
+    private function createSniffs(array $names): iterable
+    {
+        return array_map(function (string $name) {
+            return $this->createSniff($name);
+        }, $names);
+    }
+
     protected function setUp(): void
     {
+        (new Filesystem())->remove('var/markdown/Standard');
+
         $this->codeRepository = $this->createMock(CodeRepository::class);
         $this->generator = $this->createMock(Generator::class);
         $this->sniffFinder = $this->createMock(SniffFinder::class);
@@ -77,4 +98,24 @@ protected function setUp(): void
             $this->sniffFinder
         );
     }
+
+    private function createSniff(string $name): Sniff
+    {
+        return new Sniff(
+            'Standard.Category.' . $name,
+            '',
+            [],
+            new Urls([]),
+            'Description',
+            [],
+            [
+                new Violation(
+                    'Standard.Category.' . $name . '.ErrorCode',
+                    'Description',
+                    [],
+                    new Urls([])
+                )
+            ]
+        );
+    }
 }