[Imported] AC-1718 return types for arrayaccess methods (#138)

* AC-1717: Passing null to non-nullable internal function parameters is deprecated

Author: m2-github-services

Magento2/Rector/Src/AddArrayAccessInterfaceReturnTypes.php

@@ -0,0 +1,69 @@
+<?php
+/**
+ * Copyright 2021 Adobe
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento2\Rector\Src;
+
+use PhpParser\Node;
+use PhpParser\Node\Stmt\Class_;
+use Rector\Core\Rector\AbstractRector;
+use Symplify\RuleDocGenerator\Exception\PoorDocumentationException;
+use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
+use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+
+final class AddArrayAccessInterfaceReturnTypes extends AbstractRector
+{
+    /**
+     * @return array<class-string<Node>>
+     */
+    public function getNodeTypes(): array
+    {
+        return [Class_::class];
+    }
+
+    /**
+     * @param Class_ $node
+     */
+    public function refactor(Node $node): ?Node
+    {
+        foreach ($node->implements as $implement) {
+            if ($this->isName($implement, 'ArrayAccess')) {
+                break;
+            }
+            return null;
+        }
+
+        foreach ($node->getMethods() as $method) {
+            if ($this->isName($method, 'offsetExists') && empty($method->getReturnType())) {
+                $method->returnType = new \PhpParser\Node\Name('bool');
+            }
+            if ($this->isName($method, 'offsetSet') && empty($method->getReturnType())) {
+                $method->returnType = new \PhpParser\Node\Name('void');
+            }
+            if ($this->isName($method, 'offsetUnset') && empty($method->getReturnType())) {
+                $method->returnType = new \PhpParser\Node\Name('void');
+            }
+        }
+
+        return null;
+    }
+
+    /**
+     * @return RuleDefinition
+     * @throws PoorDocumentationException
+     */
+    public function getRuleDefinition(): RuleDefinition
+    {
+        return new RuleDefinition(
+            'Add return types specified by ArrayAccess interface', [
+                new CodeSample(
+                    'public function offsetSet($offset, $value)',
+                    'public function offsetSet($offset, $value): void'
+                ),
+            ]
+        );
+    }
+}

Magento2/Rector/Tests/AddArrayAccessInterfaceReturnTypes/AddArrayAccessInterfaceReturnTypesTest.php

@@ -0,0 +1,36 @@
+<?php
+/**
+ * Copyright 2021 Adobe
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento2\Rector\Tests\AddArrayAccessInterfaceReturnTypes;
+
+use Iterator;
+use Rector\Testing\PHPUnit\AbstractRectorTestCase;
+use Symplify\SmartFileSystem\SmartFileInfo;
+
+final class AddArrayAccessInterfaceReturnTypesTest extends AbstractRectorTestCase
+{
+    /**
+     * @dataProvider provideData()
+     */
+    public function test(SmartFileInfo $fileInfo): void
+    {
+        $this->doTestFileInfo($fileInfo);
+    }
+
+    /**
+     * @return Iterator<SmartFileInfo>
+     */
+    public function provideData(): Iterator
+    {
+        return $this->yieldFilesFromDirectory(__DIR__ . '/Fixture');
+    }
+
+    public function provideConfigFilePath(): string
+    {
+        return __DIR__ . '/config/configured_rule.php';
+    }
+}

Magento2/Rector/Tests/AddArrayAccessInterfaceReturnTypes/Fixture/addReturnTypes.php.inc

@@ -0,0 +1,39 @@
+<?php
+
+class MyExampleClass implements \ArrayAccess
+{
+    public function offsetExists($offset)
+    {
+    }
+    public function offsetGet($offset)
+    {
+    }
+    public function offsetSet($offset, $value)
+    {
+    }
+    public function offsetUnset($offset)
+    {
+    }
+}
+
+?>
+-----
+<?php
+
+class MyExampleClass implements \ArrayAccess
+{
+    public function offsetExists($offset): bool
+    {
+    }
+    public function offsetGet($offset)
+    {
+    }
+    public function offsetSet($offset, $value): void
+    {
+    }
+    public function offsetUnset($offset): void
+    {
+    }
+}
+
+?>

Magento2/Rector/Tests/AddArrayAccessInterfaceReturnTypes/config/configured_rule.php

@@ -0,0 +1,14 @@
+<?php
+/**
+ * Copyright 2021 Adobe
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+use Magento2\Rector\Src\AddArrayAccessInterfaceReturnTypes;
+use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
+
+return static function (ContainerConfigurator $containerConfigurator): void {
+    $services = $containerConfigurator->services();
+    $services->set(AddArrayAccessInterfaceReturnTypes::class);
+};