WIP - Adding sample variant config to the admin UI

BabDev · Feb 21, 2022 · 8073913 · 8073913
1 parent ad0bca5
commit 8073913
Show file tree

Hide file tree

Showing 25 changed files with 547 additions and 17 deletions.
diff --git a/.gitattributes b/.gitattributes
@@ -15,4 +15,5 @@ phpstan.neon export-ignore
 phpstan-baseline.neon export-ignore
 phpunit.xml.dist export-ignore
 psalm.xml export-ignore
+psalm-baseline.xml export-ignore
 README.md export-ignore
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -150,11 +150,11 @@ jobs:
 
             -
                 name: Check coding standards
-                run: vendor/bin/ecs check src
+                run: vendor/bin/ecs check
 
             -
                 name: Run PHPStan
-                run: vendor/bin/phpstan analyse -c phpstan.neon -l max src/
+                run: vendor/bin/phpstan analyse
 
             -
                 name: Run Psalm

diff --git a/ecs.php b/ecs.php
@@ -1,14 +1,15 @@
 <?php
 
 use PhpCsFixer\Fixer\ClassNotation\VisibilityRequiredFixer;
-use SlevomatCodingStandard\Sniffs\Commenting\InlineDocCommentDeclarationSniff;
 use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
 use Symplify\EasyCodingStandard\ValueObject\Option;
 
 return static function (ContainerConfigurator $containerConfigurator): void {
     $containerConfigurator->import('vendor/sylius-labs/coding-standard/ecs.php');
 
-    $containerConfigurator->parameters()->set(Option::SKIP, [
+    $parameters = $containerConfigurator->parameters();
+    $parameters->set(Option::PATHS, [__DIR__ . '/src']);
+    $parameters->set(Option::SKIP, [
         VisibilityRequiredFixer::class => ['*Spec.php'],
     ]);
 };
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -1,3 +1,32 @@
 parameters:
-	ignoreErrors: []
+	ignoreErrors:
+		-
+			message: "#^Short ternary operator is not allowed\\. Use null coalesce operator if applicable or consider using long ternary\\.$#"
+			count: 1
+			path: src/BabDevSyliusProductSamplesPlugin.php
+
+		-
+			message: "#^Cannot call method getData\\(\\) on Symfony\\\\Component\\\\Form\\\\FormInterface\\|null\\.$#"
+			count: 2
+			path: src/Form/Type/SampleProductVariantType.php
+
+		-
+			message: "#^Cannot call method getParent\\(\\) on Symfony\\\\Component\\\\Form\\\\FormInterface\\|null\\.$#"
+			count: 1
+			path: src/Form/Type/SampleProductVariantType.php
+
+		-
+			message: "#^Cannot call method getSamplesActive\\(\\) on Sylius\\\\Component\\\\Product\\\\Model\\\\ProductInterface\\|null\\.$#"
+			count: 1
+			path: src/Form/Type/SampleProductVariantType.php
+
+		-
+			message: "#^Only booleans are allowed in a negated boolean, mixed given\\.$#"
+			count: 1
+			path: src/Form/Type/SampleProductVariantType.php
+
+		-
+			message: "#^Parameter \\#1 \\$sampleOf of method BabDev\\\\SyliusProductSamplesPlugin\\\\Model\\\\ProductVariantInterface\\:\\:setSampleOf\\(\\) expects Sylius\\\\Component\\\\Product\\\\Model\\\\ProductVariantInterface\\|null, mixed given\\.$#"
+			count: 1
+			path: src/Form/Type/SampleProductVariantType.php
 
diff --git a/phpstan.neon b/phpstan.neon
@@ -4,6 +4,11 @@ parameters:
     reportUnmatchedIgnoredErrors: false
     checkMissingIterableValueType: false
 
+    level: max
+
+    paths:
+        - 'src'
+
     excludePaths:
         # Makes PHPStan crash
         # - 'src/DependencyInjection/Configuration.php'

diff --git a/psalm-baseline.xml b/psalm-baseline.xml
@@ -0,0 +1,26 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<files psalm-version="4.20.0@f82a70e7edfc6cf2705e9374c8a0b6a974a779ed">
+  <file src="src/BabDevSyliusProductSamplesPlugin.php">
+    <MixedInferredReturnType occurrences="1">
+      <code>?ExtensionInterface</code>
+    </MixedInferredReturnType>
+    <MixedReturnStatement occurrences="1">
+      <code>$this-&gt;extension ?: null</code>
+    </MixedReturnStatement>
+  </file>
+  <file src="src/Form/Type/SampleProductVariantType.php">
+    <MixedArgument occurrences="1">
+      <code>$variantForm-&gt;getData()</code>
+    </MixedArgument>
+    <MixedAssignment occurrences="1">
+      <code>$productVariant</code>
+    </MixedAssignment>
+    <PossiblyNullReference occurrences="2">
+      <code>getParent</code>
+      <code>getSamplesActive</code>
+    </PossiblyNullReference>
+    <UndefinedInterfaceMethod occurrences="1">
+      <code>getSamplesActive</code>
+    </UndefinedInterfaceMethod>
+  </file>
+</files>
diff --git a/psalm.xml b/psalm.xml
@@ -5,6 +5,7 @@
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xmlns="https://getpsalm.org/schema/config"
         xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"
+        errorBaseline="psalm-baseline.xml"
 >
     <projectFiles>
         <directory name="src" />

diff --git a/spec/Menu/ProductFormMenuBuilderSpec.php b/spec/Menu/ProductFormMenuBuilderSpec.php
@@ -16,5 +16,7 @@ public function it_adds_the_menu_item_to_the_product_form_menu(ProductMenuBuilde
         $menu->addChild('product_samples')->willReturn($menu);
         $menu->setAttribute('template', '@BabDevSyliusProductSamplesPlugin/Admin/Product/Tab/_product_samples.html.twig')->willReturn($menu);
         $menu->setLabel('babdev_sylius_product_samples.ui.product_samples')->willReturn($menu);
+
+        $this->addProductSamplesMenu($event);
     }
 }
diff --git a/spec/Menu/ProductVariantFormMenuBuilderSpec.php b/spec/Menu/ProductVariantFormMenuBuilderSpec.php
@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace spec\BabDev\SyliusProductSamplesPlugin\Menu;
+
+use Knp\Menu\ItemInterface;
+use PhpSpec\ObjectBehavior;
+use Sylius\Bundle\AdminBundle\Event\ProductVariantMenuBuilderEvent;
+
+final class ProductVariantFormMenuBuilderSpec extends ObjectBehavior
+{
+    public function it_adds_the_menu_item_to_the_product_form_menu(ProductVariantMenuBuilderEvent $event, ItemInterface $menu): void
+    {
+        $event->getMenu()->willReturn($menu);
+        $menu->addChild('product_samples')->willReturn($menu);
+        $menu->setAttribute('template', '@BabDevSyliusProductSamplesPlugin/Admin/ProductVariant/Tab/_product_samples.html.twig')->willReturn($menu);
+        $menu->setLabel('babdev_sylius_product_samples.ui.product_samples')->willReturn($menu);
+
+        $this->addProductSamplesMenu($event);
+    }
+}
diff --git a/src/BabDevSyliusProductSamplesPlugin.php b/src/BabDevSyliusProductSamplesPlugin.php
@@ -18,20 +18,12 @@ protected function getBundlePrefix(): string
         return 'babdev_sylius_product_samples';
     }
 
