Fixed the handling of custom image prefix

javiereguiluz · javiereguiluz · commit d37d011a8d10 · 2021-03-23T19:45:58.000+01:00
diff --git a/src/BuildConfig.php b/src/BuildConfig.php
@@ -37,7 +37,7 @@ public function __construct()
         $this->theme = Configuration::THEME_DEFAULT;
         $this->symfonyVersion = '4.4';
         $this->excludedPaths = [];
-        $this->imagesPublicPrefix = '/_images';
+        $this->imagesPublicPrefix = '';
     }
 
     public function createFileFinder(): Finder
diff --git a/src/Listener/CopyImagesListener.php b/src/Listener/CopyImagesListener.php
@@ -53,7 +53,11 @@ public function preNodeRender(PreNodeRenderEvent $event)
         $newAbsoluteFilePath = $this->buildConfig->getImagesDir().'/'.$fileInfo->getFilename();
         $fs->copy($sourceImage, $newAbsoluteFilePath, true);
 
-        $newUrlPath = $this->buildConfig->getImagesPublicPrefix().'/'.$fileInfo->getFilename();
-        $node->setValue($node->getEnvironment()->relativeUrl($newUrlPath));
+        if ('' === $this->buildConfig->getImagesPublicPrefix()) {
+            $newUrlPath = $node->getEnvironment()->relativeUrl('_images/'.$fileInfo->getFilename());
+        } else {
+            $newUrlPath = $this->buildConfig->getImagesPublicPrefix().'/'.$fileInfo->getFilename();
+        }
+        $node->setValue($newUrlPath);
     }
 }
diff --git a/tests/Command/BuildDocsCommandTest.php b/tests/Command/BuildDocsCommandTest.php
@@ -90,6 +90,30 @@ public function testBuildDocsForPdf()
         $this->assertStringContainsString('[OK] Build complete', $output);
     }
 
+    public function testBuildDocsWithCustomImagePrefix()
+    {
+        $buildConfig = $this->createBuildConfig();
+        $buildConfig->setImagesPublicPrefix('/some/custom/prefix-for-images');
+        $outputDir = __DIR__.'/../_output';
+
+        $filesystem = new Filesystem();
+        $filesystem->remove($outputDir);
+        $filesystem->mkdir($outputDir);
+
+        $output = $this->executeCommand(
+            $buildConfig,
+            [
+                'source-dir' => __DIR__.'/../fixtures/source/main',
+                'output-dir' => $outputDir,
+            ]
+        );
+
+        $this->assertStringContainsString('[OK] Build complete', $output);
+
+        $generatedHtml = file_get_contents($outputDir.'/index.html');
+        $this->assertStringContainsString('/some/custom/prefix-for-images/symfony-logo.png', $generatedHtml);
+    }
+
     private function executeCommand(BuildConfig $buildConfig, array $input): string
     {
         $input['--no-theme'] = true;
diff --git a/tests/fixtures/expected/main/form/form_type.html b/tests/fixtures/expected/main/form/form_type.html
@@ -3,15 +3,15 @@
     <head>
         <meta charset="utf-8" />
 
-            
+
     </head>
 
     <body>
             <div class="section">
 <h1 id="formtype-documentation"><a class="headerlink" href="#formtype-documentation" title="Permalink to this headline">FormType Documentation</a></h1>
 <span id="internal-reference"></span>
-<img src="../_images/symfony-logo.png" />
+<img src="_images/symfony-logo.png" />
 </div>
 
     </body>
-</html>
+</html>

Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@ public function __construct()`
`37`	`37`	`$this->theme = Configuration::THEME_DEFAULT;`
`38`	`38`	`$this->symfonyVersion = '4.4';`
`39`	`39`	`$this->excludedPaths = [];`
`40`		`- $this->imagesPublicPrefix = '/_images';`
	`40`	`+ $this->imagesPublicPrefix = '';`
`41`	`41`	`}`
`42`	`42`
`43`	`43`	`public function createFileFinder(): Finder`
Original file line number	Diff line number	Diff line change
`@@ -53,7 +53,11 @@ public function preNodeRender(PreNodeRenderEvent $event)`
`53`	`53`	`$newAbsoluteFilePath = $this->buildConfig->getImagesDir().'/'.$fileInfo->getFilename();`
`54`	`54`	`$fs->copy($sourceImage, $newAbsoluteFilePath, true);`
`55`	`55`
`56`		`- $newUrlPath = $this->buildConfig->getImagesPublicPrefix().'/'.$fileInfo->getFilename();`
`57`		`- $node->setValue($node->getEnvironment()->relativeUrl($newUrlPath));`
	`56`	`+ if ('' === $this->buildConfig->getImagesPublicPrefix()) {`
	`57`	`+ $newUrlPath = $node->getEnvironment()->relativeUrl('_images/'.$fileInfo->getFilename());`
	`58`	`+ } else {`
	`59`	`+ $newUrlPath = $this->buildConfig->getImagesPublicPrefix().'/'.$fileInfo->getFilename();`
	`60`	`+ }`
	`61`	`+ $node->setValue($newUrlPath);`
`58`	`62`	`}`
`59`	`63`	`}`