Allow to use Sylius from 1.7 to 1.10 and php 7.4 and 8.0

README.md

@@ -21,6 +21,10 @@ can be used for auditing.
 
 ![Screenshot showing gift card admin create page](docs/images/admin-gift-card-create.png)
 
+## Api platform support
+
+Everything related to Gift Card can be done via API. Whether it is admin or shop actions
+
 ## Installation
 
 ### Require plugin with composer:

behat.yml.dist

@@ -4,7 +4,7 @@ imports:
 
 default:
     extensions:
-        Lakion\Behat\MinkDebugExtension:
+        FriendsOfBehat\MinkDebugExtension:
             directory: etc/build
             clean_start: false
             screenshot: true

composer-require-checker.json

@@ -15,8 +15,11 @@
     "string",
     "true",
     "void",
-    "Sylius\\Bundle\\CoreBundle\\Application\\SyliusPluginTrait",
     "Setono\\SyliusCatalogPromotionPlugin\\Rule\\Rule",
+    "Sylius\\Bundle\\ApiBundle\\Command\\CommandAwareDataTransformerInterface",
+    "Sylius\\Bundle\\ApiBundle\\Context\\UserContextInterface",
+    "Sylius\\Bundle\\ApiBundle\\DataTransformer\\CommandDataTransformerInterface",
+    "Sylius\\Bundle\\CoreBundle\\Application\\SyliusPluginTrait",
     "Sylius\\Bundle\\ChannelBundle\\Form\\Type\\ChannelChoiceType",
     "Sylius\\Bundle\\CoreBundle\\Application\\SyliusPluginTrait",
     "Sylius\\Bundle\\CoreBundle\\Fixture\\AbstractResourceFixture",

composer.json

@@ -7,11 +7,12 @@
         "php": ">=7.4",
         "ext-filter": "*",
         "ext-mbstring": "*",
+        "api-platform/core": "^2.6",
         "doctrine/collections": "^1.6",
+        "doctrine/dbal": "^2.13",
         "doctrine/orm": "^2.7",
         "doctrine/persistence": "^1.3 || ^2.2",
-        "friendsofsymfony/rest-bundle": "^2.8",
-        "fzaninotto/faker": "^1.9",
+        "fakerphp/faker": "^1.9.0",
         "knplabs/knp-menu": "^3.2",
         "knplabs/knp-snappy": "^1.2",
         "knplabs/knp-snappy-bundle": "^1.7",
@@ -22,6 +23,7 @@
         "symfony/form": "^4.4 || ^5.0",
         "symfony/http-foundation": "^4.4 || ^5.0.7",
         "symfony/http-kernel": "^4.4 || ^5.1.5",
+        "symfony/messenger": "^4.4 || ^5.0",
         "symfony/options-resolver": "^4.4 || ^5.0",
         "symfony/property-access": "^4.4 || ^5.0",
         "symfony/routing": "^4.4 || ^5.0",
