✨ Add ranges to reports, add new report type

hisabi-app · Jan 15, 2022 · 331819f · 331819f
1 parent f4b916d
commit 331819f
Show file tree

Hide file tree

Showing 23 changed files with 14,051 additions and 130 deletions.
diff --git a/app/Domain/Ranges/Range.php b/app/Domain/Ranges/Range.php
@@ -7,7 +7,6 @@
 
 abstract class Range implements JsonSerializable
 {
-    protected $key;
     protected $name;
     protected $start;
     protected $end;

diff --git a/app/GraphQL/Queries/ExpensesPerCategory.php b/app/GraphQL/Queries/ExpensesPerCategory.php
@@ -0,0 +1,32 @@
+<?php
+
+namespace App\GraphQL\Queries;
+
+use App\Models\Category;
+use Illuminate\Support\Facades\DB;
+
+class ExpensesPerCategory
+{
+    /**
+     * @param  null  $_
+     * @param  array<string, mixed>  $args
+     */
+    public function __invoke($_, array $args)
+    {
+        $rangeData = app('findRangeByKey', ["key" => $args['range']]);
+
+        $query = Category::query()
+            ->where('type', Category::EXPENSES)
+            ->join('brands', 'brands.category_id', '=', 'categories.id')
+            ->join('transactions', 'transactions.brand_id', '=', 'brands.id')
+            ->select("categories.name as label", DB::raw("SUM(transactions.amount) as value"))
+            ->groupBy("categories.id")
+            ->orderBy('value', 'DESC');
+
+        if($rangeData) {
+            $query->whereBetween('transactions.created_at', [$rangeData->start(), $rangeData->end()]);
+        }
+
+        return $query->get();
+    }
+}
diff --git a/app/GraphQL/Queries/IncomePerCategory.php b/app/GraphQL/Queries/IncomePerCategory.php
@@ -0,0 +1,32 @@
+<?php
+
+namespace App\GraphQL\Queries;
+
+use App\Models\Category;
+use Illuminate\Support\Facades\DB;
+
+class IncomePerCategory
+{
+    /**
+     * @param  null  $_
+     * @param  array<string, mixed>  $args
+     */
+    public function __invoke($_, array $args)
+    {
+        $rangeData = app('findRangeByKey', ["key" => $args['range']]);
+
+        $query = Category::query()
+            ->where('type', Category::INCOME)
+            ->join('brands', 'brands.category_id', '=', 'categories.id')
+            ->join('transactions', 'transactions.brand_id', '=', 'brands.id')
+            ->select("categories.name as label", DB::raw("SUM(transactions.amount) as value"))
+            ->groupBy("categories.id")
+            ->orderBy('value', 'DESC');
+
+        if($rangeData) {
+            $query->whereBetween('transactions.created_at', [$rangeData->start(), $rangeData->end()]);
+        }
+
+        return $query->get();
+    }
+}
diff --git a/app/GraphQL/Queries/TotalExpenses.php b/app/GraphQL/Queries/TotalExpenses.php
@@ -0,0 +1,25 @@
+<?php
+
+namespace App\GraphQL\Queries;
+
+use App\Models\Transaction;
+
+class TotalExpenses
+{
+    /**
+     * @param  null  $_
+     * @param  array<string, mixed>  $args
+     */
+    public function __invoke($_, array $args)
+    {
+        $rangeData = app('findRangeByKey', ["key" => $args['range']]);
+
+        $query = Transaction::query()->expenses();
+
+        if($rangeData) {
+            $query->whereBetween('created_at', [$rangeData->start(), $rangeData->end()]);
+        }
+
+        return $query->sum('amount');
+    }
+}
diff --git a/app/GraphQL/Queries/TotalIncome.php b/app/GraphQL/Queries/TotalIncome.php
@@ -0,0 +1,25 @@
+<?php
+
+namespace App\GraphQL\Queries;
+
+use App\Models\Transaction;
+
+class TotalIncome
+{
+    /**
+     * @param  null  $_
+     * @param  array<string, mixed>  $args
+     */
+    public function __invoke($_, array $args)
+    {
+        $rangeData = app('findRangeByKey', ["key" => $args['range']]);
+
+        $query = Transaction::query()->income();
+
+        if($rangeData) {
+            $query->whereBetween('created_at', [$rangeData->start(), $rangeData->end()]);
+        }
+
+        return $query->sum('amount');
+    }
+}
diff --git a/app/Http/Controllers/DashboardController.php b/app/Http/Controllers/DashboardController.php
@@ -8,15 +8,8 @@ class DashboardController extends Controller
 {
     public function index()
     {
-        $metrics = config('finance.reports');
-
-        $graphqlQueries = array_map(function($metric) {
-            return $metric['graphql_query'];
-        }, $metrics);
-
         return Inertia::render('Dashboard', [
-            'metrics' => $metrics,
-            'graphqlQueries' => implode("\n", $graphqlQueries)
+            'metrics' => config('finance.reports')
         ]);
     }
 }
diff --git a/app/Models/Transaction.php b/app/Models/Transaction.php
@@ -2,7 +2,6 @@
 
 namespace App\Models;
 
-use Illuminate\Support\Facades\DB;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Factories\HasFactory;
 
@@ -35,17 +34,6 @@ public function scopeIncome($query)
         });
     }
 
