Adding baseline feature (#9)

* Adding baseline feature

* Updated readme with example of baselien

* cs

Author: Nyholm

README.md

@@ -3,5 +3,17 @@
 Make sure that code blocks have valid syntax and can actually run.
 
 ```terminal
-./code-block-checker.php verify:docs /path/to/docs cache.rst controller.rst --env=dev
+$ ./code-block-checker.php verify:docs /path/to/docs cache.rst controller.rst --env=dev
+
+::error file=cache,line=377::[Invalid syntax] PHP Parse error:  syntax error, unexpected token "}"
+
+ [ERROR] Build completed with 1 errors
+
+
+$ ./code-block-checker.php verify:docs /path/to/docs cache.rst controller.rst --env=dev --generate-baseline=baseline.json
+$ ./code-block-checker.php verify:docs /path/to/docs cache.rst controller.rst --env=dev --baseline=baseline.json
+
+ [OK] Build completed successfully!
+
 ```
+

psalm.baseline.xml

@@ -6,6 +6,9 @@
     </UndefinedClass>
   </file>
   <file src="src/Service/CodeValidator.php">
-    <InvalidArgument occurrences="1"/>
+    <InvalidArgument occurrences="3">
+      <code>'bis'</code>
+      <code>'foobar'</code>
+    </InvalidArgument>
   </file>
 </files>

src/Command/CheckDocsCommand.php

@@ -10,8 +10,8 @@
 use Doctrine\RST\ErrorManager;
 use Doctrine\RST\Event\PostNodeCreateEvent;
 use Doctrine\RST\Meta\Metas;
-use Symfony\CodeBlockChecker\Issue\IssueCollection;
 use Symfony\CodeBlockChecker\Listener\CodeNodeCollector;
+use Symfony\CodeBlockChecker\Service\Baseline;
 use Symfony\CodeBlockChecker\Service\CodeValidator;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputArgument;
@@ -27,25 +27,27 @@ class CheckDocsCommand extends Command
     protected static $defaultName = 'verify:docs';
 
     private SymfonyStyle $io;
-    private IssueCollection $errorManager;
     private ParseQueueProcessor $queueProcessor;
     private CodeNodeCollector $collector;
     private CodeValidator $validator;
+    private Baseline $baseline;
 
-    public function __construct(CodeValidator $validator)
+    public function __construct(CodeValidator $validator, Baseline $baseline)
     {
         parent::__construct(self::$defaultName);
         $this->validator = $validator;
+        $this->baseline = $baseline;
     }
 
     protected function configure()
     {
         $this
             ->addArgument('source-dir', InputArgument::REQUIRED, 'RST files Source directory')
             ->addArgument('files', InputArgument::IS_ARRAY + InputArgument::REQUIRED, 'RST files that should be verified.')
-            ->addOption('output-format', null, InputOption::VALUE_OPTIONAL, 'Valid options are github and console', 'github')
+            ->addOption('output-format', null, InputOption::VALUE_REQUIRED, 'Valid options are github and console', 'github')
+            ->addOption('generate-baseline', null, InputOption::VALUE_REQUIRED, 'Generate a new baseline', false)
+            ->addOption('baseline', null, InputOption::VALUE_REQUIRED, 'Use a baseline', false)
             ->setDescription('Make sure the docs blocks are valid')
-
         ;
     }
 
@@ -88,6 +90,16 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         $this->queueProcessor->process($parseQueue);
         $issues = $this->validator->validateNodes($this->collector->getNodes());
 
+        if ($baselineFile = $input->getOption('generate-baseline')) {
+            $this->baseline->generate($issues, $baselineFile);
+
+            return Command::SUCCESS;
+        }
+
+        if ($baselineFile = $input->getOption('baseline')) {
+            $issues = $this->baseline->filter($issues, $baselineFile);
+        }
+
         $issueCount = count($issues);
         if ($issueCount > 0) {
             $format = $input->getOption('output-format');

src/Issue/Issue.php

@@ -16,6 +16,7 @@ class Issue implements \Stringable
     private string $text;
     private string $type;
     private string $file;
+    private ?string $erroredLine;
 
     /**
      * The line in the file.
@@ -35,6 +36,7 @@ public function __construct(CodeNode $node, string $text, string $type, string $
         $this->file = $file;
         $this->localLine = $localLine;
         $this->line = null;
+        $this->erroredLine = null;
     }
 
     public function getHash(): string
@@ -67,6 +69,21 @@ public function getLine(): int
         return $this->line;
     }
 
+    public function getLocalLine(): int
+    {
+        return $this->localLine;
+    }
+
+    public function getErroredLine()
+    {
+        if (null === $this->erroredLine) {
+            $lines = explode(PHP_EOL, $this->node->getValue());
+            $this->erroredLine = $lines[$this->localLine - 1];
+        }
+
+        return $this->erroredLine;
+    }
+
     public function __toString()
     {
         return sprintf('[%s] %s in file %s at %d', $this->getType(), $this->getText(), $this->getFile(), $this->getLine());

src/Service/Baseline.php

@@ -0,0 +1,74 @@
+<?php
+
+namespace Symfony\CodeBlockChecker\Service;
+
+use Symfony\CodeBlockChecker\Issue\Issue;
+use Symfony\CodeBlockChecker\Issue\IssueCollection;
+
+/**
+ * @author Tobias Nyholm <tobias.nyholm@gmail.com>
+ */
+class Baseline
+{
+    public function generate(IssueCollection $issues, string $file)
+    {
+        $data = ['issues' => []];
+        foreach ($issues as $issue) {
+            $data['issues'][$issue->getFile()][$issue->getHash()] = [
+                'text' => $issue->getText(),
+                'type' => $issue->getType(),
+                'code' => $issue->getErroredLine(),
+            ];
+        }
+
+        file_put_contents($file, json_encode($data, JSON_PRETTY_PRINT));
+    }
+
+    /**
+     * Remove items from $issues that are in the baseline.
+     */
+    public function filter(IssueCollection $issues, string $file): IssueCollection
+    {
+        $json = file_get_contents($file);
+        try {
+            $baseline = json_decode($json, true, 512, JSON_THROW_ON_ERROR);
+            $baseline = $baseline['issues'];
+        } catch (\JsonException $e) {
+            throw new \RuntimeException('Could not parse baseline', 0, $e);
+        }
+
+        $output = new IssueCollection();
+        $perFile = [];
+        foreach ($issues as $issue) {
+            if (!isset($baseline[$issue->getFile()])) {
+                $output->addIssue($issue);
+                continue;
+            } elseif (isset($baseline[$issue->getFile()][$issue->getHash()])) {
+                // This has not been modified.
+                continue;
+            }
+
+            $perFile[$issue->getFile()][] = $issue;
+        }
+
+        foreach ($perFile as $file => $fileIssues) {
+            $fileBaseline = $baseline[$file];
+            /** @var Issue $issue */
+            foreach ($fileIssues as $issue) {
+                foreach ($fileBaseline as $i => $item) {
+                    if (
+                        $issue->getType() === $item['type'] &&
+                        $issue->getText() === $item['text'] &&
+                        $issue->getErroredLine()() === $item['code']
+                    ) {
+                        unset($fileBaseline[$i]);
+                    } else {
+                        $output->addIssue($issue);
+                    }
+                }
+            }
+        }
+
+        return $output;
+    }
+}