Merge pull request #502 from linawolf/feature-orphan

linawolf · web-flow · commit 83da7546c1b8 · 2023-08-06T14:58:25.000+02:00
Orphaned pages do not enforce uniqe title
diff --git a/packages/guides-restructured-text/src/RestructuredText/Parser/Productions/FieldList/OrphanFieldListItemRule.php b/packages/guides-restructured-text/src/RestructuredText/Parser/Productions/FieldList/OrphanFieldListItemRule.php
@@ -20,6 +20,8 @@ public function applies(FieldListItemNode $fieldListItemNode): bool
 
     public function apply(FieldListItemNode $fieldListItemNode, DocumentParserContext $documentParserContext): MetadataNode
     {
+        $documentParserContext->getDocument()->setOrphan(true);
+
         return new OrphanNode();
     }
 }
diff --git a/packages/guides/src/Compiler/NodeTransformers/DocumentEntryRegistrationTransformer.php b/packages/guides/src/Compiler/NodeTransformers/DocumentEntryRegistrationTransformer.php
@@ -31,7 +31,7 @@ public function leaveNode(Node $node, CompilerContext $compilerContext): Node|nu
             return $node;
         }
 
-        if ($node->getTitle() === null) {
+        if ($node->getTitle() === null && !$node->isOrphan()) {
             $this->logger->warning('Document has not title', $node->getLoggerInformation());
         }
 
diff --git a/packages/guides/src/Nodes/DocumentNode.php b/packages/guides/src/Nodes/DocumentNode.php
@@ -67,6 +67,7 @@ final class DocumentNode extends CompoundNode
     private DocumentEntryNode|null $documentEntry = null;
     private SectionEntryNode|null $rootSectionEntry = null;
     private bool $isRoot = false;
+    private bool $orphan = false;
 
     public function __construct(
         private readonly string $hash,
@@ -285,4 +286,16 @@ public function withIsRoot(bool $isRoot): DocumentNode
 
         return $node;
     }
+
+    public function isOrphan(): bool
+    {
+        return $this->orphan;
+    }
+
+    public function setOrphan(bool $orphan): DocumentNode
+    {
+        $this->orphan = $orphan;
+
+        return $this;
+    }
 }
diff --git a/tests/Integration/tests/orphan-without-title/expected/index.html b/tests/Integration/tests/orphan-without-title/expected/index.html
@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <title>Document Title</title>
+
+</head>
+<body>
+    <div class="section" id="document-title">
+    <h1>Document Title</h1>
+
+            <p>Some Document</p>
+    </div>
+
+</body>
+</html>
diff --git a/tests/Integration/tests/orphan-without-title/expected/orphan.html b/tests/Integration/tests/orphan-without-title/expected/orphan.html
@@ -0,0 +1,11 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <title></title>
+
+
+</head>
+<body>
+    <p>A page without title that is marked as <code>orphan</code> does not cause warnings.</p>
+</body>
+</html>
diff --git a/tests/Integration/tests/orphan-without-title/input/index.rst b/tests/Integration/tests/orphan-without-title/input/index.rst
@@ -0,0 +1,5 @@
+==============
+Document Title
+==============
+
+Some Document
diff --git a/tests/Integration/tests/orphan-without-title/input/orphan.rst b/tests/Integration/tests/orphan-without-title/input/orphan.rst
@@ -0,0 +1,3 @@
+:orphan:
+
+A page without title that is marked as `orphan` does not cause warnings.

Original file line number	Diff line number	Diff line change
`@@ -20,6 +20,8 @@ public function applies(FieldListItemNode $fieldListItemNode): bool`
`20`	`20`
`21`	`21`	`public function apply(FieldListItemNode $fieldListItemNode, DocumentParserContext $documentParserContext): MetadataNode`
`22`	`22`	`{`
	`23`	`+ $documentParserContext->getDocument()->setOrphan(true);`
	`24`	`+`
`23`	`25`	`return new OrphanNode();`
`24`	`26`	`}`
`25`	`27`	`}`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ public function leaveNode(Node $node, CompilerContext $compilerContext): Node\|nu`
`31`	`31`	`return $node;`
`32`	`32`	`}`
`33`	`33`
`34`		`- if ($node->getTitle() === null) {`
	`34`	`+ if ($node->getTitle() === null && !$node->isOrphan()) {`
`35`	`35`	`$this->logger->warning('Document has not title', $node->getLoggerInformation());`
`36`	`36`	`}`
`37`	`37`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+:orphan:`
	`2`	`+`
	`3`	+A page without title that is marked as `orphan` does not cause warnings.