Refactor RangeState interface (#7)

Replace comparison methods with compareStartTime and compareEndTime.

Author: slavcodev

src/DateRange.php

@@ -10,6 +10,7 @@
 
 namespace Zee\DateRange;
 
+use DateTimeImmutable;
 use DateTimeInterface;
 use JsonSerializable;
 use Zee\DateRange\States\RangeState;
@@ -140,30 +141,34 @@ public function setEndTime(DateTimeInterface $time): DateRangeInterface
      */
     public function isStartAt(DateTimeInterface $time): bool
     {
-        return $this->state->isStartAt($time);
+        return $this->hasStartTime() && $this->state->compareStartTime($time) === 0;
     }
 
     /**
      * {@inheritdoc}
      */
     public function isEndAt(DateTimeInterface $time): bool
     {
-        return $this->state->isEndAt($time);
+        return $this->hasEndTime() && $this->state->compareEndTime($time) === 0;
     }
 
     /**
      * {@inheritdoc}
      */
     public function isStarted(): bool
     {
-        return $this->state->isStarted();
+        if ($this->hasStartTime()) {
+            return $this->state->compareStartTime(new DateTimeImmutable()) <= 0;
+        } else {
+            return $this->hasEndTime();
+        }
     }
 
     /**
      * {@inheritdoc}
      */
     public function isEnded(): bool
     {
-        return $this->state->isEnded();
+        return $this->hasEndTime() && $this->state->compareEndTime(new DateTimeImmutable()) < 0;
     }
 }

src/States/FiniteRange.php

@@ -2,7 +2,6 @@
 
 namespace Zee\DateRange\States;
 
-use DateTimeImmutable;
 use DateTimeInterface;
 use Zee\DateRange\DateRangeException;
 
@@ -102,32 +101,16 @@ public function setEndTime(DateTimeInterface $time): RangeState
     /**
      * {@inheritdoc}
      */
-    public function isStartAt(DateTimeInterface $time): bool
+    public function compareStartTime(DateTimeInterface $time): int
     {
-        return $this->startTime->getTimestamp() === $time->getTimestamp();
+        return $this->startTime->getTimestamp() <=> $time->getTimestamp();
     }
 
     /**
      * {@inheritdoc}
      */
