Merge pull request #1280 from CybotTM/feature/nbsp-text-role

[FEATURE] Add :nbsp: text role for non-breaking spaces

Author: jaapio

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

@@ -114,6 +114,7 @@
 use phpDocumentor\Guides\RestructuredText\TextRoles\GenericTextRole;
 use phpDocumentor\Guides\RestructuredText\TextRoles\LiteralTextRole;
 use phpDocumentor\Guides\RestructuredText\TextRoles\MathTextRole;
+use phpDocumentor\Guides\RestructuredText\TextRoles\NbspTextRole;
 use phpDocumentor\Guides\RestructuredText\TextRoles\ReferenceTextRole;
 use phpDocumentor\Guides\RestructuredText\TextRoles\SpanTextRole;
 use phpDocumentor\Guides\RestructuredText\TextRoles\TextRole;
@@ -172,6 +173,7 @@
         ->set(ApiClassTextRole::class)
         ->set(MathTextRole::class)
         ->set(LiteralTextRole::class)
+        ->set(NbspTextRole::class)
         ->set(SpanTextRole::class)
 
         ->set(GeneralDirective::class)

packages/guides-restructured-text/src/RestructuredText/TextRoles/NbspTextRole.php

@@ -0,0 +1,39 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * This file is part of phpDocumentor.
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ *
+ * @link https://phpdoc.org
+ */
+
+namespace phpDocumentor\Guides\RestructuredText\TextRoles;
+
+use phpDocumentor\Guides\Nodes\Inline\WhitespaceInlineNode;
+use phpDocumentor\Guides\RestructuredText\Parser\DocumentParserContext;
+
+/**
+ * Role for inserting a non-breaking space.
+ *
+ * Usage: :nbsp:`ignored content`
+ *
+ * The content is ignored; the role simply produces a non-breaking space.
+ * This is an alternative to the ~ syntax (e.g., a~b).
+ */
+final class NbspTextRole extends BaseTextRole
+{
+    protected string $name = 'nbsp';
+
+    public function processNode(
+        DocumentParserContext $documentParserContext,
+        string $role,
+        string $content,
+        string $rawContent,
+    ): WhitespaceInlineNode {
+        return new WhitespaceInlineNode();
+    }
+}

tests/Functional/tests/nbsp-role/nbsp-role.html

@@ -1,3 +1,2 @@
-SKIP non-breacking space role does not work
 <p>This is a non breakable space: a&nbsp;b</p>
 <p>This is also a non breakable space: a &nbsp; b</p>