Merge pull request #13 from loevgaard/make-unique-constraint-configurable

Make unique constraint configurable to revert 1.5 and get back to 1.4.X

Author: igormukhingmailcom

README.md

@@ -71,11 +71,7 @@ use Sylius\Component\Core\Model\ProductVariant as BaseProductVariant;
 
 /**
  * @ORM\Entity
- * @ORM\Table(name="sylius_product_variant",
- *    uniqueConstraints={
- *        @ORM\UniqueConstraint(name="loevgaard_barcode_unique", columns={"barcode", "version"})
- *    }
- * )
+ * @ORM\Table(name="sylius_product_variant")
  */
 class ProductVariant extends BaseProductVariant implements LoevgaardSyliusBarcodePluginProductVariantInterface
 {

UPGRADE.md

@@ -1,28 +1,3 @@
-# Upgrade from 1.4 to 1.5
-
-1. Update your `ProductVariant` mapping annotations to have `loevgaard_barcode_unique` constraint:
-
-```php
-/**
- * @ORM\Entity
- * @ORM\Table(name="sylius_product_variant",
- *    uniqueConstraints={
- *        @ORM\UniqueConstraint(name="loevgaard_barcode_unique", columns={"barcode", "version"})
- *    }
- * )
- */
-class ProductVariant extends BaseProductVariant implements LoevgaardSyliusBarcodePluginProductVariantInterface 
-...
-```
-
-1. Generate and run database migration
-
-```bash
-php bin/console doctrine:migrations:diff
-php bin/console doctrine:migrations:migrate
-```
-
-More context - at https://github.com/loevgaard/SyliusBarcodePlugin/pull/12/files
 
 # Upgrade from 1.2 to 1.3
 

phpstan.neon

@@ -13,5 +13,5 @@ parameters:
         - 'src/DependencyInjection/Configuration.php'
 
     ignoreErrors:
-        - '/Parameter #1 $configuration of method Symfony\Component\DependencyInjection\Extension\Extension::processConfiguration() expects Symfony\Component\Config\Definition\ConfigurationInterface, Symfony\Component\Config\Definition\ConfigurationInterface|null given./'
+        - '/Parameter #1 \$configuration of method .+processConfiguration\(\) expects .+ConfigurationInterface, .+ConfigurationInterface\|null given\./'
         - '/Method Symfony\\Contracts\\EventDispatcher\\EventDispatcherInterface\:\:dispatch\(\) invoked with 2 parameters, 1 required\./'

src/DependencyInjection/Configuration.php

@@ -33,6 +33,10 @@ public function getConfigTreeBuilder(): TreeBuilder
                             ->defaultFalse()
                             ->info('If true the barcode field will be validated when entered in the product forms (both product and variant)')
                         ->end()
+                        ->booleanNode('require_unique')
+                            ->defaultTrue()
+                            ->info('If true the barcode unique constraint will be added to the field')
+                        ->end()
                     ->end()
                 ->end()
             ->end()

src/DependencyInjection/LoevgaardSyliusBarcodeExtension.php

@@ -4,24 +4,19 @@
 
 namespace Loevgaard\SyliusBarcodePlugin\DependencyInjection;
 
-use Exception;
 use Symfony\Component\Config\FileLocator;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Extension\Extension;
 use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
 
 final class LoevgaardSyliusBarcodeExtension extends Extension
 {
-    /**
-     * {@inheritdoc}
-     *
-     * @throws Exception
-     */
     public function load(array $config, ContainerBuilder $container): void
     {
         $config = $this->processConfiguration($this->getConfiguration([], $container), $config);
         $container->setParameter('loevgaard_sylius_barcode.form.require', $config['form']['require']);
         $container->setParameter('loevgaard_sylius_barcode.form.require_valid', $config['form']['require_valid']);
+        $container->setParameter('loevgaard_sylius_barcode.form.require_unique', $config['form']['require_unique']);
 
         $loader = new XmlFileLoader($container, new FileLocator(__DIR__ . '/../Resources/config'));
         $loader->load('services.xml');

src/EventListener/AddBarcodeUniqueSubscriber.php

@@ -0,0 +1,43 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Loevgaard\SyliusBarcodePlugin\EventListener;
+
+use Doctrine\Common\EventSubscriber;
+use Doctrine\ORM\Event\LoadClassMetadataEventArgs;
+use Doctrine\ORM\Events;
+use Loevgaard\SyliusBarcodePlugin\Model\BarcodeAwareInterface;
+
+final class AddBarcodeUniqueSubscriber implements EventSubscriber
+{
+    /** @var bool */
+    private $uniqueEnabled;
+
+    public function __construct(bool $uniqueEnabled)
+    {
+        $this->uniqueEnabled = $uniqueEnabled;
+    }
+
+    public function getSubscribedEvents(): array
+    {
+        return [
+            Events::loadClassMetadata,
+        ];
+    }
+
+    public function loadClassMetadata(LoadClassMetadataEventArgs $event): void
+    {
+        $metadata = $event->getClassMetadata();
+
+        if (!is_subclass_of($metadata->name, BarcodeAwareInterface::class, true)) {
+            return;
+        }
+
+        if (!$this->uniqueEnabled) {
+            return;
+        }
+
+        $metadata->fieldMappings['barcode']['unique'] = true;
+    }
+}

src/Resources/config/services.xml

@@ -4,8 +4,9 @@
            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
            xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
     <imports>
+        <import resource="services/checker.xml"/>
         <import resource="services/command.xml"/>
-        <import resource="services/etc.xml"/>
+        <import resource="services/event_listener.xml"/>
         <import resource="services/form.xml"/>
         <import resource="services/messenger.xml"/>
         <import resource="services/validator.xml"/>

src/Resources/config/services/etc.xml src/Resources/config/services/checker.xmlsrc/Resources/config/services/etc.xml renamed to src/Resources/config/services/checker.xml

@@ -13,9 +13,5 @@
         <service id="Loevgaard\SyliusBarcodePlugin\BarcodeChecker\BarcodeCheckerInterface"
                  alias="loevgaard_sylius_barcode.barcode_checker"/>
 
-        <service id="Loevgaard\SyliusBarcodePlugin\EventListener\AddIndicesSubscriber">
-            <tag name="doctrine.event_subscriber"/>
-        </service>
-
     </services>
 </container>

src/Resources/config/services/event_listener.xml

@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+
+<container xmlns="http://symfony.com/schema/dic/services"
+           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+           xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
+    <services>
+
+        <service id="Loevgaard\SyliusBarcodePlugin\EventListener\AddBarcodeUniqueSubscriber">
+            <argument>%loevgaard_sylius_barcode.form.require_unique%</argument>
+
+            <tag name="doctrine.event_subscriber"/>
+        </service>
+
+        <service id="Loevgaard\SyliusBarcodePlugin\EventListener\AddIndicesSubscriber">
+            <tag name="doctrine.event_subscriber"/>
+        </service>
+
+    </services>
+</container>

src/Validator/Constraint/Barcode.php

@@ -12,7 +12,7 @@
 class Barcode extends Constraint
 {
     /** @var string */
-    public $message = 'The string "{{ string }}" is not a valid barcode.';
+    public $message = 'loevgaard_sylius_barcode.product_variant.barcode.valid';
 
     public function validatedBy(): string
     {