Merge pull request #10 from monsieurbiz/feature/product-preparation-d…

…elay

Add preparation delay in product variants

src/Entity/ProductVariantInterface.php

@@ -0,0 +1,23 @@
+<?php
+
+/*
+ * This file is part of Monsieur Biz' Shipping Slot plugin for Sylius.
+ *
+ * (c) Monsieur Biz <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace MonsieurBiz\SyliusShippingSlotPlugin\Entity;
+
+use Sylius\Component\Core\Model\ProductVariantInterface as SyliusProductVariantInterface;
+
+interface ProductVariantInterface extends SyliusProductVariantInterface
+{
+    public function getPreparationDelay(): ?int;
+
+    public function setPreparationDelay(?int $preparationDelay): void;
+}

src/Entity/ProductVariantTrait.php

@@ -0,0 +1,34 @@
+<?php
+
+/*
+ * This file is part of Monsieur Biz' Shipping Slot plugin for Sylius.
+ *
+ * (c) Monsieur Biz <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace MonsieurBiz\SyliusShippingSlotPlugin\Entity;
+
+use Doctrine\ORM\Mapping as ORM;
+
+trait ProductVariantTrait
+{
+    /**
+     * @ORM\Column(name="preparation_delay", type="integer", nullable=true)
+     */
+    private ?int $preparationDelay = null;
+
+    public function getPreparationDelay(): ?int
+    {
+        return $this->preparationDelay;
+    }
+
+    public function setPreparationDelay(?int $preparationDelay): void
+    {
+        $this->preparationDelay = $preparationDelay;
+    }
+}

src/Entity/ShippingSlotConfig.php

@@ -134,11 +134,19 @@ public function getSlotDelay(): int
      */
     public function getRecurrences(
         ?DateTimeInterface $startDate = null,
-        ?DateTimeInterface $endDate = null
+        ?DateTimeInterface $endDate = null,
+        ?int $customPreparationDelay = null
     ): array {
         $recurrences = [];
+
+        // Use greater preparation delay, for example a product can make some time to be produced
+        $slotDelay = $this->getSlotDelay();
+        if (null !== $customPreparationDelay && $customPreparationDelay > $slotDelay) {
+            $slotDelay = $customPreparationDelay;
+        }
+
         $minDate = (new DateTime())
-            ->add(new DateInterval(sprintf('PT%dM', $this->getSlotDelay())))
+            ->add(new DateInterval(sprintf('PT%dM', $slotDelay)))
             ->setTimezone(new DateTimeZone($this->getTimezone() ?? 'UTC'))
         ;
 

src/Entity/ShippingSlotConfigInterface.php

@@ -58,6 +58,7 @@ public function getSlotDelay(): int;
      */
     public function getRecurrences(
         ?DateTimeInterface $startDate = null,
-        ?DateTimeInterface $endDate = null
+        ?DateTimeInterface $endDate = null,
+        ?int $customPreparationDelay = null
     ): array;
 }

src/Fixture/ProductVariantShippingSlotFixture.php

@@ -0,0 +1,80 @@
+<?php
+
+/*
+ * This file is part of Monsieur Biz' Shipping Slot plugin for Sylius.
+ *
+ * (c) Monsieur Biz <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace MonsieurBiz\SyliusShippingSlotPlugin\Fixture;
+
+use Doctrine\ORM\EntityManagerInterface;
+use MonsieurBiz\SyliusShippingSlotPlugin\Entity\ProductVariantInterface;
+use Sylius\Bundle\FixturesBundle\Fixture\AbstractFixture;
+use Sylius\Bundle\FixturesBundle\Fixture\FixtureInterface;
+use Sylius\Component\Core\Repository\ProductVariantRepositoryInterface;
+use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
+
+final class ProductVariantShippingSlotFixture extends AbstractFixture implements FixtureInterface
+{
+    private ProductVariantRepositoryInterface $productVariantRepository;
+    private EntityManagerInterface $productVariantManager;
+
+    public function __construct(
+        ProductVariantRepositoryInterface $productVariantRepository,
+        EntityManagerInterface $productVariantManager
+    ) {
+        $this->productVariantRepository = $productVariantRepository;
+        $this->productVariantManager = $productVariantManager;
+    }
+
+    /**
+     * @param array $options
+     */
+    public function load(array $options): void
+    {
+        foreach ($options['product_variants'] ?? [] as $option) {
+            /** @var ProductVariantInterface $productVariant */
+            if (null === ($productVariant = $this->productVariantRepository->findOneBy(['code' => $option['code'] ?? '']))) {
+                continue;
+            }
+
+            $productVariant->setPreparationDelay($option['preparationDelay'] ?? null);
+            $this->productVariantManager->persist($productVariant);
+        }
+
+        $this->productVariantManager->flush();
+    }
+
+    /**
+     * @return string
+     */
+    public function getName(): string
+    {
+        return 'monsieurbiz_shipping_slot_product_variant';
+    }
+
+    /**
+     * @param ArrayNodeDefinition $optionsNode
+     */
+    protected function configureOptionsNode(ArrayNodeDefinition $optionsNode): void
+    {
+        /** @phpstan-ignore-next-line */
+        $optionsNode
+            ->children()
+                ->arrayNode('product_variants')
+                    ->arrayPrototype()
+                    ->children()
+                        ->scalarNode('code')->cannotBeEmpty()->end()
+                        ->integerNode('preparationDelay')->end()
+                    ->end()
+                ->end()
+            ->end()
+        ;
+    }
+}

