From 7ed6c896665cedcf487333ddc823f1045f260742 Mon Sep 17 00:00:00 2001 From: Eduardo Silva Date: Sun, 17 Aug 2025 23:16:55 +0100 Subject: [PATCH] Added the SharesEven column logic --- src/expenses/db/queries/expenses.sql | 5 +- src/expenses/db/repository/expenses.sql.go | 11 +- src/expenses/expenseDebts.go | 56 ++++++--- src/expenses/expenseDebts_aux.go | 9 +- src/expenses/expenseDebts_aux_test.go | 126 ++++++++++++--------- src/expenses/expenseDebts_test.go | 49 +++++++- src/expenses/expenses.go | 55 ++++++++- src/expenses/expenses_test.go | 16 +++ src/expenses/models/expense.go | 3 + src/expenses/models/expenseDebts.go | 17 +++ 10 files changed, 269 insertions(+), 78 deletions(-) create mode 100644 src/expenses/models/expenseDebts.go diff --git a/src/expenses/db/queries/expenses.sql b/src/expenses/db/queries/expenses.sql index cbedee0..f752173 100644 --- a/src/expenses/db/queries/expenses.sql +++ b/src/expenses/db/queries/expenses.sql @@ -48,9 +48,10 @@ INSERT INTO expenses( "OwnerUserID", "ExpDate", "PaidOff", + "SharesEven", "CreationDate" ) -VALUES(?, ?, ? , ?, ?, ?, ?, ?, ?); +VALUES(?, ?, ? , ?, ?, ?, ?, ?, ?, ?); -- name: DeleteExpense :execresult DELETE FROM expenses WHERE "ExpID" = ?; @@ -64,5 +65,7 @@ SET "CategoryID" = ?, "TypeID" = ?, "OwnerUserID" = ?, + "PaidOff" = ?, + "SharesEven" = ?, "ExpDate" = ? WHERE "ExpID" = ?; diff --git a/src/expenses/db/repository/expenses.sql.go b/src/expenses/db/repository/expenses.sql.go index 7940ecb..85e2198 100644 --- a/src/expenses/db/repository/expenses.sql.go +++ b/src/expenses/db/repository/expenses.sql.go @@ -163,9 +163,10 @@ INSERT INTO expenses( "OwnerUserID", "ExpDate", "PaidOff", + "SharesEven", "CreationDate" ) -VALUES(?, ?, ? , ?, ?, ?, ?, ?, ?) +VALUES(?, ?, ? , ?, ?, ?, ?, ?, ?, ?) ` type InsertExpenseParams struct { @@ -177,6 +178,7 @@ type InsertExpenseParams struct { OwnerUserID int64 ExpDate int64 PaidOff bool + SharesEven bool CreationDate int64 } @@ -190,6 +192,7 @@ func (q *Queries) InsertExpense(ctx context.Context, arg InsertExpenseParams) (s arg.OwnerUserID, arg.ExpDate, arg.PaidOff, + arg.SharesEven, arg.CreationDate, ) } @@ -203,6 +206,8 @@ SET "CategoryID" = ?, "TypeID" = ?, "OwnerUserID" = ?, + "PaidOff" = ?, + "SharesEven" = ?, "ExpDate" = ? WHERE "ExpID" = ? ` @@ -214,6 +219,8 @@ type UpdateExpenseParams struct { CategoryID int64 TypeID int64 OwnerUserID int64 + PaidOff bool + SharesEven bool ExpDate int64 ExpID int64 } @@ -226,6 +233,8 @@ func (q *Queries) UpdateExpense(ctx context.Context, arg UpdateExpenseParams) (s arg.CategoryID, arg.TypeID, arg.OwnerUserID, + arg.PaidOff, + arg.SharesEven, arg.ExpDate, arg.ExpID, ) diff --git a/src/expenses/expenseDebts.go b/src/expenses/expenseDebts.go index 5af780b..792013b 100644 --- a/src/expenses/expenseDebts.go +++ b/src/expenses/expenseDebts.go @@ -3,15 +3,10 @@ package expenses import ( mod "expenses/expenses/models" - "github.com/shopspring/decimal" + dec "github.com/shopspring/decimal" ) -type Debt struct { - Debtor mod.User - Sum decimal.Decimal -} - -func sortBySum(a, b Debt) int { +func sortBySum(a, b mod.Debt) int { if a.Sum.LessThan(b.Sum) { return -1 } @@ -23,12 +18,47 @@ func sortBySum(a, b Debt) int { return 0 } -func CalculateDebts(e *mod.Expense) ([]Debt, error) { - dc := NewDebtCalculator(e) - dc.mapShares() - dc.mapPayments() +func filterExpenseParticipants(e *mod.Expense, +) (map[mod.User]dec.Decimal, map[mod.User]dec.Decimal) { + shares := mapShares(e) + payments := mapPayments(e) - debts := dc.getDebts() + debtors := make(map[mod.User]dec.Decimal) + creditors := make(map[mod.User]dec.Decimal) - return debts, nil + for user, share := range shares { + debt := (share.Mul(e.Value)).Sub(payments[user]) + if debt.LessThan(dec.NewFromFloat(0.0)) { + creditors[user] = debt.Abs() + } + + if debt.GreaterThan(dec.NewFromFloat(0.0)) { + debtors[user] = debt.Abs() + } + } + + return debtors, creditors +} + +func resolveDebts(debtors map[mod.User]dec.Decimal, + creditors map[mod.User]dec.Decimal) []mod.Debt { + debts := []mod.Debt{} + + // maybe create a map point to the debt of each user and count from there? + // I should sketch this one first + + return debts +} + +func CalculateDebts(e *mod.Expense) ([]mod.Debt, error) { + // dc := NewDebtCalculator(e) + // dc.mapShares() + // dc.mapPayments() + // + // debts := dc.getDebts() + + debtors, creditors := filterExpenseParticipants(e) + debts := resolveDebts(debtors, creditors) + + return []mod.Debt{}, nil } diff --git a/src/expenses/expenseDebts_aux.go b/src/expenses/expenseDebts_aux.go index d89976e..c6bb12f 100644 --- a/src/expenses/expenseDebts_aux.go +++ b/src/expenses/expenseDebts_aux.go @@ -20,6 +20,9 @@ func NewDebtCalculator(e *mod.Expense) *DebtCalculator { } } +// TODO +// This code will be replicated in the expenses controller but without +// the dc func (dc *DebtCalculator) mapShares() { for _, share := range dc.Expense.Shares { dc.Shares[share.User] = share.Share @@ -33,15 +36,15 @@ func (dc *DebtCalculator) mapPayments() { } } -func (dc *DebtCalculator) getDebts() []Debt { - debts := []Debt{} +func (dc *DebtCalculator) getDebts() []mod.Debt { + debts := []mod.Debt{} for user := range dc.Payments { // debt := (dc.Shares[user] * dc.Expense.Value) - dc.Payments[user] debt := (dc.Shares[user].Mul(dc.Expense.Value)).Sub(dc.Payments[user]) if debt.GreaterThan(decimal.NewFromInt(0)) { - debts = append(debts, Debt{Debtor: user, Sum: debt}) + debts = append(debts, mod.Debt{Debtor: user, Sum: debt}) } } diff --git a/src/expenses/expenseDebts_aux_test.go b/src/expenses/expenseDebts_aux_test.go index 02fd1ef..6f0b8e3 100644 --- a/src/expenses/expenseDebts_aux_test.go +++ b/src/expenses/expenseDebts_aux_test.go @@ -2,8 +2,6 @@ package expenses import ( mod "expenses/expenses/models" - "reflect" - "slices" "testing" "github.com/shopspring/decimal" @@ -28,6 +26,8 @@ var ( UserName: "Sílvio Vieira", } + // this expense isn't evenly shared + // this expense is paid off expense1 = mod.Expense{ ExpID: 0, Value: decimal.NewFromInt(150), @@ -40,11 +40,13 @@ var ( {ExpPaymID: 0, User: user1, PayedAmount: decimal.NewFromInt(50)}, {ExpPaymID: 1, User: user1, PayedAmount: decimal.NewFromInt(50)}, {ExpPaymID: 2, User: user2, PayedAmount: decimal.NewFromInt(0)}, - {ExpPaymID: 3, User: user3, PayedAmount: decimal.NewFromInt(40)}, + {ExpPaymID: 3, User: user3, PayedAmount: decimal.NewFromInt(30)}, {ExpPaymID: 4, User: user3, PayedAmount: decimal.NewFromInt(20)}, }, } + // Expense isn't evenly shared + // Expense is paid off expense2 = mod.Expense{ ExpID: 0, Value: decimal.NewFromInt(160), @@ -59,58 +61,80 @@ var ( {ExpPaymID: 1, User: user1, PayedAmount: decimal.NewFromInt(40)}, {ExpPaymID: 2, User: user2, PayedAmount: decimal.NewFromInt(5)}, {ExpPaymID: 3, User: user3, PayedAmount: decimal.NewFromInt(30)}, - {ExpPaymID: 3, User: user3, PayedAmount: decimal.NewFromInt(30)}, - {ExpPaymID: 3, User: user3, PayedAmount: decimal.NewFromInt(10)}, - {ExpPaymID: 4, User: user4, PayedAmount: decimal.NewFromInt(4)}, - {ExpPaymID: 5, User: user4, PayedAmount: decimal.NewFromInt(1)}, + {ExpPaymID: 4, User: user3, PayedAmount: decimal.NewFromInt(30)}, + {ExpPaymID: 5, User: user3, PayedAmount: decimal.NewFromInt(10)}, + {ExpPaymID: 6, User: user4, PayedAmount: decimal.NewFromInt(4)}, + {ExpPaymID: 7, User: user4, PayedAmount: decimal.NewFromInt(1)}, + }, + } + + // Expense is: evenly shared and paid off + expense3 = mod.Expense{ + ExpID: 0, + Value: decimal.NewFromInt(160), + Shares: []mod.ExpenseShare{ + {ExpShareID: 0, User: user1, Share: decimal.NewFromFloat(0.3)}, + {ExpShareID: 1, User: user2, Share: decimal.NewFromFloat(0.3)}, + {ExpShareID: 2, User: user3, Share: decimal.NewFromFloat(0.3)}, + {ExpShareID: 3, User: user4, Share: decimal.NewFromFloat(0.1)}, + }, + Payments: []mod.ExpensePayment{ + {ExpPaymID: 0, User: user1, PayedAmount: decimal.NewFromInt(40)}, + {ExpPaymID: 1, User: user1, PayedAmount: decimal.NewFromInt(8)}, + {ExpPaymID: 2, User: user2, PayedAmount: decimal.NewFromInt(48)}, + {ExpPaymID: 3, User: user3, PayedAmount: decimal.NewFromInt(15)}, + {ExpPaymID: 4, User: user3, PayedAmount: decimal.NewFromInt(15)}, + {ExpPaymID: 5, User: user3, PayedAmount: decimal.NewFromInt(18)}, + {ExpPaymID: 6, User: user4, PayedAmount: decimal.NewFromInt(8)}, + {ExpPaymID: 7, User: user4, PayedAmount: decimal.NewFromInt(8)}, }, } ) func TestSharesAndPaymentsMapping(t *testing.T) { - expectedPayments := map[mod.User]float32{ - user1: 100, - user2: 0, - user3: 60, - } - - expectedShares := map[mod.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) - } + // expectedPayments := map[mod.User]float32{ + // user1: 100, + // user2: 0, + // user3: 60, + // } + // + // expectedShares := map[mod.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, decimal.NewFromInt(43)}, - {user4, decimal.NewFromInt(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) - } -} +// func TestFilterExpenseParticipants(t *testing.T) { + // expectedDebtors := []Debt{ + // {user2, decimal.NewFromInt(43)}, + // {user4, decimal.NewFromInt(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 index 6d85345..bfa9b31 100644 --- a/src/expenses/expenseDebts_test.go +++ b/src/expenses/expenseDebts_test.go @@ -1,11 +1,11 @@ package expenses import ( - // mod "expenses/expenses/models" + mod "expenses/expenses/models" // "slices" - // "testing" - // - // "github.com/shopspring/decimal" + "testing" + + dec "github.com/shopspring/decimal" // "github.com/stretchr/testify/assert" ) @@ -64,6 +64,47 @@ Summary: {creditor: U1, debtor: U4, debt: 11} - U4 owes U1 11 */ +func TestFilterExpenseParticipants(t *testing.T) { + // Use expense2 here for the test + expectedCreditors := map[mod.User]dec.Decimal{ + user1: dec.NewFromFloat(32.0), + user3: dec.NewFromFloat(22.0), + } + + expectedDebtors := map[mod.User]dec.Decimal{ + user2: dec.NewFromFloat(43.0), + user4: dec.NewFromFloat(11.0), + } + + debtors, creditors := filterExpenseParticipants(&expense2) + + // Compare the creditors + for user, cred := range creditors { + val, ok := expectedCreditors[user] + if !ok { + t.Errorf("Expected user `%+v` to be present in expectedCreditors `%+v`", + user, expectedCreditors) + } + + if !val.Equal(cred) { + t.Errorf("Expected value `%+v` to be `%+v`", cred, val) + } + } + + // Compare the debtors + for user, cred := range debtors { + val, ok := expectedDebtors[user] + if !ok { + t.Errorf("Expected user `%+v` to be present in expectedCreditors `%+v`", + user, expectedDebtors) + } + + if !val.Equal(cred) { + t.Errorf("Expected value `%+v` to be `%+v`", cred, val) + } + } +} + // func TestCalculateDebtsTestCase1(t *testing.T) { // expense := mod.Expense{ // ExpID: 1, diff --git a/src/expenses/expenses.go b/src/expenses/expenses.go index 0336ea3..f98330a 100644 --- a/src/expenses/expenses.go +++ b/src/expenses/expenses.go @@ -110,16 +110,62 @@ func (s *Service) DeleteExpense(id int64) error { return tx.Commit() } +func mapShares(e *mod.Expense) map[mod.User]decimal.Decimal { + shares := make(map[mod.User]decimal.Decimal) + for _, share := range e.Shares { + shares[share.User] = share.Share + } + + return shares +} + +func mapPayments(e *mod.Expense) map[mod.User]decimal.Decimal { + payments := make(map[mod.User]decimal.Decimal) + for _, p := range e.Payments { + payments[p.User] = payments[p.User].Add(p.PayedAmount) + } + + return payments +} + func ExpenseTotalPayed(exp *mod.Expense) decimal.Decimal { total := decimal.NewFromFloat(0.0) for _, p := range exp.Payments { - log.Println(total) total = total.Add(p.PayedAmount) } return total } +func ExpenseIsEvenlyShared(exp *mod.Expense) bool { + shares := mapShares(exp) + payments := mapPayments(exp) + + for user, share := range shares { + userShare := share.Mul(exp.Value) + val, userHasPayment := payments[user] + + // If a user doesn't even have a payment but has a share, its not even + if !userHasPayment { + return false + } + + if !val.Equal(userShare) { + return false + } + } + + return true +} + +func analyzeExpense(e *mod.Expense) { + // Figure out if its paid off or not by adding the existing payments + e.PaidOff = e.Value.Equal(ExpenseTotalPayed(e)) + + // Figure out if its evenly shared by the people associated to it + e.SharesEven = ExpenseIsEvenlyShared(e) +} + func (s *Service) NewExpense(exp mod.Expense) error { tx, err := s.DB.Begin() if err != nil { @@ -127,10 +173,7 @@ func (s *Service) NewExpense(exp mod.Expense) error { } defer tx.Rollback() - // Figure out if its paid off or not by adding the existing payments - exp.PaidOff = exp.Value.Equal(ExpenseTotalPayed(&exp)) - - // Figure out if its evenly shared by the people associated to it + analyzeExpense(&exp) err = exp.Insert(tx) if err != nil { @@ -147,6 +190,8 @@ func (s *Service) UpdateExpense(exp mod.Expense) error { } defer tx.Rollback() + analyzeExpense(&exp) + err = exp.Update(tx) if err != nil { return err diff --git a/src/expenses/expenses_test.go b/src/expenses/expenses_test.go index 8f542ad..958ffdc 100644 --- a/src/expenses/expenses_test.go +++ b/src/expenses/expenses_test.go @@ -15,3 +15,19 @@ func TestExpenseTotalPayed(t *testing.T) { t.Errorf("Expected %v, got %v\n", result, expectedTotal) } } + +func TestExpenseIsEvenlyShared(t *testing.T) { + // expense3 is evenly shared + expected := true + result := ExpenseIsEvenlyShared(&expense3) + if expected != result { + t.Errorf("Expected %v, got %v\n", expected, result) + } + + // expense1 isn't evenly shared + expected = false + result = ExpenseIsEvenlyShared(&expense1) + if expected != result { + t.Errorf("Expected %v, got %v\n", expected, result) + } +} diff --git a/src/expenses/models/expense.go b/src/expenses/models/expense.go index fc41a1e..2646d65 100644 --- a/src/expenses/models/expense.go +++ b/src/expenses/models/expense.go @@ -84,6 +84,7 @@ func (exp *Expense) Insert(tx *sql.Tx) error { OwnerUserID: exp.Owner.UserID, ExpDate: exp.Date, PaidOff: exp.PaidOff, + SharesEven: exp.SharesEven, CreationDate: exp.CreationDate, }) if err != nil { @@ -149,6 +150,8 @@ func (e *Expense) Update(tx *sql.Tx) error { CategoryID: e.Category.CategoryID, TypeID: e.Type.TypeID, OwnerUserID: e.Owner.UserID, + PaidOff: e.PaidOff, + SharesEven: e.SharesEven, ExpDate: e.Date, }) if err != nil { diff --git a/src/expenses/models/expenseDebts.go b/src/expenses/models/expenseDebts.go new file mode 100644 index 0000000..d1a2b28 --- /dev/null +++ b/src/expenses/models/expenseDebts.go @@ -0,0 +1,17 @@ +package models + +import ( + "github.com/shopspring/decimal" +) + +type Debt struct { + Creditor User + Debtor User + Sum decimal.Decimal +} + +func (d *Debt) Insert() { +} + +// func (d *Debt) Update() { +// }