feat: Show the requirement checker in the PHAR info (#1111)

Related to #857
box-project · Oct 22, 2023 · 59d2d4f · 59d2d4f
1 parent f330e3e
commit 59d2d4f
Show file tree

Hide file tree

Showing 11 changed files with 421 additions and 8 deletions.
diff --git a/fixtures/info/req-checker-conflict.phar b/fixtures/info/req-checker-conflict.phar
diff --git a/fixtures/info/req-checker-empty.phar b/fixtures/info/req-checker-empty.phar
diff --git a/fixtures/info/req-checker-ext-and-php-and-conflict.phar b/fixtures/info/req-checker-ext-and-php-and-conflict.phar
diff --git a/fixtures/info/req-checker-ext-and-php.phar b/fixtures/info/req-checker-ext-and-php.phar
diff --git a/fixtures/info/req-checker-ext.phar b/fixtures/info/req-checker-ext.phar
diff --git a/fixtures/info/req-checker-old-req.phar b/fixtures/info/req-checker-old-req.phar
diff --git a/fixtures/info/req-checker-php.phar b/fixtures/info/req-checker-php.phar
diff --git a/src/Console/Command/Info.php b/src/Console/Command/Info.php
@@ -178,7 +178,15 @@ private static function showPharInfo(
         bool $indent,
         IO $io,
     ): int {
-        self::showPharMeta($pharInfo, $io);
+        PharInfoRenderer::renderVersion($pharInfo, $io);
+
+        $io->newLine();
+
+        PharInfoRenderer::renderShortSummary(
+            $pharInfo,
+            $io,
+            static fn () => $io->newLine(),
+        );
 
         if ($content) {
             PharInfoRenderer::renderContent(

diff --git a/src/Console/PharInfoRenderer.php b/src/Console/PharInfoRenderer.php
@@ -20,13 +20,20 @@
 use KevinGH\Box\NotInstantiable;
 use KevinGH\Box\Phar\CompressionAlgorithm;
 use KevinGH\Box\Phar\PharInfo;
+use KevinGH\Box\RequirementChecker\Requirement;
+use KevinGH\Box\RequirementChecker\RequirementType;
 use SplFileInfo;
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Filesystem\Path;
 use function array_filter;
 use function array_key_last;
+use function array_map;
+use function array_reduce;
 use function array_sum;
+use function array_values;
 use function count;
+use function implode;
+use function is_array;
 use function KevinGH\Box\format_size;
 use function KevinGH\Box\format_size as format_size1;
 use function KevinGH\Box\noop;
@@ -44,6 +51,7 @@ final class PharInfoRenderer
 {
     use NotInstantiable;
 
+    private const BOX_REQUIREMENTS = '.box/.requirements.php';
     private const INDENT_SIZE = 2;
 
     public static function renderShortSummary(
@@ -58,6 +66,7 @@ public static function renderShortSummary(
             self::renderSignature(...),
             self::renderMetadata(...),
             self::renderTimestamp(...),
+            self::renderRequirementChecker(...),
             self::renderContentsSummary(...),
         ];
 
@@ -184,6 +193,41 @@ public static function renderTimestamp(PharInfo $pharInfo, IO $io): void
         );
     }
 
+    public static function renderRequirementChecker(
+        PharInfo $pharInfo,
+        IO $io,
+    ): void {
+        $requirements = $pharInfo->getFiles()[self::BOX_REQUIREMENTS] ?? null;
+
+        if (null === $requirements) {
+            $io->writeln('<comment>RequirementChecker:</comment> Not found.');
+
+            return;
+        }
+
+        $evaluatedRequirements = require $requirements->getPathname();
+
+        if (!is_array($evaluatedRequirements)) {
+            $io->writeln('<comment>RequirementChecker:</comment> Could not be checked.');
+
+            return;
+        }
+
+        $io->write('<comment>RequirementChecker:</comment>');
+
+        if (0 === count($evaluatedRequirements)) {
+            $io->writeln(' No requirement found.');
+
+            return;
+        }
+        $io->writeln('');
+
+        [$required, $conflicting] = self::retrieveRequirements($evaluatedRequirements);
+
+        self::renderRequiredSection($required, $io);
+        self::renderConflictingSection($conflicting, $io);
+    }
+
     public static function renderContentsSummary(PharInfo $pharInfo, IO $io): void
     {
         $count = array_filter($pharInfo->getFilesCompressionCount());
@@ -252,6 +296,100 @@ public static function renderContent(
         }
     }
 
+    /**
+     * @return array{Requirement[], Requirement[]}
+     */
+    private static function retrieveRequirements(array $requirements): array
+    {
+        $evaluatedRequirements = array_map(
+            Requirement::fromArray(...),
+            $requirements,
+        );
+
+        [$required, $conflicting] = array_reduce(
+            $evaluatedRequirements,
+            static function ($carry, Requirement $requirement): array {
+                $hash = implode(
+                    ':',
+                    [
+                        $requirement->type->value,
+                        $requirement->condition,
+                        $requirement->source,
+                    ],
+                );
+
+                if (RequirementType::EXTENSION_CONFLICT === $requirement->type) {
+                    $carry[1][$hash] = $requirement;
+                } else {
+                    $carry[0][$hash] = $requirement;
+                }
+
+                return $carry;
+            },
+            [[], []],
+        );
+
+        return [
+            array_values($required),
+            array_values($conflicting),
+        ];
+    }
+
+    /**
+     * @param Requirement[] $required
+     */
+    private static function renderRequiredSection(
+        array $required,
+        IO $io,
+    ): void {
+        if (0 === count($required)) {
+            return;
+        }
+
+        $io->writeln('  <comment>Required:</comment>');
+        $io->writeln(
+            array_map(
+                static fn (Requirement $requirement) => match ($requirement->type) {
+                    RequirementType::PHP => sprintf(
+                        '  - PHP %s (%s)',
+                        $requirement->condition,
+                        $requirement->source ?? 'root',
+                    ),
+                    RequirementType::EXTENSION => sprintf(
+                        '  - ext-%s (%s)',
+                        $requirement->condition,
+                        $requirement->source ?? 'root',
+                    ),
+                },
+                $required,
+            ),
+        );
+    }
+
+    /**
+     * @param Requirement[] $conflicting
+     */
+    private static function renderConflictingSection(
+        array $conflicting,
+        IO $io,
+    ): void {
+        if (0 === count($conflicting)) {
+            return;
+        }
+
+        $io->writeln('  <comment>Conflict:</comment>');
+        $io->writeln(
+            array_map(
+                static fn (Requirement $requirement) => sprintf(
+                    '  - ext-%s (%s)',
+                    $requirement->condition,
+                    $requirement->source ?? 'root',
+                ),
+                $conflicting,
+            ),
+        );
+    }
+
     private static function renderParentDirectoriesIfNecessary(
         SplFileInfo $fileInfo,
         OutputInterface $output,