Merge pull request #22 from weaverryan/fix-cache-issue

Fix cache issue

Author: weaverryan

src/BuildContext.php

@@ -15,6 +15,7 @@ class BuildContext
     private $htmlOutputDir;
     private $jsonOutputDir;
     private $parseSubPath;
+    private $disableCache = false;
 
     public function __construct(
         string $basePath,
@@ -30,12 +31,13 @@ public function __construct(
         $this->symfonyDocUrl  = $symfonyDocUrl;
     }
 
-    public function initializeRuntimeConfig(string $sourceDir, string $htmlOutputDir, ?string $jsonOutputDir = null, ?string $parseSubPath = null)
+    public function initializeRuntimeConfig(string $sourceDir, string $htmlOutputDir, ?string $jsonOutputDir = null, ?string $parseSubPath = null, bool $disableCache = false)
     {
         $this->sourceDir          = $sourceDir;
         $this->htmlOutputDir      = $htmlOutputDir;
         $this->jsonOutputDir      = $jsonOutputDir;
         $this->parseSubPath       = $parseSubPath;
+        $this->disableCache       = $disableCache;
         $this->runtimeInitialized = true;
     }
 
@@ -92,6 +94,13 @@ public function getParseSubPath(): ?string
         return $this->parseSubPath;
     }
 
+    public function getDisableCache(): bool
+    {
+        $this->checkThatRuntimeConfigIsInitialized();
+
+        return $this->disableCache;
+    }
+
     private function checkThatRuntimeConfigIsInitialized()
     {
         if (false === $this->runtimeInitialized) {

src/Command/BuildDocsCommand.php

@@ -3,6 +3,8 @@
 namespace SymfonyDocsBuilder\Command;
 
 use Doctrine\RST\Event\PostBuildRenderEvent;
+use Doctrine\RST\Meta\CachedMetasLoader;
+use Doctrine\RST\Meta\Metas;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Helper\ProgressBar;
 use Symfony\Component\Console\Input\InputArgument;
@@ -49,6 +51,12 @@ protected function configure()
                 InputOption::VALUE_OPTIONAL,
                 'Parse only given sub directory and combine it into a single file (directory relative from source-dir)',
                 ''
+            )
+            ->addOption(
+                'disable-cache',
+                null,
+                InputOption::VALUE_NONE,
+                'If provided, caching meta will be disabled'
             );
     }
 
@@ -74,29 +82,40 @@ protected function execute(InputInterface $input, OutputInterface $output)
 
         $this->missingFilesChecker->checkMissingFiles($this->io);
 
+        $metas = $this->getMetas();
         if (!$this->buildContext->getParseSubPath()) {
-            $this->generateJson();
+            $this->generateJson($metas);
         } else {
-            $this->renderDocForPDF();
+            $this->renderDocForPDF($metas);
         }
 
         $this->io->newLine(2);
-        $this->io->success('Parse process complete');
+
+        $successMessage = 'Parse process complete';
+
+        if (!$this->buildContext->getDisableCache()) {
+            $successMessage = sprintf(
+                '%s (%d files were loaded from cache)',
+                $successMessage,
+                $this->finder->count() - count($this->builder->getDocuments()->getAll())
+            );
+        }
+        $this->io->success($successMessage);
     }
 
-    private function generateJson()
+    private function generateJson(Metas $metas)
     {
         $this->io->note('Start exporting doc into json files');
         $this->progressBar = new ProgressBar($this->output, $this->finder->count());
 
-        $jsonGenerator = new JsonGenerator();
-        $jsonGenerator->generateJson($this->builder->getDocuments()->getAll(), $this->buildContext, $this->progressBar);
+        $jsonGenerator = new JsonGenerator($metas, $this->buildContext);
+        $jsonGenerator->generateJson($this->progressBar);
     }
 
-    private function renderDocForPDF()
+    private function renderDocForPDF(Metas $metas)
     {
-        $htmlForPdfGenerator = new HtmlForPdfGenerator();
-        $htmlForPdfGenerator->generateHtmlForPdf($this->builder->getDocuments()->getAll(), $this->buildContext);
+        $htmlForPdfGenerator = new HtmlForPdfGenerator($metas, $this->buildContext);
+        $htmlForPdfGenerator->generateHtmlForPdf();
     }
 
     public function preBuildRender()
@@ -105,4 +124,17 @@ public function preBuildRender()
 
         $this->io->note('Start rendering in HTML...');
     }
+
+    private function getMetas(): Metas
+    {
+        /*
+         * TODO - get this from the Builder when it is exposed
+         * https://github.com/doctrine/rst-parser/pull/97
+         */
+        $metas = new Metas();
+        $cachedMetasLoader = new CachedMetasLoader();
+        $cachedMetasLoader->loadCachedMetaEntries($this->buildContext->getHtmlOutputDir(), $metas);
+
+        return $metas;
+    }
 }

