Enhancing how images are copied

Author: weaverryan

src/BuildContext.php

@@ -33,8 +33,16 @@ public function __construct(
 
     public function initializeRuntimeConfig(string $sourceDir, string $outputDir, ?string $parseSubPath = null, bool $disableCache = false, string $theme = Configuration::THEME_DEFAULT)
     {
-        $this->sourceDir          = $sourceDir;
-        $this->outputDir          = $outputDir;
+        if (!file_exists($sourceDir)) {
+            throw new \Exception(sprintf('Source directory "%s" does not exist', $sourceDir));
+        }
+
+        if (!file_exists($outputDir)) {
+            throw new \Exception(sprintf('Output directory "%s" does not exist', $outputDir));
+        }
+
+        $this->sourceDir          = realpath($sourceDir);
+        $this->outputDir          = realpath($outputDir);
         $this->parseSubPath       = $parseSubPath;
         $this->disableCache       = $disableCache;
         $this->theme              = $theme;

src/Command/BuildDocsCommand.php

@@ -5,7 +5,9 @@
 use Doctrine\Common\EventManager;
 use Doctrine\RST\Builder;
 use Doctrine\RST\Configuration;
+use Doctrine\RST\ErrorManager;
 use Doctrine\RST\Event\PostBuildRenderEvent;
+use Doctrine\RST\Event\PreNodeRenderEvent;
 use Doctrine\RST\Meta\Metas;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputArgument;
@@ -21,7 +23,7 @@
 use SymfonyDocsBuilder\KernelFactory;
 use SymfonyDocsBuilder\Listener\AssetsCopyListener;
 use SymfonyDocsBuilder\Listener\BuildProgressListener;
-use SymfonyDocsBuilder\Listener\CopyImagesDirectoryListener;
+use SymfonyDocsBuilder\Listener\CopyImagesListener;
 
 class BuildDocsCommand extends Command
 {
@@ -96,6 +98,8 @@ protected function initialize(InputInterface $input, OutputInterface $output)
             $filesystem->remove($htmlOutputDir);
         }
 
+        $filesystem->mkdir($htmlOutputDir);
+
         $parseSubPath = $input->getOption('parse-sub-path');
         if ($parseSubPath && $input->getOption('output-json')) {
             throw new \InvalidArgumentException('Cannot pass both --parse-sub-path and --output-json options.');
@@ -120,7 +124,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
             KernelFactory::createKernel($this->buildContext, $this->urlChecker ?? null)
         );
 
-        $this->initializeListeners($builder->getConfiguration()->getEventManager());
+        $this->addProgressListener($builder->getConfiguration()->getEventManager());
 
         $builder->build(
             $this->buildContext->getSourceDir(),
@@ -175,20 +179,8 @@ private function renderDocForPDF(Metas $metas)
         $htmlForPdfGenerator->generateHtmlForPdf();
     }
 
-    private function initializeListeners(EventManager $eventManager)
+    private function addProgressListener(EventManager $eventManager)
     {
-        $eventManager->addEventListener(
-            PostBuildRenderEvent::POST_BUILD_RENDER,
-            new CopyImagesDirectoryListener($this->buildContext)
-        );
-
-        if (!$this->buildContext->getParseSubPath()) {
-            $eventManager->addEventListener(
-                [PostBuildRenderEvent::POST_BUILD_RENDER],
-                new AssetsCopyListener($this->buildContext->getOutputDir())
-            );
-        }
-
         $progressListener = new BuildProgressListener($this->io);
         $progressListener->attachListeners($eventManager);
     }

src/DocsKernel.php

@@ -0,0 +1,48 @@
+<?php
+
+namespace SymfonyDocsBuilder;
+
+use Doctrine\Common\EventManager;
+use Doctrine\RST\Builder;
+use Doctrine\RST\Configuration;
+use Doctrine\RST\ErrorManager;
+use Doctrine\RST\Event\PostBuildRenderEvent;
+use Doctrine\RST\Event\PreNodeRenderEvent;
+use Doctrine\RST\Kernel;
+use SymfonyDocsBuilder\Listener\AssetsCopyListener;
+use SymfonyDocsBuilder\Listener\CopyImagesListener;
+
+class DocsKernel extends Kernel
+{
+    private $buildContext;
+
+    public function __construct(?Configuration $configuration = null, $directives = [], $references = [], BuildContext $buildContext)
+    {
+        parent::__construct($configuration, $directives, $references);
+
+        $this->buildContext = $buildContext;
+    }
+
+    public function initBuilder(Builder $builder): void
+    {
+        $this->initializeListeners(
+            $builder->getConfiguration()->getEventManager(),
+            $builder->getErrorManager()
+        );
+    }
+
+    private function initializeListeners(EventManager $eventManager, ErrorManager $errorManager)
+   {
+       $eventManager->addEventListener(
+           PreNodeRenderEvent::PRE_NODE_RENDER,
+           new CopyImagesListener($this->buildContext, $errorManager)
+       );
+
+       if (!$this->buildContext->getParseSubPath()) {
+           $eventManager->addEventListener(
+               [PostBuildRenderEvent::POST_BUILD_RENDER],
+               new AssetsCopyListener($this->buildContext->getOutputDir())
+           );
+       }
+   }
+}

src/KernelFactory.php

@@ -48,10 +48,11 @@ static function (string $path) use ($parseSubPath) : bool {
         $twig = $configuration->getTemplateEngine();
         $twig->addExtension(new AssetsExtension($buildContext->getOutputDir()));
 
-        return new Kernel(
+        return new DocsKernel(
             $configuration,
             self::getDirectives(),
-            self::getReferences($buildContext)
+            self::getReferences($buildContext),
+            $buildContext
         );
     }
 

src/Listener/CopyImagesDirectoryListener.php

@@ -0,0 +1,53 @@
+<?php declare(strict_types=1);
+
+namespace SymfonyDocsBuilder\Listener;
+
+use Doctrine\RST\ErrorManager;
+use Doctrine\RST\Event\PreNodeRenderEvent;
+use Doctrine\RST\Nodes\ImageNode;
+use Symfony\Component\Filesystem\Filesystem;
+use SymfonyDocsBuilder\BuildContext;
+
+class CopyImagesListener
+{
+    private $buildContext;
+    private $errorManager;
+
+    public function __construct(BuildContext $buildContext, ErrorManager $errorManager)
+    {
+        $this->buildContext = $buildContext;
+        $this->errorManager = $errorManager;
+    }
+
+    public function preNodeRender(PreNodeRenderEvent $event)
+    {
+        $node = $event->getNode();
+        if (!$node instanceof ImageNode) {
+            return;
+        }
+
+        $sourceImage = $node->getEnvironment()->absoluteRelativePath($node->getUrl());
+
+        if (!file_exists($sourceImage)) {
+            $this->errorManager->error(sprintf(
+                'Missing image file "%s" in "%s"',
+                $node->getUrl(),
+                $node->getEnvironment()->getCurrentFileName()
+            ));
+
+            return;
+        }
+
+        $fileInfo = new \SplFileInfo($sourceImage);
+        $fs = new Filesystem();
+
+        // the /_images path is currently hardcoded here and respected
+        // in the overridden image node template
+        $newPath = '/_images/'.$fileInfo->getFilename();
+        $fs->copy($sourceImage, $this->buildContext->getOutputDir().$newPath, true);
+
+        $node->setValue($node->getEnvironment()->relativeUrl(
+            '/_images/' . $fileInfo->getFilename()
+        ));
+    }
+}

src/Listener/CopyImagesListener.php

@@ -0,0 +1,5 @@
+{#
+    Overridden so we can control the path to the image based on our copying logic.
+    See CopyImagesListener.
+#}
+<img src="{{ imageNode.value }}" {% for key, value in imageNode.options %}{{ key }}="{{ value }}" {% endfor %}/>

src/Templates/default/html/image.html.twig

@@ -33,6 +33,7 @@ public function testIntegration(string $folder)
     {
         $fs = new Filesystem();
         $fs->remove(__DIR__.'/_output');
+        $fs->mkdir(__DIR__.'/_output');
 
         $buildContext = $this->createBuildContext(sprintf('%s/fixtures/source/%s', __DIR__, $folder));