Fill in gaps when events are split. (#32)

TwoD · web-flow · commit 1034b29ee1a5 · 2020-08-25T18:07:22.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -11,10 +11,10 @@ All Notable changes to BAT will be documented in this file
 - Nothing
 
 ### Fixed
-- Nothing
+- The event stores now ensure new events splitting existing events do not leave empty gaps between day boundaries and the new event.
 
 ### Removed
 - Nothing
 
 ### Security
-- Nothing
+- Nothing
diff --git a/src/Calendar/AbstractCalendar.php b/src/Calendar/AbstractCalendar.php
@@ -30,7 +30,7 @@ abstract class AbstractCalendar implements CalendarInterface {
   /**
    * The class that will access the actual event store where event data is held.
    *
-   * @var
+   * @var \Roomify\Bat\Store\StoreInterface
    */
   protected $store;
 
diff --git a/src/Calendar/CalendarInterface.php b/src/Calendar/CalendarInterface.php
@@ -23,18 +23,18 @@ interface CalendarInterface {
    * @param $end_date
    * The end date of our range
    *
-   * @return EventInterface[]
+   * @return \Roomify\Bat\Event\EventInterface[]
    * An array of Event objects
    */
   public function getEvents(\DateTime $start_date, \DateTime $end_date);
 
   /**
    * Given an array of Events the calendar is updated with the relevant data.
    *
-   * @param EventInterface[] $events
+   * @param \Roomify\Bat\Event\EventInterface[] $events
    *   An array of events to update the calendar with
    *
-   * @param granularity
+   * @param $granularity
    *  The leverl of detail (one of HOURLY, DAILY) at which to store the event
    */
   public function addEvents($events, $granularity);
diff --git a/src/Event/AbstractEvent.php b/src/Event/AbstractEvent.php
@@ -10,6 +10,7 @@
 use Roomify\Bat\Event\EventInterface;
 use Roomify\Bat\Store\Store;
 use Roomify\Bat\EventFormatter\EventFormatter;
+use Roomify\Bat\Store\StoreInterface;
 
 abstract class AbstractEvent implements EventInterface {
 
@@ -466,12 +467,12 @@ public function itemize($itemizer) {
   /**
    * Saves an event using the Store object
    *
-   * @param Store $store
+   * @param StoreInterface $store
    * @param string $granularity
    *
    * @return boolean
    */
-  public function saveEvent(Store $store, $granularity = AbstractEvent::BAT_HOURLY) {
+  public function saveEvent(StoreInterface $store, $granularity = AbstractEvent::BAT_HOURLY) {
     return $store->storeEvent($this, $granularity);
   }
 
diff --git a/src/Store/DrupalDBStore.php b/src/Store/DrupalDBStore.php
@@ -88,13 +88,21 @@ public function storeEvent(EventInterface $event, $granularity = Event::BAT_HOUR
       $transaction = db_transaction();
     }
 
+    // Get existing event data from db
+    $existing_events = $this->getEventData($event->getStartDate(), $event->getEndDate(), array($event->getUnitId()));
+
     try {
       // Itemize an event so we can save it
       $itemized = $event->itemize(new EventItemizer($event, $granularity));
 
       //Write days
       foreach ($itemized[Event::BAT_DAY] as $year => $months) {
         foreach ($months as $month => $days) {
+          if ($granularity === Event::BAT_HOURLY) {
+            foreach ($days as $day => $value) {
+              $this->itemizeSplitDay($existing_events, $itemized, $value, $event->getUnitId(), $year, $month, $day);
+            }
+          }
           if (class_exists('Drupal') && floatval(\Drupal::VERSION) >= 9) {
             \Drupal\Core\Database\Database::getConnection()->merge($this->day_table_no_prefix)
               ->key(array(
@@ -124,6 +132,9 @@ public function storeEvent(EventInterface $event, $granularity = Event::BAT_HOUR
             foreach ($days as $day => $hours) {
               // Count required as we may receive empty hours for granular events that start and end on midnight
               if (count($hours) > 0) {
+                foreach ($hours as $hour => $value){
+                  $this->itemizeSplitHour($existing_events, $itemized, $value, $event->getUnitId(), $year, $month, $day, $hour);
+                }
                 if (class_exists('Drupal') && floatval(\Drupal::VERSION) >= 9) {
                   \Drupal\Core\Database\Database::getConnection()->merge($this->hour_table_no_prefix)
                     ->key(array(
diff --git a/src/Store/SqlLiteDBStore.php b/src/Store/SqlLiteDBStore.php
@@ -86,9 +86,10 @@ public function getEventData(\DateTime $start_date, \DateTime $end_date, $unit_i
    */
   public function storeEvent(EventInterface $event, $granularity = Event::BAT_HOURLY) {
     $stored = TRUE;
+    $unit_id = $event->getUnitId();
 
     // Get existing event data from db
-    $existing_events = $this->getEventData($event->getStartDate(), $event->getEndDate(), array($event->getUnitId()));
+    $existing_events = $this->getEventData($event->getStartDate(), $event->getEndDate(), array($unit_id));
 
     try {
       // Itemize an event so we can save it
@@ -100,17 +101,20 @@ public function storeEvent(EventInterface $event, $granularity = Event::BAT_HOUR
           $values = array_values($days);
           $keys = array_keys($days);
           // Because SQLite does not have a nice merge first we have to check if a row exists to determine whether to do an insert or an update
-          if (isset($existing_events[$event->getUnitId()][EVENT::BAT_DAY][$year][$month])) {
+          if (isset($existing_events[$unit_id][EVENT::BAT_DAY][$year][$month])) {
             $command = "UPDATE $this->day_table SET ";
             foreach ($days as $day => $value) {
+              if ($granularity === Event::BAT_HOURLY) {
+                $this->itemizeSplitDay($existing_events, $itemized, $value, $unit_id, $year, $month, $day);
+              }
               $command .= "$day = $value,";
             }
             $command = rtrim($command, ',');
-            $command .= " WHERE unit_id = " . $event->getUnitId() . " AND year = $year AND month = $month";
+            $command .= " WHERE unit_id = " . $unit_id . " AND year = $year AND month = $month";
             $this->pdo->exec($command);
           }
           else {
-            $this->pdo->exec("INSERT INTO $this->day_table (unit_id, year, month, " . implode(', ', $keys) . ") VALUES (" . $event->getUnitId() . ", $year, $month, " . implode(', ', $values) . ")");
+            $this->pdo->exec("INSERT INTO $this->day_table (unit_id, year, month, " . implode(', ', $keys) . ") VALUES (" . $unit_id . ", $year, $month, " . implode(', ', $values) . ")");
           }
         }
       }
@@ -124,16 +128,22 @@ public function storeEvent(EventInterface $event, $granularity = Event::BAT_HOUR
               if (count($hours) > 0) {
                 $values = array_values($hours);
                 $keys = array_keys($hours);
-                if (isset($existing_events[$event->getUnitId()][EVENT::BAT_HOUR][$year][$month][$day])) {
+                if (isset($existing_events[$unit_id][EVENT::BAT_HOUR][$year][$month][$day])) {
                   $command = "UPDATE $this->hour_table SET ";
                   foreach ($hours as $hour => $value){
+                    $this->itemizeSplitHour($existing_events, $itemized, $value, $unit_id, $year, $month, $day, $hour);
                     $command .= "$hour = $value,";
                   }
                   $command = rtrim($command, ',');
-                  $command .= " WHERE unit_id = " . $event->getUnitId() . " AND year = $year AND month = $month AND day = " . substr($day,1);
+                  $command .= " WHERE unit_id = " . $unit_id . " AND year = $year AND month = $month AND day = " . substr($day,1);
                   $this->pdo->exec($command);
                 } else {
-                  $this->pdo->exec("INSERT INTO $this->hour_table (unit_id, year, month, day, " . implode(', ', $keys) . ") VALUES (" . $event->getUnitId() . ", $year, $month, " . substr($day, 1) . ", " . implode(', ', $values) . ")");
+                  if (isset($existing_events[$unit_id][EVENT::BAT_DAY][$year][$month][$day])) {
+                    foreach ($hours as $hour => $value) {
+                      $this->itemizeSplitHour($existing_events, $itemized, $value, $unit_id, $year, $month, $day, $hour);
+                    }
+                  }
+                  $this->pdo->exec("INSERT INTO $this->hour_table (unit_id, year, month, day, " . implode(', ', $keys) . ") VALUES (" . $unit_id . ", $year, $month, " . substr($day, 1) . ", " . implode(', ', $values) . ")");
                 }
               }
             }
@@ -147,16 +157,16 @@ public function storeEvent(EventInterface $event, $granularity = Event::BAT_HOUR
               foreach ($hours as $hour => $minutes) {
                 $values = array_values($minutes);
                 $keys = array_keys($minutes);
-                if (isset($existing_events[$event->getUnitId()][EVENT::BAT_MINUTE][$year][$month][$day][$hour])) {
+                if (isset($existing_events[$unit_id][EVENT::BAT_MINUTE][$year][$month][$day][$hour])) {
                   $command = "UPDATE $this->minute_table SET ";
                   foreach ($minutes as $minute => $value){
                     $command .= "$minute = $value,";
                   }
                   $command = rtrim($command, ',');
-                  $command .= " WHERE unit_id = " . $event->getUnitId() . " AND year = $year AND month = $month AND day = " . substr($day,1) . " AND hour = " . substr($hour,1);
+                  $command .= " WHERE unit_id = " . $unit_id . " AND year = $year AND month = $month AND day = " . substr($day,1) . " AND hour = " . substr($hour,1);
                   $this->pdo->exec($command);
                 } else {
-                  $this->pdo->exec("INSERT INTO $this->minute_table (unit_id, year, month, day, hour, " . implode(', ', $keys) . ") VALUES (" . $event->getUnitId() . ", $year, $month, " . substr($day, 1) . ", " . substr($hour, 1) . ", " . implode(', ', $values) . ")");
+                  $this->pdo->exec("INSERT INTO $this->minute_table (unit_id, year, month, day, hour, " . implode(', ', $keys) . ") VALUES (" . $unit_id . ", $year, $month, " . substr($day, 1) . ", " . substr($hour, 1) . ", " . implode(', ', $values) . ")");
                 }
               }
             }
diff --git a/src/Store/Store.php b/src/Store/Store.php
@@ -7,11 +7,86 @@
 
 namespace Roomify\Bat\Store;
 
-use Roomify\Bat\Store\StoreInterface;
+use Roomify\Bat\Event\Event;
 
 /**
  * The basic Store class
  */
 abstract class Store implements StoreInterface {
 
+  /**
+   * Fill in hourly values from existing events when a day is being split.
+   *
+   * $existing_events must contain an existing event for the unit the same day.
+   * This only needs to be called for hourly granularity.
+   *
+   * @param array $existing_events
+   *   Existing event data from ::getEventData().
+   * @param array $itemized
+   *   The new event itemized. Values from existing overlapping events will be
+   *   inserted into it.
+   * @param int $value
+   *   The value of the event being added.
+   * @param int $unit_id
+   *   The unit the event being added.
+   * @param int $year
+   *   Year of the event.
+   * @param int $month
+   *   A month of the event.
+   * @param int $day
+   *   Day of the event.
+   */
+  protected function itemizeSplitDay(array &$existing_events, array &$itemized, $value, $unit_id, $year, $month, $day) {
+    $existing_value = $existing_events[$unit_id][EVENT::BAT_DAY][$year][$month][$day];
+    if ($value === -1 && $existing_value > 0) {
+      $itemized_day = &$itemized[Event::BAT_HOUR][$year][$month][$day];
+      for ($hour = 0; $hour < 24; $hour++) {
+        $hour_key = 'h' . $hour;
+        $var = &$itemized_day[$hour_key];
+        $var = isset($var) && $var != 0 ? $var : $existing_value;
+      }
+    }
+  }
+
+  /**
+   * Fill in minute values from existing events when an hour is being split.
+   *
+   * $existing_events must contain an existing event for the unit during either
+   * the same hour or day.
+   *
+   * @param array $existing_events
+   *   Existing event data from ::getEventData().
+   * @param array $itemized
+   *   The new event itemized. Values from existing overlapping events will be
+   *   inserted into it.
+   * @param int $value
+   *   The value of the event being added.
+   * @param int $unit_id
+   *   The unit the event being added.
+   * @param int $year
+   *   Year of the event.
+   * @param int $month
+   *   A month of the event.
+   * @param int $day
+   *   A day of the event.
+   * @param int $hour
+   *   An hour in which an existing event overlaps.
+   */
+  protected function itemizeSplitHour(array $existing_events, array &$itemized, $value, $unit_id, $year, $month, $day, $hour) {
+    if (isset($existing_events[$unit_id][EVENT::BAT_HOUR][$year][$month][$day][$hour])) {
+      $existing_value = $existing_events[$unit_id][EVENT::BAT_HOUR][$year][$month][$day][$hour];
+    }
+    else {
+      $existing_value = $existing_events[$unit_id][EVENT::BAT_DAY][$year][$month][$day];
+    }
+    if ($value === -1 && $existing_value > 0) {
+      $itemized_hour = &$itemized[Event::BAT_MINUTE][$year][$month][$day][$hour];
+      for ($minute = 0; $minute < 60; $minute++) {
+        $minute_key = 'm' . str_pad($minute, 2, '0', STR_PAD_LEFT);
+        $var = &$itemized_hour[$minute_key];
+        $var = isset($var) && $var != 0 ? $var : $existing_value;
+      }
+    }
+  }
+
 }
diff --git a/tests/CalendarTest.php b/tests/CalendarTest.php
@@ -891,4 +891,41 @@ public function testDstTransition2() {
     $this->assertEquals($events[1][1]->getValue(), 11);
   }
 
+  public function testPartialOverlap() {
+    $u1 = new Unit(1, 0, array());
+    $units = array($u1);
+    $store = new SqlLiteDBStore($this->pdo, 'availability_event', SqlDBStore::BAT_STATE);
+    $calendar = new Calendar($units, $store);
+
+    $sd = new \DateTime('2020-07-12 00:00');
+    $ed = new \DateTime('2020-07-13 23:59');
+    // Base event to be split.
+    $sd1 = new \DateTime('2020-07-12 00:00');
+    $ed1 = new \DateTime('2020-07-13 23:59');
+    $e1s11 = new Event($sd1, $ed1, $u1, 11);
+    // Splits an existing day.
+    $sd2 = new \DateTime('2020-07-12 01:00');
+    $ed2 = new \DateTime('2020-07-12 03:00');
+    $e2s22 = new Event($sd2, $ed2, $u1, 22);
+    // Splits an existing hour when day is already split.
+    $sd3 = new \DateTime('2020-07-12 04:20');
+    $ed3 = new \DateTime('2020-07-12 04:25');
+    $e3s33 = new Event($sd3, $ed3, $u1, 33);
+    // Splits an hour in an existing day not previously split.
+    $sd4 = new \DateTime('2020-07-13 04:20');
+    $ed4 = new \DateTime('2020-07-13 04:25');
+    $e4s44 = new Event($sd4, $ed4, $u1, 44);
+
+    $calendar->addEvents(array($e1s11, $e2s22, $e3s33, $e4s44), Event::BAT_HOURLY);
+    $events = $calendar->getEvents($sd, $ed);
+
+    $this->assertEquals(11, $events[1][0]->getValue());
+    $this->assertEquals(22, $events[1][1]->getValue());
+    $this->assertEquals(11, $events[1][2]->getValue());
+    $this->assertEquals(33, $events[1][3]->getValue());
+    $this->assertEquals(11, $events[1][4]->getValue());
+    $this->assertEquals(44, $events[1][5]->getValue());
+    $this->assertEquals(11, $events[1][4]->getValue());
+  }
+
 }

Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ abstract class AbstractCalendar implements CalendarInterface {`
`30`	`30`	`/**`
`31`	`31`	`* The class that will access the actual event store where event data is held.`
`32`	`32`	`*`
`33`		`- * @var`
	`33`	`+ * @var \Roomify\Bat\Store\StoreInterface`
`34`	`34`	`*/`
`35`	`35`	`protected $store;`
`36`	`36`
Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,7 @@`
`10`	`10`	`use Roomify\Bat\Event\EventInterface;`
`11`	`11`	`use Roomify\Bat\Store\Store;`
`12`	`12`	`use Roomify\Bat\EventFormatter\EventFormatter;`
	`13`	`+use Roomify\Bat\Store\StoreInterface;`
`13`	`14`
`14`	`15`	`abstract class AbstractEvent implements EventInterface {`
`15`	`16`
`@@ -466,12 +467,12 @@ public function itemize($itemizer) {`
`466`	`467`	`/**`
`467`	`468`	`* Saves an event using the Store object`
`468`	`469`	`*`
`469`		`- * @param Store $store`
	`470`	`+ * @param StoreInterface $store`
`470`	`471`	`* @param string $granularity`
`471`	`472`	`*`
`472`	`473`	`* @return boolean`
`473`	`474`	`*/`
`474`		`- public function saveEvent(Store $store, $granularity = AbstractEvent::BAT_HOURLY) {`
	`475`	`+ public function saveEvent(StoreInterface $store, $granularity = AbstractEvent::BAT_HOURLY) {`
`475`	`476`	`return $store->storeEvent($this, $granularity);`
`476`	`477`	`}`
`477`	`478`