Issue #2894792 by mitrpaka, bojanz: Add Adjustment::getPercentage()

Author: mitrpaka

modules/order/src/Adjustment.php

@@ -30,6 +30,13 @@ final class Adjustment {
    */
   protected $amount;
 
+  /**
+   * The adjustment percentage.
+   *
+   * @var string
+   */
+  protected $percentage;
+
   /**
    * The source identifier of the adjustment.
    *
@@ -67,13 +74,20 @@ public function __construct(array $definition) {
     if (empty($types[$definition['type']])) {
       throw new \InvalidArgumentException(sprintf('%s is an invalid adjustment type.', $definition['type']));
     }
+    if (!empty($definition['percentage'])) {
+      if (is_float($definition['percentage'])) {
+        throw new \InvalidArgumentException(sprintf('The provided percentage "%s" must be a string, not a float.', $definition['percentage']));
+      }
+      if (!is_numeric($definition['percentage'])) {
+        throw new \InvalidArgumentException(sprintf('The provided percentage "%s" is not a numeric value.', $definition['percentage']));
+      }
+    }
 
     $this->type = $definition['type'];
     $this->label = $definition['label'];
     $this->amount = $definition['amount'];
-    if (!empty($definition['source_id'])) {
-      $this->sourceId = $definition['source_id'];
-    }
+    $this->percentage = !empty($definition['percentage']) ? $definition['percentage'] : NULL;
+    $this->sourceId = !empty($definition['source_id']) ? $definition['source_id'] : NULL;
     $this->included = !empty($definition['included']);
   }
 
@@ -97,16 +111,6 @@ public function getLabel() {
     return $this->label;
   }
 
-  /**
-   * Get the source identifier.
-   *
-   * @return string
-   *   The source identifier.
-   */
-  public function getSourceId() {
-    return $this->sourceId;
-  }
-
   /**
    * Gets the adjustment amount.
    *
@@ -121,7 +125,7 @@ public function getAmount() {
    * Gets whether the adjustment is positive.
    *
    * @return bool
-   *   TRUE if the adjustmnet is positive, FALSE otherwise.
+   *   TRUE if the adjustment is positive, FALSE otherwise.
    */
   public function isPositive() {
     return $this->amount->getNumber() >= 0;
@@ -137,6 +141,27 @@ public function isNegative() {
     return $this->amount->getNumber() < 0;
   }
 
+  /**
+   * Gets the adjustment percentage.
+   *
+   * @return string|null
+   *   The percentage as a decimal. For example, "0.2" for a 20% adjustment.
+   *   Otherwise NULL, if the adjustment was not calculated from a percentage.
+   */
+  public function getPercentage() {
+    return $this->percentage;
+  }
+
+  /**
+   * Get the source identifier.
+   *
+   * @return string
+   *   The source identifier.
+   */
+  public function getSourceId() {
+    return $this->sourceId;
+  }
+
   /**
    * Gets whether the adjustment is included in the base price.
    *

modules/order/src/Entity/Order.php

@@ -324,8 +324,9 @@ public function collectAdjustments() {
         $multiplied_adjustment = new Adjustment([
           'type' => $adjustment->getType(),
           'label' => $adjustment->getLabel(),
-          'source_id' => $adjustment->getSourceId(),
           'amount' => $adjustment->getAmount()->multiply($order_item->getQuantity()),
+          'percentage' => $adjustment->getPercentage(),
+          'source_id' => $adjustment->getSourceId(),
           'included' => $adjustment->isIncluded(),
         ]);
         $adjustments[] = $multiplied_adjustment;

modules/order/tests/src/Functional/OrderAdminTest.php

@@ -125,6 +125,7 @@ public function testEditOrder() {
       'type' => 'custom',
       'label' => '10% off',
       'amount' => new Price('-1.00', 'USD'),
+      'percentage' => '0.1',
     ]);
     $adjustments[] = new Adjustment([
       'type' => 'custom',

modules/order/tests/src/Kernel/AdjustmentItemTest.php

@@ -68,6 +68,7 @@ public function testAdjustmentItem() {
       'type' => 'custom',
       'label' => '10% off',
       'amount' => new Price('-1.00', 'USD'),
+      'percentage' => '0.1',
       'source_id' => '1',
     ]));
 

modules/order/tests/src/Kernel/AdjustmentTest.php

@@ -65,6 +65,24 @@ public function invalidDefinitionProvider() {
         ],
         'foo is an invalid adjustment type.',
       ],
+      [
+        [
+          'type' => 'custom',
+          'label' => 'Foo',
+          'amount' => new Price('1.00', 'USD'),
+          'percentage' => 0.1,
+        ],
+        'The provided percentage "0.1" must be a string, not a float.',
+      ],
+      [
+        [
+          'type' => 'custom',
+          'label' => 'Foo',
+          'amount' => new Price('1.00', 'USD'),
+          'percentage' => 'INVALID',
+        ],
+        'The provided percentage "INVALID" is not a numeric value.',
+      ],
     ];
   }
 
@@ -93,14 +111,16 @@ public function testValidAdjustmentConstruct() {
    * @covers ::getAmount
    * @covers ::isPositive
    * @covers ::isNegative
-   * @covers ::isIncluded
+   * @covers ::getPercentage
    * @covers ::getSourceId
+   * @covers ::isIncluded
    */
   public function testAdjustmentMethods() {
     $definition = [
       'type' => 'custom',
       'label' => '10% off',
       'amount' => new Price('-1.00', 'USD'),
+      'percentage' => '0.1',
       'source_id' => '1',
       'included' => TRUE,
     ];
@@ -112,8 +132,9 @@ public function testAdjustmentMethods() {
     $this->assertEquals('USD', $adjustment->getAmount()->getCurrencyCode());
     $this->assertFalse($adjustment->isPositive());
     $this->assertTrue($adjustment->isNegative());
-    $this->assertTrue($adjustment->isIncluded());
+    $this->assertEquals('0.1', $adjustment->getPercentage());
     $this->assertEquals('1', $adjustment->getSourceId());
+    $this->assertTrue($adjustment->isIncluded());
   }
 
 }

modules/order/tests/src/Kernel/Entity/OrderItemTest.php

@@ -96,6 +96,7 @@ public function testOrderItem() {
       'type' => 'custom',
       'label' => '10% off',
       'amount' => new Price('-1.00', 'USD'),
+      'percentage' => '0.1',
     ]);
     $adjustments[] = new Adjustment([
       'type' => 'custom',

modules/promotion/src/Plugin/Commerce/PromotionOffer/OrderItemPercentageOff.php

@@ -24,14 +24,15 @@ public function apply(EntityInterface $entity, PromotionInterface $promotion) {
     $this->assertEntity($entity);
     /** @var \Drupal\commerce_order\Entity\OrderItemInterface $order_item */
     $order_item = $entity;
-    $adjustment_amount = $order_item->getUnitPrice()->multiply($this->getAmount());
+    $adjustment_amount = $order_item->getUnitPrice()->multiply($this->getPercentage());
     $adjustment_amount = $this->rounder->round($adjustment_amount);
 
     $order_item->addAdjustment(new Adjustment([
       'type' => 'promotion',
       // @todo Change to label from UI when added in #2770731.
       'label' => t('Discount'),
       'amount' => $adjustment_amount->multiply('-1'),
+      'percentage' => $this->getPercentage(),
       'source_id' => $promotion->id(),
     ]));
   }

modules/promotion/src/Plugin/Commerce/PromotionOffer/OrderPercentageOff.php

@@ -24,14 +24,15 @@ public function apply(EntityInterface $entity, PromotionInterface $promotion) {
     $this->assertEntity($entity);
     /** @var \Drupal\commerce_order\Entity\OrderInterface $order */
     $order = $entity;
-    $adjustment_amount = $order->getTotalPrice()->multiply($this->getAmount());
+    $adjustment_amount = $order->getTotalPrice()->multiply($this->getPercentage());
     $adjustment_amount = $this->rounder->round($adjustment_amount);
 
     $order->addAdjustment(new Adjustment([
       'type' => 'promotion',
       // @todo Change to label from UI when added in #2770731.
       'label' => t('Discount'),
       'amount' => $adjustment_amount->multiply('-1'),
+      'percentage' => $this->getPercentage(),
       'source_id' => $promotion->id(),
     ]));
   }

modules/promotion/src/Plugin/Commerce/PromotionOffer/PercentageOffBase.php

@@ -14,17 +14,17 @@ abstract class PercentageOffBase extends PromotionOfferBase {
    */
   public function defaultConfiguration() {
     return [
-      'amount' => 0,
+      'amount' => '0',
     ] + parent::defaultConfiguration();
   }
 
   /**
-   * Gets the percentage amount.
+   * Gets the percentage.
    *
    * @return string
-   *   The amount.
+   *   The percentage.
    */
-  public function getAmount() {
+  public function getPercentage() {
     return (string) $this->configuration['amount'];
   }
 

modules/promotion/tests/src/Kernel/PromotionOfferTest.php

@@ -238,6 +238,7 @@ public function testProductPercentageOff() {
     $adjustment = reset($adjustments);
     // Adjustment for 50% of the order item total.
     $this->assertEquals(new Price('-5.00', 'USD'), $adjustment->getAmount());
+    $this->assertEquals('0.50', $adjustment->getPercentage());
     // Adjustments don't affect total order item price, but the order's total.
     $this->assertEquals(new Price('20.00', 'USD'), $order_item->getTotalPrice());