-    public function statistics2() 
-    {
-        return Transaction::query()
-            ->income()
-            ->with(['brand', 'brand.category'])
-            ->join('brands', 'brands.id', '=', 'transactions.brand_id')
-            // ->join('categories', 'categories.id', '=', 'brands.category_id')
-            ->select(DB::raw("brands.category_id, SUM(transactions.amount) as total"))
-            ->groupBy("brands.category_id");
-    }
-
     public static function tryCreateFromSms($sms) 
     {
         $brandFromSms = $sms->meta['data']['brand'] ?? null;

diff --git a/app/Providers/AppServiceProvider.php b/app/Providers/AppServiceProvider.php
@@ -9,6 +9,10 @@
 use App\Contracts\SmsParser as SmsParserContract;
 use App\Contracts\SmsTemplateDetector as SmsTemplateDetectorContract;
 use App\Contracts\SmsTransactionProcessor as SmsTransactionProcessorContract;
+use App\Domain\Ranges\CurrentMonth;
+use App\Domain\Ranges\CurrentYear;
+use App\Domain\Ranges\LastMonth;
+use App\Domain\Ranges\LastYear;
 
 class AppServiceProvider extends ServiceProvider
 {
@@ -22,6 +26,21 @@ public function register()
         $this->app->bind(SmsParserContract::class, SmsParser::class);
         $this->app->bind(SmsTemplateDetectorContract::class, SmsTemplateDetector::class);
         $this->app->bind(SmsTransactionProcessorContract::class, SmsTransactionProcessor::class);
+
+        // TODO: find a better way to load classes based on base class Range
+        $this->app->bind('findRangeByKey', function($_, $params) {
+            $key = $params['key'];
+
+            return collect([
+                new CurrentMonth,
+                new LastMonth,
+                new CurrentYear,
+                new LastYear,
+            ])->first(function ($range) use($key) {
+                return $key === $range->key();
+            }) ?: null;
+
+        });
     }
 
     /**

diff --git a/config/finance.php b/config/finance.php
@@ -1,5 +1,17 @@
 <?php
 
+use \App\Domain\Ranges\CurrentMonth;
+use \App\Domain\Ranges\LastMonth;
+use \App\Domain\Ranges\CurrentYear;
+use \App\Domain\Ranges\LastYear;
+
+$ranges = [
+    new CurrentMonth,
+    new LastMonth,
+    new CurrentYear,
+    new LastYear,
+];
+
 return [
     'sms_templates' => [
         'Purchase of AED {amount} with {card} at {brand},',
@@ -13,24 +25,28 @@
             'graphql_query' => 'totalIncome',
             'component' => 'value-metric',
             'width' => '1/2',
+            'ranges' => $ranges,
         ],
         [
             'name' => 'Total Expenses',
             'graphql_query' => 'totalExpenses',
             'component' => 'value-metric',
             'width' => '1/2',
+            'ranges' => $ranges,
         ],
         [
             'name' => 'Expenses per Category',
             'graphql_query' => 'expensesPerCategory',
             'component' => 'partition-metric',
             'width' => '1/2',
-            'ranges' => [
-                \App\Domain\Ranges\CurrentMonth::class,
-                \App\Domain\Ranges\LastMonth::class,
-                \App\Domain\Ranges\CurrentYear::class,
-                \App\Domain\Ranges\LastYear::class,
-            ],
+            'ranges' => $ranges,
+        ],
+        [
+            'name' => 'Income per Category',
+            'graphql_query' => 'incomePerCategory',
+            'component' => 'partition-metric',
+            'width' => '1/2',
+            'ranges' => $ranges,
         ],
 
         // Brand per category partition for this month

diff --git a/graphql/schema.graphql b/graphql/schema.graphql
@@ -25,12 +25,6 @@ type Transaction {
     created_at: Date!
 }
 
-type TransactionStatistics {
-    category_id: Int!
-    total: Float!
-    category: Category
-}
-
 type Sms {
     id: ID!
     body: String!
@@ -42,16 +36,17 @@ type Query {
     transactions: [Transaction!]! @paginate(defaultCount: 25) @orderBy(column: id direction: DESC)
 
     allBrands: [Brand!]! @all
-    brands: [Brand!]! @paginate(defaultCount: 25) @orderBy(column: id direction: DESC)
+    brands: [Brand!]! @paginate(defaultCount: 25) @orderBy(column: category_id direction: ASC)
 
     allCategories: [Category!]! @all
     categories: [Category!]! @paginate(defaultCount: 25) @orderBy(column: id direction: DESC)
 
     sms: [Sms!]! @paginate(defaultCount: 100) @orderBy(column: transaction_id direction: ASC)
 
-    totalExpenses: Float! @aggregate(model: Transaction column: amount function: SUM scopes:["expenses"])
-    totalIncome: Float! @aggregate(model: Transaction column: amount function: SUM scopes: ["income"])
-    expensesPerCategory: Float! @aggregate(model: Transaction column: amount function: SUM scopes: ["income"])
+    totalExpenses(range: String): Json
+    totalIncome(range: String): Json
+    expensesPerCategory(range: String): Json
+    incomePerCategory(range: String): Json
 }
 
 type Mutation {

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -28,7 +28,9 @@
     },
     "dependencies": {
         "@heroicons/react": "^1.0.5",
+        "chart.js": "^3.7.0",
         "graphql": "^16.2.0",
-        "numbro": "^2.3.6"
+        "numbro": "^2.3.6",
+        "react-chartjs-2": "^4.0.0"
     }
 }