From 9f9e5f1e18208a72aa5c6dc8188ffdbf36aadf06 Mon Sep 17 00:00:00 2001
From: tuqqu <artkurbidaev@gmail.com>
Date: Tue, 3 Oct 2023 03:41:11 +0200
Subject: [PATCH] Emit MethodSignatureMismatch when descendant does not return
 by reference

---
 .../Internal/Analyzer/MethodComparator.php    | 10 +++++
 tests/MethodSignatureTest.php                 | 42 +++++++++++++++++++
 2 files changed, 52 insertions(+)

diff --git a/src/Psalm/Internal/Analyzer/MethodComparator.php b/src/Psalm/Internal/Analyzer/MethodComparator.php
index 82e1c6c48..d595df158 100644
--- a/src/Psalm/Internal/Analyzer/MethodComparator.php
+++ b/src/Psalm/Internal/Analyzer/MethodComparator.php
@@ -313,6 +313,16 @@ class MethodComparator
             );
         }
 
+        if ($guide_method_storage->returns_by_ref && !$implementer_method_storage->returns_by_ref) {
+            IssueBuffer::maybeAdd(
+                new MethodSignatureMismatch(
+                    'Method ' . $cased_implementer_method_id . ' must return by-reference',
+                    $code_location,
+                ),
+                $suppressed_issues + $implementer_classlike_storage->suppressed_issues,
+            );
+        }
+
         if ($guide_method_storage->external_mutation_free
             && !$implementer_method_storage->external_mutation_free
             && !$guide_method_storage->mutation_free_inferred
diff --git a/tests/MethodSignatureTest.php b/tests/MethodSignatureTest.php
index 4c65719ee..61cd41b9b 100644
--- a/tests/MethodSignatureTest.php
+++ b/tests/MethodSignatureTest.php
@@ -929,6 +929,34 @@ class MethodSignatureTest extends TestCase
                     }
                 ',
             ],
+            'allowByRefReturn' => [
+                'code' => '<?php
+                    interface Foo {
+                        public function &foo(): int;
+                    }
+
+                    class Bar implements Foo {
+                        private int $x = 0;
+                        public function &foo(): int {
+                            return $this->x;
+                        }
+                    }
+                ',
+            ],
+            'descendantAddsByRefReturn' => [
+                'code' => '<?php
+                    interface Foo {
+                        public function foo(): int;
+                    }
+
+                    class Bar implements Foo {
+                        private int $x = 0;
+                        public function &foo(): int {
+                            return $this->x;
+                        }
+                    }
+                ',
+            ],
         ];
     }
 
@@ -1586,6 +1614,20 @@ class MethodSignatureTest extends TestCase
                 'ignored_issues' => [],
                 'php_version' => '8.1',
             ],
+            'absentByRefReturnInDescendant' => [
+                'code' => '<?php
+                    interface Foo {
+                        public function &foo(): int;
+                    }
+
+                    class Bar implements Foo {
+                        public function foo(): int {
+                            return 1;
+                        }
+                    }
+                ',
+                'error_message' => 'MethodSignatureMismatch',
+            ],
         ];
     }
 }