[TASK] Move Document URL calculations from the RenderContext

It seems like the method is quite hacky, more clean up is needed

Author: linawolf

packages/guides/src/RenderContext.php

@@ -15,15 +15,12 @@
 
 use Exception;
 use League\Flysystem\FilesystemInterface;
-use League\Uri\Uri;
-use League\Uri\UriInfo;
 use phpDocumentor\Guides\Nodes\DocumentNode;
 use phpDocumentor\Guides\Nodes\DocumentTree\DocumentEntryNode;
 use phpDocumentor\Guides\Nodes\Node;
 use phpDocumentor\Guides\Nodes\ProjectNode;
 
 use function dirname;
-use function ltrim;
 use function trim;
 
 class RenderContext
@@ -99,20 +96,14 @@ public function canonicalUrl(string $url): string
 
     public function relativeDocUrl(string $filename, string|null $anchor = null): string
     {
-        if (UriInfo::isAbsolutePath(Uri::createFromString($filename))) {
-            return $this->destinationPath . $this->urlGenerator->createFileUrl($filename, $this->outputFormat, $anchor);
-        }
-
-        $baseUrl = ltrim($this->urlGenerator->absoluteUrl($this->destinationPath, $this->getDirName()), '/');
-
-        if ($this->projectNode->findDocumentEntry($filename) !== null) {
-            return $this->destinationPath . '/'
-                . $this->urlGenerator->createFileUrl($filename, $this->outputFormat, $anchor);
-        }
-
-        return $this->urlGenerator->canonicalUrl(
-            $baseUrl,
-            $this->urlGenerator->createFileUrl($filename, $this->outputFormat, $anchor),
+        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,
+            $this->outputFormat,
+            $anchor,
         );
     }
 

packages/guides/src/UrlGenerator.php

@@ -13,6 +13,7 @@
 
 namespace phpDocumentor\Guides;
 
+use League\Uri\Uri;
 use League\Uri\UriInfo;
 
 use function array_pop;
@@ -84,4 +85,29 @@ public function createFileUrl(string $filename, string $outputFormat = 'html', s
         return $filename . '.' . $outputFormat .
             ($anchor !== null ? '#' . $anchor : '');
     }
+
+    public function generateOutputUrlFromDocumentPath(
+        string $currentDirectory,
+        string $destinationPath,
+        bool $validDocumentEntry,
+        string $linkedDocument,
+        string $outputFormat,
+        string|null $anchor = null,
+    ): string {
+        if (UriInfo::isAbsolutePath(Uri::createFromString($linkedDocument))) {
+            return $destinationPath . $this->createFileUrl($linkedDocument, $outputFormat, $anchor);
+        }
+
+        $baseUrl = ltrim($this->absoluteUrl($destinationPath, $currentDirectory), '/');
+
+        if ($validDocumentEntry) {
+            return $destinationPath . '/'
+                . $this->createFileUrl($linkedDocument, $outputFormat, $anchor);
+        }
+
+        return $this->canonicalUrl(
+            $baseUrl,
+            $this->createFileUrl($linkedDocument, $outputFormat, $anchor),
+        );
+    }
 }

packages/guides/src/UrlGeneratorInterface.php

@@ -30,4 +30,13 @@ public function canonicalUrl(string $basePath, string $url): string;
      * Create a url with a file ending derived from the output format
      */
     public function createFileUrl(string $filename, string $outputFormat = 'html', string|null $anchor = null): string;
+
+    public function generateOutputUrlFromDocumentPath(
+        string $currentDirectory,
+        string $destinationPath,
+        bool $validDocumentEntry,
+        string $linkedDocument,
+        string $outputFormat,
+        string|null $anchor = null,
+    ): string;
 }

packages/guides/tests/unit/UrlGeneratorTest.php

@@ -137,4 +137,60 @@ public static function abstractUrlProvider(): array
             ],
         ];
     }
+
+    #[DataProvider('documentPathProvider')]
+    public function testRelativeDocUrl(
+        string $currentDirectory,
+        string $destinationPath,
+        bool $validDocumentEntry,
+        string $linkedDocument,
+        string $result,
+        string|null $anchor = null,
+    ): void {
+        $urlGenerator = new UrlGenerator();
+        self::assertSame($result, $urlGenerator->generateOutputUrlFromDocumentPath(
+            $currentDirectory,
+            $destinationPath,
+            $validDocumentEntry,
+            $linkedDocument,
+            'txt',
+            $anchor,
+        ));
+    }
+
+    /** @return array<string, array<string, bool|string>> */
+    public static function documentPathProvider(): array
+    {
+        return [
+            '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' => [
+                'currentDirectory' => 'getting-started',
+                'destinationPath' => 'guide',
+                'validDocumentEntry' => true,
+                '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',
+            ],
+        ];
+    }
 }