Add Laravel Cashier 13 & 14 upgrade rules

config/sets/packages/cashier/cashier-13.php

@@ -0,0 +1,29 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Config\RectorConfig;
+use Rector\Renaming\Rector\MethodCall\RenameMethodRector;
+use Rector\Renaming\ValueObject\MethodCallRename;
+use RectorLaravel\Rector\Class_\CashierStripeOptionsToStripeRector;
+
+# see https://github.com/laravel/cashier-stripe/blob/master/UPGRADE.md#upgrading-to-130-from-12x
+return static function (RectorConfig $rectorConfig): void {
+    $rectorConfig->import(__DIR__ . '/../config.php');
+
+    $rectorConfig->ruleWithConfiguration(RenameMethodRector::class, [
+        new MethodCallRename('Laravel\Cashier\Billable', 'subscribedToPlan', 'subscribedToPrice'),
+        new MethodCallRename('Laravel\Cashier\Billable', 'onPlan', 'onPrice'),
+        new MethodCallRename('Laravel\Cashier\Billable', 'planTaxRates', 'priceTaxRates'),
+        new MethodCallRename('Laravel\Cashier\SubscriptionBuilder', 'plan', 'price'),
+        new MethodCallRename('Laravel\Cashier\SubscriptionBuilder', 'meteredPlan', 'meteredPrice'),
+        new MethodCallRename('Laravel\Cashier\Subscription', 'hasMultiplePlans', 'hasMultiplePrices'),
+        new MethodCallRename('Laravel\Cashier\Subscription', 'hasSinglePlan', 'hasSinglePrice'),
+        new MethodCallRename('Laravel\Cashier\Subscription', 'hasPlan', 'hasPrice'),
+        new MethodCallRename('Laravel\Cashier\Subscription', 'addPlan', 'addPrice'),
+        new MethodCallRename('Laravel\Cashier\Subscription', 'addPlanAndInvoice', 'addPriceAndInvoice'),
+        new MethodCallRename('Laravel\Cashier\Subscription', 'removePlan', 'removePrice'),
+    ]);
+
+    $rectorConfig->rule(CashierStripeOptionsToStripeRector::class);
+};

config/sets/packages/cashier/cashier-14.php

@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Config\RectorConfig;
+use Rector\Renaming\Rector\MethodCall\RenameMethodRector;
+use Rector\Renaming\ValueObject\MethodCallRename;
+
+# see https://github.com/laravel/cashier-stripe/blob/master/UPGRADE.md#upgrading-to-140-from-13x
+return static function (RectorConfig $rectorConfig): void {
+    $rectorConfig->import(__DIR__ . '/../config.php');
+
+    $rectorConfig->ruleWithConfiguration(RenameMethodRector::class, [
+        new MethodCallRename('Laravel\Cashier\Billable', 'removePaymentMethod', 'deletePaymentMethod'),
+        new MethodCallRename('Laravel\Cashier\Payment', 'isCancelled', 'isCanceled'),
+        new MethodCallRename('Laravel\Cashier\Subscription', 'cancelled', 'canceled'),
+        new MethodCallRename('Laravel\Cashier\Subscription', 'markAsCancelled', 'markAsCanceled'),
+    ]);
+};

config/sets/packages/cashier/level/up-to-cashier-13.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Config\RectorConfig;
+use RectorLaravel\Set\Packages\Cashier\CashierSetList;
+
+return static function (RectorConfig $rectorConfig): void {
+    $rectorConfig->sets([CashierSetList::LARAVEL_CASHIER_130]);
+};

config/sets/packages/cashier/level/up-to-cashier-14.php

@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Config\RectorConfig;
+use RectorLaravel\Set\Packages\Cashier\CashierLevelSetList;
+use RectorLaravel\Set\Packages\Cashier\CashierSetList;
+
+return static function (RectorConfig $rectorConfig): void {
+    $rectorConfig->sets([CashierSetList::LARAVEL_CASHIER_140, CashierLevelSetList::UP_TO_LARAVEL_CASHIER_130]);
+};

docs/rector_rules_overview.md

@@ -1,4 +1,4 @@
-# 36 Rules Overview
+# 37 Rules Overview
 
 ## AddArgumentDefaultValueRector
 
@@ -362,6 +362,29 @@ Replace magical call on `$this->app["something"]` to standalone type assign vari
 
 <br>
 
+## CashierStripeOptionsToStripeRector
+
+Renames the Billable `stripeOptions()` to `stripe().`
+
+- class: [`RectorLaravel\Rector\Class_\CashierStripeOptionsToStripeRector`](../src/Rector/Class_/CashierStripeOptionsToStripeRector.php)
+
+```diff
+ use Illuminate\Database\Eloquent\Model;
+ use Laravel\Cashier\Billable;
+
+ class User extends Model
+ {
+     use Billable;
+
+-    public function stripeOptions(array $options = []) {
++    public function stripe(array $options = []) {
+         return [];
+     }
+ }
+```
+
+<br>
+
 ## ChangeQueryWhereDateValueWithCarbonRector
 
 Add `parent::boot();` call to `boot()` class method in child of `Illuminate\Database\Eloquent\Model`

src/Rector/Class_/CashierStripeOptionsToStripeRector.php

