feat: projected cash flow dashboard widget (#16)

* explicit declare widgets

* carbon namespace fix

* recurring cash flow widget added

* test added

* url change

* test name fix

* dead property cleaned

* test fix

* currency symbol added

app/Enums/Frequency.php

@@ -2,8 +2,8 @@
 
 namespace App\Enums;
 
+use Carbon\Carbon;
 use Filament\Support\Contracts\HasLabel;
-use Illuminate\Support\Carbon;
 
 enum Frequency: string implements HasLabel
 {

app/Filament/Pages/Dashboard.php

@@ -2,6 +2,7 @@
 
 namespace App\Filament\Pages;
 
+use App\Filament\Widgets;
 use Filament\Forms\Components\DatePicker;
 use Filament\Forms\Components\Section;
 use Filament\Forms\Form;
@@ -24,4 +25,12 @@ public function filtersForm(Form $form): Form
                     ->columns(2),
             ]);
     }
+
+    public function getWidgets(): array
+    {
+        return [
+            Widgets\IncomeChart::class,
+            Widgets\ExpenseChart::class,
+        ];
+    }
 }

app/Filament/Pages/RecurringCashFlowOverviewDashboard.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace App\Filament\Pages;
+
+use App\Filament\Widgets;
+use Filament\Pages\Dashboard as BaseDashboard;
+
+class RecurringCashFlowOverviewDashboard extends BaseDashboard
+{
+    protected static ?string $navigationGroup = 'Recurring Transactions';
+
+    protected static string $routePath = 'recurring-overview';
+
+    protected static ?string $title = 'Recurring CashFlow Overview';
+
+    public function getWidgets(): array
+    {
+        return [
+            Widgets\RecurringCashFlowOverviewWidget::class,
+        ];
+    }
+}

app/Filament/Widgets/RecurringCashFlowOverviewWidget.php

@@ -0,0 +1,38 @@
+<?php
+
+namespace App\Filament\Widgets;
+
+use App\Services\RecurringCashFlowService;
+use Filament\Widgets\StatsOverviewWidget as BaseWidget;
+use Filament\Widgets\StatsOverviewWidget\Stat;
+
+class RecurringCashFlowOverviewWidget extends BaseWidget
+{
+    protected function getStats(): array
+    {
+        $startDate = today();
+        $endDate = today()->addYear();
+
+        $totalIncomes = RecurringCashFlowService::processRecurringIncomes(
+            auth()->user(),
+            $startDate,
+            $endDate
+        );
+
+        $totalExpenses = RecurringCashFlowService::processRecurringExpenses(
+            auth()->user(),
+            $startDate,
+            $endDate
+        );
+
+        $disposableIncome = $totalIncomes - $totalExpenses;
+
+        $symbol = config('penny.currency_symbol');
+
+        return [
+            Stat::make('Total Estimated Incomes', $symbol.' '.number_format($totalIncomes)),
+            Stat::make('Total Estimated Expenses', $symbol.' '.number_format($totalExpenses)),
+            Stat::make('Estimated Disposable Income', $symbol.' '.number_format($disposableIncome)),
+        ];
+    }
+}

app/Services/RecurringCashFlowService.php

@@ -0,0 +1,47 @@
+<?php
+
+namespace App\Services;
+
+use App\Models\RecurringExpense;
+use App\Models\RecurringIncome;
+use App\Models\User;
+use Carbon\Carbon;
+
+class RecurringCashFlowService
+{
+    public static function processRecurringIncomes(User $user, Carbon $startDate, Carbon $endDate): float
+    {
+        return RecurringIncome::query()
+            ->where('user_id', $user->id)
+            ->whereDate('next_transaction_at', '>=', $startDate)
+            ->whereDate('next_transaction_at', '<=', $endDate)
+            ->get()
+            ->reduce(function (?float $carry, RecurringIncome $recurringIncome) use ($endDate) {
+                $count = $recurringIncome->frequency->getRemainingIterations(
+                    $recurringIncome->next_transaction_at,
+                    $endDate,
+                    $recurringIncome->remaining_recurrences
+                );
+
+                return $carry + $count * $recurringIncome->amount;
+            });
+    }
+
+    public static function processRecurringExpenses(User $user, Carbon $startDate, Carbon $endDate): float
+    {
+        return RecurringExpense::query()
+            ->where('user_id', $user->id)
+            ->whereDate('next_transaction_at', '>=', $startDate)
+            ->whereDate('next_transaction_at', '<=', $endDate)
+            ->get()
+            ->reduce(function (?float $carry, RecurringExpense $recurringExpense) use ($endDate) {
+                $count = $recurringExpense->frequency->getRemainingIterations(
+                    $recurringExpense->next_transaction_at,
+                    $endDate,
+                    $recurringExpense->remaining_recurrences
+                );
+
+                return $carry + $count * $recurringExpense->amount;
+            });
+    }
+}

config/penny.php

@@ -2,4 +2,6 @@
 
 return [
     'currency' => env('CURRENCY', 'INR'),
+
+    'currency_symbol' => env('CURRENCY_SYMBOL', '₹'),
 ];

tests/Feature/RecurringOverviewTest.php

@@ -0,0 +1,18 @@
+<?php
+
+use App\Filament\Widgets\RecurringCashFlowOverviewWidget;
+use App\Models\User;
+use Illuminate\Foundation\Testing\RefreshDatabase;
+
+uses(RefreshDatabase::class);
+
+beforeEach(function () {
+    $this->user = User::factory()->create();
+    $this->actingAs($this->user);
+});
+
+it('sees recurring cash flow overview widget', function () {
+    $this->get('/app/recurring-overview')
+        ->assertOk()
+        ->assertSeeLivewire(RecurringCashFlowOverviewWidget::class);
+});