Rendering JSON files as .fjson and in same directory

This is to match Sphinx

Author: weaverryan

.gitignore

@@ -1,4 +1,3 @@
 /vendor/
 /tests/_output
-/tests/_outputJson
 /var/

src/BuildContext.php

@@ -12,8 +12,7 @@ class BuildContext
 
     private $runtimeInitialized = false;
     private $sourceDir;
-    private $htmlOutputDir;
-    private $jsonOutputDir;
+    private $outputDir;
     private $parseSubPath;
     private $disableCache = false;
 
@@ -31,11 +30,10 @@ public function __construct(
         $this->symfonyDocUrl  = $symfonyDocUrl;
     }
 
-    public function initializeRuntimeConfig(string $sourceDir, string $htmlOutputDir, ?string $jsonOutputDir = null, ?string $parseSubPath = null, bool $disableCache = false)
+    public function initializeRuntimeConfig(string $sourceDir, string $outputDir, ?string $parseSubPath = null, bool $disableCache = false)
     {
         $this->sourceDir          = $sourceDir;
-        $this->htmlOutputDir      = $htmlOutputDir;
-        $this->jsonOutputDir      = $jsonOutputDir;
+        $this->outputDir          = $outputDir;
         $this->parseSubPath       = $parseSubPath;
         $this->disableCache       = $disableCache;
         $this->runtimeInitialized = true;
@@ -73,18 +71,11 @@ public function getSourceDir(): string
         return $this->sourceDir;
     }
 
-    public function getHtmlOutputDir(): string
+    public function getOutputDir(): string
     {
         $this->checkThatRuntimeConfigIsInitialized();
 
-        return $this->htmlOutputDir;
-    }
-
-    public function getJsonOutputDir(): string
-    {
-        $this->checkThatRuntimeConfigIsInitialized();
-
-        return $this->jsonOutputDir;
+        return $this->outputDir;
     }
 
     public function getParseSubPath(): ?string

src/CI/MissingFilesChecker.php

@@ -33,7 +33,7 @@ public function getMissingFiles(): array
         foreach ($this->finder as $file) {
             $htmlFile = str_replace(
                 [$this->buildContext->getSourceDir(), '.rst'],
-                [$this->buildContext->getHtmlOutputDir(), '.html'],
+                [$this->buildContext->getOutputDir(), '.html'],
                 $file->getRealPath()
             );
 

src/Command/CheckUrlsCommand.php

@@ -61,7 +61,7 @@ protected function execute(InputInterface $input, OutputInterface $output)
             $this->io->success('All urls in the docs are valid!');
         }
 
-        $this->filesystem->remove($this->buildContext->getHtmlOutputDir());
+        $this->filesystem->remove($this->buildContext->getOutputDir());
     }
 
     public function preBuildRender()

src/Command/CommandInitializerTrait.php

