From 26815fcac3ef4667620c30bddf94482fd3504b56 Mon Sep 17 00:00:00 2001
From: Julien Rosset <julien.rosset@solulog.fr>
Date: Fri, 25 Oct 2024 11:25:08 +0200
Subject: [PATCH] Add command requirements support

---
 composer.json                                 | 13 ++--
 src/CliProgram/OutputHelper.php               | 22 ++++++
 src/CliProgram/Requirements/IRequirements.php | 24 +++++++
 .../Requirements/TRequirementsApplication.php | 72 +++++++++++++++++++
 tests/Application.php                         |  3 +
 tests/Commands/FailedHello.php                | 15 ++++
 tests/Commands/Hello.php                      |  6 +-
 tests/FailedRequirement.php                   | 19 +++++
 tests/SuccessRequirement.php                  | 17 +++++
 9 files changed, 183 insertions(+), 8 deletions(-)
 create mode 100644 src/CliProgram/OutputHelper.php
 create mode 100644 src/CliProgram/Requirements/IRequirements.php
 create mode 100644 src/CliProgram/Requirements/TRequirementsApplication.php
 create mode 100644 tests/Commands/FailedHello.php
 create mode 100644 tests/FailedRequirement.php
 create mode 100644 tests/SuccessRequirement.php

