fix vat number selection from address book

Author: gewebe

config/services/form.yaml

@@ -11,3 +11,8 @@ services:
         class: Gewebe\SyliusVATPlugin\Form\Extension\ShopBillingDataTypeExtension
         tags:
             - { name: form.type_extension, extended_type: Sylius\Bundle\CoreBundle\Form\Type\ShopBillingDataType }
+
+    gewebe_sylius_vat_plugin.form.modifier.vat_number_address_form_values:
+        class: Gewebe\SyliusVATPlugin\Form\Modifier\VatNumberAddressFormValuesModifier
+        tags:
+            - { name: sylius_shop.modifier.address_form_values }

features/checkout/seeing_tax_total_dependent_on_country_and_vat.feature

@@ -53,6 +53,14 @@ Feature: Seeing tax total dependent on country and vat
         And I have 2 products "PHP T-Shirt" in the cart
         And I am at the checkout addressing step
 
+    @ui @javascript
+    Scenario: Choosing an address with VAT number from the address book
+        Given I have an address "Ankh Morpork", "Rue Neuve", "1000", "Brussels", "Belgium" in my address book
+        And the "Rue Neuve" street VAT number is "BE0123456789"
+        And I go to the checkout addressing step
+        When I choose "Rue Neuve" street for billing address
+        Then the billing VAT number should be "BE0123456789"
+
     @ui
     Scenario: Seeing included tax of 21% within business country
         When I specify the billing address as "Gent", "Merelstraat", "9000", "Belgium" for "Ankh Morpork"

src/DependencyInjection/Compiler/ConfigureCheckoutAddressFormComponentPass.php

@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Gewebe\SyliusVATPlugin\DependencyInjection\Compiler;
+
+use Gewebe\SyliusVATPlugin\Twig\Component\Checkout\Address\FormComponent;
+use Sylius\Bundle\ShopBundle\Modifier\AddressFormValuesModifierInterface;
+use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+
+final class ConfigureCheckoutAddressFormComponentPass implements CompilerPassInterface
+{
+    private const FORM_COMPONENT_SERVICE_ID = 'sylius_shop.twig.component.checkout.address.form';
+
+    public function process(ContainerBuilder $container): void
+    {
+        if (
+            interface_exists(AddressFormValuesModifierInterface::class) ||
+            !$container->hasDefinition(self::FORM_COMPONENT_SERVICE_ID)
+        ) {
+            return;
+        }
+
+        $container->getDefinition(self::FORM_COMPONENT_SERVICE_ID)->setClass(FormComponent::class);
+    }
+}

src/DependencyInjection/GewebeSyliusVATExtension.php

@@ -6,6 +6,7 @@
 
 use Sylius\Bundle\CoreBundle\DependencyInjection\PrependDoctrineMigrationsTrait;
 use Sylius\Bundle\ResourceBundle\DependencyInjection\Extension\AbstractResourceExtension;
+use Sylius\Bundle\ShopBundle\Modifier\AddressFormValuesModifierInterface;
 use Symfony\Component\Config\FileLocator;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Extension\PrependExtensionInterface;
@@ -20,6 +21,11 @@ public function load(array $configs, ContainerBuilder $container): void
         $loader = new YamlFileLoader($container, new FileLocator(__DIR__ . '/../../config'));
         $loader->load('services.yaml');
 
