Some renames

javiereguiluz · javiereguiluz · commit e320c4820de4 · 2021-07-15T09:17:19.000+02:00
diff --git a/src/BuildConfig.php b/src/BuildConfig.php
@@ -30,8 +30,10 @@ class BuildConfig
     private $subdirectoryToBuild;
     private $excludedPaths;
     private $fileFinder;
-    private $isContentAString;
-    private $disableJsonFileGeneration;
+    // needed to know if we're building an entire directory of RST contents or just a single RST string
+    private $contentIsString;
+    // these are the *.fjson files generated by Sphinx and maintained for compatibility reasons
+    private $generateJsonFiles;
 
     public function __construct()
     {
@@ -40,8 +42,8 @@ public function __construct()
         $this->symfonyVersion = '4.4';
         $this->excludedPaths = [];
         $this->imagesPublicPrefix = '';
-        $this->isContentAString = false;
-        $this->disableJsonFileGeneration = false;
+        $this->contentIsString = false;
+        $this->generateJsonFiles = true;
     }
 
     public function createFileFinder(): Finder
@@ -134,12 +136,12 @@ public function getImagesPublicPrefix(): string
 
     public function generateJsonFiles(): bool
     {
-        return !$this->disableJsonFileGeneration;
+        return $this->generateJsonFiles;
     }
 
     public function isContentAString(): bool
     {
-        return $this->isContentAString;
+        return $this->contentIsString;
     }
 
     public function setSymfonyVersion(string $version): self
@@ -234,17 +236,21 @@ public function setExcludedPaths(array $excludedPaths)
         $this->excludedPaths = $excludedPaths;
     }
 
-    // needed to differentiate between building a dir of contents or just a string of contents
-    public function setIsContentAString(bool $isString): self
+    /*
+     * Call this method when you're building a string of RST contents (e.g. the
+     * contents of a single file) instead of the common case of building an
+     * entire directory of RST files.
+     */
+    public function setContentIsString(): self
     {
-        $this->isContentAString = true;
+        $this->contentIsString = true;
 
         return $this;
     }
 
     public function disableJsonFileGeneration(): self
     {
-        $this->disableJsonFileGeneration = true;
+        $this->generateJsonFiles = false;
 
         return $this;
     }
diff --git a/src/DocBuilder.php b/src/DocBuilder.php
@@ -39,21 +39,22 @@ public function build(BuildConfig $config): BuildResult
             $filesystem->dumpFile($config->getOutputDir().'/build_errors.txt', implode("\n", $buildResult->getErrors()));
         }
 