-    /**
-     * @psalm-suppress DocblockTypeContradiction
-     * @psalm-suppress InvalidReturnStatement
-     * @psalm-suppress InvalidReturnType
-     */
     public function getContainerExtension(): ?ExtensionInterface
     {
-        if (null === $this->containerExtension) {
-            $this->containerExtension = new BabDevSyliusProductSamplesExtension();
+        if (null === $this->extension) {
+            $this->extension = new BabDevSyliusProductSamplesExtension();
         }
 
-        /**
-         * @phpstan-ignore-next-line
-         */
-        return $this->containerExtension === false ? null : $this->containerExtension;
+        return $this->extension ?: null;
     }
 }
diff --git a/src/EventListener/ProductListener.php b/src/EventListener/ProductListener.php
@@ -0,0 +1,32 @@
+<?php
+
+declare(strict_types=1);
+
+namespace BabDev\SyliusProductSamplesPlugin\EventListener;
+
+use BabDev\SyliusProductSamplesPlugin\Model\ProductInterface;
+use BabDev\SyliusProductSamplesPlugin\Model\ProductVariantInterface;
+use Sylius\Bundle\ResourceBundle\Event\ResourceControllerEvent;
+
+final class ProductListener
+{
+    public function ensureSampleVariantsHaveCodes(ResourceControllerEvent $event): void
+    {
+        /** @var ProductInterface $product */
+        $product = $event->getSubject();
+
+        foreach ($product->getVariants() as $variant) {
+            if (!$variant instanceof ProductVariantInterface) {
+                continue;
+            }
+
+            if (null === $sample = $variant->getSample()) {
+                continue;
+            }
+
+            if (null === $sample->getCode()) {
+                $sample->setCode(sprintf('SAMPLE-%s', $variant->getCode() ?? ''));
+            }
+        }
+    }
+}
diff --git a/src/Form/Extension/ProductTypeExtension.php b/src/Form/Extension/ProductTypeExtension.php
@@ -4,13 +4,23 @@
 
 namespace BabDev\SyliusProductSamplesPlugin\Form\Extension;
 
