Add rector rules for B2BKit

TheMilek · TheMilek · commit 0aced4aa1090 · 2025-02-03T15:05:39.000+01:00
diff --git a/config/sets/sylius/plus/b2b-kit.php b/config/sets/sylius/plus/b2b-kit.php
@@ -0,0 +1,44 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Config\RectorConfig;
+use Sylius\SyliusRector\Rector\Class_\AddInterfaceToClassExtendingTypeRector;
+use Sylius\SyliusRector\Rector\Class_\AddTraitToClassExtendingTypeRector;
+
+return static function (RectorConfig $rectorConfig): void {
+    $rectorConfig->ruleWithConfiguration(AddInterfaceToClassExtendingTypeRector::class, [
+        'Sylius\Component\Core\Model\Address' => [
+            'Sylius\B2BKit\Entity\AddressInterface',
+        ],
+        'Sylius\Component\Core\Model\Customer' => [
+            'Sylius\B2BKit\Entity\CustomerInterface',
+        ],
+        'Sylius\Component\Customer\Model\CustomerGroup' => [
+            'Sylius\B2BKit\Entity\CustomerGroupInterface',
+        ],
+        'Sylius\Component\Core\Model\Order' => [
+            'Sylius\B2BKit\Entity\OrderInterface',
+        ],
+        'Sylius\Component\Core\Model\ShopUser' => [
+            'Sylius\B2BKit\Entity\ShopUserInterface',
+        ],
+    ]);
+    $rectorConfig->ruleWithConfiguration(AddTraitToClassExtendingTypeRector::class, [
+        'Sylius\Component\Core\Model\Address' => [
+            'Sylius\B2BKit\Entity\AddressAwareTrait',
+        ],
+        'Sylius\Component\Core\Model\Customer' => [
+            'Sylius\B2BKit\Entity\CustomerAwareTrait',
+        ],
+        'Sylius\Component\Customer\Model\CustomerGroup' => [
+            'Sylius\B2BKit\Entity\CustomerGroupAwareTrait',
+        ],
+        'Sylius\Component\Core\Model\Order' => [
+            'Sylius\B2BKit\Entity\OrderAwareTrait',
+        ],
+        'Sylius\Component\Core\Model\ShopUser' => [
+            'Sylius\B2BKit\Entity\ShopUserAwareTrait',
+        ],
+    ]);
+};
diff --git a/src/Set/SyliusPlus.php b/src/Set/SyliusPlus.php
@@ -6,6 +6,7 @@
 
 final class SyliusPlus
 {
+    public const B2BKit = __DIR__ . '/../../config/sets/sylius/plus/b2b-kit.php';
     public const LOYALTY_PLUGIN = __DIR__ . '/../../config/sets/sylius/plus/loyalty-plugin.php';
     public const MULTI_SOURCE_INVENTORY_PLUGIN = __DIR__ . '/../../config/sets/sylius/plus/multi-source-inventory-plugin.php';
     public const MULTI_STORE_PLUGIN = __DIR__ . '/../../config/sets/sylius/plus/multi-store-plugin.php';
diff --git a/stubs/Sylius/B2BKit/Entity/AddressAwareTrait.php b/stubs/Sylius/B2BKit/Entity/AddressAwareTrait.php
@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sylius\B2BKit\Entity;
+
+if (trait_exists('Sylius\B2BKit\Entity\AddressAwareTrait')) {
+    return;
+}
+
+trait AddressAwareTrait
+{
+}
diff --git a/stubs/Sylius/B2BKit/Entity/AddressInterface.php b/stubs/Sylius/B2BKit/Entity/AddressInterface.php
@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sylius\B2BKit\Entity;
+
+if (class_exists('Sylius\B2BKit\Entity\AddressInterface')) {
+    return;
+}
+
+interface AddressInterface
+{
+}
diff --git a/stubs/Sylius/B2BKit/Entity/CustomerAwareTrait.php b/stubs/Sylius/B2BKit/Entity/CustomerAwareTrait.php
@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sylius\B2BKit\Entity;
+
+if (trait_exists('Sylius\B2BKit\Entity\CustomerAwareTrait')) {
+    return;
+}
+
+trait CustomerAwareTrait
+{
+}
diff --git a/stubs/Sylius/B2BKit/Entity/CustomerGroupAwareTrait.php b/stubs/Sylius/B2BKit/Entity/CustomerGroupAwareTrait.php
@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sylius\B2BKit\Entity;
+
+if (trait_exists('Sylius\B2BKit\Entity\CustomerGroupAwareTrait')) {
+    return;
+}
+
+trait CustomerGroupAwareTrait
+{
+}
diff --git a/stubs/Sylius/B2BKit/Entity/CustomerGroupInterface.php b/stubs/Sylius/B2BKit/Entity/CustomerGroupInterface.php
@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sylius\B2BKit\Entity;
+
+if (class_exists('Sylius\B2BKit\Entity\CustomerGroupInterface')) {
+    return;
+}
+
+interface CustomerGroupInterface
+{
+}
diff --git a/stubs/Sylius/B2BKit/Entity/CustomerInterface.php b/stubs/Sylius/B2BKit/Entity/CustomerInterface.php
@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sylius\B2BKit\Entity;
+
+if (class_exists('Sylius\B2BKit\Entity\CustomerInterface')) {
+    return;
+}
+
+interface CustomerInterface
+{
+}
diff --git a/stubs/Sylius/B2BKit/Entity/OrderAwareTrait.php b/stubs/Sylius/B2BKit/Entity/OrderAwareTrait.php
@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sylius\B2BKit\Entity;
+
+if (trait_exists('Sylius\B2BKit\Entity\OrderAwareTrait')) {
+    return;
+}
+
+trait OrderAwareTrait
+{
+}
diff --git a/stubs/Sylius/B2BKit/Entity/OrderInterface.php b/stubs/Sylius/B2BKit/Entity/OrderInterface.php
@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sylius\B2BKit\Entity;
+
+if (class_exists('Sylius\B2BKit\Entity\OrderInterface')) {
+    return;
+}
+
+interface OrderInterface
+{
+}
diff --git a/stubs/Sylius/B2BKit/Entity/ShopUserAwareTrait.php b/stubs/Sylius/B2BKit/Entity/ShopUserAwareTrait.php
@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sylius\B2BKit\Entity;
+
+if (trait_exists('Sylius\B2BKit\Entity\ShopUserAwareTrait')) {
+    return;
+}
+
+trait ShopUserAwareTrait
+{
+}
diff --git a/stubs/Sylius/B2BKit/Entity/ShopUserInterface.php b/stubs/Sylius/B2BKit/Entity/ShopUserInterface.php
@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sylius\B2BKit\Entity;
+
+if (class_exists('Sylius\B2BKit\Entity\ShopUserInterface')) {
+    return;
+}
+
+interface ShopUserInterface
+{
+}
diff --git a/stubs/Sylius/Component/Core/Model/Address.php b/stubs/Sylius/Component/Core/Model/Address.php
@@ -0,0 +1,11 @@
+<?php
+
+namespace Sylius\Component\Core\Model;
+
+if (class_exists('Sylius\Component\Core\Model\Address')) {
+    return;
+}
+
+class Address
+{
+}
diff --git a/stubs/Sylius/Component/Core/Model/ShopUser.php b/stubs/Sylius/Component/Core/Model/ShopUser.php
@@ -0,0 +1,11 @@
+<?php
+
+namespace Sylius\Component\Core\Model;
+
+if (class_exists('Sylius\Component\Core\Model\ShopUser')) {
+    return;
+}
+
+class ShopUser
+{
+}
diff --git a/stubs/Sylius/Component/Customer/Model/CustomerGroup.php b/stubs/Sylius/Component/Customer/Model/CustomerGroup.php
@@ -0,0 +1,11 @@
+<?php
+
+namespace Sylius\Component\Customer\Model;
+
+if (class_exists('Sylius\Component\Customer\Model\CustomerGroup')) {
+    return;
+}
+
+class CustomerGroup
+{
+}
diff --git a/tests/Set/SyliusPlus/B2BKit/B2BKitTest.php b/tests/Set/SyliusPlus/B2BKit/B2BKitTest.php
@@ -0,0 +1,32 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sylius\SyliusRector\Tests\Set\SyliusPlus\B2BKit;
+
+use Iterator;
+use Rector\Testing\PHPUnit\AbstractRectorTestCase;
+
+final class B2BKitTest extends AbstractRectorTestCase
+{
+    /**
+     * @dataProvider provideData()
+     */
+    public function test(string $file): void
+    {
+        $this->doTestFile($file);
+    }
+
+    /**
+     * @return Iterator<string>
+     */
+    public function provideData(): Iterator
+    {
+        return self::yieldFilesFromDirectory(__DIR__ . '/Fixture');
+    }
+
+    public function provideConfigFilePath(): string
+    {
+        return __DIR__ . '/config/configured_rule.php';
+    }
+}
diff --git a/tests/Set/SyliusPlus/B2BKit/Fixture/class_extending_core_address_model.php.inc b/tests/Set/SyliusPlus/B2BKit/Fixture/class_extending_core_address_model.php.inc
@@ -0,0 +1,24 @@
+<?php
+
+namespace Sylius\SyliusRector\Tests\Rector\Class_\AddInterfaceToClassExtendingType\Fixture;
+
+use Sylius\Component\Core\Model\Address as BaseAddress;
+
+class Address extends BaseAddress
+{
+}
+
+?>
+-----
+<?php
+
+namespace Sylius\SyliusRector\Tests\Rector\Class_\AddInterfaceToClassExtendingType\Fixture;
+
+use Sylius\Component\Core\Model\Address as BaseAddress;
+
+class Address extends BaseAddress implements \Sylius\B2BKit\Entity\AddressInterface
+{
+    use \Sylius\B2BKit\Entity\AddressAwareTrait;
+}
+
+?>
diff --git a/tests/Set/SyliusPlus/B2BKit/Fixture/class_extending_core_customer_group_model.php.inc b/tests/Set/SyliusPlus/B2BKit/Fixture/class_extending_core_customer_group_model.php.inc
@@ -0,0 +1,24 @@
+<?php
+
+namespace Sylius\SyliusRector\Tests\Rector\Class_\AddInterfaceToClassExtendingType\Fixture;
+
+use Sylius\Component\Customer\Model\CustomerGroup as BaseCustomerGroup;
+
+class CustomerGroup extends BaseCustomerGroup
+{
+}
+
+?>
+-----
+<?php
+
+namespace Sylius\SyliusRector\Tests\Rector\Class_\AddInterfaceToClassExtendingType\Fixture;
+
+use Sylius\Component\Customer\Model\CustomerGroup as BaseCustomerGroup;
+
+class CustomerGroup extends BaseCustomerGroup implements \Sylius\B2BKit\Entity\CustomerGroupInterface
+{
+    use \Sylius\B2BKit\Entity\CustomerGroupAwareTrait;
+}
+
+?>
diff --git a/tests/Set/SyliusPlus/B2BKit/Fixture/class_extending_core_customer_model.php.inc b/tests/Set/SyliusPlus/B2BKit/Fixture/class_extending_core_customer_model.php.inc
@@ -0,0 +1,24 @@
+<?php
+
+namespace Sylius\SyliusRector\Tests\Rector\Class_\AddInterfaceToClassExtendingType\Fixture;
+
+use Sylius\Component\Core\Model\Customer as BaseCustomer;
+
+class Customer extends BaseCustomer
+{
+}
+
+?>
+-----
+<?php
+
+namespace Sylius\SyliusRector\Tests\Rector\Class_\AddInterfaceToClassExtendingType\Fixture;
+
+use Sylius\Component\Core\Model\Customer as BaseCustomer;
+
+class Customer extends BaseCustomer implements \Sylius\B2BKit\Entity\CustomerInterface
+{
+    use \Sylius\B2BKit\Entity\CustomerAwareTrait;
+}
+
+?>
diff --git a/tests/Set/SyliusPlus/B2BKit/Fixture/class_extending_core_order_model.php.inc b/tests/Set/SyliusPlus/B2BKit/Fixture/class_extending_core_order_model.php.inc
@@ -0,0 +1,24 @@
+<?php
+
+namespace Sylius\SyliusRector\Tests\Rector\Class_\AddInterfaceToClassExtendingType\Fixture;
+
+use Sylius\Component\Core\Model\Order as BaseOrder;
+
+class Order extends BaseOrder
+{
+}
+
+?>
+-----
+<?php
+
+namespace Sylius\SyliusRector\Tests\Rector\Class_\AddInterfaceToClassExtendingType\Fixture;
+
+use Sylius\Component\Core\Model\Order as BaseOrder;
+
+class Order extends BaseOrder implements \Sylius\B2BKit\Entity\OrderInterface
+{
+    use \Sylius\B2BKit\Entity\OrderAwareTrait;
+}
+
+?>
diff --git a/tests/Set/SyliusPlus/B2BKit/Fixture/class_extending_core_shop_user_model.php.inc b/tests/Set/SyliusPlus/B2BKit/Fixture/class_extending_core_shop_user_model.php.inc
@@ -0,0 +1,24 @@
+<?php
+
+namespace Sylius\SyliusRector\Tests\Rector\Class_\AddInterfaceToClassExtendingType\Fixture;
+
+use Sylius\Component\Core\Model\ShopUser as BaseShopUser;
+
+class ShopUser extends BaseShopUser
+{
+}
+
+?>
+-----
+<?php
+
+namespace Sylius\SyliusRector\Tests\Rector\Class_\AddInterfaceToClassExtendingType\Fixture;
+
+use Sylius\Component\Core\Model\ShopUser as BaseShopUser;
+
+class ShopUser extends BaseShopUser implements \Sylius\B2BKit\Entity\ShopUserInterface
+{
+    use \Sylius\B2BKit\Entity\ShopUserAwareTrait;
+}
+
+?>
diff --git a/tests/Set/SyliusPlus/B2BKit/config/configured_rule.php b/tests/Set/SyliusPlus/B2BKit/config/configured_rule.php
@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Config\RectorConfig;
+use Sylius\SyliusRector\Set\SyliusPlus;
+
+return static function (RectorConfig $rectorConfig): void {
+    $rectorConfig->import(__DIR__ . '/../../../../../config/config.php');
+    $rectorConfig->sets([SyliusPlus::B2BKit]);
+};
diff --git a/tests/Set/SyliusPlus/LoyaltyPlugin/LoyaltyPluginTest.php b/tests/Set/SyliusPlus/LoyaltyPlugin/LoyaltyPluginTest.php

Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,7 @@`
`6`	`6`
`7`	`7`	`final class SyliusPlus`
`8`	`8`	`{`
	`9`	`+ public const B2BKit = __DIR__ . '/../../config/sets/sylius/plus/b2b-kit.php';`
`9`	`10`	`public const LOYALTY_PLUGIN = __DIR__ . '/../../config/sets/sylius/plus/loyalty-plugin.php';`
`10`	`11`	`public const MULTI_SOURCE_INVENTORY_PLUGIN = __DIR__ . '/../../config/sets/sylius/plus/multi-source-inventory-plugin.php';`
`11`	`12`	`public const MULTI_STORE_PLUGIN = __DIR__ . '/../../config/sets/sylius/plus/multi-store-plugin.php';`