Simple debt aggregator

This commit is contained in:
2025-07-25 22:05:10 +01:00
parent 944fc1c905
commit 9ba5106c2d
9 changed files with 322 additions and 279 deletions
+139
View File
@@ -0,0 +1,139 @@
package expenses
import (
"slices"
"testing"
"github.com/stretchr/testify/assert"
)
/*
The debt calculation is pretty much the core functionality of this thing
Formula to calculate how much a given user owes:
(share * total) - payedAmount
TestCase1
A simple expense of 150 with:
Shares:
User1 0.5
User2 0.5
Payments | Debts
User1 135 | (0.5 * 150) - 135 = -60 (is owed 60)
User2 15 | (0.5 * 150) - 15 = 60 (owes 60)
Debtors: [User2: 60]
Credtiors: [User1: -60]
Kill the debts with:
User1.Debt + User2.Credit = 0 {creditor: User1, debtor: User2, debt: 60}
State Update:
Debtors: [User2: 0]
Credtiors: [User1: 0]
Summary:
User2 owes User1 60
TestCase2
An expense of 160 with:
Shares:
User1 0.3
User2 0.3
User3 0.3
User4 0.1
Payments | Debts
User1 80 | (0.5 * 160) - 80 = -32 (is owed 60)
User2 5 | (0.5 * 160) - 5 = 43 (owes 43)
User3 70 | (0.5 * 160) - 70 = -22 (is owed 22)
User4 5 | (0.5 * 160) - 5 = 11 (owes 11)
1 2
Debtors: [U2: 43, U4: 11] -> [U2: 21, U4: 11] -> [U4: 11]
1 2
Creditors: [U3: -22, U1: -32] -> [U1: -32] -> [U1: -11]
Kill the debts with:
1. User3.Credit + User2.Debt -> -22 + 43 = 21 - can pay the 22
2. User1.Credit + User2.Debt -> -32 + 21 = -11 - can only pay 21
3. User1.Credit + User4.Debt -> -11 + 11 = 0 - can pay the 11
Summary:
{creditor: U3, debtor: U2, debt: 22} - U2 owes U3 22
{creditor: U1, debtor: U2, debt: 21} - U2 owes U1 21
{creditor: U1, debtor: U4, debt: 11} - U4 owes U1 11
*/
func TestCalculateDebtsTestCase1(t *testing.T) {
expense := Expense{
ExpID: 1,
Description: "Test Exp",
Value: 150.0,
ExpType: Type{
TypeID: 1,
TypeName: "Despesa",
},
ExpCategory: Category{
CategoryID: 0,
CategoryName: "Groceries",
},
OwnerUser: User{
UserID: 1,
UserName: "ESilva",
},
ExpDate: 1753307982,
Payments: []ExpensePayment{
{
ExpPaymID: 0,
User: User{
UserID: 1,
UserName: "ESilva",
},
PayedAmount: 135,
},
{
ExpPaymID: 1,
User: User{
UserID: 2,
UserName: "Kika",
},
PayedAmount: 15,
},
},
Shares: []ExpenseShare{
{
ExpShareID: 0,
User: User{
UserID: 1,
UserName: "ESilva",
},
Share: 0.5,
},
{
ExpShareID: 1,
User: User{
UserID: 2,
UserName: "Kika",
},
Share: 0.5,
},
},
}
expectedDebts := []Debt{
{
Debtor: User{
UserID: 2,
UserName: "Kika",
},
Sum: 60,
},
}
slices.SortFunc(expectedDebts, sortBySum)
resultDebts, err := expense.calculateDebts()
if err != nil {
t.Fatalf("Debt calculation failed: %+v", err)
}
slices.SortFunc(resultDebts, sortBySum)
assert.Equal(t, expectedDebts, resultDebts)
}