+use BabDev\SyliusProductSamplesPlugin\Model\ProductInterface;
+use BabDev\SyliusProductSamplesPlugin\Model\ProductVariantInterface;
 use Sylius\Bundle\ProductBundle\Form\Type\ProductType;
+use Sylius\Component\Product\Factory\ProductVariantFactoryInterface;
 use Symfony\Component\Form\AbstractTypeExtension;
 use Symfony\Component\Form\Extension\Core\Type\CheckboxType;
 use Symfony\Component\Form\FormBuilderInterface;
+use Symfony\Component\Form\FormEvent;
+use Symfony\Component\Form\FormEvents;
+use Webmozart\Assert\Assert;
 
 final class ProductTypeExtension extends AbstractTypeExtension
 {
+    public function __construct(private ProductVariantFactoryInterface $productVariantFactory)
+    {
+    }
+
     public function buildForm(FormBuilderInterface $builder, array $options): void
     {
         $builder
@@ -19,6 +29,24 @@ public function buildForm(FormBuilderInterface $builder, array $options): void
                 'label' => 'babdev_sylius_product_samples.form.product.samples_available',
             ])
         ;
+
+        $builder->addEventListener(FormEvents::PRE_SET_DATA, function (FormEvent $event): void {
+            $product = $event->getData();
+
+            Assert::isInstanceOf($product, ProductInterface::class);
+
+            if (!$product->isSimple()) {
+                return;
+            }
+
+            $variant = $product->getVariants()->first();
+
+            Assert::isInstanceOf($variant, ProductVariantInterface::class);
+
+            if (null === $variant->getSample()) {
+                $variant->setSample($this->productVariantFactory->createForProduct($product));
+            }
+        });
     }
 
     public static function getExtendedTypes(): iterable

