Merge pull request #599 from phpDocumentor/feature/renderSingleFile

[FEATURE] Add option input-file to render a specific file

Author: jaapio

packages/guides-cli/resources/schema/guides.xsd

@@ -16,6 +16,7 @@
         </xsd:choice>
 
         <xsd:attribute name="input" type="xsd:string"/>
+        <xsd:attribute name="input-file" type="xsd:string"/>
         <xsd:attribute name="output" type="xsd:string"/>
         <xsd:attribute name="input-format" type="xsd:string"/>
         <xsd:attribute name="log-path" type="xsd:string"/>

packages/guides-cli/src/Command/Run.php

@@ -15,6 +15,7 @@
 use phpDocumentor\Guides\Compiler\CompilerContext;
 use phpDocumentor\Guides\Handlers\CompileDocumentsCommand;
 use phpDocumentor\Guides\Handlers\ParseDirectoryCommand;
+use phpDocumentor\Guides\Handlers\ParseFileCommand;
 use phpDocumentor\Guides\Handlers\RenderCommand;
 use phpDocumentor\Guides\Intersphinx\InventoryRepository;
 use phpDocumentor\Guides\Nodes\ProjectNode;
@@ -36,6 +37,7 @@
 use function implode;
 use function is_countable;
 use function is_dir;
+use function pathinfo;
 use function realpath;
 use function sprintf;
 use function str_starts_with;
@@ -63,6 +65,13 @@ public function __construct(
             'Directory to read for files',
         );
 
+        $this->addOption(
+            'input-file',
+            null,
+            InputOption::VALUE_REQUIRED,
+            'If set only this file is parsed.',
+        );
+
         $this->addOption(
             'input-format',
             null,
@@ -114,6 +123,19 @@ private function getSettingsOverridenWithInput(InputInterface $input): ProjectSe
             $settings->setOutput((string) $input->getArgument('output'));
         }
 
+        if ($input->getOption('input-file')) {
+            $inputFile = (string) $input->getOption('input-file');
+            $pathInfo = pathinfo($inputFile);
+            $settings->setInputFile($pathInfo['filename']);
+            if (!empty($pathInfo['extension'])) {
+                $settings->setInputFormat($pathInfo['extension']);
+            }
+        }
+
+        if ($input->getOption('input-format')) {
+            $settings->setInputFormat((string) $input->getOption('input-format'));
+        }
+
         if ($input->getOption('log-path')) {
             $settings->setLogPath((string) $input->getOption('log-path'));
         }
@@ -122,10 +144,6 @@ private function getSettingsOverridenWithInput(InputInterface $input): ProjectSe
             $settings->setFailOnError(true);
         }
 
-        if ($input->getOption('input-format')) {
-            $settings->setInputFormat((string) $input->getOption('input-format'));
-        }
-
         if (count($input->getOption('output-format')) > 0) {
             $settings->setOutputFormats($input->getOption('output-format'));
         }
@@ -168,16 +186,30 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             $this->logger->pushProcessor($spyProcessor);
         }
 
-        $documents = $this->commandBus->handle(
-            new ParseDirectoryCommand(
-                $sourceFileSystem,
-                '',
-                $settings->getInputFormat(),
-                $projectNode,
-            ),
-        );
-
+        $documents = [];
 
+        if ($settings->getInputFile() === '') {
+            $documents = $this->commandBus->handle(
+                new ParseDirectoryCommand(
+                    $sourceFileSystem,
+                    '',
+                    $settings->getInputFormat(),
+                    $projectNode,
+                ),
+            );
+        } else {
+            $documents[] = $this->commandBus->handle(
+                new ParseFileCommand(
+                    $sourceFileSystem,
+                    '',
+                    $settings->getInputFile(),
+                    $settings->getInputFormat(),
+                    1,
+                    $projectNode,
+                    true,
+                ),
+            );
+        }
 
         $this->themeManager->useTheme($settings->getTheme());
 

packages/guides/src/DependencyInjection/GuidesExtension.php

@@ -22,6 +22,7 @@
 use function assert;
 use function dirname;
 use function is_array;
+use function pathinfo;
 
 class GuidesExtension extends Extension implements CompilerPassInterface, ConfigurationInterface
 {
@@ -53,6 +54,7 @@ public function getConfigTreeBuilder(): TreeBuilder
                 ->end()
                 ->scalarNode('theme')->end()
                 ->scalarNode('input')->end()
+                ->scalarNode('input_file')->end()
                 ->scalarNode('output')->end()
                 ->scalarNode('input_format')->end()
                 ->arrayNode('output_format')
@@ -128,6 +130,15 @@ public function load(array $configs, ContainerBuilder $container): void
             $projectSettings->setInput((string) $config['input']);
         }
 
+        if (isset($config['input_file']) && $config['input_file'] !== '') {
+            $inputFile = (string) $config['input_file'];
+            $pathInfo = pathinfo($inputFile);
+            $projectSettings->setInputFile($pathInfo['filename']);
+            if (!empty($pathInfo['extension'])) {
+                $projectSettings->setInputFormat($pathInfo['extension']);
+            }
+        }
+
         if (isset($config['output'])) {
             $projectSettings->setOutput((string) $config['output']);
         }

packages/guides/src/Settings/ProjectSettings.php

@@ -12,6 +12,7 @@ class ProjectSettings
     private string $version = '';
     private string $theme = 'default';
     private string $input = 'docs';
+    private string $inputFile = '';
     private string $output = 'output';
     private string $inputFormat = 'rst';
     /** @var string[]  */
@@ -133,4 +134,14 @@ public function setOutputFormats(array $outputFormats): void
     {
         $this->outputFormats = $outputFormats;
     }
+
+    public function getInputFile(): string
+    {
+        return $this->inputFile;
+    }
+
+    public function setInputFile(string $inputFile): void
+    {
+        $this->inputFile = $inputFile;
+    }
 }

tests/Integration/tests/input-file/expected/README.html

@@ -0,0 +1,12 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+<title>Document Title</title>
+</head>
+<body>
+    <div class="section" id="document-title">
+    <h1>Document Title</h1>
+            <p>Lorem Ipsum Dolor.</p>
+    </div>
+</body>
+</html>

tests/Integration/tests/input-file/input/README.rst

@@ -0,0 +1,5 @@
+==============
+Document Title
+==============
+
+Lorem Ipsum Dolor.

tests/Integration/tests/input-file/input/guides.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<guides
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:schemaLocation="https://www.phpdoc.org/guides packages/guides-cli/resources/schema/guides.xsd"
+        input-file="README.rst"
+>
+</guides>