Merge branch 'main' into document-extension

linawolf · web-flow · commit 0ae7b829fdde · 2023-07-06T14:28:07.000+02:00
diff --git a/composer.json b/composer.json
@@ -17,6 +17,7 @@
     "autoload-dev": {
         "psr-4": {
             "phpDocumentor\\Guides\\": ["packages/guides/tests/unit/", "tests/"],
+            "phpDocumentor\\Guides\\Cli\\": "packages/guides-cli/tests/unit",
             "phpDocumentor\\Guides\\Graphs\\": "packages/guides-graphs/tests/unit",
             "phpDocumentor\\Guides\\RestructuredText\\": "packages/guides-restructured-text/tests/unit",
             "phpDocumentor\\Guides\\Markdown\\": "packages/guides-markdown/tests/unit"
diff --git a/composer.lock b/composer.lock
diff --git a/packages/guides-cli/composer.json b/packages/guides-cli/composer.json
@@ -11,6 +11,13 @@
             "phpDocumentor\\Guides\\Cli\\": "src/"
         }
     },
+    "autoload-dev": {
+        "psr-4": {
+            "phpDocumentor\\Guides\\": [
+                "tests/unit/"
+            ]
+        }
+    },
     "authors": [
         {
             "name": "jaapio",
diff --git a/packages/guides-cli/src/Command/Run.php b/packages/guides-cli/src/Command/Run.php
@@ -11,6 +11,7 @@
 use Monolog\Handler\ErrorLogHandler;
 use Monolog\Handler\StreamHandler;
 use Monolog\Logger;
+use phpDocumentor\Guides\Cli\Logger\SpyProcessor;
 use phpDocumentor\Guides\Compiler\CompilerContext;
 use phpDocumentor\Guides\Handlers\CompileDocumentsCommand;
 use phpDocumentor\Guides\Handlers\ParseDirectoryCommand;
@@ -83,6 +84,12 @@ public function __construct(
             'Write log to this path',
             'php://stder',
         );
+        $this->addOption(
+            'fail-on-log',
+            null,
+            InputOption::VALUE_NONE,
+            'Use a non-zero exit code as soon as any log is written',
+        );
 
         $this->addOption(
             'theme',
@@ -136,6 +143,13 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             $this->logger->pushHandler(new StreamHandler($logPath . '/error.log', Logger::ERROR));
         }
 
+        $failOnLog = $input->getOption('fail-on-log') ?? false;
+
+        if ($failOnLog) {
+            $spyProcessor = new SpyProcessor();
+            $this->logger->pushProcessor($spyProcessor);
+        }
+
         $documents = $this->commandBus->handle(
             new ParseDirectoryCommand(
                 $sourceFileSystem,
@@ -185,7 +199,11 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             'Successfully placed ' . (is_countable($documents) ? count($documents) : 0) . ' rendered ' . $formatsText . ' files into ' . $outputDir,
         );
 
-        return 0;
+        if ($failOnLog && $spyProcessor->hasBeenCalled()) {
+            return Command::FAILURE;
+        }
+
+        return Command::SUCCESS;
     }
 
     private function getAbsolutePath(string $path): string
diff --git a/packages/guides-cli/src/Logger/SpyProcessor.php b/packages/guides-cli/src/Logger/SpyProcessor.php
@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+namespace phpDocumentor\Guides\Cli\Logger;
+
+use Monolog\Processor\ProcessorInterface;
+
+/**
+ * This decorator has an extra method to check whether anything was logged
+ *
+ * @internal
+ */
+final class SpyProcessor implements ProcessorInterface
+{
+    private bool $hasBeenCalled = false;
+
+    public function hasBeenCalled(): bool
+    {
+        return $this->hasBeenCalled;
+    }
+
+    /** @inheritDoc */
+    public function __invoke(array $record): array
+    {
+        $this->hasBeenCalled = true;
+
+        return $record;
+    }
+}
diff --git a/packages/guides-cli/tests/unit/Logger/SpyProcessorTest.php b/packages/guides-cli/tests/unit/Logger/SpyProcessorTest.php
@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types=1);
+
+namespace phpDocumentor\Guides\Cli\Logger;
+
+use PHPUnit\Framework\TestCase;
+
+class SpyProcessorTest extends TestCase
+{
+    public function testHasBeenCalledReturnsFalseByDefault(): void
+    {
+        $spyProcessor = new SpyProcessor();
+
+        $this->assertFalse($spyProcessor->hasBeenCalled());
+    }
+
+    public function testItKnowsWhenALogIsEmitted(): void
+    {
+        $process = new SpyProcessor();
+        $process(['channel' => 'test']);
+        self::assertTrue($process->hasBeenCalled());
+    }
+}
diff --git a/tests/Functional/tests/main-directive/main-directive.html b/tests/Functional/tests/main-directive/main-directive.html
diff --git a/tests/Functional/tests/main-directive/main-directive.rst b/tests/Functional/tests/main-directive/main-directive.rst
diff --git a/tests/Functional/tests/main-directive/main-directive.tex b/tests/Functional/tests/main-directive/main-directive.tex
diff --git a/tests/Integration/tests/directive-unkown/expected/index.html b/tests/Integration/tests/directive-unkown/expected/index.html
@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <title>Test</title>
+
+</head>
+<body>
+    <div class="section" id="test">
+    <h1>Test</h1>
+        .. some-unknown-directive::
+    </div>
+
+</body>
+</html>
diff --git a/tests/Integration/tests/directive-unkown/expected/logs/warning.log b/tests/Integration/tests/directive-unkown/expected/logs/warning.log
@@ -0,0 +1 @@
+Unknown directive
diff --git a/tests/Integration/tests/directive-unkown/input/index.rst b/tests/Integration/tests/directive-unkown/input/index.rst
@@ -0,0 +1,4 @@
+Test
+====
+
+.. some-unknown-directive::
diff --git a/tests/Integration/tests/directive-unkown/input/skip b/tests/Integration/tests/directive-unkown/input/skip
@@ -0,0 +1 @@
+Unknown directives do not cause warnings, they are swallowed

Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,13 @@`
`11`	`11`	`"phpDocumentor\\Guides\\Cli\\": "src/"`
`12`	`12`	`}`
`13`	`13`	`},`
	`14`	`+ "autoload-dev": {`
	`15`	`+ "psr-4": {`
	`16`	`+ "phpDocumentor\\Guides\\": [`
	`17`	`+ "tests/unit/"`
	`18`	`+ ]`
	`19`	`+ }`
	`20`	`+ },`
`14`	`21`	`"authors": [`
`15`	`22`	`{`
`16`	`23`	`"name": "jaapio",`