Adding Bill::usageInterval (#83)

Author: SilverFire

src/action/UsageInterval.php

@@ -169,4 +169,18 @@ public function ratioOfMonth(): float
 
         return $usageSeconds / $secondsInCurrentMonth;
     }
+
+    /**
+     * Extends the usage interval to include both current and other intervals.
+     *
+     * @param UsageInterval $other
+     * @return self
+     */
+    public function extend(self $other): self
+    {
+        return new self(
+            min($this->start, $other->start),
+            max($this->end, $other->end),
+        );
+    }
 }

src/bill/Bill.php

@@ -11,6 +11,7 @@
 namespace hiqdev\php\billing\bill;
 
 use DateTimeImmutable;
+use hiqdev\php\billing\action\UsageInterval;
 use hiqdev\php\billing\charge\ChargeInterface;
 use hiqdev\php\billing\customer\CustomerInterface;
 use hiqdev\php\billing\Exception\CannotReassignException;
@@ -63,6 +64,9 @@ class Bill implements BillInterface
     /** @var string */
     protected $comment;
 
+    /** @var UsageInterval */
+    protected $usageInterval;
+
     public function __construct(
                             $id,
         TypeInterface $type,
@@ -85,6 +89,7 @@ public function __construct(
         $this->plan         = $plan;
         $this->charges      = $charges;
         $this->state        = $state;
+        $this->setUsageInterval(UsageInterval::wholeMonth($time));
     }
 
     /**
@@ -104,6 +109,10 @@ public function getUniqueString(): string
         return implode('-', $parts);
     }
 
+    public function getUsageInterval(): UsageInterval
+    {
+    }
+
     public function calculatePrice()
     {
         $quantity = $this->quantity->getQuantity();
@@ -233,4 +242,9 @@ public function jsonSerialize(): array
     {
         return array_filter(get_object_vars($this));
     }
+
+    public function setUsageInterval(UsageInterval $usageInterval): void
+    {
+        $this->usageInterval = $usageInterval;
+    }
 }

src/bill/BillInterface.php

@@ -11,6 +11,7 @@
 namespace hiqdev\php\billing\bill;
 
 use DateTimeImmutable;
+use hiqdev\php\billing\action\UsageInterval;
 use hiqdev\php\billing\charge\ChargeInterface;
 use hiqdev\php\billing\customer\CustomerInterface;
 use hiqdev\php\billing\EntityInterface;
@@ -50,4 +51,8 @@ public function getPlan(): ?PlanInterface;
      * @return ChargeInterface[]
      */
     public function getCharges();
+
+    public function getUsageInterval(): UsageInterval;
+
+    public function setUsageInterval(UsageInterval $usageInterval): void;
 }

src/charge/Generalizer.php

@@ -10,6 +10,7 @@
 
 namespace hiqdev\php\billing\charge;
 
+use hiqdev\php\billing\action\UsageInterval;
 use hiqdev\php\billing\bill\Bill;
 use hiqdev\php\billing\bill\BillInterface;
 use hiqdev\php\billing\customer\CustomerInterface;
@@ -26,7 +27,7 @@ class Generalizer implements GeneralizerInterface
 {
     public function createBill(ChargeInterface $charge): BillInterface
     {
-        return new Bill(
+        $bill = new Bill(
             null,
             $this->generalizeType($charge),
             $this->generalizeTime($charge),
@@ -35,8 +36,12 @@ public function createBill(ChargeInterface $charge): BillInterface
             $this->generalizeCustomer($charge),
             $this->generalizeTarget($charge),
             $this->generalizePlan($charge),
-            [$charge]
+            [$charge],
         );
+
+        $bill->setUsageInterval($this->generalizeUsageInterval($charge));
+
+        return $bill;
     }
 
     public function generalizeType(ChargeInterface $charge): TypeInterface
@@ -83,4 +88,9 @@ public function specializeTarget(TargetInterface $first, TargetInterface $other)
     {
         return $first;
     }
+
+    private function generalizeUsageInterval(ChargeInterface $charge): UsageInterval
+    {
+        return $charge->getAction()->getUsageInterval();
+    }
 }

src/tools/Aggregator.php

@@ -10,6 +10,7 @@
 
 namespace hiqdev\php\billing\tools;
 
+use hiqdev\php\billing\action\UsageInterval;
 use hiqdev\php\billing\bill\Bill;
 use hiqdev\php\billing\bill\BillInterface;
 use hiqdev\php\billing\charge\ChargeInterface;
@@ -77,7 +78,7 @@ protected function aggregateBills(array $bills, array $others): array
 
     protected function aggregateBill(BillInterface $first, BillInterface $other): BillInterface
     {
-        return new Bill(
+        $bill = new Bill(
             $this->aggregateId($first, $other),
             $first->getType(),
             $first->getTime(),
@@ -88,6 +89,15 @@ protected function aggregateBill(BillInterface $first, BillInterface $other): Bi
             $first->getPlan(),
             array_merge($first->getCharges(), $other->getCharges())
         );
+
+        $bill->setUsageInterval($this->aggregateUsageInterval($first, $other));
+
+        return $bill;
+    }
+
+    protected function aggregateUsageInterval(BillInterface $first, BillInterface $other): UsageInterval
+    {
+        return $first->getUsageInterval()->extend($other->getUsageInterval());
     }
 
     /**