Add UnaliasCollectionMethodsRector (#291)

Author: spawnia

composer.json

@@ -33,6 +33,7 @@
     },
     "scripts": {
         "phpstan": "vendor/bin/phpstan analyse --ansi",
+        "test": "vendor/bin/phpunit tests",
         "lint": "vendor/bin/duster lint",
         "fix": "vendor/bin/duster fix",
         "rector-dry-run": "vendor/bin/rector process --dry-run --ansi",

config/sets/laravel-collection.php

@@ -5,9 +5,11 @@
 use Rector\Config\RectorConfig;
 use RectorLaravel\Rector\BooleanNot\AvoidNegatedCollectionContainsOrDoesntContainRector;
 use RectorLaravel\Rector\MethodCall\AvoidNegatedCollectionFilterOrRejectRector;
+use RectorLaravel\Rector\MethodCall\UnaliasCollectionMethodsRector;
 
 return static function (RectorConfig $rectorConfig): void {
     $rectorConfig->import(__DIR__ . '/../config.php');
     $rectorConfig->rule(AvoidNegatedCollectionContainsOrDoesntContainRector::class);
     $rectorConfig->rule(AvoidNegatedCollectionFilterOrRejectRector::class);
+    $rectorConfig->rule(UnaliasCollectionMethodsRector::class);
 };

docs/rector_rules_overview.md

@@ -1,4 +1,4 @@
-# 76 Rules Overview
+# 77 Rules Overview
 
 ## AbortIfRector
 
@@ -1445,6 +1445,24 @@ Automatically type hints your tappable closures
 
 <br>
 
+## UnaliasCollectionMethodsRector
+
+Use the base collection methods instead of their aliases.
+
+- class: [`RectorLaravel\Rector\MethodCall\UnaliasCollectionMethodsRector`](../src/Rector/MethodCall/UnaliasCollectionMethodsRector.php)
+
+```diff
+ use Illuminate\Support\Collection;
+
+ $collection = new Collection([0, 1, null, -1]);
+-$collection->average();
+-$collection->some(fn (?int $number): bool => is_null($number));
++$collection->avg();
++$collection->contains(fn (?int $number): bool => is_null($number));
+```
+
+<br>
+
 ## UnifyModelDatesWithCastsRector
 
 Unify Model `$dates` property with `$casts`

src/Rector/MethodCall/UnaliasCollectionMethodsRector.php

@@ -0,0 +1,81 @@
+<?php
+
+declare(strict_types=1);
+
+namespace RectorLaravel\Rector\MethodCall;
+
+use PhpParser\Node;
+use PhpParser\Node\Expr\MethodCall;
+use PhpParser\Node\Identifier;
+use PHPStan\Type\ObjectType;
+use RectorLaravel\AbstractRector;
+use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
+use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+
+/**
+ * @see \RectorLaravel\Tests\Rector\MethodCall\UnaliasCollectionMethodsRector\UnaliasCollectionMethodsRectorTest
+ */
+final class UnaliasCollectionMethodsRector extends AbstractRector
+{
+    public function getRuleDefinition(): RuleDefinition
+    {
+        return new RuleDefinition(
+            'Use the base collection methods instead of their aliases.',
+            [
+                new CodeSample(
+                    <<<'CODE_SAMPLE'
+use Illuminate\Support\Collection;
+
+$collection = new Collection([0, 1, null, -1]);
+$collection->average();
+$collection->some(fn (?int $number): bool => is_null($number));
+CODE_SAMPLE
+                    ,
+                    <<<'CODE_SAMPLE'
+use Illuminate\Support\Collection;
+
+$collection = new Collection([0, 1, null, -1]);
+$collection->avg();
+$collection->contains(fn (?int $number): bool => is_null($number));
+CODE_SAMPLE
+                ),
+            ]
+        );
+    }
+
+    /**
+     * @return array<class-string<Node>>
+     */
+    public function getNodeTypes(): array
+    {
+        return [MethodCall::class];
+    }
+
+    /**
+     * @param  MethodCall  $node
+     */
+    public function refactor(Node $node): ?Node
+    {
+        return $this->updateMethodCall($node);
+    }
+
+    private function updateMethodCall(MethodCall $methodCall): ?MethodCall
+    {
+        if (! $this->isObjectType($methodCall->var, new ObjectType('Illuminate\Support\Enumerable'))) {
+            return null;
+        }
+
+        $name = $methodCall->name;
+        if ($this->isName($name, 'some')) {
+            $replacement = 'contains';
+        } elseif ($this->isName($name, 'average')) {
+            $replacement = 'avg';
+        } else {
+            return null;
+        }
+
+        $methodCall->name = new Identifier($replacement);
+
+        return $methodCall;
+    }
+}

stubs/Illuminate/Support/Enumerable.php

@@ -18,6 +18,32 @@
  */
 interface Enumerable
 {
+    /**
+     * Alias for the "avg" method.
+     *
+     * @param  (callable(TValue): float|int)|string|null  $callback
+     * @return float|int|null
+     */
+    public function average($callback = null);
+
+    /**
+     * Get the average value of a given key.
+     *
+     * @param  (callable(TValue): float|int)|string|null  $callback
+     * @return float|int|null
+     */
+    public function avg($callback = null);
+
+    /**
+     * Alias for the "contains" method.
+     *
+     * @param  (callable(TValue, TKey): bool)|TValue|string  $key
+     * @param  mixed  $operator
+     * @param  mixed  $value
+     * @return bool
+     */
+    public function some($key, $operator = null, $value = null);
+
     /**
      * Determine if an item exists in the enumerable.
      *

tests/Rector/MethodCall/AvoidNegatedCollectionFilterOrRejectRector/config/configured_rule.php

@@ -7,6 +7,5 @@
 
 return static function (RectorConfig $rectorConfig): void {
     $rectorConfig->import(__DIR__ . '/../../../../../config/config.php');
-
     $rectorConfig->rule(AvoidNegatedCollectionFilterOrRejectRector::class);
 };

tests/Rector/MethodCall/UnaliasCollectionMethodsRector/Fixture/fixture.php.inc

@@ -0,0 +1,23 @@
+<?php
+
+namespace RectorLaravel\Tests\Rector\MethodCall\UnaliasCollectionMethodsRector\Fixture;
+
+use Illuminate\Support\Collection;
+
+$collection = new Collection([0, 1, null, -1]);
+$collection->average();
+$collection->some(fn (?int $number): bool => is_null($number));
+
+?>
+-----
+<?php
+
+namespace RectorLaravel\Tests\Rector\MethodCall\UnaliasCollectionMethodsRector\Fixture;
+
+use Illuminate\Support\Collection;
+
+$collection = new Collection([0, 1, null, -1]);
+$collection->avg();
+$collection->contains(fn (?int $number): bool => is_null($number));
+
+?>

tests/Rector/MethodCall/UnaliasCollectionMethodsRector/UnaliasCollectionMethodsRectorTest.php

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+namespace RectorLaravel\Tests\Rector\MethodCall\UnaliasCollectionMethodsRector;
+
+use Iterator;
+use PHPUnit\Framework\Attributes\DataProvider;
+use Rector\Testing\PHPUnit\AbstractRectorTestCase;
+
+final class UnaliasCollectionMethodsRectorTest extends AbstractRectorTestCase
+{
+    public static function provideData(): Iterator
+    {
+        return self::yieldFilesFromDirectory(__DIR__ . '/Fixture');
+    }
+
+    /**
+     * @test
+     */
+    #[DataProvider('provideData')]
+    public function test(string $filePath): void
+    {
+        $this->doTestFile($filePath);
+    }
+
+    public function provideConfigFilePath(): string
+    {
+        return __DIR__ . '/config/configured_rule.php';
+    }
+}

tests/Rector/MethodCall/UnaliasCollectionMethodsRector/config/configured_rule.php

@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Config\RectorConfig;
+use RectorLaravel\Rector\MethodCall\UnaliasCollectionMethodsRector;
+
+return static function (RectorConfig $rectorConfig): void {
+    $rectorConfig->import(__DIR__ . '/../../../../../config/config.php');
+    $rectorConfig->rule(UnaliasCollectionMethodsRector::class);
+};