+        // Sylius 2.1 has no address form value modifier; a compiler pass configures the fallback component instead.
+        if (!interface_exists(AddressFormValuesModifierInterface::class)) {
+            $container->removeDefinition('gewebe_sylius_vat_plugin.form.modifier.vat_number_address_form_values');
+        }
+
         $configuration = $this->getConfiguration([], $container);
         if ($configuration === null) {
             return;

src/Form/Modifier/VatNumberAddressFormValuesModifier.php

@@ -0,0 +1,26 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Gewebe\SyliusVATPlugin\Form\Modifier;
+
+use Gewebe\SyliusVATPlugin\Entity\VatNumberAddressInterface;
+use Sylius\Bundle\ShopBundle\Modifier\AddressFormValuesModifierInterface;
+use Sylius\Component\Addressing\Model\AddressInterface;
+
+final readonly class VatNumberAddressFormValuesModifier implements AddressFormValuesModifierInterface
+{
+    /**
+     * @param array<string, mixed> $addressData
+     *
+     * @return array<string, mixed>
+     */
+    public function modify(array $addressData, AddressInterface $address): array
+    {
+        if ($address instanceof VatNumberAddressInterface) {
+            $addressData['vatNumber'] = $address->getVatNumber();
+        }
+
+        return $addressData;
+    }
+}

src/GewebeSyliusVATPlugin.php

@@ -4,13 +4,25 @@
 
 namespace Gewebe\SyliusVATPlugin;
 
+use Gewebe\SyliusVATPlugin\DependencyInjection\Compiler\ConfigureCheckoutAddressFormComponentPass;
 use Sylius\Bundle\CoreBundle\Application\SyliusPluginTrait;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\HttpKernel\Bundle\Bundle;
 
 final class GewebeSyliusVATPlugin extends Bundle
 {
     use SyliusPluginTrait;
 
+    public function build(ContainerBuilder $container): void
+    {
+        parent::build($container);
+
+        // Sylius 2.1 does not provide address form value modifiers. The compiler pass replaces the checkout
+        // address component with a compatibility fallback after all bundle services have been loaded.
+        // TODO: Remove the compiler pass and the fallback component when support for Sylius 2.1 is dropped.
+        $container->addCompilerPass(new ConfigureCheckoutAddressFormComponentPass());
+    }
+
     public function getPath(): string
     {
         return \dirname(__DIR__);

src/Twig/Component/Checkout/Address/FormComponent.php

@@ -0,0 +1,35 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Gewebe\SyliusVATPlugin\Twig\Component\Checkout\Address;
+
+use Gewebe\SyliusVATPlugin\Entity\VatNumberAddressInterface;
+use Sylius\Bundle\ShopBundle\Twig\Component\Checkout\Address\AddressBookComponent;
+use Sylius\Bundle\ShopBundle\Twig\Component\Checkout\Address\FormComponent as BaseFormComponent;
+use Sylius\Component\Core\Model\CustomerInterface;
+use Symfony\UX\LiveComponent\Attribute\LiveArg;
+use Symfony\UX\LiveComponent\Attribute\LiveListener;
+
+/**
+ * Sylius 2.1 compatibility fallback; Sylius 2.2+ uses VatNumberAddressFormValuesModifier instead.
+ */
+final class FormComponent extends BaseFormComponent
+{
+    #[LiveListener(AddressBookComponent::SYLIUS_SHOP_ADDRESS_UPDATED)]
+    public function addressFieldUpdated(#[LiveArg] mixed $addressId, #[LiveArg] string $field): void
+    {
+        $customer = $this->customerContext->getCustomer();
+        if (!$customer instanceof CustomerInterface || !is_scalar($addressId)) {
+            return;
+        }
+
+        $address = $this->addressRepository->findOneByCustomer((string) $addressId, $customer);
+        if (!$address instanceof VatNumberAddressInterface) {
+            return;
+        }
+
+        parent::addressFieldUpdated($addressId, $field);
+        $this->formValues[$field]['vatNumber'] = $address->getVatNumber();
+    }
+}

tests/Behat/Context/Setup/AddressContext.php

@@ -9,6 +9,7 @@
 use DateTime;
 use Doctrine\Persistence\ObjectManager;
 use Gewebe\SyliusVATPlugin\Entity\VatNumberAddressInterface;
+use Sylius\Component\Core\Model\AddressInterface;
 use Sylius\Component\Core\Model\CustomerInterface;
 
 class AddressContext implements Context
@@ -36,4 +37,15 @@ public function theirDefaultAddressVatNumberIs(
 
         $this->objectManager->flush();
     }
+
+    #[Given('/^the ("[^"]+" street) VAT number is "([^"]+)"$/')]
+    public function theAddressVatNumberIs(AddressInterface $address, string $vatNumber): void
+    {
+        if (!$address instanceof VatNumberAddressInterface) {
+            throw new \InvalidArgumentException('The address does not support VAT numbers.');
+        }
+
+        $address->setVatNumber($vatNumber);
+        $this->objectManager->flush();
+    }
 }

tests/Behat/Context/Ui/Shop/Checkout/AddressVatNumberContext.php

@@ -40,6 +40,17 @@ public function iSpecifyTheVatNumberForShippingAddress(string $vatNumber): void
         $this->addressPage->specifyShippingAddressVatNumber($vatNumber);
     }
 
+    #[Then('/^the (shipping|billing) VAT number should be "([^"]+)"$/')]
+    public function theVatNumberShouldBe(string $type, string $vatNumber): void
+    {
+        $actualVatNumber = $type === 'shipping'
+            ? $this->addressPage->getShippingAddressVatNumber()
+            : $this->addressPage->getBillingAddressVatNumber()
+        ;
+
+        Assert::same($actualVatNumber, $vatNumber);
+    }
+
     #[Then('/^I should be notified that the VAT number in (shipping|billing) is required$/')]
     public function iShouldBeNotifiedThatTheVatNumberIsRequired(string $type): void
     {

tests/Behat/Page/Shop/Checkout/AddressPage.php

@@ -5,6 +5,7 @@
 namespace Tests\Gewebe\SyliusVATPlugin\Behat\Page\Shop\Checkout;
 
 use Sylius\Behat\Page\Shop\Checkout\AddressPage as BaseAddressPage;
+use Webmozart\Assert\Assert;
 
 class AddressPage extends BaseAddressPage implements AddressPageInterface
 {
@@ -18,6 +19,16 @@ public function specifyBillingAddressVatNumber(string $vatNumber): void
         $this->getElement('billing_vat_number')->setValue($vatNumber);
     }
 
+    public function getBillingAddressVatNumber(): string
+    {
+        $this->waitForFormToStopLoading();
+
+        $vatNumber = $this->getElement('billing_vat_number')->getValue();
+        Assert::string($vatNumber);
+
+        return $vatNumber;
+    }
+
     public function specifyShippingAddressCompany(string $company): void
     {
         $this->getElement('shipping_company')->setValue($company);
@@ -28,6 +39,16 @@ public function specifyShippingAddressVatNumber(string $vatNumber): void
         $this->getElement('shipping_vat_number')->setValue($vatNumber);
     }
 
+    public function getShippingAddressVatNumber(): string
+    {
+        $this->waitForFormToStopLoading();
+
+        $vatNumber = $this->getElement('shipping_vat_number')->getValue();
+        Assert::string($vatNumber);
+
+        return $vatNumber;
+    }
+
     protected function getDefinedElements(): array
     {
         return array_merge(parent::getDefinedElements(), [