@@ -49,7 +49,6 @@ private function doInitialize(InputInterface $input, OutputInterface $output, st
         $this->buildContext->initializeRuntimeConfig(
             $sourceDir,
             $this->initializeHtmlOutputDir($this->filesystem, $outputDir),
-            $this->initializeJsonOutputDir($outputDir),
             $this->initializeParseSubPath($input, $sourceDir),
             $this->isCacheDisabled()
         );
@@ -104,16 +103,6 @@ private function initializeParseSubPath(InputInterface $input, string $sourceDir
         return $parseSubPath;
     }
 
-    private function initializeJsonOutputDir(string $outputDir): string
-    {
-        $jsonOutputDir = $this->getRealAbsolutePath($outputDir.'/_json', $this->filesystem);
-        if ($this->isCacheDisabled() && $this->filesystem->exists($jsonOutputDir)) {
-            $this->filesystem->remove($jsonOutputDir);
-        }
-
-        return $jsonOutputDir;
-    }
-
     private function getRealAbsolutePath(string $path, Filesystem $filesystem): string
     {
         return sprintf(
@@ -157,7 +146,7 @@ private function startBuild()
 
         $this->builder->build(
             $this->buildContext->getSourceDir(),
-            $this->buildContext->getHtmlOutputDir()
+            $this->buildContext->getOutputDir()
         );
     }
 
@@ -174,8 +163,8 @@ function (string $rstFile) {
             array_keys(iterator_to_array($finder))
         );
 
-        $this->sanitizeOutputDir($rstFiles, $this->buildContext->getHtmlOutputDir(), 'html');
-        $this->sanitizeOutputDir($rstFiles, $this->buildContext->getJsonOutputDir(), 'json');
+        $this->sanitizeOutputDir($rstFiles, $this->buildContext->getOutputDir(), 'html');
+        $this->sanitizeOutputDir($rstFiles, $this->buildContext->getOutputDir(), 'fjson');
     }
 
     private function sanitizeOutputDir(array $existingRstFiles, string $outputDir, string $format)

src/Generator/HtmlForPdfGenerator.php

@@ -24,7 +24,7 @@ public function __construct(Metas $metas, BuildContext $buildContext)
     public function generateHtmlForPdf() {
 
         $finder = new Finder();
-        $finder->in($this->buildContext->getHtmlOutputDir())
+        $finder->in($this->buildContext->getOutputDir())
             ->depth(0)
             ->notName([$this->buildContext->getParseSubPath(), '_images']);
 
@@ -33,21 +33,21 @@ public function generateHtmlForPdf() {
             $fs->remove($file->getRealPath());
         }
 
-        $basePath  = sprintf('%s/%s', $this->buildContext->getHtmlOutputDir(), $this->buildContext->getParseSubPath());
+        $basePath  = sprintf('%s/%s', $this->buildContext->getOutputDir(), $this->buildContext->getParseSubPath());
         $indexFile = sprintf('%s/%s', $basePath, 'index.html');
         if (!$fs->exists($indexFile)) {
             throw new \InvalidArgumentException(sprintf('File "%s" does not exist', $indexFile));
         }
 
         // extracting all files from index's TOC, in the right order
-        $parserFilename = $this->getParserFilename($indexFile, $this->buildContext->getHtmlOutputDir());
+        $parserFilename = $this->getParserFilename($indexFile, $this->buildContext->getOutputDir());
         $meta           = $this->getMetaEntry($parserFilename);
         $files          = current($meta->getTocs());
         array_unshift($files, sprintf('%s/index', $this->buildContext->getParseSubPath()));
 
         // building one big html file with all contents
         $content = '';
-        $htmlDir = $this->buildContext->getHtmlOutputDir();
+        $htmlDir = $this->buildContext->getOutputDir();
         $relativeImagesPath = str_repeat('../', substr_count($this->buildContext->getParseSubPath(), '/'));
         foreach ($files as $file) {
             $meta = $this->getMetaEntry($file);

src/Generator/JsonGenerator.php

@@ -33,12 +33,11 @@ public function generateJson(ProgressBar $progressBar)
 
         foreach ($this->metas->getAll() as $filename => $metaEntry) {
             $parserFilename = $filename;
-            $jsonFilename   = $this->buildContext->getJsonOutputDir().'/'.$filename.'.json';
+            $jsonFilename   = $this->buildContext->getOutputDir().'/'.$filename.'.fjson';
 
-            $crawler = new Crawler(file_get_contents($this->buildContext->getHtmlOutputDir().'/'.$filename.'.html'));
+            $crawler = new Crawler(file_get_contents($this->buildContext->getOutputDir().'/'.$filename.'.html'));
 
             $data = [
-                'body'              => $crawler->filter('body')->html(),
                 'title'             => $metaEntry->getTitle(),
                 'current_page_name' => $parserFilename,
                 'toc'               => $this->generateToc($metaEntry, current($metaEntry->getTitles())[1]),
@@ -48,6 +47,7 @@ public function generateJson(ProgressBar $progressBar)
                     $this->guessNext($parserFilename),
                     $this->guessPrev($parserFilename),
                 ],
+                'body'              => $crawler->filter('body')->html(),
             ];
 
             $fs->dumpFile(

src/Listener/CopyImagesDirectoryListener.php

@@ -18,7 +18,7 @@ public function postBuildRender()
     {
         $fs = new Filesystem();
         if ($fs->exists($imageDir = sprintf('%s/_images', $this->buildContext->getSourceDir()))) {
-            $fs->mirror($imageDir, sprintf('%s/_images', $this->buildContext->getHtmlOutputDir()));
+            $fs->mirror($imageDir, sprintf('%s/_images', $this->buildContext->getOutputDir()));
         }
     }
 }

tests/IntegrationTest.php

@@ -77,7 +77,7 @@ public function testIntegration(string $folder)
 
         foreach ($finder as $htmlFile) {
             $relativePath   = $htmlFile->getRelativePathname();
-            $actualFilename = __DIR__.'/_outputJson/'.str_replace('.html', '.json', $relativePath);
+            $actualFilename = __DIR__.'/_output/'.str_replace('.html', '.fjson', $relativePath);
             $this->assertFileExists($actualFilename);
 
             $jsonData = json_decode(file_get_contents($actualFilename), true);
@@ -286,7 +286,6 @@ private function createBuildContext(string $sourceDir): BuildContext
         $buildContext->initializeRuntimeConfig(
             $sourceDir,
             __DIR__.'/_output',
-            __DIR__.'/_outputJson',
             null
         );