feat(categories)!: Ability to delete Categories and consequences on transactions and recurring transactions

lib/constants/constants.dart

@@ -20,6 +20,7 @@ const Map<String, IconData> iconList = {
   'device_thermostat': Icons.device_thermostat,
   'dry_cleaning': Icons.dry_cleaning,
   'work': Icons.work,
+  'question_mark': Icons.question_mark,
 };
 
 const Map<String, IconData> accountIconList = {
@@ -31,6 +32,7 @@ const Map<String, IconData> accountIconList = {
 
 // colors
 const categoryColorList = [
+  category0,
   category1,
   category2,
   category3,
@@ -43,6 +45,7 @@ const categoryColorList = [
 ];
 
 const darkCategoryColorList = [
+  darkCategory0,
   darkCategory1,
   darkCategory2,
   darkCategory3,

lib/constants/style.dart

@@ -35,6 +35,7 @@ const grey1 = Color(0xFF666666);
 const grey2 = Color(0xFFB9BABC);
 const grey3 = Color(0xFFF4F4F4);
 
+const category0 = Color(0xFFB9BABC);
 const category1 = Color(0xFFEDC31C);
 const category2 = Color(0xFFF68428);
 const category3 = Color(0xFFFF4754);
@@ -71,6 +72,7 @@ const darkGrey2 = Color(0xFFC6C7C8);
 const darkGrey3 = Color(0xFF181E25);
 const darkGrey4 = Color(0xFF2E3338);
 
+const darkCategory0 = Color(0xFFB9BABC);
 const darkCategory1 = Color(0xFFE3B912);
 const darkCategory2 = Color(0xFFF6740C);
 const darkCategory3 = Color(0xFFFA3240);

lib/database/migrations/0004_category_marked_as_deleted.dart

@@ -0,0 +1,25 @@
+// ignore_for_file: file_names
+
+import 'package:sqflite/sqflite.dart';
+import '../migration_base.dart';
+
+// Models
+import '/model/category_transaction.dart';
+
+class CategoryMarkedAsDeleted extends Migration {
+  CategoryMarkedAsDeleted()
+      : super(
+          version: 4,
+          description: 'Add deleted column to CategoryTransaction model',
+        );
+
+  @override
+  Future<void> up(Database db) async {
+    const integerNotNull = 'INTEGER NOT NULL';
+
+    // CategoryTransactionTable
+    await db.execute('''
+      ALTER TABLE `$categoryTransactionTable` ADD COLUMN `${CategoryTransactionFields.deleted}` $integerNotNull DEFAULT 0;
+    ''');
+  }
+}

lib/database/migrations/0005_uncategorized_default_category.dart

@@ -0,0 +1,25 @@
+// ignore_for_file: file_names
+
+import 'package:sqflite/sqflite.dart';
+import '../migration_base.dart';
+
+// Models
+import '/model/category_transaction.dart';
+
+class UncategorizedDefaultCategory extends Migration {
+  UncategorizedDefaultCategory()
+      : super(
+          version: 5,
+          description: 'Create default "Uncategorized" category',
+        );
+
+  @override
+  Future<void> up(Database db) async {
+    // Default "Uncategorized" Category
+    await db.execute('''
+      INSERT INTO `$categoryTransactionTable`(`${CategoryTransactionFields.id}`, `${CategoryTransactionFields.name}`, `${CategoryTransactionFields.type}`, `${CategoryTransactionFields.symbol}`, `${CategoryTransactionFields.color}`, `${CategoryTransactionFields.note}`, `${CategoryTransactionFields.parent}`, `${CategoryTransactionFields.deleted}`, `${CategoryTransactionFields.createdAt}`, `${CategoryTransactionFields.updatedAt}`) VALUES
+        (0, "Uncategorized", "IN", "question_mark", 0, 'This is a default category for no categorized transactions', null, '0', '${DateTime.now()}', '${DateTime.now()}'),
+        (1, "Uncategorized", "OUT", "question_mark", 0, 'This is a default category for no categorized transactions', null, '0', '${DateTime.now()}', '${DateTime.now()}');
+    ''');
+  }
+}

lib/database/migrations/migration_registry.dart

@@ -14,6 +14,8 @@ library;
 import '0001_initial_schema.dart';
 import '0002_account_net_worth.dart';
 import '0003_recurring_transaction_type.dart';
+import '0004_category_marked_as_deleted.dart';
+import '0005_uncategorized_default_category.dart';
 import '../migration_base.dart';
 
 /// Returns all available migrations in execution order.
@@ -27,6 +29,8 @@ List<Migration> getMigrations() {
     InitialSchema(),
     AccountNetWorth(),
     RecurringTransactionType(),
+    CategoryMarkedAsDeleted(),
+    UncategorizedDefaultCategory(),
     // Add future migrations here
   ];
 }

lib/database/sossoldi_database.dart

@@ -205,14 +205,16 @@ class SossoldiDatabase {
 
     // Add fake categories
     await _database?.execute('''
-      INSERT INTO categoryTransaction(id, name, type, symbol, color, note, parent, createdAt, updatedAt) VALUES
-        (10, "Out", "OUT", "restaurant", 0, '', null, '${DateTime.now()}', '${DateTime.now()}'),
-        (11, "Home", "OUT", "home", 1, '', null, '${DateTime.now()}', '${DateTime.now()}'),
-        (12, "Furniture","OUT", "home", 2, '', 11, '${DateTime.now()}', '${DateTime.now()}'),
-        (13, "Shopping", "OUT", "shopping_cart", 3, '', null, '${DateTime.now()}', '${DateTime.now()}'),
-        (14, "Leisure", "OUT", "subscriptions", 4, '', null, '${DateTime.now()}', '${DateTime.now()}'),
-        (15, "Transports", "OUT", "directions_car_rounded", 6, '', null, '${DateTime.now()}', '${DateTime.now()}'),
-        (16, "Salary", "IN", "work", 5, '', null, '${DateTime.now()}', '${DateTime.now()}');
+      INSERT OR IGNORE INTO categoryTransaction(id, name, type, symbol, color, note, parent, deleted, createdAt, updatedAt) VALUES
+        (0, "Uncategorized", "IN", "question_mark", 0, 'This is a default category for no categorized transactions', null, '0', '${DateTime.now()}', '${DateTime.now()}'),
+        (1, "Uncategorized", "OUT", "question_mark", 0, 'This is a default category for no categorized transactions', null, '0', '${DateTime.now()}', '${DateTime.now()}'),
+        (10, "Out", "OUT", "restaurant", 1, '', null, 0, '${DateTime.now()}', '${DateTime.now()}'),
+        (11, "Home", "OUT", "home", 2, '', null, 0, '${DateTime.now()}', '${DateTime.now()}'),
+        (12, "Furniture","OUT", "home", 3, '', 11, 0, '${DateTime.now()}', '${DateTime.now()}'),
+        (13, "Shopping", "OUT", "shopping_cart", 4, '', null, 0, '${DateTime.now()}', '${DateTime.now()}'),
+        (14, "Leisure", "OUT", "subscriptions", 5, '', null, 0, '${DateTime.now()}', '${DateTime.now()}'),
+        (15, "Transports", "OUT", "directions_car_rounded", 6, '', null, 0, '${DateTime.now()}', '${DateTime.now()}'),
+        (16, "Salary", "IN", "work", 5, '', null, 0, '${DateTime.now()}', '${DateTime.now()}');
     ''');
 
     // Add currencies

lib/model/bank_account.dart

@@ -360,10 +360,10 @@ class BankAccountMethods extends SossoldiDatabase {
   }
 
   Future<List> accountMonthlyBalance(
-      int accountId, {
-        DateTime? dateRangeStart,
-        DateTime? dateRangeEnd,
-      }) async {
+    int accountId, {
+    DateTime? dateRangeStart,
+    DateTime? dateRangeEnd,
+  }) async {
     final db = await database;
 
     final accountFilter =
@@ -402,8 +402,8 @@ class BankAccountMethods extends SossoldiDatabase {
     if (dateRangeStart != null) {
       return result
           .where((element) => dateRangeStart.isBefore(
-          DateTime.parse(("${element["month"]}-01").toString())
-              .add(const Duration(days: 1))))
+              DateTime.parse(("${element["month"]}-01").toString())
+                  .add(const Duration(days: 1))))
           .toList();
     }
 

lib/model/category_transaction.dart

@@ -12,6 +12,7 @@ class CategoryTransactionFields extends BaseEntityFields {
   static String color = 'color';
   static String note = 'note';
   static String parent = 'parent';
+  static String deleted = 'deleted';
   static String createdAt = BaseEntityFields.getCreatedAt;
   static String updatedAt = BaseEntityFields.getUpdatedAt;
 
@@ -23,11 +24,49 @@ class CategoryTransactionFields extends BaseEntityFields {
     color,
     note,
     parent,
+    deleted,
     BaseEntityFields.createdAt,
     BaseEntityFields.updatedAt
   ];
 }
 
+class CategoryFilter {
+  final bool showSystemCategories;
+  final bool showDeletedCategories;
+
+  const CategoryFilter({
+    this.showSystemCategories = false,
+    this.showDeletedCategories = false,
+  });
+
+  //Avoid useless Riverpod recostructions
+  @override
+  bool operator ==(Object other) {
+    if (identical(this, other)) return true;
+    return other is CategoryFilter &&
+        other.showSystemCategories == showSystemCategories &&
+        other.showDeletedCategories == showDeletedCategories;
+  }
+
+  @override
+  int get hashCode =>
+      showSystemCategories.hashCode ^ showDeletedCategories.hashCode;
+}
+
+const userCategoriesFilter = CategoryFilter(
+  showSystemCategories: false,
+  showDeletedCategories: false,
+);
+
+const availableCategoriesFilter = CategoryFilter(
+  showSystemCategories: true,
+  showDeletedCategories: false,
+);
+const allCategoriesFilter = CategoryFilter(
+  showSystemCategories: true,
+  showDeletedCategories: true,
+);
+
 enum CategoryTransactionType { income, expense }
 
 Map<String, CategoryTransactionType> categoryTypeMap = {
@@ -42,6 +81,7 @@ class CategoryTransaction extends BaseEntity {
   final int color;
   final String? note;
   final int? parent;
+  final bool deleted;
 
   const CategoryTransaction({
     super.id,
@@ -51,6 +91,7 @@ class CategoryTransaction extends BaseEntity {
     required this.color,
     this.note,
     this.parent,
+    required this.deleted,
     super.createdAt,
     super.updatedAt,
   });
@@ -63,6 +104,7 @@ class CategoryTransaction extends BaseEntity {
           int? color,
           String? note,
           int? parent,
+          bool? deleted,
           DateTime? createdAt,
           DateTime? updatedAt}) =>
       CategoryTransaction(
@@ -73,6 +115,7 @@ class CategoryTransaction extends BaseEntity {
           color: color ?? this.color,
           note: note ?? this.note,
           parent: parent ?? this.parent,
+          deleted: deleted ?? this.deleted,
           createdAt: createdAt ?? this.createdAt,
           updatedAt: updatedAt ?? this.updatedAt);
 
@@ -86,6 +129,7 @@ class CategoryTransaction extends BaseEntity {
           color: json[CategoryTransactionFields.color] as int,
           note: json[CategoryTransactionFields.note] as String?,
           parent: json[CategoryTransactionFields.parent] as int?,
+          deleted: json[CategoryTransactionFields.deleted] == 1 ? true : false,
           createdAt: DateTime.parse(json[BaseEntityFields.createdAt] as String),
           updatedAt:
               DateTime.parse(json[BaseEntityFields.updatedAt] as String));
@@ -99,6 +143,7 @@ class CategoryTransaction extends BaseEntity {
         CategoryTransactionFields.color: color,
         CategoryTransactionFields.note: note,
         CategoryTransactionFields.parent: parent,
+        CategoryTransactionFields.deleted: deleted ? 1 : 0,
         BaseEntityFields.createdAt: update
             ? createdAt?.toIso8601String()
             : DateTime.now().toIso8601String(),
@@ -141,6 +186,39 @@ class CategoryTransactionMethods extends SossoldiDatabase {
     return result.map((json) => CategoryTransaction.fromJson(json)).toList();
   }
 
+  Future<List<CategoryTransaction>> selectCategories(
+      CategoryFilter filter) async {
+    final db = await database;
+
+    String whereClause = '';
+    List<dynamic> whereArgs = [];
+
+    // showSystemCategories == false => no uncategorized
+    if (!filter.showSystemCategories) {
+      whereClause =
+          '${CategoryTransactionFields.id} != ? AND ${CategoryTransactionFields.id} != ?';
+      whereArgs = [0, 1];
+    }
+
+    // showDeletedCategories == false => no deleted
+    if (!filter.showDeletedCategories) {
+      if (whereClause.isNotEmpty) {
+        whereClause += ' AND ';
+      }
+      whereClause += '${CategoryTransactionFields.deleted} = ?';
+      whereArgs.add(0);
+    }
+
+    final result = await db.query(
+      categoryTransactionTable,
+      where: whereClause.isNotEmpty ? whereClause : null,
+      whereArgs: whereArgs.isNotEmpty ? whereArgs : null,
+      orderBy: orderByASC,
+    );
+
+    return result.map((json) => CategoryTransaction.fromJson(json)).toList();
+  }
+
   Future<List<CategoryTransaction>> selectCategoriesByType(
       CategoryTransactionType type) async {
     final db = await database;
@@ -173,6 +251,17 @@ class CategoryTransactionMethods extends SossoldiDatabase {
     );
   }
 
+  Future<int> markAsDeleted(int id) async {
+    final db = await database;
+
+    return await db.update(
+      categoryTransactionTable,
+      {CategoryTransactionFields.deleted: 1},
+      where: '${CategoryTransactionFields.id} = ?',
+      whereArgs: [id],
+    );
+  }
+
   Future<int> deleteById(int id) async {
     final db = await database;
 

lib/pages/account_page/account_page.dart

@@ -37,7 +37,7 @@ class _AccountPage extends ConsumerState<AccountPage> {
   Widget build(BuildContext context) {
     final account = ref.read(selectedAccountProvider);
     final accountTransactions =
-      ref.watch(selectedAccountCurrentYearMonthlyBalanceProvider);
+        ref.watch(selectedAccountCurrentYearMonthlyBalanceProvider);
     final transactions = ref.watch(selectedAccountLastTransactions);
     final currencyState = ref.watch(currencyStateNotifier);