[TASK] Move "valid Document entries" handling hack to renderContext

Author: linawolf

packages/guides/src/RenderContext.php

@@ -94,14 +94,17 @@ public function canonicalUrl(string $url): string
         return $this->urlGenerator->canonicalUrl($this->getDirName(), $url);
     }
 
-    public function relativeDocUrl(string $filename, string|null $anchor = null): string
+    public function relativeDocUrl(string $linkedDocument, string|null $anchor = null): string
     {
+        if ($this->projectNode->findDocumentEntry($linkedDocument) !== null) {
+            // todo: this is a hack, existing documents are expected to be handled like absolute links in some places
+            $linkedDocument = '/' . $linkedDocument;
+        }
+
         return $this->urlGenerator->generateOutputUrlFromDocumentPath(
             $this->getDirName(),
             $this->destinationPath,
-            // Todo: it does not really make sense to treat relavtive paths that are found in the project node differently?
-            $this->projectNode->findDocumentEntry($filename) !== null,
-            $filename,
+            $linkedDocument,
             $this->outputFormat,
             $anchor,
         );

packages/guides/src/UrlGenerator.php

@@ -89,15 +89,10 @@ public function createFileUrl(string $filename, string $outputFormat = 'html', s
     public function generateOutputUrlFromDocumentPath(
         string $currentDirectory,
         string $destinationPath,
-        bool $validDocumentEntry,
         string $linkedDocument,
         string $outputFormat,
         string|null $anchor = null,
     ): string {
-        if ($validDocumentEntry) {
-            $linkedDocument = '/' . $linkedDocument;
-        }
-
         $fileUrl = $this->createFileUrl($linkedDocument, $outputFormat, $anchor);
         if (UriInfo::isAbsolutePath(Uri::createFromString($linkedDocument))) {
             return $destinationPath . $fileUrl;

packages/guides/src/UrlGeneratorInterface.php

@@ -34,7 +34,6 @@ public function createFileUrl(string $filename, string $outputFormat = 'html', s
     public function generateOutputUrlFromDocumentPath(
         string $currentDirectory,
         string $destinationPath,
-        bool $validDocumentEntry,
         string $linkedDocument,
         string $outputFormat,
         string|null $anchor = null,

packages/guides/tests/unit/UrlGeneratorTest.php

@@ -142,7 +142,6 @@ public static function abstractUrlProvider(): array
     public function testRelativeDocUrl(
         string $currentDirectory,
         string $destinationPath,
-        bool $validDocumentEntry,
         string $linkedDocument,
         string $result,
         string|null $anchor = null,
@@ -151,7 +150,6 @@ public function testRelativeDocUrl(
         self::assertSame($result, $urlGenerator->generateOutputUrlFromDocumentPath(
             $currentDirectory,
             $destinationPath,
-            $validDocumentEntry,
             $linkedDocument,
             'txt',
             $anchor,
@@ -165,43 +163,37 @@ public static function documentPathProvider(): array
             'relative document' => [
                 'currentDirectory' => 'getting-started',
                 'destinationPath' => 'guide',
-                'validDocumentEntry' => false,
                 'linkedDocument' => 'installing',
                 'result' => 'guide/getting-started/installing.txt',
             ],
             'absolute document path' => [
                 'currentDirectory' => 'getting-started',
                 'destinationPath' => 'guide',
-                'validDocumentEntry' => false,
                 'linkedDocument' => '/installing',
                 'result' => 'guide/installing.txt',
             ],
-            'relative document path with anchor' => [
+            'absolute document path with anchor' => [
                 'currentDirectory' => 'getting-started',
                 'destinationPath' => 'guide',
-                'validDocumentEntry' => true,
-                'linkedDocument' => 'getting-started/configuration',
+                'linkedDocument' => '/getting-started/configuration',
                 'result' => 'guide/getting-started/configuration.txt#composer',
                 'anchor' => 'composer',
             ],
             'relative document path up in directory' => [
                 'currentDirectory' => 'getting-started',
                 'destinationPath' => 'guide',
-                'validDocumentEntry' => false,
                 'linkedDocument' => '../references/installing',
                 'result' => 'guide/references/installing.txt',
             ],
             'relative document path up in subdirectory' => [
                 'currentDirectory' => 'getting-started/something',
                 'destinationPath' => 'guide',
-                'validDocumentEntry' => false,
                 'linkedDocument' => '../references/installing',
                 'result' => 'guide/getting-started/references/installing.txt',
             ],
             'relative document path two up in directory' => [
                 'currentDirectory' => 'getting-started/something',
                 'destinationPath' => 'guide',
-                'validDocumentEntry' => false,
                 'linkedDocument' => '../../references/installing',
                 'result' => 'guide/references/installing.txt',
             ],