Use new Symfony bundle directory structure (#63)

UPGRADE-0.X.md

@@ -1,5 +1,21 @@
 # UPGRADE FROM `v0.1.0` TO `v0.X`
 
+## UPGRADE FROM `v0.6.0` TO `v0.7.0`
+
+The plugin directory structure has been updated to follow the Symfony bundle best practices.
+Adjust your `config/packages/webgriffe_sylius_active_campaign_plugin.yaml` file by removing the word `Resources`:
+```diff
+- - { resource: "@WebgriffeSyliusActiveCampaignPlugin/Resources/config/app/config.yaml" }
++ - { resource: "@WebgriffeSyliusActiveCampaignPlugin/config/app/config.yaml" }
+```
+
+Update your route config import file by removing the word `Resources`:
+```diff
+webgriffe_sylius_active_campaign_shop:
+- resource: "@WebgriffeSyliusActiveCampaignPlugin/Resources/config/app_routing.yml"
++ resource: "@WebgriffeSyliusActiveCampaignPlugin/config/app_routing.yml"
+```
+
 ## UPGRADE FROM `v0.2.0` TO `v0.3.0`
 
 Adjust you entity following the subsequent PR notes, then remember to run a migration diff and run it with:

composer.json

@@ -66,7 +66,7 @@
  },
  "autoload-dev": {
  "psr-4": {
- "App\\": "tests/Application/src"
+ "Tests\\Webgriffe\\SyliusActiveCampaignPlugin\\App\\": "tests/Application/src"
  },
  "classmap": [
  "tests/Application/Kernel.php"

docs/01-Requirements.md

@@ -3,4 +3,5 @@
 [Return to Summary main page](README.md)
 
 * PHP `^8.0` or higher
-* Sylius `^1.11`
+* Sylius `^1.12`
+* Symfony `^5.4` or `^6.0`

docs/02-Installation.md

@@ -12,7 +12,7 @@
 3. Configure your ActiveCampaign API connection parameters by creating the `config/packages/webgriffe_sylius_active_campaign_plugin.yaml` file with the following content:
  ```yaml
  imports:
- - { resource: "@WebgriffeSyliusActiveCampaignPlugin/Resources/config/app/config.yaml" }
+ - { resource: "@WebgriffeSyliusActiveCampaignPlugin/config/app/config.yaml" }
 
  webgriffe_sylius_active_campaign:
  api_client:
@@ -26,7 +26,7 @@
 4. Import the routes needed for updating the list status of contact (you can omit this if you don't need to update the list status, or you don't use the list subscription feature). Add the following to your `config/routes.yaml` file:
  ```yaml
  webgriffe_sylius_active_campaign_shop:
- resource: "@WebgriffeSyliusActiveCampaignPlugin/Resources/config/app_routing.yml"
+ resource: "@WebgriffeSyliusActiveCampaignPlugin/config/app_routing.yml"
  ```
  Note that these routes shouldn't be inside your "shop routes", the locale parameter is not needed.
 

spec/Enqueuer/ConnectionEnqueuerSpec.php

@@ -4,7 +4,7 @@
 
 namespace spec\Webgriffe\SyliusActiveCampaignPlugin\Enqueuer;
 
-use App\Entity\Channel\ChannelInterface;
+use Tests\Webgriffe\SyliusActiveCampaignPlugin\App\Entity\Channel\ChannelInterface;
 use Doctrine\ORM\EntityManagerInterface;
 use PhpSpec\ObjectBehavior;
 use Prophecy\Argument;

spec/Enqueuer/ContactEnqueuerSpec.php

@@ -4,7 +4,7 @@
 
 namespace spec\Webgriffe\SyliusActiveCampaignPlugin\Enqueuer;
 
-use App\Entity\Customer\CustomerInterface;
+use Tests\Webgriffe\SyliusActiveCampaignPlugin\App\Entity\Customer\CustomerInterface;
 use Doctrine\ORM\EntityManagerInterface;
 use PhpSpec\ObjectBehavior;
 use Prophecy\Argument;

spec/Enqueuer/EcommerceCustomerEnqueuerSpec.php

@@ -4,8 +4,8 @@
 
 namespace spec\Webgriffe\SyliusActiveCampaignPlugin\Enqueuer;
 
-use App\Entity\Channel\ChannelInterface;
-use App\Entity\Customer\CustomerInterface;
+use Tests\Webgriffe\SyliusActiveCampaignPlugin\App\Entity\Channel\ChannelInterface;
+use Tests\Webgriffe\SyliusActiveCampaignPlugin\App\Entity\Customer\CustomerInterface;
 use Doctrine\ORM\EntityManagerInterface;
 use PhpSpec\ObjectBehavior;
 use Prophecy\Argument;

spec/Enqueuer/EcommerceOrderEnqueuerSpec.php

@@ -4,8 +4,8 @@
 
 namespace spec\Webgriffe\SyliusActiveCampaignPlugin\Enqueuer;
 
-use App\Entity\Channel\ChannelInterface;
-use App\Entity\Order\OrderInterface;
+use Tests\Webgriffe\SyliusActiveCampaignPlugin\App\Entity\Channel\ChannelInterface;
+use Tests\Webgriffe\SyliusActiveCampaignPlugin\App\Entity\Order\OrderInterface;
 use Doctrine\ORM\EntityManagerInterface;
 use PhpSpec\ObjectBehavior;
 use Prophecy\Argument;

spec/Enqueuer/WebhookEnqueuerSpec.php

@@ -4,7 +4,7 @@
 
 namespace spec\Webgriffe\SyliusActiveCampaignPlugin\Enqueuer;
 
-use App\Entity\Channel\ChannelInterface;
+use Tests\Webgriffe\SyliusActiveCampaignPlugin\App\Entity\Channel\ChannelInterface;
 use Prophecy\Argument;
 use Symfony\Component\Messenger\Envelope;
 use Symfony\Component\Messenger\MessageBusInterface;

spec/Mapper/EcommerceCustomerMapperSpec.php

@@ -4,7 +4,7 @@
 
 namespace spec\Webgriffe\SyliusActiveCampaignPlugin\Mapper;
 
-use App\Entity\Channel\ChannelInterface;
+use Tests\Webgriffe\SyliusActiveCampaignPlugin\App\Entity\Channel\ChannelInterface;
 use PhpSpec\ObjectBehavior;
 use Sylius\Component\Core\Model\CustomerInterface;
 use Webgriffe\SyliusActiveCampaignPlugin\Exception\ChannelConnectionNotSetException;

spec/Mapper/EcommerceOrderMapperSpec.php

@@ -4,8 +4,8 @@
 
 namespace spec\Webgriffe\SyliusActiveCampaignPlugin\Mapper;
 
-use App\Entity\Channel\ChannelInterface;
-use App\Entity\Customer\CustomerInterface;
+use Tests\Webgriffe\SyliusActiveCampaignPlugin\App\Entity\Channel\ChannelInterface;
+use Tests\Webgriffe\SyliusActiveCampaignPlugin\App\Entity\Customer\CustomerInterface;
 use DateTime;
 use DateTimeInterface;
 use Doctrine\Common\Collections\ArrayCollection;

spec/MessageHandler/Connection/ConnectionCreateHandlerSpec.php

@@ -4,7 +4,7 @@
 
 namespace spec\Webgriffe\SyliusActiveCampaignPlugin\MessageHandler\Connection;
 
-use App\Entity\Channel\ChannelInterface;
+use Tests\Webgriffe\SyliusActiveCampaignPlugin\App\Entity\Channel\ChannelInterface;
 use InvalidArgumentException;
 use PhpSpec\ObjectBehavior;
 use Sylius\Component\Channel\Repository\ChannelRepositoryInterface;

spec/MessageHandler/Connection/ConnectionUpdateHandlerSpec.php

@@ -4,7 +4,7 @@
 
 namespace spec\Webgriffe\SyliusActiveCampaignPlugin\MessageHandler\Connection;
 
-use App\Entity\Channel\ChannelInterface;
+use Tests\Webgriffe\SyliusActiveCampaignPlugin\App\Entity\Channel\ChannelInterface;
 use InvalidArgumentException;
 use PhpSpec\ObjectBehavior;
 use Sylius\Component\Channel\Repository\ChannelRepositoryInterface;

spec/MessageHandler/Contact/ContactCreateHandlerSpec.php

@@ -4,7 +4,7 @@
 
 namespace spec\Webgriffe\SyliusActiveCampaignPlugin\MessageHandler\Contact;
 
-use App\Entity\Customer\CustomerInterface;
+use Tests\Webgriffe\SyliusActiveCampaignPlugin\App\Entity\Customer\CustomerInterface;
 use InvalidArgumentException;
 use PhpSpec\ObjectBehavior;
 use Sylius\Component\Core\Model\CustomerInterface as SyliusCustomerInterface;

spec/MessageHandler/Contact/ContactListsSubscriberHandlerSpec.php

@@ -4,8 +4,8 @@
 
 namespace spec\Webgriffe\SyliusActiveCampaignPlugin\MessageHandler\Contact;
 
-use App\Entity\Channel\ChannelInterface;
-use App\Entity\Customer\CustomerInterface;
+use Tests\Webgriffe\SyliusActiveCampaignPlugin\App\Entity\Channel\ChannelInterface;
+use Tests\Webgriffe\SyliusActiveCampaignPlugin\App\Entity\Customer\CustomerInterface;
 use InvalidArgumentException;
 use Psr\Log\LoggerInterface;
 use Sylius\Component\Core\Model\ChannelInterface as SyliusChannelInterface;

spec/MessageHandler/Contact/ContactListsUpdaterHandlerSpec.php

@@ -4,8 +4,8 @@
 
 namespace spec\Webgriffe\SyliusActiveCampaignPlugin\MessageHandler\Contact;
 
-use App\Entity\Channel\ChannelInterface;
-use App\Entity\Customer\CustomerInterface;
+use Tests\Webgriffe\SyliusActiveCampaignPlugin\App\Entity\Channel\ChannelInterface;
+use Tests\Webgriffe\SyliusActiveCampaignPlugin\App\Entity\Customer\CustomerInterface;
 use InvalidArgumentException;
 use LogicException;
 use PhpSpec\ObjectBehavior;

spec/MessageHandler/Contact/ContactTagsAdderHandlerSpec.php

@@ -4,7 +4,7 @@
 
 namespace spec\Webgriffe\SyliusActiveCampaignPlugin\MessageHandler\Contact;
 
-use App\Entity\Customer\CustomerInterface;
+use Tests\Webgriffe\SyliusActiveCampaignPlugin\App\Entity\Customer\CustomerInterface;
 use InvalidArgumentException;
 use Psr\Log\LoggerInterface;
 use Sylius\Component\Core\Model\CustomerInterface as SyliusCustomerInterface;

spec/MessageHandler/Contact/ContactUpdateHandlerSpec.php

@@ -4,7 +4,7 @@
 
 namespace spec\Webgriffe\SyliusActiveCampaignPlugin\MessageHandler\Contact;
 
-use App\Entity\Customer\CustomerInterface;
+use Tests\Webgriffe\SyliusActiveCampaignPlugin\App\Entity\Customer\CustomerInterface;
 use InvalidArgumentException;
 use PhpSpec\ObjectBehavior;
 use Sylius\Component\Core\Model\CustomerInterface as SyliusCustomerInterface;

spec/MessageHandler/EcommerceCustomer/EcommerceCustomerCreateHandlerSpec.php

@@ -4,8 +4,8 @@
 
 namespace spec\Webgriffe\SyliusActiveCampaignPlugin\MessageHandler\EcommerceCustomer;
 
-use App\Entity\Channel\ChannelInterface;
-use App\Entity\Customer\CustomerInterface;
+use Tests\Webgriffe\SyliusActiveCampaignPlugin\App\Entity\Channel\ChannelInterface;
+use Tests\Webgriffe\SyliusActiveCampaignPlugin\App\Entity\Customer\CustomerInterface;
 use Doctrine\ORM\EntityManagerInterface;
 use InvalidArgumentException;
 use PhpSpec\ObjectBehavior;

spec/MessageHandler/EcommerceCustomer/EcommerceCustomerUpdateHandlerSpec.php

@@ -4,8 +4,8 @@
 
 namespace spec\Webgriffe\SyliusActiveCampaignPlugin\MessageHandler\EcommerceCustomer;
 
-use App\Entity\Channel\ChannelInterface;
-use App\Entity\Customer\CustomerInterface;
+use Tests\Webgriffe\SyliusActiveCampaignPlugin\App\Entity\Channel\ChannelInterface;
+use Tests\Webgriffe\SyliusActiveCampaignPlugin\App\Entity\Customer\CustomerInterface;
 use InvalidArgumentException;
 use PhpSpec\ObjectBehavior;
 use Sylius\Component\Channel\Repository\ChannelRepositoryInterface;

spec/MessageHandler/EcommerceOrder/EcommerceOrderCreateHandlerSpec.php

@@ -4,7 +4,7 @@
 
 namespace spec\Webgriffe\SyliusActiveCampaignPlugin\MessageHandler\EcommerceOrder;
 
-use App\Entity\Order\OrderInterface;
+use Tests\Webgriffe\SyliusActiveCampaignPlugin\App\Entity\Order\OrderInterface;
 use InvalidArgumentException;
 use PhpSpec\ObjectBehavior;
 use Sylius\Component\Core\Model\OrderInterface as SyliusOrderInterface;

spec/MessageHandler/EcommerceOrder/EcommerceOrderUpdateHandlerSpec.php

@@ -4,7 +4,7 @@
 
 namespace spec\Webgriffe\SyliusActiveCampaignPlugin\MessageHandler\EcommerceOrder;
 
-use App\Entity\Order\OrderInterface;
+use Tests\Webgriffe\SyliusActiveCampaignPlugin\App\Entity\Order\OrderInterface;
 use InvalidArgumentException;
 use PhpSpec\ObjectBehavior;
 use Sylius\Component\Core\Model\OrderInterface as SyliusOrderInterface;

spec/MessageHandler/Webhook/WebhookCreateHandlerSpec.php

@@ -4,7 +4,7 @@
 
 namespace spec\Webgriffe\SyliusActiveCampaignPlugin\MessageHandler\Webhook;
 
-use App\Entity\Channel\ChannelInterface;
+use Tests\Webgriffe\SyliusActiveCampaignPlugin\App\Entity\Channel\ChannelInterface;
 use InvalidArgumentException;
 use Sylius\Component\Channel\Repository\ChannelRepositoryInterface;
 use Sylius\Component\Core\Model\ChannelInterface as SyliusChannelInterface;

spec/Resolver/ChannelCustomerBasedListSubscriptionStatusResolverSpec.php

@@ -4,8 +4,8 @@
 
 namespace spec\Webgriffe\SyliusActiveCampaignPlugin\Resolver;
 
-use App\Entity\Channel\ChannelInterface;
-use App\Entity\Customer\CustomerInterface;
+use Tests\Webgriffe\SyliusActiveCampaignPlugin\App\Entity\Channel\ChannelInterface;
+use Tests\Webgriffe\SyliusActiveCampaignPlugin\App\Entity\Customer\CustomerInterface;
 use Webgriffe\SyliusActiveCampaignPlugin\Exception\ChannelCustomerDoesNotExistException;
 use Webgriffe\SyliusActiveCampaignPlugin\Exception\ChannelListIdDoesNotExistException;
 use Webgriffe\SyliusActiveCampaignPlugin\Exception\CustomerListSubscriptionStatusNotDefinedException;

spec/Resolver/CustomerBasedListSubscriptionStatusResolverSpec.php

@@ -4,8 +4,8 @@
 
 namespace spec\Webgriffe\SyliusActiveCampaignPlugin\Resolver;
 
-use App\Entity\Channel\ChannelInterface;
-use App\Entity\Customer\CustomerInterface;
+use Tests\Webgriffe\SyliusActiveCampaignPlugin\App\Entity\Channel\ChannelInterface;
+use Tests\Webgriffe\SyliusActiveCampaignPlugin\App\Entity\Customer\CustomerInterface;
 use Webgriffe\SyliusActiveCampaignPlugin\Exception\ChannelListIdDoesNotExistException;
 use Webgriffe\SyliusActiveCampaignPlugin\Model\ActiveCampaign\ContactListInterface;
 use Webgriffe\SyliusActiveCampaignPlugin\Model\ChannelCustomerInterface;

spec/Updater/ChannelCustomerBasedListSubscriptionStatusUpdaterSpec.php

@@ -4,14 +4,13 @@
 
 namespace spec\Webgriffe\SyliusActiveCampaignPlugin\Updater;
 
-use App\Entity\Customer\CustomerInterface;
+use Tests\Webgriffe\SyliusActiveCampaignPlugin\App\Entity\Customer\CustomerInterface;
 use InvalidArgumentException;
 use Sylius\Component\Core\Model\ChannelInterface;
 use Sylius\Component\Core\Model\CustomerInterface as SyliusCustomerInterface;
 use Sylius\Component\Resource\Repository\RepositoryInterface;
 use Webgriffe\SyliusActiveCampaignPlugin\Model\ActiveCampaign\ContactListInterface;
 use Webgriffe\SyliusActiveCampaignPlugin\Model\ChannelCustomerInterface;
-use Webgriffe\SyliusActiveCampaignPlugin\Resolver\ListSubscriptionStatusResolverInterface;
 use Webgriffe\SyliusActiveCampaignPlugin\Updater\ChannelCustomerBasedListSubscriptionStatusUpdater;
 use PhpSpec\ObjectBehavior;
 use Webgriffe\SyliusActiveCampaignPlugin\Updater\ListSubscriptionStatusUpdaterInterface;

spec/Updater/CustomerBasedListSubscriptionStatusUpdaterSpec.php

@@ -4,11 +4,10 @@
 
 namespace spec\Webgriffe\SyliusActiveCampaignPlugin\Updater;
 
-use App\Entity\Customer\CustomerInterface;
+use Tests\Webgriffe\SyliusActiveCampaignPlugin\App\Entity\Customer\CustomerInterface;
 use Sylius\Component\Core\Model\ChannelInterface;
 use Sylius\Component\Core\Repository\CustomerRepositoryInterface;
 use Webgriffe\SyliusActiveCampaignPlugin\Model\ActiveCampaign\ContactListInterface;
-use Webgriffe\SyliusActiveCampaignPlugin\Resolver\ListSubscriptionStatusResolverInterface;
 use Webgriffe\SyliusActiveCampaignPlugin\Updater\CustomerBasedListSubscriptionStatusUpdater;
 use PhpSpec\ObjectBehavior;
 use Webgriffe\SyliusActiveCampaignPlugin\Updater\ListSubscriptionStatusUpdaterInterface;

src/DependencyInjection/WebgriffeSyliusActiveCampaignExtension.php

@@ -18,7 +18,7 @@ final class WebgriffeSyliusActiveCampaignExtension extends AbstractResourceExten
  public function load(array $configs, ContainerBuilder $container): void
  {
  $config = $this->processConfiguration($this->getConfiguration([], $container), $configs);
- $fileLocator = new FileLocator(__DIR__ . '/../Resources/config');
+ $fileLocator = new FileLocator(__DIR__ . '/../../config');
  $loader = new XmlFileLoader($container, $fileLocator);
 
  $this->registerResources('webgriffe_sylius_active_campaign', $config['driver'], $config['resources'], $container);

src/WebgriffeSyliusActiveCampaignPlugin.php

@@ -7,6 +7,7 @@
 use Sylius\Bundle\CoreBundle\Application\SyliusPluginTrait;
 use Sylius\Bundle\ResourceBundle\AbstractResourceBundle;
 use Sylius\Bundle\ResourceBundle\SyliusResourceBundle;
+use function dirname;
 
 final class WebgriffeSyliusActiveCampaignPlugin extends AbstractResourceBundle
 {
@@ -21,11 +22,20 @@ public function getSupportedDrivers(): array
 
  public function getPath(): string
  {
- return __DIR__;
+ return dirname(__DIR__);
  }
 
  protected function getModelNamespace(): string
  {
  return 'Webgriffe\SyliusActiveCampaignPlugin\Model';
  }
+
+ protected function getConfigFilesPath(): string
+ {
+ return sprintf(
+ '%s/config/doctrine/%s',
+ $this->getPath(),
+ strtolower($this->getDoctrineMappingDirectory()),
+ );
+ }
 }

tests/Application/config/packages/_sylius.yaml

@@ -21,19 +21,19 @@ sylius_channel:
  resources:
  channel:
  classes:
- model: App\Entity\Channel\Channel
- repository: App\Doctrine\ORM\ChannelRepository
+ model: Tests\Webgriffe\SyliusActiveCampaignPlugin\App\Entity\Channel\Channel
+ repository: Tests\Webgriffe\SyliusActiveCampaignPlugin\App\Doctrine\ORM\ChannelRepository
 
 sylius_customer:
  resources:
  customer:
  classes:
- model: App\Entity\Customer\Customer
- repository: App\Doctrine\ORM\CustomerRepository
+ model: Tests\Webgriffe\SyliusActiveCampaignPlugin\App\Entity\Customer\Customer
+ repository: Tests\Webgriffe\SyliusActiveCampaignPlugin\App\Doctrine\ORM\CustomerRepository
 
 sylius_order:
  resources:
  order:
  classes:
- model: App\Entity\Order\Order
- repository: App\Doctrine\ORM\OrderRepository
+ model: Tests\Webgriffe\SyliusActiveCampaignPlugin\App\Entity\Order\Order
+ repository: Tests\Webgriffe\SyliusActiveCampaignPlugin\App\Doctrine\ORM\OrderRepository

tests/Application/config/packages/doctrine.yaml

@@ -18,9 +18,9 @@ doctrine:
  default:
  auto_mapping: true
  mappings:
- App:
+ Tests\Webgriffe\SyliusActiveCampaignPlugin\App:
  is_bundle: false
  type: annotation
  dir: '%kernel.project_dir%/src/Entity'
- prefix: 'App\Entity'
- alias: App
+ prefix: 'Tests\Webgriffe\SyliusActiveCampaignPlugin\App\Entity'
+ alias: Tests\Webgriffe\SyliusActiveCampaignPlugin\App

tests/Application/config/packages/webgriffe_sylius_active_campaign_plugin.yaml

@@ -1,5 +1,5 @@
 imports:
- - { resource: "@WebgriffeSyliusActiveCampaignPlugin/Resources/config/app/config.yaml" }
+ - { resource: "@WebgriffeSyliusActiveCampaignPlugin/config/app/config.yaml" }
 
 webgriffe_sylius_active_campaign:
  api_client:
@@ -11,4 +11,4 @@ webgriffe_sylius_active_campaign:
  resources:
  channel_customer:
  classes:
- model: App\Entity\Customer\ChannelCustomer
+ model: Tests\Webgriffe\SyliusActiveCampaignPlugin\App\Entity\Customer\ChannelCustomer

tests/Application/config/routes.yaml

@@ -1,2 +1,2 @@
 webgriffe_sylius_active_campaign_shop:
- resource: "@WebgriffeSyliusActiveCampaignPlugin/Resources/config/app_routing.yml"
+ resource: "@WebgriffeSyliusActiveCampaignPlugin/config/app_routing.yml"

tests/Application/src/Doctrine/ORM/ChannelRepository.php

@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace App\Doctrine\ORM;
+namespace Tests\Webgriffe\SyliusActiveCampaignPlugin\App\Doctrine\ORM;
 
 use Sylius\Bundle\ChannelBundle\Doctrine\ORM\ChannelRepository as BaseChannelRepository;
 use Webgriffe\SyliusActiveCampaignPlugin\Doctrine\ORM\ActiveCampaignChannelRepositoryTrait;