feat(CartDiscount): support cart discount stacking mode

Closes #354

Author: Jens Schulze

src/Core/Model/CartDiscount/CartDiscount.php

@@ -44,10 +44,15 @@
  * @method CartDiscount setRequiresDiscountCode(bool $requiresDiscountCode = null)
  * @method ReferenceCollection getReferences()
  * @method CartDiscount setReferences(ReferenceCollection $references = null)
+ * @method string getStackingMode()
+ * @method CartDiscount setStackingMode(string $stackingMode = null)
  * @method CartDiscountReference getReference()
  */
 class CartDiscount extends Resource
 {
+    const MODE_STACKING = 'Stacking';
+    const MODE_STOP = 'StopAfterThisDiscount';
+
     public function fieldDefinitions()
     {
         return [
@@ -77,7 +82,8 @@ public function fieldDefinitions()
                 static::DECORATOR => DateTimeDecorator::class
             ],
             'requiresDiscountCode' => [static::TYPE => 'bool'],
-            'references' => [static::TYPE => ReferenceCollection::class]
+            'references' => [static::TYPE => ReferenceCollection::class],
+            'stackingMode' => [static::TYPE => 'string'],
         ];
     }
 }

src/Core/Model/CartDiscount/CartDiscountDraft.php

@@ -34,6 +34,8 @@
  * @method CartDiscountDraft setValidUntil(DateTime $validUntil = null)
  * @method bool getRequiresDiscountCode()
  * @method CartDiscountDraft setRequiresDiscountCode(bool $requiresDiscountCode = null)
+ * @method string getStackingMode()
+ * @method CartDiscountDraft setStackingMode(string $stackingMode = null)
  */
 class CartDiscountDraft extends JsonObject
 {
@@ -47,6 +49,7 @@ class CartDiscountDraft extends JsonObject
     const VALID_FROM = 'validFrom';
     const VALID_UNTIL = 'validUntil';
     const REQUIRES_DISCOUNT_CODE = 'requiresDiscountCode';
+    const STACKING_MODE = 'stackingMode';
 
     public function fieldDefinitions()
     {
@@ -67,6 +70,7 @@ public function fieldDefinitions()
                 static::DECORATOR => DateTimeDecorator::class
             ],
             static::REQUIRES_DISCOUNT_CODE => [static::TYPE => 'bool'],
+            static::STACKING_MODE => [static::TYPE => 'string'],
         ];
     }
 

src/Core/Request/CartDiscounts/Command/CartDiscountChangeStackingModeAction.php

@@ -0,0 +1,48 @@
+<?php
+/**
+ * @author @jayS-de <jens.schulze@commercetools.de>
+ */
+
+namespace Commercetools\Core\Request\CartDiscounts\Command;
+
+use Commercetools\Core\Model\Common\Context;
+use Commercetools\Core\Request\AbstractAction;
+
+/**
+ * @package Commercetools\Core\Request\CartDiscounts\Command
+ * @link https://dev.commercetools.com/http-api-projects-cartDiscounts.html#change-stacking-mode
+ * @method string getAction()
+ * @method CartDiscountChangeStackingModeAction setAction(string $action = null)
+ * @method CartDiscountChangeStackingModeAction setStackingMode(string $stackingMode = null)
+ * @method string getStackingMode()
+ */
+class CartDiscountChangeStackingModeAction extends AbstractAction
+{
+    public function fieldDefinitions()
+    {
+        return [
+            'action' => [static::TYPE => 'string'],
+            'stackingMode' => [static::TYPE => 'string'],
+        ];
+    }
+
+    /**
+     * @param array $data
+     * @param Context|callable $context
+     */
+    public function __construct(array $data = [], $context = null)
+    {
+        parent::__construct($data, $context);
+        $this->setAction('changeStackingMode');
+    }
+
+    /**
+     * @param string $stackingMode
+     * @param Context|callable $context
+     * @return CartDiscountChangeStackingModeAction
+     */
+    public static function ofStackingMode($stackingMode, $context = null)
+    {
+        return static::of($context)->setStackingMode($stackingMode);
+    }
+}

tests/fixtures/models.yaml

@@ -139,6 +139,7 @@ cartDiscount:
     - validUntil
     - requiresDiscountCode
     - references
