feat: allow null remaining occurrences for infinite iterations (#19)

* infinite recurrence logic added with test

* helper texts added

Author: chinmaypurav

app/Enums/Frequency.php

@@ -19,7 +19,7 @@ public function getLabel(): ?string
         return $this->name;
     }
 
-    public function getRemainingIterations(Carbon $start, Carbon $end, int $iterationsLeft): int
+    public function getRemainingIterations(Carbon $start, Carbon $end, ?int $iterationsLeft): int
     {
         $diff = match ($this->value) {
             self::DAILY->value => $start->diffInDays($end),
@@ -34,6 +34,10 @@ public function getRemainingIterations(Carbon $start, Carbon $end, int $iteratio
 
         $diff = $diff + 1; // the first date is inclusive
 
+        if (is_null($iterationsLeft)) {
+            return $diff;
+        }
+
         return min($iterationsLeft, $diff);
     }
 }

app/Filament/Concerns/RecurringIncomeRecurringExpenseTrait.php

@@ -60,7 +60,8 @@ public static function form(Form $form): Form
                     ->required(),
 
                 TextInput::make('remaining_recurrences')
-                    ->integer(),
+                    ->integer()
+                    ->helperText('Leave blank for infinite recurrences'),
 
                 Select::make('tags')
                     ->relationship('tags', 'name')

app/Filament/Resources/RecurringTransferResource.php

@@ -63,7 +63,8 @@ public static function form(Form $form): Form
                     ->required(),
 
                 TextInput::make('remaining_recurrences')
-                    ->integer(),
+                    ->integer()
+                    ->helperText('Leave blank for infinite recurrences'),
 
                 Select::make('tags')
                     ->relationship('tags', 'name')

tests/Unit/Enums/FrequencyTest.php

@@ -72,3 +72,13 @@
 
     expect($remainingOccurrences)->toEqual(5);
 });
+
+it('returns the iterations within the date range when remaining recurrences is null', function () {
+    $start = Carbon::create(2023, 1, 1);
+    $end = Carbon::create(2023, 1, 5); // 5 days
+    $iterationsLeft = null;
+
+    $remainingOccurrences = Frequency::DAILY->getRemainingIterations($start, $end, $iterationsLeft);
+
+    expect($remainingOccurrences)->toEqual(5);
+});