diff --git a/src/Form/Extension/ProductVariantTypeExtension.php b/src/Form/Extension/ProductVariantTypeExtension.php
@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace BabDev\SyliusProductSamplesPlugin\Form\Extension;
+
+use BabDev\SyliusProductSamplesPlugin\Form\Type\SampleProductVariantType;
+use Sylius\Bundle\ProductBundle\Form\Type\ProductVariantType;
+use Symfony\Component\Form\AbstractTypeExtension;
+use Symfony\Component\Form\FormBuilderInterface;
+
+final class ProductVariantTypeExtension extends AbstractTypeExtension
+{
+    public function buildForm(FormBuilderInterface $builder, array $options): void
+    {
+        $builder
+            ->add('sample', SampleProductVariantType::class)
+        ;
+    }
+
+    public static function getExtendedTypes(): iterable
+    {
+        return [ProductVariantType::class];
+    }
+}
diff --git a/src/Form/Type/SampleProductVariantType.php b/src/Form/Type/SampleProductVariantType.php
@@ -0,0 +1,101 @@
+<?php
+
+declare(strict_types=1);
+
+namespace BabDev\SyliusProductSamplesPlugin\Form\Type;
+
+use BabDev\SyliusProductSamplesPlugin\Model\ProductVariantInterface;
+use Sylius\Bundle\CoreBundle\Form\Type\ChannelCollectionType;
+use Sylius\Bundle\CoreBundle\Form\Type\Product\ChannelPricingType;
+use Sylius\Bundle\ResourceBundle\Form\Type\AbstractResourceType;
+use Sylius\Bundle\ShippingBundle\Form\Type\ShippingCategoryChoiceType;
+use Sylius\Bundle\TaxationBundle\Form\Type\TaxCategoryChoiceType;
+use Sylius\Component\Core\Model\ChannelInterface;
+use Symfony\Component\Form\Extension\Core\Type\NumberType;
+use Symfony\Component\Form\FormBuilderInterface;
+use Symfony\Component\Form\FormEvent;
+use Symfony\Component\Form\FormEvents;
+
+final class SampleProductVariantType extends AbstractResourceType
+{
+    public function buildForm(FormBuilderInterface $builder, array $options): void
+    {
+        $builder
+            ->add('shippingCategory', ShippingCategoryChoiceType::class, [
+                'required' => false,
+                'placeholder' => 'sylius.ui.no_requirement',
+                'label' => 'sylius.form.product_variant.shipping_category',
+            ])
+            ->add('width', NumberType::class, [
+                'required' => false,
+                'label' => 'sylius.form.variant.width',
+                'invalid_message' => 'sylius.product_variant.width.invalid',
+            ])
+            ->add('height', NumberType::class, [
+                'required' => false,
+                'label' => 'sylius.form.variant.height',
+                'invalid_message' => 'sylius.product_variant.height.invalid',
+            ])
+            ->add('depth', NumberType::class, [
+                'required' => false,
+                'label' => 'sylius.form.variant.depth',
+                'invalid_message' => 'sylius.product_variant.depth.invalid',
+            ])
+            ->add('weight', NumberType::class, [
+                'required' => false,
+                'label' => 'sylius.form.variant.weight',
+                'invalid_message' => 'sylius.product_variant.weight.invalid',
+            ])
+            ->add('taxCategory', TaxCategoryChoiceType::class, [
+                'required' => false,
+                'placeholder' => '---',
+                'label' => 'sylius.form.product_variant.tax_category',
+            ])
+        ;
+
+        $builder->addEventListener(FormEvents::PRE_SET_DATA, function (FormEvent $event): void {
+            $productVariant = $event->getData();
+
+            $event->getForm()->add('channelPricings', ChannelCollectionType::class, [
+                'entry_type' => ChannelPricingType::class,
+                'entry_options' => static fn (ChannelInterface $channel): array => [
+                    'channel' => $channel,
+                    'product_variant' => $productVariant,
+                    'required' => false,
+                ],
+                'label' => 'sylius.form.variant.price',
+            ]);
+        });
+
+        $builder->addEventListener(FormEvents::SUBMIT, function (FormEvent $event): void {
+            /** @var ProductVariantInterface $sampleVariant */
+            $sampleVariant = $event->getData();
+
+            $variantForm = $event->getForm()->getParent();
+
+            if (null !== $productForm = $variantForm->getParent()) {
+                if (!$productForm->get('samplesActive')->getData() && null === $sampleVariant->getId()) {
+                    $event->setData(null);
+
+                    return;
+                }
+            } else {
+                if (!$sampleVariant->getProduct()->getSamplesActive() && null === $sampleVariant->getId()) {
+                    $event->setData(null);
+
+                    return;
+                }
+            }
+
+            if (null !== $sampleVariant->getId()) {
+                return;
+            }
+
+            /** @var ProductVariantInterface $actualVariant */
+            $actualVariant = $variantForm->getData();
+            $actualVariant->setSample($sampleVariant);
+
+            $sampleVariant->setSampleOf($variantForm->getData());
+        });
+    }
+}