skip object types in DocblockReturnArrayFromDirectArrayInstanceRector (#7373)

* skip object types in DocblockReturnArrayFromDirectArrayInstanceRector

* fill known array types

Author: TomasVotruba

rector.php

@@ -13,7 +13,7 @@
         codeQuality: true,
         codingStyle: true,
         typeDeclarations: true,
-        // typeDeclarationDocblocks: true,
+        typeDeclarationDocblocks: true,
         privatization: true,
         naming: true,
         instanceOf: true,

rules-tests/TypeDeclarationDocblocks/Rector/ClassMethod/DocblockReturnArrayFromDirectArrayInstanceRector/Fixture/Nesting/complex_array.php.inc

@@ -7,7 +7,6 @@ class ComplexArray
    public function run(): array
     {
         return [
-            'id' => new \stdClass(),
             'other' => false,
             'context' => [
                 'id' => 1,
@@ -37,12 +36,11 @@ namespace Rector\Tests\TypeDeclarationDocblocks\Rector\ClassMethod\DocblockRetur
 class ComplexArray
 {
    /**
-    * @return array<string, mixed>
+    * @return array<string, array<string, array<string, string>|int>|array<string, int|string>|bool>
     */
    public function run(): array
     {
         return [
-            'id' => new \stdClass(),
             'other' => false,
             'context' => [
                 'id' => 1,

rules-tests/TypeDeclarationDocblocks/Rector/ClassMethod/DocblockReturnArrayFromDirectArrayInstanceRector/Fixture/skip_sole_type.php.inc

@@ -0,0 +1,25 @@
+<?php
+
+namespace Rector\Tests\TypeDeclarationDocblocks\Rector\ClassMethod\DocblockReturnArrayFromDirectArrayInstanceRector\Fixture;
+
+use PhpParser\Node;
+use PhpParser\Node\Stmt\Class_;
+use PhpParser\Node\Stmt\ClassMethod;
+use Rector\Rector\AbstractRector;
+use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+
+final class SkipSoleType extends AbstractRector
+{
+    public function getNodeTypes(): array
+    {
+        return [Class_::class];
+    }
+
+    public function getRuleDefinition(): RuleDefinition
+    {
+    }
+
+    public function refactor(Node $node)
+    {
+    }
+}

rules-tests/TypeDeclarationDocblocks/Rector/ClassMethod/DocblockReturnArrayFromDirectArrayInstanceRector/Fixture/strip_empty_combine.php.inc

@@ -46,6 +46,9 @@ public function __construct(
     ) {
     }
 
+    /**
+     * @param array<string, mixed> $configuration
+     */
     public function configure(array $configuration): void
     {
         $this->onlyDirectAssign = $configuration[self::ONLY_DIRECT_ASSIGN] ?? false;

rules/CodeQuality/Rector/FunctionLike/SimplifyUselessVariableRector.php

@@ -55,6 +55,9 @@ final class EncapsedStringsToSprintfRector extends AbstractRector implements Con
      */
     private array $argumentVariables = [];
 
+    /**
+     * @param array<string, mixed> $configuration
+     */
     public function configure(array $configuration): void
     {
         $this->always = $configuration[self::ALWAYS] ?? false;

rules/CodingStyle/Rector/Encapsed/EncapsedStringsToSprintfRector.php

@@ -137,6 +137,9 @@ public function __construct(
         );
     }
 
+    /**
+     * @param array<string, mixed> $configuration
+     */
     public function configure(array $configuration): void
     {
         $this->inlinePublic = $configuration[self::INLINE_PUBLIC] ?? false;

rules/Php80/Rector/Class_/ClassPropertyAssignToConstructorPromotionRector.php

@@ -68,6 +68,9 @@ public function __construct(
     ) {
     }
 
+    /**
+     * @param array<string, mixed> $configuration
+     */
     public function configure(array $configuration): void
     {
         $this->inlinePublic = $configuration[self::INLINE_PUBLIC] ?? (bool) current($configuration);

rules/TypeDeclaration/Rector/Property/TypedPropertyFromAssignsRector.php

@@ -121,6 +121,9 @@ public function refactor(Node $node): ?Node
         return null;
     }
 
+    /**
+     * @param array<string, mixed> $configuration
+     */
     public function configure(array $configuration): void
     {
         Assert::keyExists($configuration, self::LIMIT);

rules/TypeDeclaration/Rector/StmtsAwareInterface/IncreaseDeclareStrictTypesRector.php

@@ -106,7 +106,7 @@ public function refactor(Node $node): ?Node
             return null;
         }
 
-        if (count($returnedType->getReferencedClasses()) > 1) {
+        if ($returnedType->getReferencedClasses() !== []) {
             // better handled by shared-interface/class rule, to avoid turning objects to mixed
             return null;
         }