src/Form/Extension/ProductVariantTypeExtension.php

@@ -0,0 +1,44 @@
+<?php
+
+/*
+ * This file is part of Monsieur Biz' Shipping Slot plugin for Sylius.
+ *
+ * (c) Monsieur Biz <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace MonsieurBiz\SyliusShippingSlotPlugin\Form\Extension;
+
+use Sylius\Bundle\ProductBundle\Form\Type\ProductVariantType;
+use Symfony\Component\Form\AbstractTypeExtension;
+use Symfony\Component\Form\Extension\Core\Type\IntegerType;
+use Symfony\Component\Form\FormBuilderInterface;
+use Symfony\Component\Validator\Constraints as Assert;
+
+class ProductVariantTypeExtension extends AbstractTypeExtension
+{
+    public static function getExtendedTypes(): iterable
+    {
+        return [ProductVariantType::class];
+    }
+
+    /**
+     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
+     */
+    public function buildForm(FormBuilderInterface $builder, array $options): void
+    {
+        $builder
+            ->add('preparationDelay', IntegerType::class, [
+                'required' => false,
+                'label' => 'monsieurbiz_shipping_slot.ui.form.preparation_delay',
+                'constraints' => [
+                    new Assert\PositiveOrZero(),
+                ],
+            ])
+        ;
+    }
+}

src/Generator/SlotGenerator.php

@@ -18,13 +18,15 @@
 use DateTimeZone;
 use Doctrine\ORM\EntityManagerInterface;
 use Exception;
+use MonsieurBiz\SyliusShippingSlotPlugin\Entity\ProductVariantInterface;
 use MonsieurBiz\SyliusShippingSlotPlugin\Entity\ShipmentInterface;
 use MonsieurBiz\SyliusShippingSlotPlugin\Entity\ShippingMethodInterface;
 use MonsieurBiz\SyliusShippingSlotPlugin\Entity\SlotInterface;
 use MonsieurBiz\SyliusShippingSlotPlugin\Event\RecurrenceGenerationEvent;
 use MonsieurBiz\SyliusShippingSlotPlugin\Repository\SlotRepositoryInterface;
 use Recurr\Recurrence;
 use Sylius\Component\Core\Model\OrderInterface;
+use Sylius\Component\Core\Model\OrderItemInterface;
 use Sylius\Component\Core\Repository\ShippingMethodRepositoryInterface;
 use Sylius\Component\Order\Context\CartContextInterface;
 use Sylius\Component\Resource\Factory\FactoryInterface;
@@ -205,7 +207,7 @@ public function generateCalendarEvents(
         if (null === $shippingSlotConfig) {
             return [];
         }
-        $recurrences = $shippingSlotConfig->getRecurrences($startDate, $endDate);
+        $recurrences = $shippingSlotConfig->getRecurrences($startDate, $endDate, $this->getCartPreparationDelay());
         $event = new RecurrenceGenerationEvent($recurrences);
         $this->eventDispatcher->dispatch($event);
         $recurrences = $event->getRecurrences();
@@ -243,4 +245,27 @@ private function isUnaivalableRecurrence(Recurrence $recurrence, array $unavaila
 
         return false;
     }
+
+    /**
+     * @SuppressWarnings(PHPMD.CyclomaticComplexity)
+     */
+    private function getCartPreparationDelay(): ?int
+    {
+        $maxPreparationDelay = null;
+        $cartItems = $this->cartContext->getCart()->getItems();
+
+        /** @var OrderItemInterface $cartItem */
+        foreach ($cartItems as $cartItem) {
+            if (
+                null !== ($variant = $cartItem->getVariant())
+                && $variant instanceof ProductVariantInterface
+                && null !== ($preparationDelay = $variant->getPreparationDelay())
+                && (null === $maxPreparationDelay || $preparationDelay > $maxPreparationDelay)
+            ) {
+                $maxPreparationDelay = $preparationDelay;
+            }
+        }
+
+        return $maxPreparationDelay;
+    }
 }

src/Migrations/Version20210813115752.php

