From 997594c95654026378598c0c50ff92e7efb263ed Mon Sep 17 00:00:00 2001 From: Jaapio Date: Fri, 30 Oct 2026 22:26:57 +0100 Subject: [PATCH] Migrate contents directive --- .../Directives/ContentsDirective.php | 28 ++++----- .../unit/Directives/ContentsDirectiveTest.php | 60 +++++++++++++++++++ phpstan-baseline.neon | 6 -- 3 files changed, 71 insertions(+), 23 deletions(-) create mode 100644 packages/guides-restructured-text/tests/unit/Directives/ContentsDirectiveTest.php diff --git a/packages/guides-restructured-text/src/RestructuredText/Directives/ContentsDirective.php b/packages/guides-restructured-text/src/RestructuredText/Directives/ContentsDirective.php index e3edfa5b4..79a49d4db 100644 --- a/packages/guides-restructured-text/src/RestructuredText/Directives/ContentsDirective.php +++ b/packages/guides-restructured-text/src/RestructuredText/Directives/ContentsDirective.php @@ -13,19 +13,21 @@ namespace phpDocumentor\Guides\RestructuredText\Directives; +use phpDocumentor\Guides\Compiler\CompilerContextInterface; use phpDocumentor\Guides\Nodes\Menu\ContentMenuNode; use phpDocumentor\Guides\Nodes\Menu\SectionMenuEntryNode; use phpDocumentor\Guides\Nodes\Node; use phpDocumentor\Guides\ReferenceResolvers\DocumentNameResolverInterface; +use phpDocumentor\Guides\RestructuredText\Directives\Attributes\Directive; use phpDocumentor\Guides\RestructuredText\Directives\Attributes\Option; -use phpDocumentor\Guides\RestructuredText\Parser\BlockContext; -use phpDocumentor\Guides\RestructuredText\Parser\Directive; +use phpDocumentor\Guides\RestructuredText\Nodes\DirectiveNode; /** - * Standarad rst `contents` directive + * Standard rst `contents` directive * * Displays a table of content of the current page */ +#[Directive(name: 'contents')] #[Option(name: 'local', type: OptionType::Boolean, description: 'If set, the table of contents will only include sections that are local to the current document.', default: false)] #[Option(name: 'depth', description: 'The maximum depth of the table of contents.')] final class ContentsDirective extends BaseDirective @@ -35,25 +37,17 @@ public function __construct( ) { } - public function getName(): string + public function createNode(DirectiveNode $directiveNode, CompilerContextInterface $compilerContext): Node { - return 'contents'; - } - - /** {@inheritDoc} */ - public function process( - BlockContext $blockContext, - Directive $directive, - ): Node { - $options = $directive->getOptions(); + $directive = $directiveNode->getDirective(); $absoluteUrl = $this->documentNameResolver->absoluteUrl( - $blockContext->getDocumentParserContext()->getContext()->getDirName(), - $blockContext->getDocumentParserContext()->getContext()->getCurrentFileName(), + (string) $directiveNode->getSourceLocation()->documentDirectory, + (string) $directiveNode->getSourceLocation()->file, ); return (new ContentMenuNode([new SectionMenuEntryNode($absoluteUrl)])) - ->withOptions($this->optionsToArray($options)) + ->withOptions($this->readAllOptions($directive)) ->withCaption($directive->getDataNode()) - ->withLocal($directive->getOptionBool('local')); + ->withLocal((bool) $this->readOption($directive, 'local')); } } diff --git a/packages/guides-restructured-text/tests/unit/Directives/ContentsDirectiveTest.php b/packages/guides-restructured-text/tests/unit/Directives/ContentsDirectiveTest.php new file mode 100644 index 000000000..e86be0dfb --- /dev/null +++ b/packages/guides-restructured-text/tests/unit/Directives/ContentsDirectiveTest.php @@ -0,0 +1,60 @@ +expects(self::once()) + ->method('absoluteUrl') + ->with('docs', 'docs/current') + ->willReturn('docs/current'); + + $directiveNode = new DirectiveNode(new Directive('', 'contents', '', [ + 'local' => new DirectiveOption('local', null), + 'depth' => new DirectiveOption('depth', '2'), + ])); + $directiveNode->setSourceLocation(new DirectiveSourceLocation( + file: 'docs/current', + documentDirectory: 'docs', + )); + + $node = (new ContentsDirective($documentNameResolver))->createNode( + $directiveNode, + self::createStub(CompilerContextInterface::class), + ); + + self::assertInstanceOf(ContentMenuNode::class, $node); + self::assertCount(1, $node->getMenuEntries()); + + $firstMenuEntry = $node->getMenuEntries()[0]; + self::assertInstanceOf(SectionMenuEntryNode::class, $firstMenuEntry); + self::assertSame('/docs/current', $firstMenuEntry->getDocumentLink()); + self::assertTrue($node->isLocal()); + self::assertSame(2, $node->getDepth()); + } +} diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon index 7857b41b3..b5307a345 100644 --- a/phpstan-baseline.neon +++ b/phpstan-baseline.neon @@ -222,12 +222,6 @@ parameters: count: 1 path: packages/guides-restructured-text/src/RestructuredText/Directives/CodeBlockDirective.php - - - message: '#^phpDocumentor\\Guides\\RestructuredText\\Directives\\ContentsDirective should apply the attribute phpDocumentor\\Guides\\RestructuredText\\Directives\\Attributes\\Directive$#' - identifier: phpat.testConcreteDirectivesHaveTheDirectiveAttribute - count: 1 - path: packages/guides-restructured-text/src/RestructuredText/Directives/ContentsDirective.php - - message: '#^phpDocumentor\\Guides\\RestructuredText\\Directives\\CsvTableDirective should apply the attribute phpDocumentor\\Guides\\RestructuredText\\Directives\\Attributes\\Directive$#' identifier: phpat.testConcreteDirectivesHaveTheDirectiveAttribute