@@ -32,18 +34,19 @@
         "webmozart/assert": "^1.10"
     },
     "require-dev": {
-        "doctrine/doctrine-bundle": "^1.2.13",
+        "friendsofsymfony/oauth-server-bundle": ">2.0.0-alpha.0 ^2.0@dev",
         "matthiasnoback/symfony-config-test": "^4.2",
         "matthiasnoback/symfony-dependency-injection-test": "^4.1",
         "phpspec/phpspec": "^7.0",
+        "phpspec/prophecy-phpunit": "^2.0",
         "phpunit/phpunit": "^9.5",
         "psalm/plugin-phpunit": "^0.16.0",
         "psalm/plugin-symfony": "^2.1",
         "roave/security-advisories": "dev-latest",
-        "setono/code-quality-pack": "^2.1",
-        "setono/sylius-behat-pack": "^0.1",
-        "setono/sylius-catalog-promotion-plugin": "^0.2.0",
-        "sylius/sylius": "~1.7.0",
+        "setono/code-quality-pack": "^2.1.2",
+        "setono/sylius-behat-pack": "^0.2",
+        "setono/sylius-catalog-promotion-plugin": "^0.4",
+        "sylius/sylius": "~1.10.0",
         "symfony/debug-bundle": "^5.1",
         "symfony/dotenv": "^5.1",
         "symfony/intl": "^4.4 || ^5.0",

features/admin/browse_gift_cards.feature

@@ -0,0 +1,17 @@
+@managing_gift_cards
+Feature: Browsing existing gift cards
+  In order to manage the existing gift cards
+  As an Administrator
+  I want to browse existing gift cards
+
+  Background:
+    Given the store operates on a single channel in "United States"
+    And I am logged in as an administrator
+    And the store has a gift card with code "GIFT-CARD-100" valued at "$100"
+    And the store has a gift card with code "GIFT-CARD-200" valued at "$200"
+
+  @api
+  Scenario: Browsing gift cards
+    When I browse gift cards
+    Then I should see a gift card with code "GIFT-CARD-100" valued at "$100"
+    And I should see a gift card with code "GIFT-CARD-200" valued at "$200"

phpunit.xml.dist

@@ -11,7 +11,7 @@
     </coverage>
     <testsuites>
         <testsuite name="SetonoSyliusGiftCardPlugin Test Suite">
-            <directory>tests</directory>
+            <directory>tests/Unit</directory>
         </testsuite>
     </testsuites>
     <php>

src/Api/Command/AddGiftCardToOrder.php

@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Setono\SyliusGiftCardPlugin\Api\Command;
+
+class AddGiftCardToOrder implements GiftCardCodeAwareInterface
+{
+    public ?string $giftCardCode = null;
+
+    public string $orderTokenValue;
+
+    public function __construct(string $orderTokenValue)
+    {
+        $this->orderTokenValue = $orderTokenValue;
+    }
+
+    public function getGiftCardCode(): ?string
+    {
+        return $this->giftCardCode;
+    }
+
+    public function setGiftCardCode(?string $giftCardCode): void
+    {
+        $this->giftCardCode = $giftCardCode;
+    }
+}

src/Api/Command/AssociateConfigurationToChannel.php

@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Setono\SyliusGiftCardPlugin\Api\Command;
+
+class AssociateConfigurationToChannel implements ConfigurationCodeAwareInterface
+{
+    public ?string $configurationCode = null;
+
+    public string $localeCode;
+
+    public string $channelCode;
+
+    public function __construct(string $localeCode, string $channelCode)
+    {
+        $this->localeCode = $localeCode;
+        $this->channelCode = $channelCode;
+    }
+
+    public function getConfigurationCode(): ?string
+    {
+        return $this->configurationCode;
+    }
+
+    public function setConfigurationCode(?string $configurationCode): void
+    {
+        $this->configurationCode = $configurationCode;
+    }
+}

src/Api/Command/ConfigurationCodeAwareInterface.php

@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Setono\SyliusGiftCardPlugin\Api\Command;
+
+use Sylius\Bundle\ApiBundle\Command\CommandAwareDataTransformerInterface;
+
+interface ConfigurationCodeAwareInterface extends CommandAwareDataTransformerInterface
+{
+    public function getConfigurationCode(): ?string;
+
+    public function setConfigurationCode(?string $configurationCode): void;
+}

src/Api/Command/GiftCardCodeAwareInterface.php

@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Setono\SyliusGiftCardPlugin\Api\Command;
+
+use Sylius\Bundle\ApiBundle\Command\CommandAwareDataTransformerInterface;
+
+interface GiftCardCodeAwareInterface extends CommandAwareDataTransformerInterface
+{
+    public function getGiftCardCode(): ?string;
+
+    public function setGiftCardCode(?string $giftCardCode): void;
+}

src/Api/Command/RemoveGiftCardFromOrder.php

@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Setono\SyliusGiftCardPlugin\Api\Command;
+
+class RemoveGiftCardFromOrder implements GiftCardCodeAwareInterface
+{
+    public ?string $giftCardCode = null;
+
+    public string $orderTokenValue;
+
+    public function __construct(string $orderTokenValue)
+    {
+        $this->orderTokenValue = $orderTokenValue;
+    }
+
+    public function getGiftCardCode(): ?string
+    {
+        return $this->giftCardCode;
+    }
+
+    public function setGiftCardCode(?string $giftCardCode): void
+    {
+        $this->giftCardCode = $giftCardCode;
+    }
+}

src/Api/CommandHandler/AddGiftCardToOrderHandler.php

@@ -0,0 +1,50 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Setono\SyliusGiftCardPlugin\Api\CommandHandler;
+
+use Setono\SyliusGiftCardPlugin\Api\Command\AddGiftCardToOrder;
+use Setono\SyliusGiftCardPlugin\Applicator\GiftCardApplicatorInterface;
+use Setono\SyliusGiftCardPlugin\Model\GiftCardInterface;
+use Setono\SyliusGiftCardPlugin\Model\OrderInterface;
+use Setono\SyliusGiftCardPlugin\Repository\GiftCardRepositoryInterface;
+use Setono\SyliusGiftCardPlugin\Repository\OrderRepositoryInterface;
+use Symfony\Component\Messenger\Handler\MessageHandlerInterface;
+use Webmozart\Assert\Assert;
+
+final class AddGiftCardToOrderHandler implements MessageHandlerInterface
+{
+    private GiftCardRepositoryInterface $giftCardRepository;
+
+    private OrderRepositoryInterface $orderRepository;
+
+    private GiftCardApplicatorInterface $giftCardApplicator;
+
+    public function __construct(
+        GiftCardRepositoryInterface $giftCardRepository,
+        OrderRepositoryInterface $orderRepository,
+        GiftCardApplicatorInterface $giftCardApplicator
+    ) {
+        $this->giftCardRepository = $giftCardRepository;
+        $this->orderRepository = $orderRepository;
+        $this->giftCardApplicator = $giftCardApplicator;
+    }
+
+    public function __invoke(AddGiftCardToOrder $command): GiftCardInterface
+    {
+        $giftCardCode = $command->getGiftCardCode();
+        Assert::notNull($giftCardCode);
+
+        $giftCard = $this->giftCardRepository->findOneByCode($giftCardCode);
+        Assert::notNull($giftCard);
+
+        /** @var OrderInterface|null $order */
+        $order = $this->orderRepository->findOneBy(['tokenValue' => $command->orderTokenValue]);
+        Assert::notNull($order);
+
+        $this->giftCardApplicator->apply($order, $giftCard);
+
+        return $giftCard;
+    }
+}

src/Api/CommandHandler/AssociateConfigurationToChannelHandler.php

@@ -0,0 +1,78 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Setono\SyliusGiftCardPlugin\Api\CommandHandler;
+
+use Setono\SyliusGiftCardPlugin\Api\Command\AssociateConfigurationToChannel;
+use Setono\SyliusGiftCardPlugin\Model\GiftCardChannelConfigurationInterface;
+use Setono\SyliusGiftCardPlugin\Model\GiftCardConfigurationInterface;
+use Sylius\Component\Channel\Repository\ChannelRepositoryInterface;
+use Sylius\Component\Locale\Model\LocaleInterface;
+use Sylius\Component\Resource\Factory\FactoryInterface;
+use Sylius\Component\Resource\Repository\RepositoryInterface;
+use Symfony\Component\Messenger\Handler\MessageHandlerInterface;
+use Webmozart\Assert\Assert;
+
+final class AssociateConfigurationToChannelHandler implements MessageHandlerInterface
+{
+    private RepositoryInterface $giftCardConfigurationRepository;
+
+    private ChannelRepositoryInterface $channelRepository;
+
+    private RepositoryInterface $localeRepository;
+
+    private RepositoryInterface $giftCardChannelConfigurationRepository;
+
+    private FactoryInterface $giftCardChannelConfigurationFactory;
+
+    public function __construct(
+        RepositoryInterface $giftCardConfigurationRepository,
+        ChannelRepositoryInterface $channelRepository,
+        RepositoryInterface $localeRepository,
+        RepositoryInterface $giftCardChannelConfigurationRepository,
+        FactoryInterface $giftCardChannelConfigurationFactory
+    ) {
+        $this->giftCardConfigurationRepository = $giftCardConfigurationRepository;
+        $this->channelRepository = $channelRepository;
+        $this->localeRepository = $localeRepository;
+        $this->giftCardChannelConfigurationRepository = $giftCardChannelConfigurationRepository;
+        $this->giftCardChannelConfigurationFactory = $giftCardChannelConfigurationFactory;
+    }
+
+    public function __invoke(AssociateConfigurationToChannel $command): GiftCardConfigurationInterface
+    {
+        Assert::notNull($command->getConfigurationCode());
+
+        /** @var GiftCardConfigurationInterface|null $configuration */
+        $configuration = $this->giftCardConfigurationRepository->findOneBy(['code' => $command->getConfigurationCode()]);
+        Assert::notNull($configuration);
+
+        $channel = $this->channelRepository->findOneByCode($command->channelCode);
+        Assert::notNull($channel);
+
+        /** @var LocaleInterface|null $locale */
+        $locale = $this->localeRepository->findOneBy(['code' => $command->localeCode]);
+        Assert::notNull($locale);
+
+        /** @var GiftCardChannelConfigurationInterface|null $existingChannelConfiguration */
+        $existingChannelConfiguration = $this->giftCardChannelConfigurationRepository->findOneBy([
+            'configuration' => $configuration,
+            'channel' => $channel,
+            'locale' => $locale,
+        ]);
+        if (null !== $existingChannelConfiguration) {
+            return $configuration;
+        }
+
+        /** @var GiftCardChannelConfigurationInterface $channelConfiguration */
+        $channelConfiguration = $this->giftCardChannelConfigurationFactory->createNew();
+        $channelConfiguration->setConfiguration($configuration);
+        $channelConfiguration->setChannel($channel);
+        $channelConfiguration->setLocale($locale);
+
+        $configuration->addChannelConfiguration($channelConfiguration);
+
+        return $configuration;
+    }
+}