feat: support tax calculation mode

Closes #376

Author: Jens Schulze

README.md

@@ -209,7 +209,7 @@ Then:
  1. fork the repository on GitHub
  2. code and add tests that cover the created code. Your code should be warning-free.
  3. stick to PSR-2 and and don't reformat existing code.
- 4. make a pull request.  @jayS-de will review it and pull or come back to you.
+ 4. make a pull request.  @jenschude will review it and pull or come back to you.
 
 
 

src/Core/Model/Cart/Cart.php

@@ -73,6 +73,8 @@
  * @method Cart setRefusedGifts(CartDiscountReferenceCollection $refusedGifts = null)
  * @method string getOrigin()
  * @method Cart setOrigin(string $origin = null)
+ * @method string getTaxCalculationMode()
+ * @method Cart setTaxCalculationMode(string $taxCalculationMode = null)
  * @method CartReference getReference()
  */
 class Cart extends Resource
@@ -90,6 +92,9 @@ class Cart extends Resource
     const ORIGIN_CUSTOMER = 'Customer';
     const ORIGIN_MERCHANT = 'Merchant';
 
+    const TAX_CALCULATION_MODE_LINE_ITEM_LEVEL = 'LineItemLevel';
+    const TAX_CALCULATION_MODE_UNIT_PRICE_LEVEL = 'UnitPriceLevel';
+
     public function fieldDefinitions()
     {
         return [
@@ -126,6 +131,7 @@ public function fieldDefinitions()
             'deleteDaysAfterLastModification' => [static::TYPE => 'int'],
             'refusedGifts' => [static::TYPE => CartDiscountReferenceCollection::class],
             'origin' => [static::TYPE => 'string'],
+            'taxCalculationMode' => [static::TYPE => 'string'],
         ];
     }
 

src/Core/Model/Cart/CartDraft.php

@@ -51,6 +51,8 @@
  * @method CartDraft setCustomerGroup(CustomerGroupReference $customerGroup = null)
  * @method string getOrigin()
  * @method CartDraft setOrigin(string $origin = null)
+ * @method string getTaxCalculationMode()
+ * @method CartDraft setTaxCalculationMode(string $taxCalculationMode = null)
  */
 class CartDraft extends JsonObject
 {
@@ -77,6 +79,7 @@ public function fieldDefinitions()
             'deleteDaysAfterLastModification' => [static::TYPE => 'int'],
             'customerGroup' => [static::TYPE => CustomerGroupReference::class],
             'origin' => [static::TYPE => 'string'],
+            'taxCalculationMode' => [static::TYPE => 'string'],
         ];
     }
 

src/Core/Model/Order/ImportOrder.php

@@ -59,6 +59,8 @@
  * @method ImportOrder setTaxRoundingMode(string $taxRoundingMode = null)
  * @method string getOrigin()
  * @method ImportOrder setOrigin(string $origin = null)
+ * @method string getTaxCalculationMode()
+ * @method ImportOrder setTaxCalculationMode(string $taxCalculationMode = null)
  */
 class ImportOrder extends JsonObject
 {
@@ -88,6 +90,7 @@ public function fieldDefinitions()
             'inventoryMode' => [static::TYPE => 'string'],
             'taxRoundingMode' => [static::TYPE => 'string'],
             'origin' => [static::TYPE => 'string'],
+            'taxCalculationMode' => [static::TYPE => 'string'],
         ];
     }
 }

src/Core/Model/Order/Order.php

@@ -90,6 +90,8 @@
  * @method Order setTaxRoundingMode(string $taxRoundingMode = null)
  * @method string getOrigin()
  * @method Order setOrigin(string $origin = null)
+ * @method string getTaxCalculationMode()
+ * @method Order setTaxCalculationMode(string $taxCalculationMode = null)
  * @method OrderReference getReference()
  */
 class Order extends Resource
@@ -148,6 +150,7 @@ public function fieldDefinitions()
             'locale' => [static::TYPE => 'string'],
             'taxRoundingMode' => [static::TYPE => 'string'],
             'origin' => [static::TYPE => 'string'],
+            'taxCalculationMode' => [static::TYPE => 'string'],
         ];
     }
 }

src/Core/Request/Carts/Command/CartChangeTaxCalculationModeAction.php

