[BUGFIX] Let Image sources respect relative and absolute links config…

…uration
phpDocumentor · Nov 21, 2023 · 649c085 · 649c085
1 parent f3caa80
commit 649c085
Show file tree

Hide file tree

Showing 19 changed files with 854 additions and 4 deletions.
diff --git a/packages/guides/src/Twig/AssetsExtension.php b/packages/guides/src/Twig/AssetsExtension.php
@@ -91,8 +91,7 @@ public function asset(array $context, string $path): string
     {
         $outputPath = $this->copyAsset($context['env'] ?? null, $path);
 
-        // make it relative so it plays nice with the base tag in the HEAD
-        return trim($outputPath, '/');
+        return $this->urlGenerator->generateInternalUrl($context['env'] ?? null, trim($outputPath, '/'));
     }
 
     /**

diff --git a/...ents/image/expected/hero-illustration.svg → ...e-absolute/expected/hero-illustration.svg b/...ents/image/expected/hero-illustration.svg → ...e-absolute/expected/hero-illustration.svg
diff --git a/...ge/expected/images/hero2-illustration.svg → ...te/expected/images/hero2-illustration.svg b/...ge/expected/images/hero2-illustration.svg → ...te/expected/images/hero2-illustration.svg
diff --git a/tests/Integration/tests/body-elements/image-absolute/expected/index.html b/tests/Integration/tests/body-elements/image-absolute/expected/index.html
@@ -0,0 +1,35 @@
+<!-- content start -->
+    <div class="section" id="document-title">
+    <h1>Document Title</h1>
+
+            <p>Lorem Ipsum Dolor.</p>
+            <div class="section" id="a-local-image">
+    <h2>A local image</h2>
+
+            <img
+    src="/hero-illustration.svg"
+    width="400"            alt="Alternative text"        />
+
+    </div>
+
+            <div class="section" id="an-image-with-absolute-paths">
+    <h2>An image with absolute paths</h2>
+
+            <img
+    src="/images/hero2-illustration.svg"
+    width="400"            alt="Alternative text"        />
+
+    </div>
+
+            <div class="section" id="an-image-with-relative-paths">
+    <h2>An image with relative paths</h2>
+
+            <img
+    src="/images/hero2-illustration.svg"
+    width="400"            alt="Alternative text"        />
+
+    </div>
+
+    </div>
+
+<!-- content end -->
diff --git a/tests/Integration/tests/body-elements/image-absolute/expected/subfolder/subpage.html b/tests/Integration/tests/body-elements/image-absolute/expected/subfolder/subpage.html
@@ -0,0 +1,35 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <title>Subpage</title>
+
+</head>
+<body>
+<!-- content start -->
+    <div class="section" id="subpage">
+    <h1>Subpage</h1>
+
+            <p>Lorem Ipsum Dolor.</p>
+            <div class="section" id="an-image-with-absolute-paths">
+    <h2>An image with absolute paths</h2>
+
+            <img
+    src="/images/hero2-illustration.svg"
+    width="400"            alt="Alternative text"        />
+
+    </div>
+
+            <div class="section" id="an-image-with-relative-paths">
+    <h2>An image with relative paths</h2>
+
+            <img
+    src="/subfolder/../images/hero2-illustration.svg"
+    width="400"            alt="Alternative text"        />
+
+    </div>
+
+    </div>
+
+<!-- content end -->
+</body>
+</html>
diff --git a/tests/Integration/tests/body-elements/image-absolute/input/guides.xml b/tests/Integration/tests/body-elements/image-absolute/input/guides.xml
@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<guides xmlns="https://www.phpdoc.org/guides"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:schemaLocation="https://www.phpdoc.org/guides packages/guides-cli/resources/schema/guides.xsd"
+        links-are-relative="false"
+>
+</guides>
diff --git a/...lements/image/input/hero-illustration.svg → ...mage-absolute/input/hero-illustration.svg b/...lements/image/input/hero-illustration.svg → ...mage-absolute/input/hero-illustration.svg
diff --git a/...image/input/images/hero2-illustration.svg → ...olute/input/images/hero2-illustration.svg b/...image/input/images/hero2-illustration.svg → ...olute/input/images/hero2-illustration.svg
diff --git a/...tests/body-elements/image/input/index.rst → ...y-elements/image-absolute/input/index.rst b/...tests/body-elements/image/input/index.rst → ...y-elements/image-absolute/input/index.rst
diff --git a/...lements/image/input/subfolder/subpage.rst → ...mage-absolute/input/subfolder/subpage.rst b/...lements/image/input/subfolder/subpage.rst → ...mage-absolute/input/subfolder/subpage.rst
diff --git a/...s/Integration/tests/body-elements/image-relative/expected/hero-illustration.svg b/...s/Integration/tests/body-elements/image-relative/expected/hero-illustration.svg