diff --git a/composer.json b/composer.json
index 6b3c649..c739b50 100644
--- a/composer.json
+++ b/composer.json
@@ -15,12 +15,13 @@
 
     "minimum-stability": "stable",
     "require": {
-        "php":                    "^8.1",
-        "jrosset/betterphptoken": "^1.0",
-        "jrosset/extendedmonolog": "^2.0",
-        "psr/log":                "^2.0",
-        "symfony/console":        "^6.1",
-        "voku/arrayy":            "^7.9"
+        "php":                      "^8.1",
+        "jrosset/betterphptoken":   "^1.0",
+        "jrosset/extendedmonolog":  "^2.0",
+        "psr/log":                  "^2.0",
+        "symfony/console":          "^6.1",
+        "symfony/event-dispatcher": "^6.1",
+        "voku/arrayy":              "^7.9"
     },
     "autoload":          {
         "psr-4":                 {
diff --git a/src/CliProgram/OutputHelper.php b/src/CliProgram/OutputHelper.php
new file mode 100644
index 0000000..b92944b
--- /dev/null
+++ b/src/CliProgram/OutputHelper.php
@@ -0,0 +1,22 @@
+<?php
+
+namespace jrosset\CliProgram;
+
+use Symfony\Component\Console\Output\ConsoleOutputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+
+/**
+ * Helper class for command/application output
+ */
+abstract class OutputHelper {
+    /**
+     * Get the “error” output if exists, else the output itself
+     *
+     * @param OutputInterface $output The output
+     *
+     * @return OutputInterface The “error” output if exists, else the output itself
+     */
+    public static final function getErrorOutput (OutputInterface $output): OutputInterface {
+        return $output instanceof ConsoleOutputInterface ? $output->getErrorOutput() : $output;
+    }
+}
\ No newline at end of file
diff --git a/src/CliProgram/Requirements/IRequirements.php b/src/CliProgram/Requirements/IRequirements.php
new file mode 100644
index 0000000..181e3af
--- /dev/null
+++ b/src/CliProgram/Requirements/IRequirements.php
@@ -0,0 +1,24 @@
+<?php
+
+namespace jrosset\CliProgram\Requirements;
+
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+use Throwable;
+
+/**
+ * Interface for a command requirements
+ */
+interface IRequirements {
+    /**
+     * Check the requirements
+     *
+     * @param InputInterface  $input  The command input
+     * @param OutputInterface $output The command output
+     *
+     * @return void
+     *
+     * @throws Throwable If a requirement failed
+     */
+    public function checkRequirements (InputInterface $input, OutputInterface $output): void;
+}
diff --git a/src/CliProgram/Requirements/TRequirementsApplication.php b/src/CliProgram/Requirements/TRequirementsApplication.php
new file mode 100644
index 0000000..7ced306
--- /dev/null
+++ b/src/CliProgram/Requirements/TRequirementsApplication.php
@@ -0,0 +1,72 @@
+<?php
+
+namespace jrosset\CliProgram\Requirements;
+
+use jrosset\CliProgram\OutputHelper;
+use ReflectionAttribute;
+use ReflectionClass;
+use Symfony\Component\Console\ConsoleEvents;
+use Symfony\Component\Console\Event\ConsoleCommandEvent;
+use Symfony\Component\EventDispatcher\EventDispatcher;
+use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
+use Throwable;
+
+/**
+ * An application with command requirements checking
+ *
+ * @see IRequirements
+ */
+trait TRequirementsApplication {
+    /**
+     * Register the listener for command requirements
+     *
+     * @param EventDispatcherInterface|null $dispatcher The event dispatcher is already existing
+     *
+     * @return void
+     */
+    protected final function registerCommandRequirementsListener (?EventDispatcherInterface $dispatcher = null): void {
+        $dispatcher ??= new EventDispatcher();
+        $dispatcher->addListener(ConsoleEvents::COMMAND, $this->checkCommandRequirements(...));
+        $this->setDispatcher($dispatcher);
+    }
+
+    /**
+     * Check the requirements of a command
+     *
+     * @param ConsoleCommandEvent $event The command event
+     *
+     * @return void
+     */
+    private function checkCommandRequirements (ConsoleCommandEvent $event): void {
+        $commandInput = $event->getInput();
+        $commandOutput = $event->getOutput();
+        try {
+            //region Check the command is valid
+            if (($command = $event->getCommand()) === null) {
+                return;
+            }
+
+            $commandReflection = new ReflectionClass($command);
+            //endregion
+            //region Check attribute requirements
+            foreach ($commandReflection->getAttributes(IRequirements::class, ReflectionAttribute::IS_INSTANCEOF) as $commandRequirementsAttribute) {
+                /** @var IRequirements $commandRequirementsAttributeInstance */
+                $commandRequirementsAttributeInstance = $commandRequirementsAttribute->newInstance();
+                $commandRequirementsAttributeInstance->checkRequirements($commandInput, $commandOutput);
+            }
+            //endregion
+            //region Contrôle pré-requis (implémentation directe)
+            if ($command instanceof IRequirements) {
+                $command->checkRequirements($commandInput, $commandOutput);
+            }
+            //endregion
+        }
+        catch (Throwable $exception) {
+            $this->renderThrowable($exception, OutputHelper::getErrorOutput($commandOutput));
+
+            $event->disableCommand();
+            $event->stopPropagation();
+            return;
+        }
+    }
+}
\ No newline at end of file
diff --git a/tests/Application.php b/tests/Application.php
index 16748cf..22e8e2a 100644
--- a/tests/Application.php
+++ b/tests/Application.php
@@ -6,12 +6,15 @@ use jrosset\CliProgram\ApplicationWithCommandMonolog;
 use jrosset\CliProgram\AutoDiscovery\AutoDiscoveryDirectory;
 use jrosset\CliProgram\AutoDiscovery\TAutoDiscoveryApplication;
 use jrosset\CliProgram\AutoPrefix\AutoPrefixNamespaceManager;
+use jrosset\CliProgram\Requirements\TRequirementsApplication;
 
 class Application extends ApplicationWithCommandMonolog {
     use TAutoDiscoveryApplication;
+    use TRequirementsApplication;
 
     public function __construct (string $name = 'UNKNOWN', string $version = 'UNKNOWN') {
         parent::__construct(__DIR__ . '/logs/', $name, $version);
+        $this->registerCommandRequirementsListener();
 
         $spot = new AutoDiscoveryDirectory(__DIR__ . '/Commands');
         $spot->getAutoPrefixManagers()->prepend(new AutoPrefixNamespaceManager('\\jrosset\\Tests\\Commands', 'test'));
diff --git a/tests/Commands/FailedHello.php b/tests/Commands/FailedHello.php
new file mode 100644
index 0000000..27ad9ba
--- /dev/null
+++ b/tests/Commands/FailedHello.php
@@ -0,0 +1,15 @@
+<?php
+
+namespace jrosset\Tests\Commands;
+
+use jrosset\Tests\FailedRequirement;
+
+#[FailedRequirement]
+class FailedHello extends Hello {
+    /**
+     * @inheritDoc
+     */
+    public function __construct () {
+        parent::__construct('failedHello');
+    }
+}
\ No newline at end of file
diff --git a/tests/Commands/Hello.php b/tests/Commands/Hello.php
index 0a397a2..a78a654 100644
--- a/tests/Commands/Hello.php
+++ b/tests/Commands/Hello.php
@@ -10,12 +10,14 @@ use jrosset\CliProgram\Validation\Validators\DateValidator;
 use jrosset\CliProgram\Validation\Validators\EnumValidator;
 use jrosset\CliProgram\Validation\Validators\IntegerValidator;
 use jrosset\Tests\Lang;
+use jrosset\Tests\SuccessRequirement;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputArgument;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Console\Output\OutputInterface;
 
+#[SuccessRequirement]
 class Hello extends CommandWithValidation {
     /**
      * @inheritdoc
@@ -25,8 +27,8 @@ class Hello extends CommandWithValidation {
     /**
      * @inheritDoc
      */
-    public function __construct () {
-        parent::__construct('hello', 'bonjour');
+    public function __construct (?string $name = null) {
+        parent::__construct($name ?? 'hello', 'bonjour');
     }
 
     /**
diff --git a/tests/FailedRequirement.php b/tests/FailedRequirement.php
new file mode 100644
index 0000000..6869701
--- /dev/null
+++ b/tests/FailedRequirement.php
@@ -0,0 +1,19 @@
+<?php
+
+namespace jrosset\Tests;
+
+use Attribute;
+use jrosset\CliProgram\Requirements\IRequirements;
+use LogicException;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+
+#[Attribute(Attribute::TARGET_CLASS)]
+class FailedRequirement implements IRequirements {
+    /**
+     * @inheritDoc
+     */
+    public function checkRequirements (InputInterface $input, OutputInterface $output): void {
+        throw new LogicException('The "foo" requirement failed');
+    }
+}
\ No newline at end of file
diff --git a/tests/SuccessRequirement.php b/tests/SuccessRequirement.php
new file mode 100644
index 0000000..b6d0254
--- /dev/null
+++ b/tests/SuccessRequirement.php
@@ -0,0 +1,17 @@
+<?php
+
+namespace jrosset\Tests;
+
+use Attribute;
+use jrosset\CliProgram\Requirements\IRequirements;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+
+#[Attribute(Attribute::TARGET_CLASS)]
+class SuccessRequirement implements IRequirements {
+    /**
+     * @inheritDoc
+     */
+    public function checkRequirements (InputInterface $input, OutputInterface $output): void {
+    }
+}
\ No newline at end of file