Merge branch 'main' into per-project-settings-docs

Author: linawolf

composer.json

@@ -53,6 +53,7 @@
         "dealerdirect/phpcodesniffer-composer-installer": "^1.0",
         "doctrine/coding-standard": "^12.0",
         "fakerphp/faker": "^1.23",
+        "fig/log-test": "^1.0",
         "gajus/dindent": "^2.0.1",
         "jangregor/phpstan-prophecy": "^1.0",
         "league/flysystem-memory": "^1.0",

composer.lock

@@ -10,6 +10,7 @@
 use phpDocumentor\Guides\RestructuredText\Directives\BaseDirective;
 use phpDocumentor\Guides\RestructuredText\Parser\Directive;
 use phpDocumentor\Guides\RestructuredText\Parser\DocumentParserContext;
+use Psr\Log\LoggerInterface;
 use Webmozart\Assert\Assert;
 
 use function dirname;
@@ -34,6 +35,10 @@
  */
 final class UmlDirective extends BaseDirective
 {
+    public function __construct(private readonly LoggerInterface $logger)
+    {
+    }
+
     public function getName(): string
     {
         return 'uml';
@@ -72,9 +77,11 @@ private function loadExternalUmlFile(ParserContext $parserContext, string $path)
         );
 
         if (!$parserContext->getOrigin()->has($fileName)) {
-            $parserContext->addError(
-                sprintf('Tried to include "%s" as a diagram but the file could not be found', $fileName),
-            );
+            $message =
+                sprintf('Tried to include "%s" as a diagram but the file could not be found', $fileName);
+
+
+            $this->logger->error($message, $parserContext->getLoggerInformation());
 
             return null;
         }

packages/guides-graphs/src/Graphs/Directives/UmlDirective.php

@@ -79,6 +79,7 @@
 use phpDocumentor\Guides\RestructuredText\Parser\Productions\RuleContainer;
 use phpDocumentor\Guides\RestructuredText\Parser\Productions\SectionRule;
 use phpDocumentor\Guides\RestructuredText\Parser\Productions\SimpleTableRule;
+use phpDocumentor\Guides\RestructuredText\Parser\Productions\Table\GridTableBuilder;
 use phpDocumentor\Guides\RestructuredText\Parser\Productions\TitleRule;
 use phpDocumentor\Guides\RestructuredText\Parser\Productions\TransitionRule;
 use phpDocumentor\Guides\RestructuredText\TextRoles\AbbreviationTextRole;
@@ -214,6 +215,7 @@
         ->set(GridTableRule::class)
         ->arg('$productions', service('phpdoc.guides.parser.rst.body_elements'))
         ->tag('phpdoc.guides.parser.rst.body_element', ['priority' => GridTableRule::PRIORITY])
+        ->set(GridTableBuilder::class)
         ->set(SimpleTableRule::class)
         ->arg('$productions', service('phpdoc.guides.parser.rst.body_elements'))
         ->tag('phpdoc.guides.parser.rst.body_element', ['priority' => SimpleTableRule::PRIORITY])

packages/guides-restructured-text/resources/config/guides-restructured-text.php

@@ -22,6 +22,7 @@
 use phpDocumentor\Guides\RestructuredText\Parser\DirectiveOption;
 use phpDocumentor\Guides\RestructuredText\Parser\DocumentParserContext;
 use phpDocumentor\Guides\RestructuredText\Parser\LinesIterator;
+use Psr\Log\LoggerInterface;
 use Throwable;
 
 use function array_merge;
@@ -52,6 +53,7 @@ final class DirectiveRule implements Rule
     /** @param iterable<DirectiveHandler> $directives */
     public function __construct(
         private readonly InlineMarkupRule $inlineMarkupRule,
+        private readonly LoggerInterface $logger,
         iterable $directives = [],
     ) {
         foreach ($directives as $directive) {
@@ -101,7 +103,7 @@ public function apply(DocumentParserContext $documentParserContext, CompoundNode
                 $openingLine,
             );
 
-            $documentParserContext->getContext()->addError($message);
+            $this->logger->error($message, $documentParserContext->getContext()->getLoggerInformation());
 
             return null;
         }
@@ -140,7 +142,8 @@ public function apply(DocumentParserContext $documentParserContext, CompoundNode
                 $e->getMessage(),
             );
 
-            $documentParserContext->getContext()->addError($message);
+
+            $this->logger->error($message, $documentParserContext->getContext()->getLoggerInformation());
         }
 
         return null;

packages/guides-restructured-text/src/RestructuredText/Parser/Productions/DirectiveRule.php

@@ -21,6 +21,7 @@
 use phpDocumentor\Guides\RestructuredText\Parser\Productions\Table\GridTableBuilder;
 use phpDocumentor\Guides\RestructuredText\Parser\Productions\Table\ParserContext;
 use phpDocumentor\Guides\RestructuredText\Parser\Productions\Table\TableSeparatorLineConfig;
+use Psr\Log\LoggerInterface;
 
 use function mb_strlen;
 use function preg_match;
@@ -37,11 +38,8 @@ final class GridTableRule implements Rule
 {
     public const PRIORITY = 50;
 
-    private readonly GridTableBuilder $builder;
-
-    public function __construct(private readonly RuleContainer $productions)
+    public function __construct(private readonly LoggerInterface $logger, private readonly RuleContainer $productions, private readonly GridTableBuilder $builder)
     {
-        $this->builder = new GridTableBuilder();
     }
 
     public function applies(DocumentParserContext $documentParser): bool
@@ -68,10 +66,12 @@ public function apply(DocumentParserContext $documentParserContext, CompoundNode
             $documentIterator->next();
 
             if ($lineLength !== mb_strlen($documentIterator->current())) {
-                $documentParserContext->getContext()->addError(sprintf(
+                $message = sprintf(
                     "Malformed table: Line\n\n%s\n\ndoes not appear to be a complete table row",
                     $documentIterator->current(),
-                ));
+                );
+
+                $this->logger->error($message, $documentParserContext->getContext()->getLoggerInformation());
             }
 
             if ($this->isHeaderDefinitionLine($documentIterator->current())) {

packages/guides-restructured-text/src/RestructuredText/Parser/Productions/GridTableRule.php

@@ -13,6 +13,7 @@
 use phpDocumentor\Guides\Nodes\TableNode;
 use phpDocumentor\Guides\RestructuredText\Parser\DocumentParserContext;
 use phpDocumentor\Guides\RestructuredText\Parser\Productions\RuleContainer;
+use Psr\Log\LoggerInterface;
 
 use function array_reverse;
 use function count;
@@ -26,6 +27,10 @@
 
 class GridTableBuilder
 {
+    public function __construct(private readonly LoggerInterface $logger)
+    {
+    }
+
     protected function compile(ParserContext $context): TableNode
     {
         $columnRanges = $context->getColumnRanges();
@@ -153,7 +158,7 @@ protected function compile(ParserContext $context): TableNode
                 try {
                     $row->absorbRowContent($targetRow);
                 } catch (InvalidTableStructure $e) {
-                    $context->addError($e->getMessage());
+                    $this->logger->error($e->getMessage());
                 }
 
                 $nextRowCounter++;
@@ -207,13 +212,13 @@ public function buildNode(
         if ($tableParserContext->hasErrors()) {
             $tableAsString = $tableParserContext->getTableAsString();
             foreach ($tableParserContext->getErrors() as $error) {
-                $documentParserContext->getContext()
-                    ->addError(sprintf(
-                        "%s\nin file %s\n\n%s",
-                        $error,
-                        $documentParserContext->getContext()->getCurrentFileName(),
-                        $tableAsString,
-                    ));
+                $message = sprintf(
+                    "%s\nin file %s\n\n%s",
+                    $error,
+                    $documentParserContext->getContext()->getCurrentFileName(),
+                    $tableAsString,
+                );
+                $this->logger->error($message, $documentParserContext->getContext()->getLoggerInformation());
             }
 
             return null;

packages/guides-restructured-text/src/RestructuredText/Parser/Productions/Table/GridTableBuilder.php

@@ -4,6 +4,7 @@
 
 namespace phpDocumentor\Guides\RestructuredText\Parser\Productions;
 
+use Monolog\Logger;
 use phpDocumentor\Guides\Nodes\CodeNode;
 use phpDocumentor\Guides\RestructuredText\Directives\BaseDirective as DirectiveHandler;
 use phpDocumentor\Guides\RestructuredText\Directives\CodeBlockDirective;
@@ -22,7 +23,7 @@ final class DirectiveRuleTest extends RuleTestCase
     public function setUp(): void
     {
         $this->directiveHandler = new DummyBaseDirective();
-        $this->rule = new DirectiveRule($this->givenInlineMarkupRule(), [$this->directiveHandler]);
+        $this->rule = new DirectiveRule($this->givenInlineMarkupRule(), new Logger('test'), [$this->directiveHandler]);
     }
 
     #[DataProvider('simpleDirectiveProvider')]
@@ -92,7 +93,7 @@ public function testApplySetsOptionValueMultipleLines(): void
     #[DataProvider('codeBlockValueProvider')]
     public function testCodeBlockValue(string $input, string $expectedValue): void
     {
-        $this->rule = new DirectiveRule($this->givenInlineMarkupRule(), [$this->directiveHandler, new CodeBlockDirective(new CodeNodeOptionMapper())]);
+        $this->rule = new DirectiveRule($this->givenInlineMarkupRule(), new Logger('test'), [$this->directiveHandler, new CodeBlockDirective(new CodeNodeOptionMapper())]);
         $context = $this->createContext($input);
         $node = $this->rule->apply($context);
         self::assertInstanceOf(CodeNode::class, $node);