[code-quality] Improve InlineArrayReturnAssignRector to include implicit variable init and nested keys

Author: TomasVotruba

phpstan.neon

@@ -338,3 +338,7 @@ parameters:
         -
             message: '#Offset float\|int\|string might not exist on string#'
             path: rules/Php70/EregToPcreTransformer.php
+
+        -
+            identifier: symplify.noReference
+            message: '#Use explicit return value over magic &reference#'

rules-tests/CodeQuality/Rector/ClassMethod/InlineArrayReturnAssignRector/Fixture/keep_comments.php.inc renamed to rules-tests/CodeQuality/Rector/ClassMethod/InlineArrayReturnAssignRector/Fixture/include_empty_assign.php.inc

@@ -2,14 +2,13 @@
 
 namespace Rector\Tests\CodeQuality\Rector\ClassMethod\InlineArrayReturnAssignRector\Fixture;
 
-final class KeepComments
+final class IncludeEmptyAssign
 {
-    public function getPerson()
+    public function run($person2)
     {
         $person = [];
-        // name
-        $person['name'] = 'Timmy';
-        // surname
+
+        $person[] = 'Timmy';
         $person['surname'] = 'Back';
 
         return $person;
@@ -22,16 +21,11 @@ final class KeepComments
 
 namespace Rector\Tests\CodeQuality\Rector\ClassMethod\InlineArrayReturnAssignRector\Fixture;
 
-final class KeepComments
+final class IncludeEmptyAssign
 {
-    public function getPerson()
+    public function run($person2)
     {
-        return [
-            // name
-            'name' => 'Timmy',
-            // surname
-            'surname' => 'Back',
-        ];
+        return ['Timmy', 'surname' => 'Back'];
     }
 }
 

rules-tests/CodeQuality/Rector/ClassMethod/InlineArrayReturnAssignRector/Fixture/include_nested_variable.php.inc

@@ -0,0 +1,30 @@
+<?php
+
+namespace Rector\Tests\CodeQuality\Rector\ClassMethod\InlineArrayReturnAssignRector\Fixture;
+
+final class IncludeNestedVariable
+{
+    public function create()
+    {
+        $items[0]['name'] = 'John';
+        $items[0]['surname'] = 'Doe';
+        $items[0]['age'] = 50;
+        return $items;
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\CodeQuality\Rector\ClassMethod\InlineArrayReturnAssignRector\Fixture;
+
+final class IncludeNestedVariable
+{
+    public function create()
+    {
+        return [['name' => 'John', 'surname' => 'Doe', 'age' => 50]];
+    }
+}
+
+?>

rules-tests/CodeQuality/Rector/ClassMethod/InlineArrayReturnAssignRector/Fixture/nested_array_with_multiple_keys.php.inc

@@ -0,0 +1,32 @@
+<?php
+
+namespace Rector\Tests\CodeQuality\Rector\ClassMethod\InlineArrayReturnAssignRector\Fixture;
+
+final class NestedArrayWithMultipleKeys
+{
+    public function run()
+    {
+        $arr = [];
+        $arr['foo']['bar']['baz'] = ['a' => 1, 'b' => 2];
+
+        return $arr;
+    }
+}
+
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\CodeQuality\Rector\ClassMethod\InlineArrayReturnAssignRector\Fixture;
+
+final class NestedArrayWithMultipleKeys
+{
+    public function run()
+    {
+        return ['foo' => ['bar' => ['baz' => ['a' => 1, 'b' => 2]]]];
+    }
+}
+
+
+?>

rules-tests/CodeQuality/Rector/ClassMethod/InlineArrayReturnAssignRector/Fixture/skip_different_variable.php.inc

@@ -0,0 +1,17 @@
+<?php
+
+namespace Rector\Tests\CodeQuality\Rector\ClassMethod\InlineArrayReturnAssignRector\Fixture;
+
+final class SkipDifferentVariable
+{
+    public function create()
+    {
+        $item['sub_key'] = 500;
+
+        $items['name'] = 'John';
+        $items['surname'] = 'Doe';
+        $items['age'] = $item;
+
+        return $items;
+    }
+}

rules-tests/CodeQuality/Rector/ClassMethod/InlineArrayReturnAssignRector/Fixture/skip_empty_assign.php.inc

@@ -0,0 +1,19 @@
+<?php
+
+namespace Rector\Tests\CodeQuality\Rector\ClassMethod\InlineArrayReturnAssignRector\Fixture;
+
+final class SkipMultipleReturns
+{
+    public function create()
+    {
+        $items['name'] = 'John';
+        $items['surname'] = 'Doe';
+        $items['age'] = 50;
+
+        if (mt_rand(1, 2)) {
+            return [];
+        }
+
+        return $items;
+    }
+}

rules-tests/CodeQuality/Rector/ClassMethod/InlineArrayReturnAssignRector/Fixture/skip_multiple_returns.php.inc

@@ -0,0 +1,30 @@
+<?php
+
+namespace Rector\Tests\CodeQuality\Rector\ClassMethod\InlineArrayReturnAssignRector\Fixture;
+
+class SomeClass
+{
+    public function create()
+    {
+        $items['name'] = 'John';
+        $items['surname'] = 'Doe';
+        $items['age'] = 50;
+        return $items;
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\CodeQuality\Rector\ClassMethod\InlineArrayReturnAssignRector\Fixture;
+
+class SomeClass
+{
+    public function create()
+    {
+        return ['name' => 'John', 'surname' => 'Doe', 'age' => 50];
+    }
+}
+
+?>