@@ -0,0 +1,107 @@
+<?php
+
+declare(strict_types=1);
+
+namespace RectorLaravel\Rector\Class_;
+
+use PhpParser\Node;
+use PhpParser\Node\Identifier;
+use PhpParser\Node\Stmt\Class_;
+use PhpParser\Node\Stmt\ClassMethod;
+use PHPStan\Analyser\Scope;
+use PHPStan\Reflection\ClassReflection;
+use PHPStan\Type\ObjectType;
+use Rector\Core\Rector\AbstractScopeAwareRector;
+use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
+use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+
+/**
+ * @changelog https://github.com/laravel/cashier-stripe/blob/master/UPGRADE.md#upgrading-to-130-from-12x
+ *
+ * @see \RectorLaravel\Tests\Rector\Class_\CashierStripeOptionsToStripeRector\CashierStripeOptionsToStripeRectorTest
+ */
+final class CashierStripeOptionsToStripeRector extends AbstractScopeAwareRector
+{
+    public function getRuleDefinition(): RuleDefinition
+    {
+        return new RuleDefinition('Renames the Billable stripeOptions() to stripe().', [
+            new CodeSample(
+                <<<'CODE_SAMPLE'
+use Illuminate\Database\Eloquent\Model;
+use Laravel\Cashier\Billable;
+
+class User extends Model
+{
+    use Billable;
+
+    public function stripeOptions(array $options = []) {
+        return [];
+    }
+}
+CODE_SAMPLE
+
+                ,
+                <<<'CODE_SAMPLE'
+use Illuminate\Database\Eloquent\Model;
+use Laravel\Cashier\Billable;
+
+class User extends Model
+{
+    use Billable;
+
+    public function stripe(array $options = []) {
+        return [];
+    }
+}
+CODE_SAMPLE
+            ),
+        ]);
+    }
+
+    /**
+     * @return array<class-string<Node>>
+     */
+    public function getNodeTypes(): array
+    {
+        return [Class_::class];
+    }
+
+    public function refactorWithScope(Node $node, Scope $scope): ?Node
+    {
+        if (! $this->isObjectType($node, new ObjectType('Illuminate\Database\Eloquent\Model'))) {
+            return null;
+        }
+
+        if (! $this->usesBillableTrait($scope)) {
+            return null;
+        }
+
+        /** @var Class_ $node */
+        $stripeOptionsMethod = $node->getMethod('stripeOptions');
+
+        if (! $stripeOptionsMethod instanceof ClassMethod) {
+            return null;
+        }
+
+        $stripeOptionsMethod->name = new Identifier('stripe');
+
+        return $node;
+    }
+
+    private function usesBillableTrait(Scope $scope): bool
+    {
+        $classReflection = $scope->getClassReflection();
+
+        while ($classReflection instanceof ClassReflection) {
+            foreach ($classReflection->getTraits() as $traitReflection) {
+                if ($traitReflection->hasTraitUse('Laravel\Cashier\Billable')) {
+                    return true;
+                }
+            }
+
+            $classReflection = $classReflection->getParentClass();
+        }
+
+        return true;
+    }
+}

src/Set/Packages/Cashier/CashierLevelSetList.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace RectorLaravel\Set\Packages\Cashier;
+
+use Rector\Set\Contract\SetListInterface;
+
+final class CashierLevelSetList implements SetListInterface
+{
+    /**
+     * @var string
+     */
+    final public const UP_TO_LARAVEL_CASHIER_130 = __DIR__ . '/../../config/sets/packages/cashier/level/up-to-cashier-13.php';
+
+    /**
+     * @var string
+     */
+    final public const UP_TO_LARAVEL_CASHIER_140 = __DIR__ . '/../../config/sets/packages/cashier/level/up-to-cashier-14.php';
+}

src/Set/Packages/Cashier/CashierSetList.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace RectorLaravel\Set\Packages\Cashier;
+
+use Rector\Set\Contract\SetListInterface;
+
+final class CashierSetList implements SetListInterface
+{
+    /**
+     * @var string
+     */
+    final public const LARAVEL_CASHIER_130 = __DIR__ . '/../../config/sets/packages/cashier/cashier-13.php';
+
+    /**
+     * @var string
+     */
+    final public const LARAVEL_CASHIER_140 = __DIR__ . '/../../config/sets/packages/cashier/cashier-14.php';
+}

stubs/Laravel/Cashier/Billable.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace Laravel\Cashier;
+
+if (class_exists('Laravel\Cashier\Billable')) {
+    return;
+}
+
+trait Billable
+{
+}

tests/Rector/Class_/CashierStripeOptionsToStripeRector/CashierStripeOptionsToStripeRectorTest.php

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

tests/Rector/Class_/CashierStripeOptionsToStripeRector/Fixture/fixture.php.inc

@@ -0,0 +1,29 @@
+<?php
+
+namespace RectorLaravel\Tests\Rector\Class_\CashierStripeOptionsToStripeRector\Fixture;
+
+use RectorLaravel\Tests\Rector\Class_\CashierStripeOptionsToStripeRector\Source\User;
+
+class SomeUser extends User
+{
+    public function stripeOptions(array $options = []) {
+        return [];
+    }
+}
+
+?>
+-----
+<?php
+
+namespace RectorLaravel\Tests\Rector\Class_\CashierStripeOptionsToStripeRector\Fixture;
+
+use RectorLaravel\Tests\Rector\Class_\CashierStripeOptionsToStripeRector\Source\User;
+
+class SomeUser extends User
+{
+    public function stripe(array $options = []) {
+        return [];
+    }
+}
+
+?>

tests/Rector/Class_/CashierStripeOptionsToStripeRector/Source/User.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace RectorLaravel\Tests\Rector\Class_\CashierStripeOptionsToStripeRector\Source;
+
+use Illuminate\Database\Eloquent\Model;
+use Laravel\Cashier\Billable;
+
+class User extends Model
+{
+    use Billable;
+}

tests/Rector/Class_/CashierStripeOptionsToStripeRector/config/configured_rule.php

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