-    public function isEndAt(DateTimeInterface $time): bool
+    public function compareEndTime(DateTimeInterface $time): int
     {
-        return $this->endTime->getTimestamp() === $time->getTimestamp();
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function isStarted(): bool
-    {
-        return $this->startTime <= new DateTimeImmutable();
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function isEnded(): bool
-    {
-        return $this->endTime <= new DateTimeImmutable();
+        return $this->endTime->getTimestamp() <=> $time->getTimestamp();
     }
 }

src/States/InfiniteEndRange.php

@@ -2,9 +2,7 @@
 
 namespace Zee\DateRange\States;
 
-use DateTimeImmutable;
 use DateTimeInterface;
-use Zee\DateRange\DateRangeException;
 
 /**
  * Class InfiniteEndRange.
@@ -48,14 +46,6 @@ public function hasStartTime(): bool
         return true;
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function hasEndTime(): bool
-    {
-        return false;
-    }
-
     /**
      * {@inheritdoc}
      */
@@ -64,14 +54,6 @@ public function getStartTime(): DateTimeInterface
         return $this->startTime;
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function getEndTime(): DateTimeInterface
-    {
-        throw new DateRangeException('Date range is undefined');
-    }
-
     /**
      * {@inheritdoc}
      */
@@ -91,16 +73,8 @@ public function setEndTime(DateTimeInterface $time): RangeState
     /**
      * {@inheritdoc}
      */
-    public function isStartAt(DateTimeInterface $time): bool
-    {
-        return $this->startTime->getTimestamp() === $time->getTimestamp();
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function isStarted(): bool
+    public function compareStartTime(DateTimeInterface $time): int
     {
-        return $this->startTime <= new DateTimeImmutable();
+        return $this->startTime->getTimestamp() <=> $time->getTimestamp();
     }
 }

src/States/InfiniteStartRange.php

@@ -2,7 +2,6 @@
 
 namespace Zee\DateRange\States;
 
-use DateTimeImmutable;
 use DateTimeInterface;
 use Zee\DateRange\DateRangeException;
 
@@ -40,14 +39,6 @@ public function jsonSerialize(): array
         return ['startTime' => null, 'endTime' => $this->endTime->format('c')];
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function hasStartTime(): bool
-    {
-        return false;
-    }
-
     /**
      * {@inheritdoc}
      */
@@ -56,14 +47,6 @@ public function hasEndTime(): bool
         return true;
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function getStartTime(): DateTimeInterface
-    {
-        throw new DateRangeException('Date range is undefined');
-    }
-
     /**
      * {@inheritdoc}
      */
@@ -91,24 +74,8 @@ public function setEndTime(DateTimeInterface $time): RangeState
     /**
      * {@inheritdoc}
      */
-    public function isEndAt(DateTimeInterface $time): bool
-    {
-        return $this->endTime->getTimestamp() === $time->getTimestamp();
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function isStarted(): bool
-    {
-        return true;
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function isEnded(): bool
+    public function compareEndTime(DateTimeInterface $time): int
     {
-        return $this->endTime <= new DateTimeImmutable();
+        return $this->endTime->getTimestamp() <=> $time->getTimestamp();
     }
 }

src/States/RangeState.php

@@ -57,26 +57,26 @@ public function setStartTime(DateTimeInterface $time): RangeState;
     public function setEndTime(DateTimeInterface $time): RangeState;
 
     /**
+     * Compares start time with specific time.
+     *
+     * Returns 0 if times are equals, negative if start time is less than given time,
+     * and positive if start time is greater.
+     *
      * @param DateTimeInterface $time
      *
-     * @return bool
+     * @return int
      */
-    public function isStartAt(DateTimeInterface $time): bool;
+    public function compareStartTime(DateTimeInterface $time): int;
 
     /**
+     * Compares end time with specific time.
+     *
+     * Returns 0 if times are equals, negative if end time is less than given time
+     * and positive if end time is greater.
+     *
      * @param DateTimeInterface $time
      *
-     * @return bool
-     */
-    public function isEndAt(DateTimeInterface $time): bool;
-
-    /**
-     * @return bool
-     */
-    public function isStarted(): bool;
-
-    /**
-     * @return bool
+     * @return int
      */
-    public function isEnded(): bool;
+    public function compareEndTime(DateTimeInterface $time): int;
 }

src/States/UndefinedRange.php

@@ -47,15 +47,15 @@ public function hasEndTime(): bool
      */
     public function getStartTime(): DateTimeInterface
     {
-        throw new DateRangeException('Date range is undefined');
+        throw new DateRangeException('Range start is undefined');
     }
 
     /**
      * {@inheritdoc}
      */
     public function getEndTime(): DateTimeInterface
     {
-        throw new DateRangeException('Date range is undefined');
+        throw new DateRangeException('Range end is undefined');
     }
 
     /**
@@ -77,32 +77,16 @@ public function setEndTime(DateTimeInterface $time): RangeState
     /**
      * {@inheritdoc}
      */
-    public function isStartAt(DateTimeInterface $time): bool
+    public function compareStartTime(DateTimeInterface $time): int
     {
-        return false;
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function isEndAt(DateTimeInterface $time): bool
-    {
-        return false;
+        throw new DateRangeException('Range start is undefined');
     }
 
     /**
      * {@inheritdoc}
      */
-    public function isStarted(): bool
+    public function compareEndTime(DateTimeInterface $time): int
     {
-        return false;
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function isEnded(): bool
-    {
-        return false;
+        throw new DateRangeException('Range end is undefined');
     }
 }