- Refactored date format SQL into enum

- Added ability to track current query model

Author: dash8x

src/Contracts/TimeSeriesStatsRepository.php

@@ -11,6 +11,12 @@ interface TimeSeriesStatsRepository extends
     InteractsWithFilters,
     InteractsWithDateRange
 {
+    /**
+     * Get which time series mode is being queried with
+     * Null means total
+     */
+    public function getCurrentMode(): ?TimeSeriesModes;
+
     /**
      * Get the stats
      */

src/Enums/TimeSeriesModes.php

@@ -67,6 +67,17 @@ public function getInternalDateFormat(): string
         };
     }
 
+    public function getSql(string $date_field): string
+    {
+        return match ($this) {
+            self::HOUR => "DATE_FORMAT($date_field, '%Y-%m-%d %H:00')",
+            self::DAY => "DATE($date_field)",
+            self::WEEK => "YEARWEEK($date_field, " . TimeSeriesStats::weekMode() . ")",
+            self::MONTH => "DATE_FORMAT($date_field, '%Y, %m')",
+            self::YEAR => "YEAR($date_field)",
+        };
+    }
+
     public function increment(Carbon $date): Carbon
     {
         $date = $date->copy()->locale(TimeSeriesStats::dateLocale());

src/Repositories/TimeSeries/AbstractTimeSeriesStatsRepository.php

@@ -22,6 +22,8 @@ abstract class AbstractTimeSeriesStatsRepository implements TimeSeriesStatsRepos
     use HasDateRange;
     use HasFilters;
 
+    protected ?TimeSeriesModes $current_mode = null;
+
     /**
      * Create a new stats repository instance.
      */
@@ -31,6 +33,16 @@ public function __construct(DateRange $date_range = PresetDateRanges::THIS_YEAR,
         $this->setFilters($filters);
     }
 
+    protected function setCurrentMode(?TimeSeriesModes $mode)
+    {
+        $this->current_mode = $mode;
+    }
+
+    public function getCurrentMode(): ?TimeSeriesModes
+    {
+        return $this->current_mode;
+    }
+
     /**
      * Check whether the given user can view the stat
      */

src/Repositories/TimeSeries/AggregateStatsRepository.php

@@ -7,6 +7,7 @@
 
 use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Support\Facades\DB;
+use Javaabu\Stats\Enums\TimeSeriesModes;
 use Javaabu\Stats\TimeSeriesStats;
 
 abstract class AggregateStatsRepository extends AbstractTimeSeriesStatsRepository
@@ -21,6 +22,11 @@ public abstract function getTable(): string;
      */
     public abstract function getAggregateSql(): string;
 
+    public function getDateSqlForTimeMode(TimeSeriesModes $mode): string
+    {
+        return $mode->getSql($this->getDateField());
+    }
+
     /**
      * Get the date field name for the repository
      */
@@ -44,8 +50,10 @@ public function getDateField(): string
      */
     public function hour(): Builder
     {
+        $this->setCurrentMode(TimeSeriesModes::HOUR);
+
         return $this->filteredQuery()
-            ->select(DB::raw($this->getAggregateSql().", DATE_FORMAT(".$this->getDateField().", '%Y-%m-%d %H:00') as hour"))
+            ->select(DB::raw($this->getAggregateSql().", " . $this->getDateSqlForTimeMode(TimeSeriesModes::HOUR) . " as hour"))
             ->groupBy('hour')
             ->orderBy('hour', 'ASC');
     }
@@ -57,8 +65,10 @@ public function hour(): Builder
      */
     public function day(): Builder
     {
+        $this->setCurrentMode(TimeSeriesModes::DAY);
+
         return $this->filteredQuery()
-            ->select(DB::raw($this->getAggregateSql().", DATE(".$this->getDateField().") as day"))
+            ->select(DB::raw($this->getAggregateSql().", " . $this->getDateSqlForTimeMode(TimeSeriesModes::DAY) . " as day"))
             ->groupBy('day')
             ->orderBy('day', 'ASC');
     }
@@ -70,11 +80,11 @@ public function day(): Builder
      */
     public function week(): Builder
     {
-        $week_mode = TimeSeriesStats::weekMode();
+        $this->setCurrentMode(TimeSeriesModes::WEEK);
 
         return $this->filteredQuery()
             //->select(DB::raw($this->getAggregateSql().", DATE_FORMAT(".$this->getDateField().", '%X, %V') as week"))
-            ->select(DB::raw($this->getAggregateSql().", YEARWEEK(".$this->getDateField().", $week_mode) as week"))
+            ->select(DB::raw($this->getAggregateSql().", " . $this->getDateSqlForTimeMode(TimeSeriesModes::WEEK) . " as week"))
             ->groupBy('week')
             ->orderBy('week', 'ASC');
     }
@@ -86,8 +96,10 @@ public function week(): Builder
      */
     public function month(): Builder
     {
+        $this->setCurrentMode(TimeSeriesModes::MONTH);
+
         return $this->filteredQuery()
-            ->select(DB::raw($this->getAggregateSql().", DATE_FORMAT(".$this->getDateField().", '%Y, %m') as month"))
+            ->select(DB::raw($this->getAggregateSql().", " . $this->getDateSqlForTimeMode(TimeSeriesModes::MONTH) . " as month"))
             ->groupBy('month')
             ->orderBy('month', 'ASC');
     }
@@ -99,8 +111,10 @@ public function month(): Builder
      */
     public function year(): Builder
     {
+        $this->setCurrentMode(TimeSeriesModes::YEAR);
+
         return $this->filteredQuery()
-            ->select(DB::raw($this->getAggregateSql().", YEAR(".$this->getDateField().") as year"))
+            ->select(DB::raw($this->getAggregateSql().", " . $this->getDateSqlForTimeMode(TimeSeriesModes::YEAR) . " as year"))
             ->groupBy('year')
             ->orderBy('year', 'ASC');
     }
@@ -110,6 +124,8 @@ public function year(): Builder
      */
     public function total(): float|int
     {
+        $this->setCurrentMode(null);
+
         $total = $this->filteredQuery()
                     ->select(DB::raw($this->getAggregateSql()))
                     ->value($this->getAggregateFieldName());

tests/Unit/Enums/TimeSeriesModesTest.php

@@ -8,6 +8,16 @@
 
 class TimeSeriesModesTest extends TestCase
 {
+    /** @test */
+    public function it_can_generate_the_correct_mysql_query_for_each_mode(): void
+    {
+        $this->assertEquals('DATE_FORMAT(created_at, \'%Y-%m-%d %H:00\')', TimeSeriesModes::HOUR->getSql('created_at'), 'Invalid mysql query for HOUR');
+        $this->assertEquals('DATE(created_at)', TimeSeriesModes::DAY->getSql('created_at'), 'Invalid mysql query for DAY');
+        $this->assertEquals('YEARWEEK(created_at, 6)', TimeSeriesModes::WEEK->getSql('created_at'), 'Invalid mysql query for WEEK');
+        $this->assertEquals('DATE_FORMAT(created_at, \'%Y, %m\')', TimeSeriesModes::MONTH->getSql('created_at'), 'Invalid mysql query for MONTH');
+        $this->assertEquals('YEAR(created_at)', TimeSeriesModes::YEAR->getSql('created_at'), 'Invalid mysql query for YEAR');
+    }
+
     /** @test */
     public function it_can_get_the_date_format_for_the_time_series_mode(): void
     {