From 9ba5106c2d87783e292075470ed14f8e2c361e21 Mon Sep 17 00:00:00 2001 From: Eduardo Silva Date: Fri, 25 Jul 2025 22:05:10 +0100 Subject: [PATCH] Simple debt aggregator --- src/expenses/debts.go | 53 ---------- src/expenses/debts_aux.go | 21 ---- src/expenses/debts_aux_test.go | 100 ------------------ src/expenses/debts_test.go | 105 ------------------- src/expenses/expenseDebts.go | 26 +++++ src/expenses/expenseDebts_aux.go | 42 ++++++++ src/expenses/expenseDebts_aux_test.go | 112 +++++++++++++++++++++ src/expenses/expenseDebts_test.go | 139 ++++++++++++++++++++++++++ src/go.mod | 3 + 9 files changed, 322 insertions(+), 279 deletions(-) delete mode 100644 src/expenses/debts.go delete mode 100644 src/expenses/debts_aux.go delete mode 100644 src/expenses/debts_aux_test.go delete mode 100644 src/expenses/debts_test.go create mode 100644 src/expenses/expenseDebts.go create mode 100644 src/expenses/expenseDebts_aux.go create mode 100644 src/expenses/expenseDebts_aux_test.go create mode 100644 src/expenses/expenseDebts_test.go diff --git a/src/expenses/debts.go b/src/expenses/debts.go deleted file mode 100644 index ee75cbd..0000000 --- a/src/expenses/debts.go +++ /dev/null @@ -1,53 +0,0 @@ -package expenses - -type Debt struct { - Creditor User - Debtor User - Sum float32 -} - -func sortBySum(a, b Debt) int { - if a.Sum < b.Sum { - return -1 - } - if a.Sum > b.Sum { - return 1 - } - return 0 -} - -func (e *Expense) calculateDebts() ([]Debt, error) { - // debts := []Debt{} - // - // if len(e.Shares) <= 1 { - // return debts, nil - // } - // - // if len(e.Shares) > 1 { - // userShares := userShares(e) - // userPayments := userPayments(e) - // - // for user := range userPayments { - // owed := (userShares[user] * e.Value) - userPayments[user] - // if owed > 0 { - // debts = append(debts, Debt{ - // Creditor: - // }) - // } - // } - // } - - return []Debt{ - { - Creditor: User{ - UserID: 1, - UserName: "ESilva", - }, - Debtor: User{ - UserID: 2, - UserName: "Kika", - }, - Sum: 60, - }, - }, nil -} diff --git a/src/expenses/debts_aux.go b/src/expenses/debts_aux.go deleted file mode 100644 index 78579c8..0000000 --- a/src/expenses/debts_aux.go +++ /dev/null @@ -1,21 +0,0 @@ -package expenses - -func userPayments(e *Expense) map[User]float32 { - userPayments := make(map[User]float32) - - for _, payment := range e.Payments { - userPayments[payment.User] += payment.PayedAmount - } - - return userPayments -} - -func userShares(e *Expense) map[User]float32 { - userShares := make(map[User]float32) - - for _, share := range e.Shares { - userShares[share.User] = share.Share - } - - return userShares -} diff --git a/src/expenses/debts_aux_test.go b/src/expenses/debts_aux_test.go deleted file mode 100644 index 7c34e38..0000000 --- a/src/expenses/debts_aux_test.go +++ /dev/null @@ -1,100 +0,0 @@ -package expenses - -import ( - "reflect" - "testing" -) - -var ( - user1 = User{ - UserID: 1, - UserName: "Gustavo Gomes", - } - user2 = User{ - UserID: 2, - UserName: "Paulo Fultre", - } - user3 = User{ - UserID: 3, - UserName: "Afonso Esteves", - } - - expense1 = Expense{ - ExpID: 0, - Value: 150, - Shares: []ExpenseShare{ - { - ExpShareID: 0, - User: user1, - Share: 0.4, - }, - { - ExpShareID: 1, - User: user2, - Share: 0.4, - }, - { - ExpShareID: 2, - User: user3, - Share: 0.2, - }, - }, - Payments: []ExpensePayment{ - { - ExpPaymID: 0, - User: user1, - PayedAmount: 50, - }, - { - ExpPaymID: 1, - User: user1, - PayedAmount: 50, - }, - { - ExpPaymID: 2, - User: user2, - PayedAmount: 0, - }, - { - ExpPaymID: 3, - User: user3, - PayedAmount: 40, - }, - { - ExpPaymID: 4, - User: user3, - PayedAmount: 20, - }, - }, - } -) - -func TestUserPayments(t *testing.T) { - expected := map[User]float32{ - user1: 100, - user2: 0, - user3: 60, - } - - result := userPayments(&expense1) - - if !reflect.DeepEqual(expected, result) { - t.Errorf("expected payments total and result is different:\n%+v\n%+v\n", - expected, result) - } -} - -func TestUserShares(t *testing.T) { - expected := map[User]float32{ - user1: 0.4, - user2: 0.4, - user3: 0.2, - } - - result := userShares(&expense1) - - if !reflect.DeepEqual(expected, result) { - t.Errorf("expected user shares and result is different:\n%+v\n%+v\n", - expected, result) - } -} diff --git a/src/expenses/debts_test.go b/src/expenses/debts_test.go deleted file mode 100644 index 29101f1..0000000 --- a/src/expenses/debts_test.go +++ /dev/null @@ -1,105 +0,0 @@ -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) - -// Summary: -// User2 owes User1 60 - -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{ - { - Creditor: User{ - UserID: 1, - UserName: "ESilva", - }, - 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) -} diff --git a/src/expenses/expenseDebts.go b/src/expenses/expenseDebts.go new file mode 100644 index 0000000..37b249e --- /dev/null +++ b/src/expenses/expenseDebts.go @@ -0,0 +1,26 @@ +package expenses + +type Debt struct { + Debtor User + Sum float32 +} + +func sortBySum(a, b Debt) int { + if a.Sum < b.Sum { + return -1 + } + if a.Sum > b.Sum { + return 1 + } + return 0 +} + +func (e *Expense) calculateDebts() ([]Debt, error) { + dc := NewDebtCalculator(e) + dc.mapShares() + dc.mapPayments() + + debts := dc.getDebts() + + return debts, nil +} diff --git a/src/expenses/expenseDebts_aux.go b/src/expenses/expenseDebts_aux.go new file mode 100644 index 0000000..c5ef4d7 --- /dev/null +++ b/src/expenses/expenseDebts_aux.go @@ -0,0 +1,42 @@ +package expenses + +type DebtCalculator struct { + Shares map[User]float32 + Payments map[User]float32 + Expense *Expense +} + +func NewDebtCalculator(e *Expense) *DebtCalculator { + return &DebtCalculator{ + Shares: make(map[User]float32), + Payments: make(map[User]float32), + Expense: e, + } +} + +func (dc *DebtCalculator) mapShares() { + for _, share := range dc.Expense.Shares { + dc.Shares[share.User] = share.Share + dc.Payments[share.User] = 0 + } +} + +func (dc *DebtCalculator) mapPayments() { + for _, payment := range dc.Expense.Payments { + dc.Payments[payment.User] += payment.PayedAmount + } +} + +func (dc *DebtCalculator) getDebts() []Debt { + debts := []Debt{} + + for user := range dc.Payments { + debt := (dc.Shares[user] * dc.Expense.Value) - dc.Payments[user] + + if debt > 0 { + debts = append(debts, Debt{Debtor: user, Sum: debt}) + } + } + + return debts +} diff --git a/src/expenses/expenseDebts_aux_test.go b/src/expenses/expenseDebts_aux_test.go new file mode 100644 index 0000000..ce4c743 --- /dev/null +++ b/src/expenses/expenseDebts_aux_test.go @@ -0,0 +1,112 @@ +package expenses + +import ( + "reflect" + "slices" + "testing" +) + +var ( + user1 = User{ + UserID: 1, + UserName: "Fernando Silva", + } + user2 = User{ + UserID: 2, + UserName: "Paulo Fultre", + } + user3 = User{ + UserID: 3, + UserName: "Afonso Esteves", + } + user4 = User{ + UserID: 4, + UserName: "Sílvio Vieira", + } + + expense1 = Expense{ + ExpID: 0, + Value: 150, + Shares: []ExpenseShare{ + {ExpShareID: 0, User: user1, Share: 0.4}, + {ExpShareID: 1, User: user2, Share: 0.4}, + {ExpShareID: 2, User: user3, Share: 0.2}, + }, + Payments: []ExpensePayment{ + {ExpPaymID: 0, User: user1, PayedAmount: 50}, + {ExpPaymID: 1, User: user1, PayedAmount: 50}, + {ExpPaymID: 2, User: user2, PayedAmount: 0}, + {ExpPaymID: 3, User: user3, PayedAmount: 40}, + {ExpPaymID: 4, User: user3, PayedAmount: 20}, + }, + } + + expense2 = Expense{ + ExpID: 0, + Value: 160, + Shares: []ExpenseShare{ + {ExpShareID: 0, User: user1, Share: 0.3}, + {ExpShareID: 1, User: user2, Share: 0.3}, + {ExpShareID: 2, User: user3, Share: 0.3}, + {ExpShareID: 3, User: user4, Share: 0.1}, + }, + Payments: []ExpensePayment{ + {ExpPaymID: 0, User: user1, PayedAmount: 40}, + {ExpPaymID: 1, User: user1, PayedAmount: 40}, + {ExpPaymID: 2, User: user2, PayedAmount: 5}, + {ExpPaymID: 3, User: user3, PayedAmount: 30}, + {ExpPaymID: 3, User: user3, PayedAmount: 30}, + {ExpPaymID: 3, User: user3, PayedAmount: 10}, + {ExpPaymID: 4, User: user4, PayedAmount: 4}, + {ExpPaymID: 5, User: user4, PayedAmount: 1}, + }, + } +) + +func TestSharesAndPaymentsMapping(t *testing.T) { + expectedPayments := map[User]float32{ + user1: 100, + user2: 0, + user3: 60, + } + + expectedShares := map[User]float32{ + user1: 0.4, + user2: 0.4, + user3: 0.2, + } + + dc := NewDebtCalculator(&expense1) + dc.mapShares() + dc.mapPayments() + + if !reflect.DeepEqual(expectedPayments, dc.Payments) { + t.Errorf("expected payments total and result is different:\n%+v\n%+v\n", + expectedPayments, dc.Payments) + } + + if !reflect.DeepEqual(expectedShares, dc.Shares) { + t.Errorf("expected user shares and result is different:\n%+v\n%+v\n", + expectedShares, dc.Shares) + } +} + +func TestFilterExpenseParticipants(t *testing.T) { + expectedDebtors := []Debt{ + {user2, 43}, + {user4, 11}, + } + slices.SortFunc(expectedDebtors, sortBySum) + + dc := NewDebtCalculator(&expense2) + dc.mapShares() + dc.mapPayments() + + debts := dc.getDebts() + slices.SortFunc(debts, sortBySum) + + if !reflect.DeepEqual(expectedDebtors, debts) { + t.Errorf("expected creditors and resulting creditors don't match:\n%+v\n%+v\n", + expectedDebtors, debts) + } +} diff --git a/src/expenses/expenseDebts_test.go b/src/expenses/expenseDebts_test.go new file mode 100644 index 0000000..0c10dfa --- /dev/null +++ b/src/expenses/expenseDebts_test.go @@ -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) +} diff --git a/src/go.mod b/src/go.mod index 9442d5f..2f7ed66 100644 --- a/src/go.mod +++ b/src/go.mod @@ -5,6 +5,7 @@ go 1.24.4 require ( github.com/gin-gonic/gin v1.10.1 github.com/mattn/go-sqlite3 v1.14.28 + github.com/stretchr/testify v1.9.0 gopkg.in/yaml.v2 v2.4.0 ) @@ -13,6 +14,7 @@ require ( github.com/bytedance/sonic/loader v0.1.1 // indirect github.com/cloudwego/base64x v0.1.4 // indirect github.com/cloudwego/iasm v0.2.0 // indirect + github.com/davecgh/go-spew v1.1.1 // indirect github.com/gabriel-vasile/mimetype v1.4.3 // indirect github.com/gin-contrib/sse v0.1.0 // indirect github.com/go-playground/locales v0.14.1 // indirect @@ -26,6 +28,7 @@ require ( github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect github.com/modern-go/reflect2 v1.0.2 // indirect github.com/pelletier/go-toml/v2 v2.2.2 // indirect + github.com/pmezard/go-difflib v1.0.0 // indirect github.com/twitchyliquid64/golang-asm v0.15.1 // indirect github.com/ugorji/go/codec v1.2.12 // indirect golang.org/x/arch v0.8.0 // indirect