-        $metas = $buildResult->getMetadata();
-        if ($config->getSubdirectoryToBuild()) {
-            $htmlForPdfGenerator = new HtmlForPdfGenerator($metas, $config);
-            $htmlForPdfGenerator->generateHtmlForPdf();
-        } elseif ($config->generateJsonFiles()) {
-            $jsonGenerator = new JsonGenerator($metas, $config);
-            $buildResult->setJsonResults($jsonGenerator->generateJson($builder->getIndexName()));
-        } elseif ($config->isContentAString()) {
+        if ($config->isContentAString()) {
             $htmlFilePath = $config->getOutputDir().'/index.html';
             if (is_file($htmlFilePath)) {
                 // generated HTML contents are a full HTML page, so we need to
                 // extract the contents of the <body> tag
                 $crawler = new Crawler(file_get_contents($htmlFilePath));
                 $buildResult->setStringResult(trim($crawler->filter('body')->html()));
             }
+        } elseif ($config->getSubdirectoryToBuild()) {
+            $metas = $buildResult->getMetadata();
+            $htmlForPdfGenerator = new HtmlForPdfGenerator($metas, $config);
+            $htmlForPdfGenerator->generateHtmlForPdf();
+        } elseif ($config->generateJsonFiles()) {
+            $metas = $buildResult->getMetadata();
+            $jsonGenerator = new JsonGenerator($metas, $config);
+            $buildResult->setJsonResults($jsonGenerator->generateJson($builder->getIndexName()));
         }
 
         return $buildResult;
@@ -62,7 +63,7 @@ public function build(BuildConfig $config): BuildResult
     public function buildString(string $contents): BuildResult
     {
         $filesystem = new Filesystem();
-        $tmpDir = sys_get_temp_dir().'/rst_'.random_int(1, 100000000);
+        $tmpDir = sys_get_temp_dir().'/doc_builder_build_string_'.random_int(1, 100000000);
         if ($filesystem->exists($tmpDir)) {
             $filesystem->remove($tmpDir);
         }
@@ -71,13 +72,16 @@ public function buildString(string $contents): BuildResult
         $filesystem->dumpFile($tmpDir.'/index.rst', $contents);
 
         $buildConfig = (new BuildConfig())
-            ->setIsContentAString(true)
+            ->setContentIsString()
             ->setContentDir($tmpDir)
             ->setOutputDir($tmpDir.'/output')
             ->disableBuildCache()
             ->disableJsonFileGeneration()
         ;
 
-        return $this->build($buildConfig);
+        $buildResult = $this->build($buildConfig);
+        $filesystem->remove($tmpDir);
+
+        return $buildResult;
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -30,8 +30,10 @@ class BuildConfig`
`30`	`30`	`private $subdirectoryToBuild;`
`31`	`31`	`private $excludedPaths;`
`32`	`32`	`private $fileFinder;`
`33`		`- private $isContentAString;`
`34`		`- private $disableJsonFileGeneration;`
	`33`	`+ // needed to know if we're building an entire directory of RST contents or just a single RST string`
	`34`	`+ private $contentIsString;`
	`35`	`+ // these are the *.fjson files generated by Sphinx and maintained for compatibility reasons`
	`36`	`+ private $generateJsonFiles;`
`35`	`37`
`36`	`38`	`public function __construct()`
`37`	`39`	`{`
`@@ -40,8 +42,8 @@ public function __construct()`
`40`	`42`	`$this->symfonyVersion = '4.4';`
`41`	`43`	`$this->excludedPaths = [];`
`42`	`44`	`$this->imagesPublicPrefix = '';`
`43`		`- $this->isContentAString = false;`
`44`		`- $this->disableJsonFileGeneration = false;`
	`45`	`+ $this->contentIsString = false;`
	`46`	`+ $this->generateJsonFiles = true;`
`45`	`47`	`}`
`46`	`48`
`47`	`49`	`public function createFileFinder(): Finder`
`@@ -134,12 +136,12 @@ public function getImagesPublicPrefix(): string`
`134`	`136`
`135`	`137`	`public function generateJsonFiles(): bool`
`136`	`138`	`{`
`137`		`- return !$this->disableJsonFileGeneration;`
	`139`	`+ return $this->generateJsonFiles;`
`138`	`140`	`}`
`139`	`141`
`140`	`142`	`public function isContentAString(): bool`
`141`	`143`	`{`
`142`		`- return $this->isContentAString;`
	`144`	`+ return $this->contentIsString;`
`143`	`145`	`}`
`144`	`146`
`145`	`147`	`public function setSymfonyVersion(string $version): self`
`@@ -234,17 +236,21 @@ public function setExcludedPaths(array $excludedPaths)`
`234`	`236`	`$this->excludedPaths = $excludedPaths;`
`235`	`237`	`}`
`236`	`238`
`237`		`- // needed to differentiate between building a dir of contents or just a string of contents`
`238`		`- public function setIsContentAString(bool $isString): self`
	`239`	`+ /*`
	`240`	`+ * Call this method when you're building a string of RST contents (e.g. the`
	`241`	`+ * contents of a single file) instead of the common case of building an`
	`242`	`+ * entire directory of RST files.`
	`243`	`+ */`
	`244`	`+ public function setContentIsString(): self`
`239`	`245`	`{`
`240`		`- $this->isContentAString = true;`
	`246`	`+ $this->contentIsString = true;`
`241`	`247`
`242`	`248`	`return $this;`
`243`	`249`	`}`
`244`	`250`
`245`	`251`	`public function disableJsonFileGeneration(): self`
`246`	`252`	`{`
`247`		`- $this->disableJsonFileGeneration = true;`
	`253`	`+ $this->generateJsonFiles = false;`
`248`	`254`
`249`	`255`	`return $this;`
`250`	`256`	`}`