refactor: deconstruct about command into insight providers

Author: innocenzi

packages/console/src/Commands/AboutCommand.php

@@ -4,142 +4,87 @@
 
 namespace Tempest\Console\Commands;
 
+use Stringable;
+use Tempest\Console\Console;
 use Tempest\Console\ConsoleArgument;
 use Tempest\Console\ConsoleCommand;
 use Tempest\Console\ExitCode;
-use Tempest\Console\HasConsole;
 use Tempest\Container\Container;
+use Tempest\Core\AppConfig;
+use Tempest\Core\Insight;
+use Tempest\Core\InsightsProvider;
+use Tempest\Support\Arr;
+use Tempest\Support\Json;
+use Tempest\Support\Str;
 
 final readonly class AboutCommand
 {
-    use HasConsole;
+    public function __construct(
+        private readonly Console $console,
+        private readonly Container $container,
+        private readonly AppConfig $appConfig,
+    ) {}
 
-    private Container $container;
-    private SystemInfoProvider $infoProvider;
-
-    public function __construct(Container $container)
-    {
-        $this->container = $container;
-        $this->infoProvider = $container->get(SystemInfoProvider::class);
-    }
-
-    #[ConsoleCommand(
-        name: 'about',
-        description: 'View a summary of information about your Tempest project',
-        aliases: ['a'],
-    )]
+    #[ConsoleCommand(name: 'about', description: 'Shows insights about the application', aliases: ['insights'])]
     public function __invoke(
-        #[ConsoleArgument(description: 'Format to json', aliases: ['-j', '--json'])]
+        #[ConsoleArgument(description: 'Formats the outpuyt to JSON', aliases: ['--json'])]
         ?bool $json = null,
     ): ExitCode {
-        // Collect all information into a structured array
-        $data = $this->infoProvider->gatherInformation();
-
-        // Check if user chose JSON option
         if ($json) {
-            // Convert array keys to snake_case
-            $snakeCaseData = $this->arrayKeysToSnakeCase($data);
-            // Encode the data as JSON
-            $jsonOutput = json_encode($snakeCaseData, JSON_PRETTY_PRINT);
-            // Check if json_encode failed
-            if ($jsonOutput === false) {
-                $this->console->error('Failed to encode JSON: ' . json_last_error_msg());
-                return ExitCode::ERROR;
-            }
-            $this->console->writeln($jsonOutput);
+            $this->writeInsightsAsJson();
         } else {
-            // Otherwise, display the data in the standard formatted way
-            $this->displayNormalOutput($data);
+            $this->writeFormattedInsights();
         }
 
         return ExitCode::SUCCESS;
     }
 
-    /**
-     * Displays the gathered information in the standard console format.
-     *
-     * @param array $data The structured information to display
-     */
-    private function displayNormalOutput(array $data): void
+    private function writeFormattedInsights(): void
     {
-        // Display Environment section
-        $this->displaySection('Environment', $data['environment']);
+        foreach ($this->appConfig->insightsProviders as $class) {
+            /** @var InsightsProvider $provider */
+            $provider = $this->container->get($class);
 
-        // Display Database section
-        $this->displaySection('Database', $data['database']);
+            $this->console->header($provider->name);
 
-        // Display Cache section with styled statuses
-        $this->console->header('Cache');
-        foreach ($data['cache'] as $key => $value) {
-            $this->displayCacheStatus($key, $value);
+            foreach ($provider->getInsights() as $key => $value) {
+                $this->console->keyValue($key, $this->formatInsight($value));
+            }
         }
-
-        // Display TailwindCSS section
-        $this->displaySection('TailwindCSS', $data['tailwindcss']);
     }
 
-    /**
-     * Displays a standard section with a header and key-value pairs.
-     *
-     * @param string $sectionName The name of the section to display
-     * @param array $sectionData The data for the section
-     */
-    private function displaySection(string $sectionName, array $sectionData): void
+    private function writeInsightsAsJson(): void
     {
-        $this->console->header($sectionName);
-        foreach ($sectionData as $key => $value) {
-            $this->console->keyValue($key, $value);
+        $json = [];
+
+        foreach ($this->appConfig->insightsProviders as $class) {
+            /** @var InsightsProvider $provider */
+            $provider = $this->container->get($class);
+
+            $json[Str\to_snake_case($provider->name)] = Arr\map_with_keys(
+                array: $provider->getInsights(),
+                map: fn (mixed $value, string $key) => yield Str\to_snake_case($key) => $this->rawInsight($value),
+            );
         }
-    }
 
-    /**
-     * Displays the status of a cache in an appropriate style.
-     *
-     * @param string $label The name of the cache to be displayed.
-     * @param string $envVar The corresponding environment variable.
-     */
-    private function displayCacheStatus(string $label, bool|string|int $value): void
-    {
-        $isEnabled = $this->infoProvider->isCacheEnabled($value);
-        $status = $isEnabled ? "<style='bold fg-green'>ENABLED</style>" : "<style='bold fg-red'>DISABLED</style>";
-        $this->console->keyValue($label, $status);
+        $this->console->writeRaw(Json\encode($json));
     }
 
-    /**
-     * Transform a string in snake case format
-     *
-     * @param string $string
-     * @return string
-     */
-    private function toSnakeCase(string $string): string
+    private function formatInsight(Stringable|Insight|string $value): string
     {
-        // Replace spaces by underscores
-        $string = str_replace(' ', '_', $string);
-        // Convert all characters in lowercase
-        $string = strtolower($string);
-        return $string;
+        if ($value instanceof Insight) {
+            return $value->formattedValue;
+        }
+
+        return (string) $value;
     }
 
-    /**
-     * Convert keys of an array in snake case
-     *
-     * @param array $array
-     * @return array
-     */
-    private function arrayKeysToSnakeCase(array $array): array
+    private function rawInsight(Stringable|Insight|string $value): string
     {
-        $result = [];
-        foreach ($array as $key => $value) {
-            // Convert key in snake_case
-            $newKey = $this->toSnakeCase($key);
-            if (is_array($value)) {
-                // If value is an array, apply recusivity
-                $result[$newKey] = $this->arrayKeysToSnakeCase($value);
-            } else {
-                // Else keep the value as is
-                $result[$newKey] = $value;
-            }
+        if ($value instanceof Insight) {
+            return $value->value;
         }
-        return $result;
+
+        return Str\strip_tags((string) $value);
     }
 }