Rename SipFrequency to Frequency

wealth-wave · Mar 30, 2024 · 63f95de · 63f95de
1 parent 72e4230
commit 63f95de
Show file tree

Hide file tree

Showing 10 changed files with 50 additions and 49 deletions.
diff --git a/lib/api/apis/sip_api.dart b/lib/api/apis/sip_api.dart
@@ -1,6 +1,6 @@
 import 'package:drift/drift.dart';
 import 'package:wealth_wave/api/db/app_database.dart';
-import 'package:wealth_wave/contract/sip_frequency.dart';
+import 'package:wealth_wave/contract/frequency.dart';
 
 class SipApi {
   final AppDatabase _db;
@@ -13,7 +13,7 @@ class SipApi {
       required final double amount,
       required final DateTime startDate,
       required final DateTime? endDate,
-      required final SipFrequency frequency}) async {
+      required final Frequency frequency}) async {
     return _db.into(_db.sipTable).insert(SipTableCompanion.insert(
         investmentId: investmentId,
         description: Value(description),
@@ -53,7 +53,7 @@ class SipApi {
       required final double amount,
       required final DateTime startDate,
       required final DateTime? endDate,
-      required final SipFrequency frequency}) async {
+      required final Frequency frequency}) async {
     return (_db.update(_db.sipTable)..where((t) => t.id.equals(id))).write(
         SipTableCompanion(
             investmentId: Value(investmentId),

diff --git a/lib/api/db/app_database.dart b/lib/api/db/app_database.dart
@@ -3,7 +3,7 @@ import 'package:drift/wasm.dart';
 import 'package:flutter/foundation.dart';
 import 'package:wealth_wave/contract/goal_importance.dart';
 import 'package:wealth_wave/contract/risk_level.dart';
-import 'package:wealth_wave/contract/sip_frequency.dart';
+import 'package:wealth_wave/contract/frequency.dart';
 
 part 'app_database.g.dart';
 
@@ -79,7 +79,7 @@ class SipTable extends Table {
       .check(endDate.isNull() | endDate.isBiggerThan(startDate))
       .named('END_DATE')();
 
-  TextColumn get frequency => textEnum<SipFrequency>().named('FREQUENCY')();
+  TextColumn get frequency => textEnum<Frequency>().named('FREQUENCY')();
 
   DateTimeColumn get executedTill =>
       dateTime().nullable().named('EXECUTED_TILL')();

diff --git a/lib/api/db/app_database.g.dart b/lib/api/db/app_database.g.dart
diff --git a/lib/contract/sip_frequency.dart → lib/contract/frequency.dart b/lib/contract/sip_frequency.dart → lib/contract/frequency.dart
@@ -1,28 +1,28 @@
-enum SipFrequency {
+enum Frequency {
   daily,
   weekly,
   biweekly,
   monthly,
   quarterly,
-  halfyearly,
+  halfYearly,
   yearly,
 }
 
-Duration getDuration(SipFrequency frequency) {
+Duration getDuration(Frequency frequency) {
   switch (frequency) {
-    case SipFrequency.daily:
+    case Frequency.daily:
       return const Duration(days: 1);
-    case SipFrequency.weekly:
+    case Frequency.weekly:
       return const Duration(days: 7);
-    case SipFrequency.biweekly:
+    case Frequency.biweekly:
       return const Duration(days: 14);
-    case SipFrequency.monthly:
+    case Frequency.monthly:
       return const Duration(days: 30);
-    case SipFrequency.quarterly:
+    case Frequency.quarterly:
       return const Duration(days: 91);
-    case SipFrequency.halfyearly:
+    case Frequency.halfYearly:
       return const Duration(days: 182);
-    case SipFrequency.yearly:
+    case Frequency.yearly:
       return const Duration(days: 365);
     default:
       throw Exception('Invalid frequency');

diff --git a/lib/domain/models/irr_calculator.dart b/lib/domain/models/irr_calculator.dart
@@ -30,7 +30,8 @@ class IRRCalculator {
         value: value, totalPayment: totalPayment, totalYears: totalYears);
 
     const int maxIterations = 1000;
-    const double precision = 0.0001;
+    const double precision =
+        0.0001; //This precision gives more accurate result within 1000 iterations
 
     for (var i = 0; i < maxIterations; i++) {
       final valueOnIrr = calculateFutureValueOnIRR(

diff --git a/lib/domain/models/sip.dart b/lib/domain/models/sip.dart
@@ -1,5 +1,5 @@
 import 'package:wealth_wave/api/db/app_database.dart';
-import 'package:wealth_wave/contract/sip_frequency.dart';
+import 'package:wealth_wave/contract/frequency.dart';
 import 'package:wealth_wave/domain/models/payment.dart';
 
 class Sip {
@@ -9,7 +9,7 @@ class Sip {
   final double amount;
   final DateTime startDate;
   final DateTime? endDate;
-  final SipFrequency frequency;
+  final Frequency frequency;
   final DateTime? executedTill;
 
   Sip._(

diff --git a/lib/domain/services/sip_service.dart b/lib/domain/services/sip_service.dart
@@ -1,6 +1,6 @@
 import 'package:wealth_wave/api/apis/sip_api.dart';
 import 'package:wealth_wave/api/apis/transaction_api.dart';
-import 'package:wealth_wave/contract/sip_frequency.dart';
+import 'package:wealth_wave/contract/frequency.dart';
 import 'package:wealth_wave/domain/models/sip.dart';
 
 class SipService {
@@ -23,7 +23,7 @@ class SipService {
           required final double amount,
           required final DateTime startDate,
           required final DateTime? endDate,
-          required final SipFrequency frequency}) =>
+          required final Frequency frequency}) =>
       _sipApi
           .create(
               investmentId: investmentId,
@@ -56,7 +56,7 @@ class SipService {
           required final double amount,
           required final DateTime startDate,
           required final DateTime? endDate,
-          required final SipFrequency frequency}) =>
+          required final Frequency frequency}) =>
       _sipApi
           .update(
               id: sipId,

diff --git a/lib/presentation/create_sip_presenter.dart b/lib/presentation/create_sip_presenter.dart
@@ -1,4 +1,4 @@
-import 'package:wealth_wave/contract/sip_frequency.dart';
+import 'package:wealth_wave/contract/frequency.dart';
 import 'package:wealth_wave/core/presenter.dart';
 import 'package:wealth_wave/core/single_event.dart';
 import 'package:wealth_wave/domain/models/sip.dart';
@@ -28,7 +28,7 @@ class CreateSipPresenter extends Presenter<CreateSipViewState> {
     final double amount = viewState.amount;
     final DateTime startDate = viewState.startDate;
     final DateTime? endDate = viewState.endDate;
-    final SipFrequency frequency = viewState.frequency;
+    final Frequency frequency = viewState.frequency;
 
     if (idToUpdate != null) {
       _sipService
@@ -72,7 +72,7 @@ class CreateSipPresenter extends Presenter<CreateSipViewState> {
     updateViewState((viewState) => viewState.endDate = date);
   }
 
-  void onFrequencyChanged(SipFrequency frequency) {
+  void onFrequencyChanged(Frequency frequency) {
     updateViewState((viewState) => viewState.frequency = frequency);
   }
 
@@ -97,7 +97,7 @@ class CreateSipViewState {
   double amount = 0;
   DateTime startDate = DateTime.now();
   DateTime? endDate = DateTime.now().add(const Duration(days: 365));
-  SipFrequency frequency = SipFrequency.monthly;
+  Frequency frequency = Frequency.monthly;
   SingleEvent<void>? onSipCreated;
   SingleEvent<void>? onSipLoaded;
 

diff --git a/lib/presentation/sips_presenter.dart b/lib/presentation/sips_presenter.dart
@@ -1,4 +1,4 @@
-import 'package:wealth_wave/contract/sip_frequency.dart';
+import 'package:wealth_wave/contract/frequency.dart';
 import 'package:wealth_wave/core/presenter.dart';
 import 'package:wealth_wave/domain/models/sip.dart';
 import 'package:wealth_wave/domain/services/sip_service.dart';
@@ -37,7 +37,7 @@ class SipVO {
   final double amount;
   final DateTime startDate;
   final DateTime? endDate;
-  final SipFrequency frequency;
+  final Frequency frequency;
 
   SipVO._(
       {required this.id,

diff --git a/lib/ui/widgets/create_sip_dialog.dart b/lib/ui/widgets/create_sip_dialog.dart
@@ -1,6 +1,6 @@
 import 'package:flutter/material.dart';
 import 'package:flutter/services.dart';
-import 'package:wealth_wave/contract/sip_frequency.dart';
+import 'package:wealth_wave/contract/frequency.dart';
 import 'package:wealth_wave/core/page_state.dart';
 import 'package:wealth_wave/presentation/create_sip_presenter.dart';
 import 'package:wealth_wave/ui/app_dimen.dart';
@@ -140,7 +140,7 @@ class _CreateTransactionPage extends PageState<CreateSipViewState,
                   border: OutlineInputBorder()),
             ),
             const SizedBox(height: AppDimen.defaultPadding),
-            DropdownButtonFormField<SipFrequency>(
+            DropdownButtonFormField<Frequency>(
               decoration: const InputDecoration(
                   border: OutlineInputBorder(), labelText: 'Frequency'),
               hint: const Text('Frequency'),
@@ -152,31 +152,31 @@ class _CreateTransactionPage extends PageState<CreateSipViewState,
               },
               items: const [
                 DropdownMenuItem(
-                  value: SipFrequency.daily,
+                  value: Frequency.daily,
                   child: Text('Daily'),
                 ),
                 DropdownMenuItem(
-                  value: SipFrequency.weekly,
+                  value: Frequency.weekly,
                   child: Text('Weekly'),
                 ),
                 DropdownMenuItem(
-                  value: SipFrequency.biweekly,
+                  value: Frequency.biweekly,
                   child: Text('Bi Weekly'),
                 ),
                 DropdownMenuItem(
-                  value: SipFrequency.monthly,
+                  value: Frequency.monthly,
                   child: Text('Monthly'),
                 ),
                 DropdownMenuItem(
-                  value: SipFrequency.quarterly,
+                  value: Frequency.quarterly,
                   child: Text('Quarterly'),
                 ),
                 DropdownMenuItem(
-                  value: SipFrequency.halfyearly,
+                  value: Frequency.halfYearly,
                   child: Text('Half Yearly'),
                 ),
                 DropdownMenuItem(
-                  value: SipFrequency.yearly,
+                  value: Frequency.yearly,
                   child: Text('Yearly'),
                 ),
               ],