Normalize object array representation keys

Author: nyamsprod

CHANGELOG.md

@@ -21,6 +21,7 @@ All Notable changes to `bakame/stackwatch` will be documented in this file.
 - **BC BREAK:** `Visibility` is renamed `Display`
 - **BC BREAK:** `State` is renamed `Feature`
 - **BC BREAK:** `Input::TABLE_FORMAT` is renamed `Input::TEXT_FORMAT`
+- Added a `Translator` class to improve human-readable key translation.
 
 ### Fixed
 
@@ -29,6 +30,8 @@ All Notable changes to `bakame/stackwatch` will be documented in this file.
 - **BC BREAK:** `Snapshot::cpu` property is replaced by 2 properties `Snapshot::cpuUserTime` and `Snapshot::cpuSystemTime`.
 - `LabelGenerator::generate` now also accepts the hyphen (`-`) character.
 - Adding support for `Timeline` on `Metrics::sum` and `Metrics::average` static methods.
+- **BC BREAK:** Fix `Report` and `Environment` keys used for `toArray` and `forHuman`
+- **BC BREAK:** Fix `Statistics::count` is not `Statistics::iterations`  keys used for `toArray` and `forHuman`
 
 ### Deprecated
 

src/Console/ConsoleFormatter.php

@@ -6,19 +6,17 @@
 
 use Bakame\Stackwatch\Exporter\ConsoleExporter;
 use Bakame\Stackwatch\Exporter\LeaderPrinter;
-use Bakame\Stackwatch\Metrics;
 use Bakame\Stackwatch\Report;
+use Bakame\Stackwatch\Translator;
 use Throwable;
 
-/**
- * @phpstan-import-type MetricsHumanReadable from Metrics
- */
 final class ConsoleFormatter implements Formatter
 {
     public function __construct(
         public readonly ConsoleExporter $exporter,
         public readonly LeaderPrinter $leaderPrinter = new LeaderPrinter(),
         public readonly Feature $dryRun = Feature::Disabled,
+        public readonly Translator $translator = new Translator(),
     ) {
     }
 
@@ -43,36 +41,9 @@ public function format(iterable $unitOfWorks): void
                 continue;
             }
 
-            /** @var MetricsHumanReadable $data */
-            $data = $stats->forHuman();
-            $this->exporter->output->writeln($this->leaderPrinter->render(self::exchangeKeys($data)));
+            $data = $this->leaderPrinter->render($this->translator->translateArrayKeys($stats->forHuman())); /* @phpstan-ignore-line */
+            $this->exporter->output->writeln($data);
             $this->exporter->output->writeln('');
         }
     }
-
-    /**
-     * @param MetricsHumanReadable $metrics
-     *
-     * @return array<string, string>
-     */
-    private static function exchangeKeys(array $metrics): array
-    {
-        static $humanKeys = [
-            'cpu_time' => 'CPU Time',
-            'memory_usage' => 'Memory Usage',
-            'real_memory_usage' => 'Real Memory Usage',
-            'peak_memory_usage' => 'Peak Memory Usage',
-            'real_peak_memory_usage' => 'Real Peak Memory Usage',
-            'execution_time' => 'Execution Time',
-        ];
-
-        $humans = [];
-        foreach ($metrics as $key => $metric) {
-            /** @var string $humanKey */
-            $humanKey = $humanKeys[$key] ?? $key;
-            $humans[ $humanKey] = $metric;
-        }
-
-        return $humans;
-    }
 }

src/Console/ConsoleHandler.php

@@ -6,6 +6,7 @@
 
 use Bakame\Stackwatch\Environment;
 use Bakame\Stackwatch\Exporter\LeaderPrinter;
+use Bakame\Stackwatch\Translator;
 use Bakame\Stackwatch\Version;
 use Bakame\Stackwatch\Warning;
 use Psr\Log\LoggerInterface;
@@ -21,6 +22,8 @@ public function __construct(
         private readonly OutputInterface $stdout,
         private readonly LoggerInterface $logger,
         private readonly Environment $environment,
+        private readonly LeaderPrinter $leaderPrinter = new LeaderPrinter(),
+        private readonly Translator $translator = new Translator(),
     ) {
     }
 
@@ -34,16 +37,14 @@ public function handle(Input $input): void
             $output = new StreamOutput($handler);
         }
 
-        $profiler = PathProfiler::forConsole($input, $output, $this->logger);
+        $profiler = PathProfiler::forConsole($input, $output, $this->logger, $this->translator);
         $output->writeln(Version::toConsoleString());
 
         if ($input->infoSection->isVisible()) {
             $formatter = $profiler->formatter;
             if ($formatter instanceof ConsoleFormatter) {
-                $leaderPrinter = new LeaderPrinter(filler: '.', padExtra: 1);
-                /** @var EnvironmentHumanReadable $data */
-                $data = $this->environment->forHuman();
-                $formatter->exporter->output->writeln($leaderPrinter->render($data));
+                $data = $this->translator->translateArrayKeys($this->environment->forHuman()); /* @phpstan-ignore-line */
+                $formatter->exporter->output->writeln($this->leaderPrinter->render($data));
                 $formatter->exporter->output->writeln('');
             }
         } else {

src/Console/PathProfiler.php

@@ -9,6 +9,7 @@
 use Bakame\Stackwatch\Exporter\JsonExporter;
 use Bakame\Stackwatch\Exporter\LeaderPrinter;
 use Bakame\Stackwatch\Profile;
+use Bakame\Stackwatch\Translator;
 use Bakame\Stackwatch\UnableToProfile;
 use CallbackFilterIterator;
 use FilesystemIterator;
@@ -50,10 +51,11 @@ public static function forConsole(
         Input $input,
         OutputInterface $output = new ConsoleOutput(),
         LoggerInterface $logger = new NullLogger(),
+        Translator $translator = new Translator(),
     ): self {
         return new self(
             new UnitOfWorkGenerator(new PathInspector(Profile::class), $logger),
-            new ConsoleFormatter(new ConsoleExporter($output), new LeaderPrinter(), $input->dryRun),
+            new ConsoleFormatter(new ConsoleExporter($output), new LeaderPrinter(), $input->dryRun, $translator),
             $input,
             $logger,
         );

src/Console/Stackwatch.php

@@ -5,6 +5,8 @@
 namespace Bakame\Stackwatch\Console;
 
 use Bakame\Stackwatch\Environment;
+use Bakame\Stackwatch\Exporter\LeaderPrinter;
+use Bakame\Stackwatch\Translator;
 use Bakame\Stackwatch\Version;
 use Bakame\Stackwatch\Warning;
 use Psr\Log\LoggerInterface;
@@ -70,6 +72,8 @@ public function __construct(
         private readonly OutputInterface $stderr,
         private readonly LoggerInterface $logger,
         private readonly Environment $environment,
+        private readonly LeaderPrinter $leaderPrinter = new LeaderPrinter(),
+        private readonly Translator $translator = new Translator(),
     ) {
     }
 
@@ -116,7 +120,7 @@ public function execute(Input $input): int
 
         try {
             (match ($input->format) {
-                Input::TEXT_FORMAT => new ConsoleHandler($this->stdout, $this->logger, $this->environment),
+                Input::TEXT_FORMAT => new ConsoleHandler($this->stdout, $this->logger, $this->environment, $this->leaderPrinter, $this->translator),
                 Input::JSON_FORMAT => new JsonHandler($this->logger, $this->environment),
                 default => throw new RuntimeException('Unknown output format: '.$input->format),
             })->handle($input);