me/flutter-expense-tracker
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 3 Wiki Activity

Successfully migrate the application to SQLIte!

Browse Source
This commit is contained in:
Hyperling
2025-02-07 15:29:20 -07:00
parent 5425b22ba2
commit ef58a06dfa
8 changed files with 535 additions and 292 deletions
Download Patch File Download Diff File Expand all files Collapse all files

112
lib/db.dart
View File

@ -1,45 +1,101 @@
// https://docs.flutter.dev/cookbook/persistence/sqlite
// SQLite
import 'dart:io';
import 'dart:async';
import 'package:flutter/widgets.dart';
import 'package:flutter_expense_tracker/models/frequency.dart';
import 'package:path/path.dart';
import 'package:path_provider/path_provider.dart';
import 'package:sqflite/sqflite.dart';
import 'package:flutter/material.dart';
// Local
import '/models/frequency.dart';
import '/models/expense.dart';
void loadDB() async {
// Avoid errors caused by flutter upgrade.
WidgetsFlutterBinding.ensureInitialized();
// Leaned on this example:
// https://learnflutterwithme.com/sqlite
class DatabaseHelper {
DatabaseHelper._privateConstructor();
static final DatabaseHelper instance = DatabaseHelper._privateConstructor();
final String frequencies =
"'${Frequency.values.map((freq) => freq.title).join("','")}'";
print(frequencies);
static Database? _db;
Future<Database> get db async => _db ??= await _initDatabase();
// Open the database and store the reference.
final database = openDatabase(
// Set the path to the database. Note: Using the `join` function from the
// `path` package is best practice to ensure the path is correctly
// constructed for each platform.
join(await getDatabasesPath(), 'expense_tracker.db'),
Future<Database> _initDatabase() async {
Directory documentsDirectory = await getApplicationDocumentsDirectory();
String path = join(documentsDirectory.path, "com_hyperling_expense.db");
return await openDatabase(
path,
version: 1,
onCreate: _onCreate,
);
}
onCreate: (db, version) {
// Run the CREATE TABLE statement on the database.
return db.execute(
"""
Future _onCreate(Database db, int version) async {
await db.execute("""
CREATE TABLE expense
( id INTEGER PRIMARY KEY
, name TEXT
, cost DOUBLE
, frequency TEXT CHECK(frequency IN ($frequencies) )
, name TEXT NOT NULL UNIQUE
, cost DOUBLE NOT NULL
, frequency TEXT NOT NULL
, description TEXT
)""",
);
},
// Set the version. This executes the onCreate function and provides a
// path to perform database upgrades and downgrades.
version: 1,
);
)
""");
}
/// Expense Section
///
Future<List<Expense>> getExpenses() async {
Database db = await instance.db;
var expenses = await db.query("expense", orderBy: "name");
List<Expense> expenseList = expenses.isNotEmpty
? expenses.map((c) => Expense.fromMap(c)).toList()
: [];
return expenseList;
}
Future<int> addExpense(Expense expense) async {
Database db = await instance.db;
return await db.insert(
"expense",
expense.toMap(),
);
}
Future<int> removeExpense(int id) async {
Database db = await instance.db;
return await db.delete(
"expense",
where: "id = ?",
whereArgs: [id],
);
}
Future<int> updateExpense(Expense expense) async {
Database db = await instance.db;
return await db.update(
"expense",
expense.toMap(),
where: "id = ?",
whereArgs: [expense.id],
);
}
Future<bool> checkExpenseNameExists(String name) async {
Database db = await instance.db;
var expenses = await db.query("expense",
where: "name = ?", whereArgs: [name],);
return expenses.isNotEmpty;
}
///
/// Income Section
///
///
/// Liquid Asset Section
///
}

143
lib/main.dart
View File

@ -2,16 +2,36 @@
import 'package:flutter/material.dart';
// Local
import '/pages/expense.dart';
import '/pages/income.dart';
import '/pages/asset.dart';
import '/pages/report.dart';
import '/pages/settings.dart';
import '/pages/help.dart';
import '/db.dart';
import '/pages/home.dart';
// SQLite
import 'dart:io';
import 'package:sqflite_common_ffi/sqflite_ffi.dart';
import 'package:path/path.dart';
import 'package:path_provider/path_provider.dart';
const bool testing = true;
void main() {
loadDB();
// I see no good explanations of why to use this other package yet, but
// trying this to see if it fixes the DB factory errors.
// "Unhandled Exception: Bad state: databaseFactory not initialized databaseFactory is only initialized when using sqflite. When using `sqflite_common_ffi`You must call `databaseFactory = databaseFactoryFfi;` before using global openDatabase API
// https://stackoverflow.com/questions/76158800/databasefactory-not-initialized-when-using-sqflite-in-flutter
if (Platform.isWindows || Platform.isLinux) {
// Initialize FFI
sqfliteFfiInit();
databaseFactory = databaseFactoryFfi;
}
WidgetsFlutterBinding.ensureInitialized();
if (testing) {
() async {
Directory documentsDirectory = await getApplicationDocumentsDirectory();
String path = join(documentsDirectory.path, 'com_hyperling_expense.db');
await deleteDatabase(path);
}();
}
runApp(const MainApp());
}
@ -36,110 +56,3 @@ class MainApp extends StatelessWidget {
);
}
}
class HomePage extends StatefulWidget {
const HomePage({
super.key,
});
@override
State<HomePage> createState() => _HomePageState();
}
class _HomePageState extends State<HomePage> {
var pageSelected = 0;
refresh() {
setState(() {});
}
@override
Widget build(BuildContext context) {
Widget page;
Widget? dialog;
switch (pageSelected) {
case 0:
page = ExpensePage();
dialog = ExpenseInputDialog(
notifyParent: refresh,
);
case 1:
page = IncomePage();
case 2:
page = AssetPage();
case 3:
page = ProjectionPage();
case 4:
page = SettingsPage();
case 5:
page = HelpPage();
default:
throw UnimplementedError('No widget for page $pageSelected yet!');
}
Future<void> addNewValue(BuildContext context) {
return showDialog(
context: context,
builder: (_) => AlertDialog(content: dialog),
);
}
Widget? floatingButton;
if (dialog != null) {
floatingButton = IconButton(
onPressed: () {
addNewValue(context);
},
icon: Icon(Icons.add),
color: Theme.of(context).colorScheme.onSurface,
);
}
return LayoutBuilder(builder: (context, constraints) {
return Scaffold(
appBar: AppBar(title: Text("Expense Tracker")),
drawer: NavigationRail(
extended: true,
destinations: [
NavigationRailDestination(
icon: Icon(Icons.payment),
label: Text('Expenses'),
),
NavigationRailDestination(
icon: Icon(Icons.account_balance),
label: Text('Income'),
),
NavigationRailDestination(
icon: Icon(Icons.attach_money),
label: Text('Liquid Assets'),
),
NavigationRailDestination(
icon: Icon(Icons.bar_chart),
label: Text('Reports'),
),
NavigationRailDestination(
icon: Icon(Icons.settings),
label: Text('Settings'),
),
NavigationRailDestination(
icon: Icon(Icons.help),
label: Text('Help'),
),
],
selectedIndex: pageSelected,
onDestinationSelected: (value) {
setState(() {
pageSelected = value;
Navigator.pop(context);
});
},
),
body: Container(
color: Theme.of(context).colorScheme.primaryContainer,
child: Center(child: page),
),
floatingActionButton: floatingButton,
);
});
}
}

