disussion#7862: adds first test case

src/Psalm/Internal/Analyzer/IssueData.php

@@ -2,6 +2,8 @@
 
 namespace Psalm\Internal\Analyzer;
 
+use Psalm\InvolvedTypes;
+
 use function str_pad;
 
 use const STR_PAD_LEFT;
@@ -127,6 +129,12 @@ class IssueData
      */
     public $dupe_key;
 
+    /**
+     * @var ?InvolvedTypes
+     * @readonly
+     */
+    public $involvedTypes;
+
     /**
      * @param ?list<DataFlowNodeData|array{label: string, entry_path_type: string}> $taint_trace
      * @param ?list<DataFlowNodeData> $other_references
@@ -151,7 +159,8 @@ public function __construct(
         int $error_level = -1,
         ?array $taint_trace = null,
         array $other_references = null,
-        ?string $dupe_key = null
+        ?string $dupe_key = null,
+        ?InvolvedTypes $involvedTypes = null
     ) {
         $this->severity = $severity;
         $this->line_from = $line_from;
@@ -174,5 +183,6 @@ public function __construct(
         $this->taint_trace = $taint_trace;
         $this->other_references = $other_references;
         $this->dupe_key = $dupe_key;
+        $this->involvedTypes = $involvedTypes;
     }
 }

src/Psalm/Internal/Analyzer/Statements/ReturnAnalyzer.php

@@ -25,6 +25,7 @@
 use Psalm\Internal\Type\TemplateInferredTypeReplacer;
 use Psalm\Internal\Type\TemplateResult;
 use Psalm\Internal\Type\TypeExpander;
+use Psalm\InvolvedTypes;
 use Psalm\Issue\FalsableReturnStatement;
 use Psalm\Issue\InvalidDocblock;
 use Psalm\Issue\InvalidReturnStatement;
@@ -483,7 +484,11 @@ public static function analyze(
                                     'The inferred type \'' . $inferred_type->getId()
                                         . '\' does not match the declared return '
                                         . 'type \'' . $local_return_type->getId() . '\' for ' . $cased_method_id,
-                                    new CodeLocation($source, $stmt->expr)
+                                    new CodeLocation($source, $stmt->expr),
+                                    new InvolvedTypes(
+                                        $inferred_type->getId(),
+                                        $local_return_type->getId()
+                                    )
                                 ),
                                 $statements_analyzer->getSuppressedIssues()
                             );

src/Psalm/InvolvedTypes.php

@@ -0,0 +1,25 @@
+<?php
+
+namespace Psalm;
+
+final class InvolvedTypes
+{
+    private string $inferredType;
+    private string $declaredType;
+
+    public function __construct(string $inferredType, string $declaredType)
+    {
+        $this->inferredType = $inferredType;
+        $this->declaredType = $declaredType;
+    }
+
+    public function getInferredType(): string
+    {
+        return $this->inferredType;
+    }
+
+    public function getDeclaredType(): string
+    {
+        return $this->declaredType;
+    }
+}

src/Psalm/Issue/CodeIssue.php

@@ -4,6 +4,7 @@
 
 use Psalm\CodeLocation;
 use Psalm\Internal\Analyzer\IssueData;
+use Psalm\InvolvedTypes;
 
 use function array_pop;
 use function explode;
@@ -32,12 +33,19 @@ abstract class CodeIssue
      */
     public $dupe_key;
 
+    /**
+     * @var ?InvolvedTypes
+     */
+    public $involvedTypes;
+
     public function __construct(
         string $message,
-        CodeLocation $code_location
+        CodeLocation $code_location,
+        ?InvolvedTypes $involvedTypes = null
     ) {
         $this->code_location = $code_location;
         $this->message = $message;
+        $this->involvedTypes = $involvedTypes;
     }
 
     public function getShortLocationWithPrevious(): string
@@ -103,7 +111,8 @@ public function toIssueData(string $severity): IssueData
                     )
                 ]
                 : null,
-            $this->dupe_key
+            $this->dupe_key,
+            $this->involvedTypes ?? null
         );
     }
 }

src/Psalm/Report.php

@@ -76,6 +76,9 @@ abstract class Report
     /** @var int */
     protected $total_expression_count;
 
+    /** @var bool */
+    protected $pretty_print_array = false;
+
     /**
      * @param array<int, IssueData> $issues_data
      * @param array<string, int> $fixable_issue_counts
@@ -102,6 +105,7 @@ public function __construct(
         $this->show_info = $report_options->show_info;
         $this->pretty = $report_options->pretty;
         $this->in_ci = $report_options->in_ci;
+        $this->pretty_print_array = $report_options->pretty_print_array;
 
         $this->mixed_expression_count = $mixed_expression_count;
         $this->total_expression_count = $total_expression_count;

src/Psalm/Report/ConsoleReport.php

@@ -6,6 +6,10 @@
 use Psalm\Internal\Analyzer\DataFlowNodeData;
 use Psalm\Internal\Analyzer\IssueData;
 use Psalm\Report;
+use Psalm\Report\PrettyPrintArray\PrettyCompare;
+use Psalm\Report\PrettyPrintArray\PrettyFormat;
+use Psalm\Report\PrettyPrintArray\PrettyHelper;
+use Throwable;
 
 use function basename;
 use function get_cfg_var;
@@ -14,6 +18,8 @@
 use function strtr;
 use function substr;
 
+use const PHP_EOL;
+
 final class ConsoleReport extends Report
 {
     /** @var string|null */