+    - stackingMode
 
 cartDiscountValue:
   domain: cartDiscount

tests/integration/CartDiscount/CartDiscountUpdateRequestTest.php

@@ -19,6 +19,7 @@
 use Commercetools\Core\Request\CartDiscounts\Command\CartDiscountChangeRequiresDiscountCodeAction;
 use Commercetools\Core\Request\CartDiscounts\Command\CartDiscountChangeSortOrderAction;
 use Commercetools\Core\Request\CartDiscounts\Command\CartDiscountChangeTargetAction;
+use Commercetools\Core\Request\CartDiscounts\Command\CartDiscountChangeStackingModeAction;
 use Commercetools\Core\Request\CartDiscounts\Command\CartDiscountChangeValueAction;
 use Commercetools\Core\Request\CartDiscounts\Command\CartDiscountSetDescriptionAction;
 use Commercetools\Core\Request\CartDiscounts\CartDiscountCreateRequest;
@@ -264,6 +265,40 @@ public function testSetValidUntil()
         $this->assertSame($validUntil->format('c'), $result->getValidUntil()->format('c'));
         $this->assertNotSame($cartDiscount->getVersion(), $result->getVersion());
     }
+
+    public function testStackingMode()
+    {
+        $draft = $this->getDraft('stacking-mode');
+        $cartDiscount = $this->createCartDiscount($draft);
+
+        $this->assertSame(CartDiscount::MODE_STACKING, $cartDiscount->getStackingMode());
+
+        $request = CartDiscountUpdateRequest::ofIdAndVersion(
+            $cartDiscount->getId(),
+            $cartDiscount->getVersion()
+        )
+            ->addAction(CartDiscountChangeStackingModeAction::ofStackingMode(CartDiscount::MODE_STOP))
+        ;
+        $response = $request->executeWithClient($this->getClient());
+        $result = $request->mapResponse($response);
+        $this->deleteRequest->setVersion($result->getVersion());
+
+        $this->assertSame(CartDiscount::MODE_STOP, $result->getStackingMode());
+        $cartDiscount = $result;
+
+        $request = CartDiscountUpdateRequest::ofIdAndVersion(
+            $cartDiscount->getId(),
+            $cartDiscount->getVersion()
+        )
+            ->addAction(CartDiscountChangeStackingModeAction::ofStackingMode(CartDiscount::MODE_STACKING))
+        ;
+        $response = $request->executeWithClient($this->getClient());
+        $result = $request->mapResponse($response);
+        $this->deleteRequest->setVersion($result->getVersion());
+
+        $this->assertSame(CartDiscount::MODE_STACKING, $result->getStackingMode());
+    }
+
     /**
      * @param $name
      * @return CartDiscountDraft

tests/integration/DiscountCode/DiscountCodeUpdateRequestTest.php

@@ -66,7 +66,7 @@ protected function createCartDiscount($draft)
         $response = $request->executeWithClient($this->getClient());
         $cartDiscount = $request->mapResponse($response);
 
-        $this->discountDeleteRequests[] = $this->deleteRequest = CartDiscountDeleteRequest::ofIdAndVersion(
+        $this->discountDeleteRequests[] = CartDiscountDeleteRequest::ofIdAndVersion(
             $cartDiscount->getId(),
             $cartDiscount->getVersion()
         );
@@ -116,7 +116,7 @@ protected function createDiscountCode(DiscountCodeDraft $draft)
         $request = DiscountCodeCreateRequest::ofDraft($draft);
         $response = $request->executeWithClient($this->getClient());
         $discountCode = $request->mapResponse($response);
-        $this->cleanupRequests[] = DiscountCodeDeleteRequest::ofIdAndVersion(
+        $this->cleanupRequests[] = $this->deleteRequest = DiscountCodeDeleteRequest::ofIdAndVersion(
             $discountCode->getId(),
             $discountCode->getVersion()
         );
@@ -130,6 +130,7 @@ public function testCustomTypeCreate()
         $draft = $this->getDraft('discount-type');
         $draft->setCustom(CustomFieldObjectDraft::ofTypeKey($type->getKey()));
         $discountCode = $this->createDiscountCode($draft);
+        $this->deleteRequest->setVersion($discountCode->getVersion());
 
         $this->assertSame($type->getId(), $discountCode->getCustom()->getType()->getId());
     }