@@ -0,0 +1,40 @@
+<?php
+
+/*
+ * This file is part of Monsieur Biz' Shipping Slot plugin for Sylius.
+ *
+ * (c) Monsieur Biz <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace MonsieurBiz\SyliusShippingSlotPlugin\Migrations;
+
+use Doctrine\DBAL\Schema\Schema;
+use Doctrine\Migrations\AbstractMigration;
+
+/**
+ * Auto-generated Migration: Please modify to your needs!
+ */
+final class Version20210813115752 extends AbstractMigration
+{
+    public function getDescription(): string
+    {
+        return '';
+    }
+
+    public function up(Schema $schema): void
+    {
+        // this up() migration is auto-generated, please modify it to your needs
+        $this->addSql('ALTER TABLE sylius_product_variant ADD preparation_delay INT DEFAULT NULL');
+    }
+
+    public function down(Schema $schema): void
+    {
+        // this down() migration is auto-generated, please modify it to your needs
+        $this->addSql('ALTER TABLE sylius_product_variant DROP preparation_delay');
+    }
+}

src/Resources/config/sylius/fixtures.yaml

@@ -49,4 +49,10 @@ sylius_fixtures:
                                 color: '#22B99A'
                                 shipping_methods:
                                     - 'courier_delivery'
-
+                monsieurbiz_shipping_slot_product_variant:
+                    options:
+                        product_variants:
+                            - code: 'Knitted_wool_blend_green_cap-variant-0'
+                              preparationDelay: 720
+                            - code: 'Cashmere_blend_violet_beanie-variant-0'
+                              preparationDelay: 1440

src/Resources/config/sylius/ui.yaml

@@ -1,16 +1,29 @@
 sylius_ui:
     events:
+        # Admin shipping method form - Add shipping slot configuration fiel
         sylius.admin.shipping_method.update.form:
             blocks:
                 shipping_slot_configuration: '@MonsieurBizSyliusShippingSlotPlugin/Admin/Form/ShippingMethod/shipping_slot_configuration.html.twig'
         sylius.admin.shipping_method.create.form:
             blocks:
                 shipping_slot_configuration: '@MonsieurBizSyliusShippingSlotPlugin/Admin/Form/ShippingMethod/shipping_slot_configuration.html.twig'
+
+        # Admin product and product variant forms - Add preparation delay field
+        sylius.admin.product_variant.tab_details:
+            blocks:
+                preparation_delay: '@MonsieurBizSyliusShippingSlotPlugin/Admin/Form/ProductVariant/preparation_delay.html.twig'
+        sylius.admin.product.tab_details:
+            blocks:
+                preparation_delay: '@MonsieurBizSyliusShippingSlotPlugin/Admin/Form/Product/preparation_delay.html.twig'
+
+        # Admin order show - Display the selected slots for shipments
         sylius.admin.order.show.sidebar:
             blocks:
                 monsieurbiz_shipping_slot_order_slots:
                     template: '@MonsieurBizSyliusShippingSlotPlugin/Admin/Order/Show/_slots.html.twig'
                     priority: 50
+
+        # Shop assets - Setup the CSS and JS
         sylius.shop.layout.javascripts:
             blocks:
                 monsieurbiz_shipping_slot_init_app:
@@ -19,6 +32,8 @@ sylius_ui:
             blocks:
                 monsieurbiz_shipping_slot_styles:
                     template: '@MonsieurBizSyliusShippingSlotPlugin/Shop/_styles.html.twig'
+
+        # Shop shipping method choice - Add calendar in shipping method choice
         sylius.shop.checkout.select_shipping.after_method:
             blocks:
                 monsieurbiz_shipping_slot_calendar:

src/Resources/views/Admin/Form/Product/preparation_delay.html.twig

@@ -0,0 +1,8 @@
+ {% if form.vars.value is defined and form.vars.value.simple %}
+    <div class="ui segment">
+        <h4 class="ui dividing header">{{ 'monsieurbiz_shipping_slot.ui.shipping_slot_config'|trans }}</h4>
+        <div id="shipping_slot_config">
+            {{ form_row(form.variant.preparationDelay) }}
+        </div>
+    </div>
+{% endif %}

src/Resources/views/Admin/Form/ProductVariant/preparation_delay.html.twig

@@ -0,0 +1,7 @@
+
+<div class="ui segment">
+    <h4 class="ui dividing header">{{ 'monsieurbiz_shipping_slot.ui.shipping_slot_config'|trans }}</h4>
+    <div id="shipping_slot_config">
+        {{ form_row(form.preparationDelay) }}
+    </div>
+</div>

tests/Application/config/packages/_sylius.yaml

@@ -35,3 +35,9 @@ sylius_order:
         order:
             classes:
                 model: App\Entity\Order
+
+sylius_product:
+    resources:
+        product_variant:
+            classes:
+                model: App\Entity\ProductVariant