Merge pull request #802 from phpDocumentor/feature/load-composer-json

[FEATURE] Load data from composer.json if present

Author: jaapio

composer.json

@@ -14,6 +14,11 @@
         },
         "sort-packages": true
     },
+    "support": {
+        "issues": "https://github.com/phpDocumentor/guides/issues",
+        "source": "https://github.com/phpDocumentor/guides",
+        "docs": "https://docs.phpdoc.org/3.0/guide/guides/index.html"
+    },
     "autoload-dev": {
         "psr-4": {
             "phpDocumentor\\Guides\\": ["packages/guides/tests/unit/", "tests/"],

docs/index.rst

@@ -6,13 +6,23 @@
     dev-main
 
 ====================
-phpDocumentor Guides
+|project|
 ====================
 
 This library can be used for rendering of
 `reStructuredText Markup <https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html>`__ and
 `Markdown <https://daringfireball.net/projects/markdown/>`__.
 
+Description
+    |composer_description|
+Source
+   |composer_support_source|
+Report issues
+   |composer_support_issues|
+Latest public documentation
+    |composer_support_docs|
+
+
 Tip: Render this documentation
 ==============================
 

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

@@ -16,6 +16,7 @@
 use phpDocumentor\Guides\Event\PostCollectFilesForParsingEvent;
 use phpDocumentor\Guides\Event\PostParseDocument;
 use phpDocumentor\Guides\Event\PostParseProcess;
+use phpDocumentor\Guides\Event\PostProjectNodeCreated;
 use phpDocumentor\Guides\Event\PostRenderDocument;
 use phpDocumentor\Guides\Event\PostRenderProcess;
 use phpDocumentor\Guides\Event\PreParseDocument;
@@ -41,6 +42,7 @@
 use Symfony\Component\EventDispatcher\EventDispatcher;
 
 use function array_pop;
+use function assert;
 use function count;
 use function getcwd;
 use function implode;
@@ -199,7 +201,7 @@ static function (PostRenderProcess $event) use ($renderingProgressBar, $renderin
         );
     }
 
-    private function getSettingsOverridenWithInput(InputInterface $input): ProjectSettings
+    private function getSettingsOverriddenWithInput(InputInterface $input): ProjectSettings
     {
         $settings = $this->settingsManager->getProjectSettings();
 
@@ -249,7 +251,7 @@ private function getSettingsOverridenWithInput(InputInterface $input): ProjectSe
 
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
-        $settings = $this->getSettingsOverridenWithInput($input);
+        $settings = $this->getSettingsOverriddenWithInput($input);
         $inputDir = $this->getAbsolutePath($settings->getInput());
         if (!is_dir($inputDir)) {
             throw new RuntimeException(sprintf('Input directory "%s" was not found! ' . "\n" .
@@ -264,6 +266,12 @@ protected function execute(InputInterface $input, OutputInterface $output): int
             $this->clock->now(),
         );
 
+        $event = new PostProjectNodeCreated($projectNode, $settings);
+        $event = $this->eventDispatcher->dispatch($event);
+        assert($event instanceof PostProjectNodeCreated);
+        $projectNode = $event->getProjectNode();
+        $settings = $event->getSettings();
+
         $outputDir = $this->getAbsolutePath($settings->getOutput());
         $sourceFileSystem = new Filesystem(new Local($settings->getInput()));
         $sourceFileSystem->addPlugin(new Finder());

packages/guides/resources/config/guides.php

@@ -10,6 +10,8 @@
 use phpDocumentor\Guides\Compiler\NodeTransformers\CustomNodeTransformerFactory;
 use phpDocumentor\Guides\Compiler\NodeTransformers\MenuNodeTransformers\InternalMenuEntryNodeTransformer;
 use phpDocumentor\Guides\Compiler\NodeTransformers\NodeTransformerFactory;
+use phpDocumentor\Guides\Event\PostProjectNodeCreated;
+use phpDocumentor\Guides\EventListener\LoadSettingsFromComposer;
 use phpDocumentor\Guides\NodeRenderers\Html\BreadCrumbNodeRenderer;
 use phpDocumentor\Guides\NodeRenderers\Html\DocumentNodeRenderer;
 use phpDocumentor\Guides\NodeRenderers\Html\MenuEntryRenderer;
@@ -47,6 +49,7 @@
 use phpDocumentor\Guides\Renderer\UrlGenerator\ConfigurableUrlGenerator;
 use phpDocumentor\Guides\Renderer\UrlGenerator\RelativeUrlGenerator;
 use phpDocumentor\Guides\Renderer\UrlGenerator\UrlGeneratorInterface;
+use phpDocumentor\Guides\Settings\ComposerSettingsLoader;
 use phpDocumentor\Guides\Settings\SettingsManager;
 use phpDocumentor\Guides\TemplateRenderer;
 use phpDocumentor\Guides\Twig\AssetsExtension;
@@ -217,6 +220,11 @@
             param('phpdoc.guides.base_template_paths'),
         )
 
+        ->set(LoadSettingsFromComposer::class)
+        ->tag('event_listener', ['event' => PostProjectNodeCreated::class])
+
+        ->set(ComposerSettingsLoader::class)
+
         ->set(EnvironmentBuilder::class)
         ->arg('$extensions', tagged_iterator('twig.extension'))
         ->arg('$themeManager', service(ThemeManager::class))

packages/guides/src/Event/PostProjectNodeCreated.php

@@ -0,0 +1,37 @@
+<?php
+
+declare(strict_types=1);
+
+namespace phpDocumentor\Guides\Event;
+
+use phpDocumentor\Guides\Nodes\ProjectNode;
+use phpDocumentor\Guides\Settings\ProjectSettings;
+
+final class PostProjectNodeCreated
+{
+    public function __construct(
+        private ProjectNode $projectNode,
+        private ProjectSettings $settings,
+    ) {
+    }
+
+    public function getProjectNode(): ProjectNode
+    {
+        return $this->projectNode;
+    }
+
+    public function setProjectNode(ProjectNode $projectNode): void
+    {
+        $this->projectNode = $projectNode;
+    }
+
+    public function getSettings(): ProjectSettings
+    {
+        return $this->settings;
+    }
+
+    public function setSettings(ProjectSettings $settings): void
+    {
+        $this->settings = $settings;
+    }
+}

packages/guides/src/EventListener/LoadSettingsFromComposer.php

@@ -0,0 +1,49 @@
+<?php
+
+declare(strict_types=1);
+
+namespace phpDocumentor\Guides\EventListener;
+
+use phpDocumentor\Guides\Event\PostProjectNodeCreated;
+use phpDocumentor\Guides\Settings\ComposerSettingsLoader;
+
+use function dirname;
+use function file_exists;
+use function getcwd;
+use function is_string;
+
+final class LoadSettingsFromComposer
+{
+    public function __construct(private readonly ComposerSettingsLoader $composerSettingsLoader)
+    {
+    }
+
+    public function __invoke(PostProjectNodeCreated $event): void
+    {
+        $workDir = getcwd();
+        if ($workDir === false) {
+            return;
+        }
+
+        $composerjson = $this->findComposerJson($workDir);
+        if (!is_string($composerjson)) {
+            return;
+        }
+
+        $projectNode = $event->getProjectNode();
+        $settings = $event->getSettings();
+
+        $this->composerSettingsLoader->loadSettings($projectNode, $settings, $composerjson);
+    }
+
+    private function findComposerJson(string $currentDir): string|null
+    {
+        // Navigate up the directory structure until finding the composer.json file
+        while (!file_exists($currentDir . '/composer.json') && $currentDir !== '/') {
+            $currentDir = dirname($currentDir);
+        }
+
+        // If found, return the path to the composer.json file; otherwise, return null
+        return file_exists($currentDir . '/composer.json') ? $currentDir . '/composer.json' : null;
+    }
+}

packages/guides/src/Nodes/ProjectNode.php

@@ -13,6 +13,9 @@
 use phpDocumentor\Guides\Nodes\Inline\PlainTextInlineNode;
 use phpDocumentor\Guides\Nodes\Menu\NavMenuNode;
 
+use function array_merge;
+use function array_unique;
+
 use const DATE_RFC2822;
 
 /** @extends CompoundNode<DocumentNode> */
@@ -40,6 +43,9 @@ class ProjectNode extends CompoundNode
     /** @var NavMenuNode[] */
     private array $globalMenues = [];
 
+    /** @var list<string> */
+    private array $keywords = [];
+
     public function __construct(
         private string|null $title = null,
         private string|null $version = null,
@@ -210,4 +216,22 @@ public function setGlobalMenues(array $globalMenues): ProjectNode
 
         return $this;
     }
+
+    /** @return list<string> */
+    public function getKeywords(): array
+    {
+        return $this->keywords;
+    }
+
+    /** @param list<string> $keywords */
+    public function setKeywords(array $keywords): void
+    {
+        $this->keywords = $keywords;
+    }
+
+    /** @param list<string> $keywords */
+    public function addKeywords(array $keywords): void
+    {
+        $this->keywords = array_unique(array_merge($this->keywords, $keywords));
+    }
 }

packages/guides/src/Settings/ComposerSettingsLoader.php

@@ -0,0 +1,79 @@
+<?php
+
+declare(strict_types=1);
+
+namespace phpDocumentor\Guides\Settings;
+
+use phpDocumentor\Guides\Nodes\Inline\PlainTextInlineNode;
+use phpDocumentor\Guides\Nodes\ProjectNode;
+
+use function file_get_contents;
+use function implode;
+use function is_array;
+use function is_string;
+use function json_decode;
+use function sprintf;
+
+final class ComposerSettingsLoader
+{
+    public function loadSettings(ProjectNode $projectNode, ProjectSettings $projectSettings, string $pathToComposerJson): void
+    {
+        $jsonContents = file_get_contents($pathToComposerJson);
+        if (!is_string($jsonContents)) {
+            return;
+        }
+
+        $composerData = json_decode($jsonContents, true);
+        if (!is_array($composerData)) {
+            return;
+        }
+
+        if (isset($composerData['name']) && is_string($composerData['name'])) {
+            $projectNode->addVariable('composer_name', new PlainTextInlineNode($composerData['name']));
+        }
+
+        if (isset($composerData['description']) && is_string($composerData['description'])) {
+            $projectNode->addVariable('composer_description', new PlainTextInlineNode($composerData['description']));
+        }
+
+        if (isset($composerData['version']) && is_string($composerData['version'])) {
+            if ($projectNode->getVersion() === null) {
+                $projectNode->setVersion($composerData['version']);
+            }
+        }
+
+        if (isset($composerData['type']) && is_string($composerData['type'])) {
+            $projectNode->addVariable('composer_type', new PlainTextInlineNode($composerData['type']));
+        }
+
+        if (isset($composerData['license'])) {
+            if (is_string($composerData['license'])) {
+                $projectNode->addVariable('license', new PlainTextInlineNode($composerData['license']));
+            } elseif (is_array($composerData['license'])) {
+                $projectNode->addVariable(
+                    'license',
+                    new PlainTextInlineNode(sprintf('(%s)', implode(' or ', $composerData['license']))),
+                );
+            }
+        }
+
+        if (isset($composerData['keywords']) && is_array($composerData['keywords'])) {
+            $projectNode->addKeywords($composerData['keywords']);
+        }
+
+        if (!isset($composerData['support']) || !is_array($composerData['support'])) {
+            return;
+        }
+
+        foreach ($composerData['support'] as $key => $support) {
+            if (!is_string($support)) {
+                continue;
+            }
+
+            $projectNode->addVariable(
+                'composer_support_' . $key,
+                new PlainTextInlineNode($support),
+            );
+        }
+    }
+}