@@ -0,0 +1,48 @@
+<?php
+/**
+ * @author @jenschude <jens.schulze@commercetools.de>
+ */
+
+namespace Commercetools\Core\Request\Carts\Command;
+
+use Commercetools\Core\Model\Common\Context;
+use Commercetools\Core\Request\AbstractAction;
+
+/**
+ * @package Commercetools\Core\Request\Carts\Command
+ * @link http://dev.commercetools.com/http-api-projects-carts.html#change-tax-calculationmode
+ * @method string getAction()
+ * @method CartChangeTaxCalculationModeAction setAction(string $action = null)
+ * @method string getTaxCalculationMode()
+ * @method CartChangeTaxCalculationModeAction setTaxCalculationMode(string $taxCalculationMode = null)
+ */
+class CartChangeTaxCalculationModeAction extends AbstractAction
+{
+    public function fieldDefinitions()
+    {
+        return [
+            'action' => [static::TYPE => 'string'],
+            'taxCalculationMode' => [static::TYPE => 'string'],
+        ];
+    }
+
+    /**
+     * @param array $data
+     * @param Context|callable $context
+     */
+    public function __construct(array $data = [], $context = null)
+    {
+        parent::__construct($data, $context);
+        $this->setAction('changeTaxCalculationMode');
+    }
+
+    /**
+     * @param string $calculationMode
+     * @param Context|callable $context
+     * @return CartChangeTaxCalculationModeAction
+     */
+    public static function ofTaxCalculationMode($calculationMode, $context = null)
+    {
+        return static::of($context)->setTaxCalculationMode($calculationMode);
+    }
+}

tests/fixtures/models.yaml

@@ -29,6 +29,7 @@ cart:
     - deleteDaysAfterLastModification
     - refusedGifts
     - origin
+    - taxCalculationMode
 lineItem:
   domain: cart
   model: LineItem
@@ -379,6 +380,7 @@ order:
     - locale
     - taxRoundingMode
     - origin
+    - taxCalculationMode
 syncInfo:
   domain: order
   model: SyncInfo
@@ -873,6 +875,7 @@ importOrder:
     - inventoryMode
     - taxRoundingMode
     - origin
+    - taxCalculationMode
 lineItemImportDraft:
   domain: order
   model: lineItemImportDraft

tests/integration/Cart/CartUpdateRequestTest.php

@@ -51,6 +51,7 @@
 use Commercetools\Core\Request\Carts\Command\CartChangeCustomLineItemMoneyAction;
 use Commercetools\Core\Request\Carts\Command\CartChangeCustomLineItemQuantityAction;
 use Commercetools\Core\Request\Carts\Command\CartChangeLineItemQuantityAction;
+use Commercetools\Core\Request\Carts\Command\CartChangeTaxCalculationModeAction;
 use Commercetools\Core\Request\Carts\Command\CartChangeTaxRoundingModeAction;
 use Commercetools\Core\Request\Carts\Command\CartRecalculateAction;
 use Commercetools\Core\Request\Carts\Command\CartRemoveCustomLineItemAction;
@@ -1432,6 +1433,34 @@ public function testCreateWithTaxRoundingMode()
         $this->assertSame(Cart::TAX_ROUNDING_MODE_HALF_DOWN, $cart->getTaxRoundingMode());
     }
 
+    public function testTaxCalculationModeUnitPrice()
+    {
+        $draft = $this->getDraft();
+        $cart = $this->createCart($draft);
+
+        $this->assertSame(Cart::TAX_CALCULATION_MODE_LINE_ITEM_LEVEL, $cart->getTaxCalculationMode());
+
+        $request = CartUpdateRequest::ofIdAndVersion($cart->getId(), $cart->getVersion())
+            ->addAction(CartChangeTaxCalculationModeAction::ofTaxCalculationMode(Cart::TAX_CALCULATION_MODE_UNIT_PRICE_LEVEL))
+        ;
+        $response = $request->executeWithClient($this->getClient());
+        $cart = $request->mapResponse($response);
+
+        $this->deleteRequest->setVersion($cart->getVersion());
+
+        $this->assertSame(Cart::TAX_CALCULATION_MODE_UNIT_PRICE_LEVEL, $cart->getTaxCalculationMode());
+    }
+
+    public function testCreateWithTaxCalculationMode()
+    {
+        $draft = $this->getDraft();
+        $draft->setTaxCalculationMode(Cart::TAX_CALCULATION_MODE_UNIT_PRICE_LEVEL);
+        $cart = $this->createCart($draft);
+
+        $this->assertSame(Cart::TAX_CALCULATION_MODE_UNIT_PRICE_LEVEL, $cart->getTaxCalculationMode());
+    }
+
+
     public function testAutomaticDelete()
     {
         $draft = $this->getDraft();