36
lib/models/expense.dart
View File

@ -1,20 +1,24 @@
import '/models/frequency.dart';
class Expense {
final int? id;
final String name;
final double cost;
final Frequency frequency;
final String description;
const Expense(
{required this.name,
required this.cost,
required this.frequency,
required this.description});
const Expense({
this.id,
required this.name,
required this.cost,
required this.frequency,
required this.description,
});
@override
String toString() {
return "$name, $cost, ${frequency.title}, $description";
//return "$name, $cost, ${frequency.title}, $description";
return toMap().toString();
}
double calcComparableCost() {
@ -24,4 +28,24 @@ class Expense {
double calcComparableCostDaily() {
return cost / frequency.numDays;
}
factory Expense.fromMap(Map<String, dynamic> json) => Expense(
id: json['id'],
name: json['name'],
cost: json['cost'],
frequency: Frequency.values
.where((expense) => expense.title == json['frequency'])
.first,
description: json['description'],
);
Map<String, dynamic> toMap() {
return {
'id': id,
'name': name,
'cost': cost,
'frequency': frequency.title,
'description': description,
};
}
}

314
lib/pages/expense.dart
View File

@ -1,12 +1,13 @@
// Flutter
import 'dart:nativewrappers/_internal/vm/lib/ffi_allocation_patch.dart';
import 'package:flutter/material.dart';
import 'package:flutter_expense_tracker/db.dart';
// Local
import '/models/expense.dart';
import '/models/frequency.dart';
List<Expense> expenses = [];
class ExpensePage extends StatefulWidget {
const ExpensePage({
super.key,
@ -25,139 +26,154 @@ class _ExpensePageState extends State<ExpensePage> {
Widget build(BuildContext context) {
final theme = Theme.of(context);
expenses.sort(
(a, b) => (b.calcComparableCost() - a.calcComparableCost()).toInt(),
);
return expenses.isEmpty
? Text("Add expenses to get started!")
: ListView.builder(
itemCount: expenses.length,
itemBuilder: (_, index) {
final Expense curr = expenses[index];
final String estimateSymbolYearly = curr.frequency.timesPerYear
.toStringAsFixed(2)
.endsWith(".00") &&
curr.calcComparableCost().toStringAsFixed(3).endsWith("0")
? ""
: "~";
final String estimateSymbolDaily =
curr.frequency.numDays.toStringAsFixed(2).endsWith(".00") &&
curr
.calcComparableCostDaily()
.toStringAsFixed(3)
.endsWith("0")
? ""
: "~";
return Padding(
padding: const EdgeInsets.all(4.0),
child: Dismissible(
key: Key(curr.toString()),
background: Container(
color: Colors.red,
child: Row(
mainAxisAlignment: MainAxisAlignment.start,
children: [
Icon(Icons.delete),
Text("Delete"),
],
),
),
secondaryBackground: Container(
color: Colors.orange,
child: Row(
mainAxisAlignment: MainAxisAlignment.end,
children: [
Text("Edit"),
Icon(Icons.edit),
],
),
),
onDismissed: (direction) {
setState(() {
expenses.remove(curr);
});
switch (direction) {
case DismissDirection.startToEnd:
// Only remove the item from the list.
break;
case DismissDirection.endToStart:
// Open an edit dialog, then remove the item from the list.
showDialog(
context: context,
builder: (_) => AlertDialog(
content: ExpenseInputDialog(
notifyParent: refresh,
expense: curr,
),
),
);
break;
default:
UnimplementedError(
"Direction ${direction.toString()} not recognized.",
);
}
},
child: Container(
decoration: BoxDecoration(
borderRadius: BorderRadius.circular(4),
color: theme.colorScheme.onPrimary,
),
child: Padding(
padding: const EdgeInsets.all(4.0),
child: Row(
mainAxisSize: MainAxisSize.max,
children: [
Column(
mainAxisSize: MainAxisSize.min,
crossAxisAlignment: CrossAxisAlignment.start,
children: [
Text(
curr.name,
style: TextStyle(fontSize: 20.0),
),
Text(
"${curr.cost.toStringAsFixed(2)} ${curr.frequency.title}",
style: TextStyle(fontSize: 12.0),
),
],
),
Expanded(
child: Center(
child: Text(
curr.description,
style: TextStyle(
fontSize: 12.0,
),
softWrap: true,
textAlign: TextAlign.center,
),
),
),
Column(
crossAxisAlignment: CrossAxisAlignment.end,
children: [
//if (curr.frequency != Frequency.daily)
Text(
"$estimateSymbolDaily${curr.calcComparableCostDaily().toStringAsFixed(2)} ${Frequency.daily.title}",
style: TextStyle(fontSize: 12.0),
),
//if (curr.frequency != Frequency.yearly)
Text(
"$estimateSymbolYearly${curr.calcComparableCost().toStringAsFixed(2)} ${Frequency.yearly.title}",
style: TextStyle(fontSize: 12.0),
),
],
),
],
),
),
),
),
);
},
return FutureBuilder<List<Expense>>(
future: DatabaseHelper.instance.getExpenses(),
builder: (BuildContext context, AsyncSnapshot<List<Expense>> snapshot) {
if (!snapshot.hasData) {
return Center(child: Text('Loading...'));
}
snapshot.data!.sort(
(a, b) => (b.calcComparableCost() - a.calcComparableCost()).toInt(),
);
return snapshot.data!.isEmpty
? Text(
"Add expenses to get started.",
softWrap: true,
)
: ListView.builder(
itemCount: snapshot.data!.length,
itemBuilder: (_, index) {
List<Expense> expenses = snapshot.data!;
final Expense curr = expenses[index];
final String estimateSymbolYearly = curr
.frequency.timesPerYear
.toStringAsFixed(2)
.endsWith(".00") &&
curr
.calcComparableCost()
.toStringAsFixed(3)
.endsWith("0")
? ""
: "~";
final String estimateSymbolDaily = curr.frequency.numDays
.toStringAsFixed(2)
.endsWith(".00") &&
curr
.calcComparableCostDaily()
.toStringAsFixed(3)
.endsWith("0")
? ""
: "~";
return Padding(
padding: const EdgeInsets.all(4.0),
child: Dismissible(
key: Key(curr.id!.toString()),
background: Container(
color: Colors.red,
child: Row(
mainAxisAlignment: MainAxisAlignment.start,
children: [
Icon(Icons.delete),
Text("Delete"),
],
),
),
secondaryBackground: Container(
color: Colors.orange,
child: Row(
mainAxisAlignment: MainAxisAlignment.end,
children: [
Text("Edit"),
Icon(Icons.edit),
],
),
),
onDismissed: (direction) {
setState(() {
expenses.remove(curr);
switch (direction) {
case DismissDirection.startToEnd:
DatabaseHelper.instance.removeExpense(curr.id!);
break;
case DismissDirection.endToStart:
// Open an edit dialog, then remove the item from the list.
showDialog(
context: context,
builder: (_) => AlertDialog(
content: ExpenseInputDialog(
notifyParent: refresh,
expense: curr,
),
),
);
break;
default:
UnimplementedError(
"Direction ${direction.toString()} not recognized.",
);
}
});
},
child: Container(
decoration: BoxDecoration(
borderRadius: BorderRadius.circular(4),
color: theme.colorScheme.onPrimary,
),
child: Padding(
padding: const EdgeInsets.all(4.0),
child: Row(
mainAxisSize: MainAxisSize.max,
children: [
Column(
mainAxisSize: MainAxisSize.min,
crossAxisAlignment: CrossAxisAlignment.start,
children: [
Text(
curr.name,
style: TextStyle(fontSize: 20.0),
),
Text(
"${curr.cost.toStringAsFixed(2)} ${curr.frequency.title}",
style: TextStyle(fontSize: 12.0),
),
],
),
Expanded(
child: Center(
child: Text(
curr.description,
style: TextStyle(
fontSize: 12.0,
),
softWrap: true,
textAlign: TextAlign.center,
),
),
),
Column(
crossAxisAlignment: CrossAxisAlignment.end,
children: [
//if (curr.frequency != Frequency.daily)
Text(
"$estimateSymbolDaily${curr.calcComparableCostDaily().toStringAsFixed(2)} ${Frequency.daily.title}",
style: TextStyle(fontSize: 12.0),
),
//if (curr.frequency != Frequency.yearly)
Text(
"$estimateSymbolYearly${curr.calcComparableCost().toStringAsFixed(2)} ${Frequency.yearly.title}",
style: TextStyle(fontSize: 12.0),
),
],
),
],
),
),
),
),
);
},
);
});
}
}
@ -178,6 +194,7 @@ class ExpenseInputDialog extends StatefulWidget {
class _ExpenseInputDialogState extends State<ExpenseInputDialog> {
final _expenseFormKey = GlobalKey<FormState>();
int? _id;
String _name = "";
double _cost = 0;
Frequency _freq = Frequency.monthly;
@ -186,6 +203,7 @@ class _ExpenseInputDialogState extends State<ExpenseInputDialog> {
@override
Widget build(BuildContext context) {
if (widget.expense != null) {
_id = widget.expense!.id;
_name = widget.expense!.name;
_cost = widget.expense!.cost;
_freq = widget.expense!.frequency;
@ -202,7 +220,7 @@ class _ExpenseInputDialogState extends State<ExpenseInputDialog> {
onPressed: () {
if (widget.expense != null) {
setState(() {
expenses.add(widget.expense!);
DatabaseHelper.instance.addExpense(widget.expense!);
widget.notifyParent();
});
}
@ -237,9 +255,12 @@ class _ExpenseInputDialogState extends State<ExpenseInputDialog> {
if (value!.isEmpty) {
return "Name must be provided.";
}
if (!expenses.every((expense) => expense.name != value)) {
// TODO: Figure out how to check the DB if a name already exists.
/*
if (DatabaseHelper.instance.checkExpenseNameExists(value)) {
return "Name must be unique, already in use.";
}
*/
return null;
},
onSaved: (value) {
@ -341,13 +362,22 @@ class _ExpenseInputDialogState extends State<ExpenseInputDialog> {
if (_expenseFormKey.currentState!.validate()) {
_expenseFormKey.currentState!.save();
setState(() {
expenses.add(
Expense(
name: _name,
cost: _cost,
frequency: _freq,
description: _desc),
Expense expense = Expense(
id: _id,
name: _name,
cost: _cost,
frequency: _freq,
description: _desc,
);
if (_id != null) {
DatabaseHelper.instance.updateExpense(
expense,
);
} else {
DatabaseHelper.instance.addExpense(
expense,
);
}
});
widget.notifyParent();
Navigator.of(context).pop();

119
lib/pages/home.dart Normal file
View File

@ -0,0 +1,119 @@
// Flutter
import 'package:flutter/material.dart';
// Local
import '/pages/expense.dart';
import '/pages/income.dart';
import '/pages/asset.dart';
import '/pages/report.dart';
import '/pages/settings.dart';
import '/pages/help.dart';
class HomePage extends StatefulWidget {
const HomePage({
super.key,
});
@override
State<HomePage> createState() => _HomePageState();
}
class _HomePageState extends State<HomePage> {
var pageSelected = 0;
refresh() {
setState(() {});
}
@override
Widget build(BuildContext context) {
Widget page;
Widget? dialog;
switch (pageSelected) {
case 0:
page = ExpensePage();
dialog = ExpenseInputDialog(
notifyParent: refresh,
);
case 1:
page = IncomePage();
case 2:
page = AssetPage();
case 3:
page = ProjectionPage();
case 4:
page = SettingsPage();
case 5:
page = HelpPage();
default:
throw UnimplementedError('No widget for page $pageSelected yet!');
}
Future<void> addNewValue(BuildContext context) {
return showDialog(
context: context,
builder: (_) => AlertDialog(content: dialog),
);
}
Widget? floatingButton;
if (dialog != null) {
floatingButton = IconButton(
onPressed: () {
addNewValue(context);
},
icon: Icon(Icons.add),
color: Theme.of(context).colorScheme.onSurface,
);
}
return LayoutBuilder(builder: (context, constraints) {
return Scaffold(
appBar: AppBar(
title: Text("Expense Tracker"),
),
drawer: NavigationRail(
extended: true,
destinations: [
NavigationRailDestination(
icon: Icon(Icons.payment),
label: Text('Expenses'),
),
NavigationRailDestination(
icon: Icon(Icons.account_balance),
label: Text('Income'),
),
NavigationRailDestination(
icon: Icon(Icons.attach_money),
label: Text('Liquid Assets'),
),
NavigationRailDestination(
icon: Icon(Icons.bar_chart),
label: Text('Reports'),
),
NavigationRailDestination(
icon: Icon(Icons.settings),
label: Text('Settings'),
),
NavigationRailDestination(
icon: Icon(Icons.help),
label: Text('Help'),
),
],
selectedIndex: pageSelected,
onDestinationSelected: (value) {
setState(() {
pageSelected = value;
Navigator.pop(context);
});
},
),
body: Container(
color: Theme.of(context).colorScheme.primaryContainer,
child: Center(child: page),
),
floatingActionButton: floatingButton,
);
});
}
}