@@ -65,6 +71,10 @@ private function format(IssueData $issue_data): string
             }
         }
 
+        if ($this->pretty_print_array === true) {
+            $issue_string .= $this->prettyPrintArray($issue_data);
+        }
+
         if ($issue_data->other_references) {
             if ($this->show_snippet) {
                 $issue_string .= "\n";
@@ -76,6 +86,28 @@ private function format(IssueData $issue_data): string
         return $issue_string;
     }
 
+    private function prettyPrintArray(IssueData $issue_data): string
+    {
+        $prettyFormat = new PrettyFormat();
+        $prettyPaired = new PrettyCompare();
+
+        try {
+            $involvedTypes = $issue_data->involvedTypes;
+            if (!$involvedTypes) {
+                return '';
+            }
+
+            $arrayPrettyPrinted0 = $prettyFormat->format($involvedTypes->getDeclaredType());
+            $arrayPrettyPrinted1 = $prettyFormat->format($involvedTypes->getInferredType());
+            $toIssue = PHP_EOL.$prettyPaired->compare($arrayPrettyPrinted0, $arrayPrettyPrinted1);
+
+            return PrettyHelper::revertNormalizedTokens($toIssue);
+        } catch (Throwable $throwable) {
+            //todo: log ?
+            return 'Pretty Print Array failed for unexpected error. Error: ' . $throwable->getMessage();
+        }
+    }
+
     /**
      * @param non-empty-list<DataFlowNodeData|array{label: string, entry_path_type: string}> $taint_trace
      */

src/Psalm/Report/PrettyPrintArray/PrettyCompare.php

@@ -0,0 +1,51 @@
+<?php
+
+namespace Psalm\Report\PrettyPrintArray;
+
+use function count;
+use function explode;
+use function join;
+use function sprintf;
+
+use const PHP_EOL;
+
+final class PrettyCompare
+{
+    public function compare(string $inferred, string $declared): string
+    {
+        $formatTable = '| %-50s | %-50s ';
+
+        $requested = explode(PHP_EOL, $inferred);
+        $provided = explode(PHP_EOL, $declared);
+
+        $maxOf = count($requested) > count($provided) ? count($requested) : count($provided);
+        $indexOne = 0;
+        $paired = [];
+
+        for ($indexTwo = 0; $indexTwo <= $maxOf; $indexTwo++) {
+            $rowProvided = $provided[$indexTwo] ?? '';
+
+            if (isset($requested[$indexOne]) && $requested[$indexOne] !== '') {
+                $paired[] = [$requested[$indexOne], $rowProvided]; //tuple
+            } else {
+                $paired[] = ['', $rowProvided]; //tuple
+            }
+            $indexOne++;
+        }
+
+        if (!count($paired)) {
+            return '';
+        }
+
+        $pairedFormattedResult = [];
+        $pairedFormattedResult[] = '|';
+        $pairedFormattedResult[] = sprintf($formatTable, 'Expected', 'Provided');
+        $pairedFormattedResult[] = sprintf($formatTable, '---', '---');
+
+        foreach ($paired as $rows) {
+            $pairedFormattedResult[] = sprintf($formatTable, ...$rows);
+        }
+
+        return join(PHP_EOL, $pairedFormattedResult);
+    }
+}

src/Psalm/Report/PrettyPrintArray/PrettyCursorBracket.php

@@ -0,0 +1,52 @@
+<?php
+
+namespace Psalm\Report\PrettyPrintArray;
+
+final class PrettyCursorBracket
+{
+    private const BRACKET_OPEN = '{';
+    private const BRACKET_CLOSE = '}';
+
+    private int $nBrackets;
+    private string $char;
+    private bool $openedBracket = false;
+
+    public function __construct()
+    {
+        $this->nBrackets = 0;
+        $this->char = '';
+    }
+
+    public function accept(string $char): void
+    {
+        $this->char = $char;
+        if (self::BRACKET_OPEN === $this->char) {
+            $this->openedBracket = true;
+            $this->nBrackets++;
+        }
+
+        if (self::BRACKET_CLOSE === $char) {
+            if ($this->getNumberBrackets() === 0) {
+                $this->nBrackets = 1;
+                return;
+            }
+
+            $this->nBrackets--;
+        }
+    }
+
+    public function closed(): bool
+    {
+        if ($this->openedBracket === true && self::BRACKET_CLOSE === $this->char) {
+            if ($this->nBrackets <= 0) {
+                return true;
+            }
+        }
+        return false;
+    }
+
+    public function getNumberBrackets(): int
+    {
+        return $this->nBrackets;
+    }
+}