src/Command/CommandInitializerTrait.php

@@ -24,6 +24,8 @@ trait CommandInitializerTrait
     private $io;
     /** @var OutputInterface */
     private $output;
+    /** @var InputInterface */
+    private $input;
     /** @var Builder */
     private $builder;
     /** @var Filesystem */
@@ -40,13 +42,15 @@ trait CommandInitializerTrait
     private function doInitialize(InputInterface $input, OutputInterface $output, string $sourceDir, string $outputDir)
     {
         $this->io     = new SymfonyStyle($input, $output);
+        $this->input  = $input;
         $this->output = $output;
 
         $this->buildContext->initializeRuntimeConfig(
             $sourceDir,
             $this->initializeHtmlOutputDir($this->filesystem, $outputDir),
             $this->initializeJsonOutputDir($outputDir),
-            $this->initializeParseSubPath($input, $sourceDir)
+            $this->initializeParseSubPath($input, $sourceDir),
+            $this->isCacheDisabled()
         );
 
         $this->builder = new Builder(
@@ -70,7 +74,12 @@ private function initializeSourceDir(InputInterface $input, Filesystem $filesyst
 
     private function initializeHtmlOutputDir(Filesystem $filesystem, string $path): string
     {
-        return rtrim($this->getRealAbsolutePath($path, $filesystem), '/');
+        $htmlOutputDir = rtrim($this->getRealAbsolutePath($path, $filesystem), '/');
+        if ($this->isCacheDisabled() && $filesystem->exists($htmlOutputDir)) {
+            $filesystem->remove($htmlOutputDir);
+        }
+
+        return $htmlOutputDir;
     }
 
     private function initializeParseSubPath(InputInterface $input, string $sourceDir): string
@@ -96,8 +105,8 @@ private function initializeParseSubPath(InputInterface $input, string $sourceDir
 
     private function initializeJsonOutputDir(string $outputDir): string
     {
-        $jsonOutputDir = $this->getRealAbsolutePath($outputDir.'/json', $this->filesystem);
-        if ($this->filesystem->exists($jsonOutputDir)) {
+        $jsonOutputDir = $this->getRealAbsolutePath($outputDir.'/_json', $this->filesystem);
+        if ($this->isCacheDisabled() && $this->filesystem->exists($jsonOutputDir)) {
             $this->filesystem->remove($jsonOutputDir);
         }
 
@@ -134,6 +143,8 @@ private function startBuild()
             ->notName('*.rst.inc')
             ->name('*.rst');
 
+        $this->sanitizeOutputDirs($this->finder);
+
         $this->io->note(sprintf('Start parsing %d rst files', $this->finder->count()));
         $this->progressBar = new ProgressBar($this->output, $this->finder->count());
 
@@ -143,6 +154,57 @@ private function startBuild()
         );
     }
 
+    /**
+     * Removes all existing html files in the output dir that should not exist
+     * because previous build in the same output directory has been executed on another version
+     */
+    private function sanitizeOutputDirs(Finder $finder)
+    {
+        $rstFiles = array_map(
+            function (string $rstFile) {
+                return str_replace([$this->buildContext->getSourceDir(), '.rst'], '', $rstFile);
+            },
+            array_keys(iterator_to_array($finder))
+        );
+
+        $this->sanitizeOutputDir($rstFiles, $this->buildContext->getHtmlOutputDir(), 'html');
+        $this->sanitizeOutputDir($rstFiles, $this->buildContext->getJsonOutputDir(), 'json');
+    }
+
+    private function sanitizeOutputDir(array $existingRstFiles, string $outputDir, string $format)
+    {
+        if (!$this->filesystem->exists($outputDir)) {
+            return;
+        }
+
+        $htmlFinder = new Finder();
+        $htmlFinder->in($outputDir)
+            ->name('*.html');
+
+        $htmlFiles = array_map(
+            function (string $htmlFile) use ($outputDir, $format) {
+                return str_replace([$outputDir, '.'.$format], '', $htmlFile);
+            },
+            array_keys(iterator_to_array($htmlFinder))
+        );
+
+        $filesNotExistingInCurrentVersion = array_map(
+            function ($file) use ($outputDir, $format) {
+                return sprintf('%s%s.%s', $outputDir, $file, $format);
+            },
+            array_values(array_diff($htmlFiles, $existingRstFiles))
+        );
+
+        foreach ($filesNotExistingInCurrentVersion as $file) {
+            $this->filesystem->remove($file);
+        }
+    }
+
+    private function isCacheDisabled(): bool
+    {
+        return $this->input->hasOption('disable-cache') && (bool) $this->input->getOption('disable-cache');
+    }
+
     public function postParseDocument(PostParseDocumentEvent $postParseDocumentEvent): void
     {
         $file = $postParseDocumentEvent->getDocumentNode()->getEnvironment()->getCurrentFileName();