feat(chore): better display of unsafe method

Author: silasjoisten

generator/src/Commands/ScanObjectsCommand.php

@@ -4,14 +4,20 @@
 
 namespace Safe\Commands;
 
+use Safe\Domain\MethodDefinition;
+use Safe\XmlDocParser\Method;
 use Safe\XmlDocParser\Scanner;
 use Safe\XmlDocParser\DocPage;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Console\Style\SymfonyStyle;
 
 class ScanObjectsCommand extends Command
 {
+    private SymfonyStyle $io;
+    private Scanner $scanner;
+
     protected function configure(): void
     {
         $this
@@ -20,20 +26,26 @@ protected function configure(): void
         ;
     }
 
-    protected function execute(InputInterface $input, OutputInterface $output): int
+    public function initialize(InputInterface $input, OutputInterface $output): void
     {
-        $scanner = new Scanner(DocPage::referenceDir());
+        $this->io = new SymfonyStyle($input, $output);
+        $this->scanner = new Scanner(DocPage::referenceDir());
+    }
 
-        $paths = $scanner->getMethodsPaths();
+    protected function execute(InputInterface $input, OutputInterface $output): int
+    {
+        $this->io->title($this->getDescription());
 
-        $res = $scanner->getMethods($paths, [], $output);
+        $result = $this->scanner->getMethods($this->scanner->getMethodsPaths(), [], $output);
 
-        foreach ($res->methods as $function) {
-            $name = $function->getFunctionName();
-            $output->writeln('Found method '.$name);
-        }
+        $this->io->table(
+            ['Method', 'Error Type', 'Safe'],
+            \array_merge(
+                \array_map(static fn(Method $method) => [$method->getFunctionName(), $method->getErrorType()->name, '✅'], $result->methods),
+                \array_map(static fn(MethodDefinition $method) => [$method->name, $method->errorType->name, '❌'], $result->overloadedFunctions),
+            ),
+        );
 
-        $output->writeln('These methods are overloaded: '.\implode(', ', $res->overloadedFunctions));
-        return 0;
+        return self::SUCCESS;
     }
 }

generator/src/Domain/MethodDefinition.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Safe\Domain;
+
+use Safe\XmlDocParser\ErrorType;
+
+final class MethodDefinition implements \Stringable
+{
+    public function __construct(
+        public readonly string $name,
+        public readonly ErrorType $errorType,
+    ) {
+    }
+
+    public function __toString(): string
+    {
+        return $this->name;
+    }
+}

generator/src/XmlDocParser/Scanner.php

@@ -4,6 +4,7 @@
 
 namespace Safe\XmlDocParser;
 
+use Safe\Domain\MethodDefinition;
 use function array_merge;
 use function iterator_to_array;
 use Safe\PhpStanFunctions\PhpStanFunctionMapReader;
@@ -115,7 +116,7 @@ public function getMethods(array $paths, array $pastFunctionNames, OutputInterfa
     {
         /** @var Method[] $functions */
         $functions = [];
-        /** @var string[] $overloadedFunctions */
+        /** @var MethodDefinition[] $overloadedFunctions */
         $overloadedFunctions = [];
 
         $phpStanFunctionMapReader = new PhpStanFunctionMapReader();
@@ -149,12 +150,9 @@ public function getMethods(array $paths, array $pastFunctionNames, OutputInterfa
             if ($errorType !== ErrorType::UNKNOWN || $wasThisFunctionUnsafe) {
                 $functionObjects = $docPage->getMethodSynopsis();
                 if (count($functionObjects) > 1) {
-                    $overloadedFunctions = array_merge($overloadedFunctions, \array_map(function ($functionObject) {
-                        return $functionObject->methodname->__toString();
-                    }, $functionObjects));
-                    $overloadedFunctions = \array_filter($overloadedFunctions, function (string $functionName) use ($ignoredFunctions) {
-                        return !isset($ignoredFunctions[$functionName]);
-                    });
+                    $overloadedFunctions = \array_merge($overloadedFunctions, \array_map(static fn(\SimpleXMLElement $functionObject) => new MethodDefinition((string) $functionObject->methodname, $errorType), $functionObjects));
+                    $overloadedFunctions = \array_filter($overloadedFunctions, static fn(MethodDefinition $method) => !\array_key_exists($method->name, $ignoredFunctions));
+
                     continue;
                 }
                 $rootEntity = $docPage->loadAndResolveFile();
@@ -167,6 +165,7 @@ public function getMethods(array $paths, array $pastFunctionNames, OutputInterfa
                 }
             }
         }
+
         $progressBar->finish();
         $output->writeln("");
 

generator/src/XmlDocParser/ScannerResponse.php

@@ -4,11 +4,13 @@
 
 namespace Safe\XmlDocParser;
 
+use Safe\Domain\MethodDefinition;
+
 class ScannerResponse
 {
     /**
      * @param Method[] $methods
-     * @param string[] $overloadedFunctions
+     * @param MethodDefinition[] $overloadedFunctions
      */
     public function __construct(
         public readonly array $methods,