From 06aafa4ee10659b50e03872160c398d025257845 Mon Sep 17 00:00:00 2001 From: Eduardo Silva Date: Wed, 13 Aug 2025 23:49:03 +0100 Subject: [PATCH] Adding the PaidOff column to the Apps logic Also had to readd a schema.sql file because sqlc was failing at parsing the migrations directory correctly --- src/cmd/debts.go | 24 ++++ src/expenses/db/queries/expenses.sql | 9 +- src/expenses/db/repository/expenses.sql.go | 19 ++- src/expenses/db/repository/models.go | 2 + src/expenses/db/schema.sql | 57 ++++++++ src/expenses/db/sqlc.yaml | 2 +- src/expenses/expenseDebts_aux_test.go | 51 +++---- src/expenses/expenseDebts_test.go | 160 +++++++++++---------- src/expenses/expenses.go | 17 +++ src/expenses/expenses_test.go | 17 +++ src/expenses/models/expense.go | 5 + src/expenses/models/expenseRepoMap.go | 4 + 12 files changed, 255 insertions(+), 112 deletions(-) create mode 100644 src/cmd/debts.go create mode 100644 src/expenses/expenses_test.go diff --git a/src/cmd/debts.go b/src/cmd/debts.go new file mode 100644 index 0000000..1813a95 --- /dev/null +++ b/src/cmd/debts.go @@ -0,0 +1,24 @@ +package cmd + +import ( + "log" + + "github.com/spf13/cobra" +) + +func debts(cmd *cobra.Command, args []string) { + log.Println("Added the debts command!") +} + +// shelf +var debtsCmd = &cobra.Command{ + Use: "debts", + Short: "", + Long: ``, + Args: nil, + Run: debts, +} + +func init() { + rootCmd.AddCommand(debtsCmd) +} diff --git a/src/expenses/db/queries/expenses.sql b/src/expenses/db/queries/expenses.sql index 8e08a00..cbedee0 100644 --- a/src/expenses/db/queries/expenses.sql +++ b/src/expenses/db/queries/expenses.sql @@ -40,14 +40,17 @@ WHERE -- name: InsertExpense :execresult INSERT INTO expenses( - "Description","Value", + "Description", + "Value", "StoreID", "CategoryID", "TypeID", "OwnerUserID", - "ExpDate","CreationDate" + "ExpDate", + "PaidOff", + "CreationDate" ) -VALUES(?, ?, ? , ?, ?, ?, ?, ?); +VALUES(?, ?, ? , ?, ?, ?, ?, ?, ?); -- name: DeleteExpense :execresult DELETE FROM expenses WHERE "ExpID" = ?; diff --git a/src/expenses/db/repository/expenses.sql.go b/src/expenses/db/repository/expenses.sql.go index c540552..7940ecb 100644 --- a/src/expenses/db/repository/expenses.sql.go +++ b/src/expenses/db/repository/expenses.sql.go @@ -20,7 +20,7 @@ func (q *Queries) DeleteExpense(ctx context.Context, expid int64) (sql.Result, e const getExpense = `-- name: GetExpense :one SELECT - expenses.ExpID, expenses.Description, expenses.Value, expenses.StoreID, expenses.CategoryID, expenses.OwnerUserID, expenses.TypeID, expenses.ExpDate, expenses.CreationDate, + expenses.ExpID, expenses.Description, expenses.Value, expenses.StoreID, expenses.CategoryID, expenses.OwnerUserID, expenses.TypeID, expenses.ExpDate, expenses.CreationDate, expenses.PaidOff, expenses.SharesEven, stores.StoreID, stores.StoreName, categories.CategoryID, categories.CategoryName, users.UserID, users.UserName, users.UserPass, @@ -59,6 +59,8 @@ func (q *Queries) GetExpense(ctx context.Context, expid int64) (GetExpenseRow, e &i.Expense.TypeID, &i.Expense.ExpDate, &i.Expense.CreationDate, + &i.Expense.PaidOff, + &i.Expense.SharesEven, &i.Store.StoreID, &i.Store.StoreName, &i.Category.CategoryID, @@ -74,7 +76,7 @@ func (q *Queries) GetExpense(ctx context.Context, expid int64) (GetExpenseRow, e const getExpenses = `-- name: GetExpenses :many SELECT - expenses.ExpID, expenses.Description, expenses.Value, expenses.StoreID, expenses.CategoryID, expenses.OwnerUserID, expenses.TypeID, expenses.ExpDate, expenses.CreationDate, + expenses.ExpID, expenses.Description, expenses.Value, expenses.StoreID, expenses.CategoryID, expenses.OwnerUserID, expenses.TypeID, expenses.ExpDate, expenses.CreationDate, expenses.PaidOff, expenses.SharesEven, stores.StoreID, stores.StoreName, categories.CategoryID, categories.CategoryName, users.UserID, users.UserName, users.UserPass, @@ -126,6 +128,8 @@ func (q *Queries) GetExpenses(ctx context.Context, arg GetExpensesParams) ([]Get &i.Expense.TypeID, &i.Expense.ExpDate, &i.Expense.CreationDate, + &i.Expense.PaidOff, + &i.Expense.SharesEven, &i.Store.StoreID, &i.Store.StoreName, &i.Category.CategoryID, @@ -151,14 +155,17 @@ func (q *Queries) GetExpenses(ctx context.Context, arg GetExpensesParams) ([]Get const insertExpense = `-- name: InsertExpense :execresult INSERT INTO expenses( - "Description","Value", + "Description", + "Value", "StoreID", "CategoryID", "TypeID", "OwnerUserID", - "ExpDate","CreationDate" + "ExpDate", + "PaidOff", + "CreationDate" ) -VALUES(?, ?, ? , ?, ?, ?, ?, ?) +VALUES(?, ?, ? , ?, ?, ?, ?, ?, ?) ` type InsertExpenseParams struct { @@ -169,6 +176,7 @@ type InsertExpenseParams struct { TypeID int64 OwnerUserID int64 ExpDate int64 + PaidOff bool CreationDate int64 } @@ -181,6 +189,7 @@ func (q *Queries) InsertExpense(ctx context.Context, arg InsertExpenseParams) (s arg.TypeID, arg.OwnerUserID, arg.ExpDate, + arg.PaidOff, arg.CreationDate, ) } diff --git a/src/expenses/db/repository/models.go b/src/expenses/db/repository/models.go index 0a72d89..65f51da 100644 --- a/src/expenses/db/repository/models.go +++ b/src/expenses/db/repository/models.go @@ -19,6 +19,8 @@ type Expense struct { TypeID int64 ExpDate int64 CreationDate int64 + PaidOff bool + SharesEven bool } type ExpenseType struct { diff --git a/src/expenses/db/schema.sql b/src/expenses/db/schema.sql index e69de29..203d055 100644 --- a/src/expenses/db/schema.sql +++ b/src/expenses/db/schema.sql @@ -0,0 +1,57 @@ +-- TODO +-- Check why sqlc doesn't correctly parse all my migrations +-- This should only be a workaround :c + +CREATE TABLE categories( + "CategoryID" integer PRIMARY KEY AUTOINCREMENT, + "CategoryName" text NOT NULL +) + +CREATE TABLE "expenseTypes"( + "TypeID" integer PRIMARY KEY AUTOINCREMENT, + "TypeName" text NOT NULL +) + +CREATE TABLE "expenses" ( + "ExpID" INTEGER PRIMARY KEY AUTOINCREMENT, + "Description" TEXT NOT NULL, + "Value" TEXT NOT NULL DEFAULT 0, + "StoreID" int NOT NULL DEFAULT 0, + "CategoryID" int NOT NULL DEFAULT 0, + "OwnerUserID" int NOT NULL DEFAULT 0, + "TypeID" int NOT NULL DEFAULT 0, + "ExpDate" int NOT NULL DEFAULT -1, + "CreationDate" int NOT NULL DEFAULT -1, + "PaidOff" BOOL NOT NULL DEFAULT FALSE, + "SharesEven" BOOL NOT NULL DEFAULT FALSE, + FOREIGN KEY(StoreID) REFERENCES stores(StoreID) ON DELETE RESTRICT, + FOREIGN KEY(CategoryID) REFERENCES categories(CategoryID) ON DELETE RESTRICT, + FOREIGN KEY(OwnerUserID) REFERENCES users(UserID) ON DELETE RESTRICT, + FOREIGN KEY(TypeID) REFERENCES expensetypes(TypeID) ON DELETE RESTRICT +) +CREATE TABLE "expensesPayments" ( + "ExpPaymID" integer PRIMARY KEY AUTOINCREMENT, + "ExpID" int NOT NULL, + "UserID" int NOT NULL, + "Payed" TEXT NOT NULL DEFAULT 0, + FOREIGN KEY(ExpID) REFERENCES expenses(ExpID) ON DELETE RESTRICT, + FOREIGN KEY(UserID) REFERENCES users(UserID) ON DELETE RESTRICT +) +CREATE TABLE "expensesShares" ( + "ExpShareID" integer PRIMARY KEY AUTOINCREMENT, + "ExpID" int NOT NULL, + "UserID" int NOT NULL, + "Share" TEXT NOT NULL DEFAULT 0.5, + FOREIGN KEY(ExpID) REFERENCES expenses(ExpID) ON DELETE RESTRICT, + FOREIGN KEY(UserID) REFERENCES users(UserID) ON DELETE RESTRICT +) +CREATE TABLE stores( + "StoreID" integer PRIMARY KEY AUTOINCREMENT, + "StoreName" text NOT NULL +) + +CREATE TABLE users( + "UserID" integer PRIMARY KEY AUTOINCREMENT, + "UserName" text NOT NULL, + "UserPass" text NOT NULL +) diff --git a/src/expenses/db/sqlc.yaml b/src/expenses/db/sqlc.yaml index 17c0529..11f3e46 100644 --- a/src/expenses/db/sqlc.yaml +++ b/src/expenses/db/sqlc.yaml @@ -2,7 +2,7 @@ version: "2" sql: - engine: "sqlite" queries: "queries/" - schema: "migrations/" + schema: "schema.sql" gen: go: package: "repository" diff --git a/src/expenses/expenseDebts_aux_test.go b/src/expenses/expenseDebts_aux_test.go index 9d3c0b4..02fd1ef 100644 --- a/src/expenses/expenseDebts_aux_test.go +++ b/src/expenses/expenseDebts_aux_test.go @@ -5,9 +5,12 @@ import ( "reflect" "slices" "testing" + + "github.com/shopspring/decimal" ) var ( + // Use this data across the other tests if necessary user1 = mod.User{ UserID: 1, UserName: "Fernando Silva", @@ -27,39 +30,39 @@ var ( expense1 = mod.Expense{ ExpID: 0, - Value: 150, + Value: decimal.NewFromInt(150), Shares: []mod.ExpenseShare{ - {ExpShareID: 0, User: user1, Share: 0.4}, - {ExpShareID: 1, User: user2, Share: 0.4}, - {ExpShareID: 2, User: user3, Share: 0.2}, + {ExpShareID: 0, User: user1, Share: decimal.NewFromFloat(0.4)}, + {ExpShareID: 1, User: user2, Share: decimal.NewFromFloat(0.4)}, + {ExpShareID: 2, User: user3, Share: decimal.NewFromFloat(0.2)}, }, Payments: []mod.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}, + {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: 4, User: user3, PayedAmount: decimal.NewFromInt(20)}, }, } expense2 = mod.Expense{ ExpID: 0, - Value: 160, + Value: decimal.NewFromInt(160), Shares: []mod.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}, + {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: 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}, + {ExpPaymID: 0, User: user1, PayedAmount: decimal.NewFromInt(40)}, + {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)}, }, } ) @@ -94,8 +97,8 @@ func TestSharesAndPaymentsMapping(t *testing.T) { func TestFilterExpenseParticipants(t *testing.T) { expectedDebtors := []Debt{ - {user2, 43}, - {user4, 11}, + {user2, decimal.NewFromInt(43)}, + {user4, decimal.NewFromInt(11)}, } slices.SortFunc(expectedDebtors, sortBySum) diff --git a/src/expenses/expenseDebts_test.go b/src/expenses/expenseDebts_test.go index 7038997..6d85345 100644 --- a/src/expenses/expenseDebts_test.go +++ b/src/expenses/expenseDebts_test.go @@ -1,10 +1,12 @@ package expenses import ( - "slices" - "testing" - - "github.com/stretchr/testify/assert" + // mod "expenses/expenses/models" + // "slices" + // "testing" + // + // "github.com/shopspring/decimal" + // "github.com/stretchr/testify/assert" ) /* @@ -62,78 +64,78 @@ Summary: {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, - Type: Type{ - TypeID: 1, - TypeName: "Despesa", - }, - Category: Category{ - CategoryID: 0, - CategoryName: "Groceries", - }, - Owner: User{ - UserID: 1, - UserName: "ESilva", - }, - Date: 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) -} +// func TestCalculateDebtsTestCase1(t *testing.T) { +// expense := mod.Expense{ +// ExpID: 1, +// Description: "Test Exp", +// Value: decimal.NewFromFloat(150.0), +// Type: mod.Type{ +// TypeID: 1, +// TypeName: "Despesa", +// }, +// Category: mod.Category{ +// CategoryID: 0, +// CategoryName: "Groceries", +// }, +// Owner: mod.User{ +// UserID: 1, +// UserName: "ESilva", +// }, +// Date: 1753307982, +// Payments: []mod.ExpensePayment{ +// { +// ExpPaymID: 0, +// User: mod.User{ +// UserID: 1, +// UserName: "ESilva", +// }, +// PayedAmount: decimal.NewFromFloat(135.0), +// }, +// { +// ExpPaymID: 1, +// User: mod.User{ +// UserID: 2, +// UserName: "Kika", +// }, +// PayedAmount: decimal.NewFromFloat(15.0), +// }, +// }, +// Shares: []mod.ExpenseShare{ +// { +// ExpShareID: 0, +// User: mod.User{ +// UserID: 1, +// UserName: "ESilva", +// }, +// Share: decimal.NewFromFloat(0.5), +// }, +// { +// ExpShareID: 1, +// User: mod.User{ +// UserID: 2, +// UserName: "Kika", +// }, +// Share: decimal.NewFromFloat(0.5), +// }, +// }, +// } +// +// expectedDebts := []Debt{ +// { +// Debtor: mod.User{ +// UserID: 2, +// UserName: "Kika", +// }, +// Sum: decimal.NewFromInt(60), +// }, +// } +// slices.SortFunc(expectedDebts, sortBySum) +// +// resultDebts, err := 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/expenses.go b/src/expenses/expenses.go index 550c669..0336ea3 100644 --- a/src/expenses/expenses.go +++ b/src/expenses/expenses.go @@ -4,6 +4,8 @@ import ( mod "expenses/expenses/models" "log" "time" + + "github.com/shopspring/decimal" ) func (s *Service) GetAllExpenses() ([]mod.Expense, error) { @@ -108,6 +110,16 @@ func (s *Service) DeleteExpense(id int64) error { return tx.Commit() } +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 (s *Service) NewExpense(exp mod.Expense) error { tx, err := s.DB.Begin() if err != nil { @@ -115,6 +127,11 @@ 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 + err = exp.Insert(tx) if err != nil { return err diff --git a/src/expenses/expenses_test.go b/src/expenses/expenses_test.go new file mode 100644 index 0000000..8f542ad --- /dev/null +++ b/src/expenses/expenses_test.go @@ -0,0 +1,17 @@ +package expenses + +import ( + "testing" + + "github.com/shopspring/decimal" +) + +func TestExpenseTotalPayed(t *testing.T) { + expectedTotal := decimal.NewFromInt(160) + + result := ExpenseTotalPayed(&expense1) + + if result.Equal(expectedTotal) { + t.Errorf("Expected %v, got %v\n", result, expectedTotal) + } +} diff --git a/src/expenses/models/expense.go b/src/expenses/models/expense.go index 43537b3..fc41a1e 100644 --- a/src/expenses/models/expense.go +++ b/src/expenses/models/expense.go @@ -22,6 +22,8 @@ type Expense struct { Date int64 Payments []ExpensePayment Shares []ExpenseShare + PaidOff bool + SharesEven bool CreationDate int64 } @@ -36,6 +38,8 @@ func NewExpense() Expense { Date: 0, Payments: []ExpensePayment{}, Shares: []ExpenseShare{}, + PaidOff: false, + SharesEven: false, CreationDate: 0, } } @@ -79,6 +83,7 @@ func (exp *Expense) Insert(tx *sql.Tx) error { TypeID: exp.Type.TypeID, OwnerUserID: exp.Owner.UserID, ExpDate: exp.Date, + PaidOff: exp.PaidOff, CreationDate: exp.CreationDate, }) if err != nil { diff --git a/src/expenses/models/expenseRepoMap.go b/src/expenses/models/expenseRepoMap.go index 1d5e6d7..5fb5324 100644 --- a/src/expenses/models/expenseRepoMap.go +++ b/src/expenses/models/expenseRepoMap.go @@ -32,6 +32,8 @@ func mapRepoGetExpenseRow(e repo.GetExpenseRow) Expense { Date: e.Expense.ExpDate, Shares: []ExpenseShare{}, Payments: []ExpensePayment{}, + PaidOff: e.Expense.PaidOff, + SharesEven: e.Expense.SharesEven, CreationDate: e.Expense.CreationDate, } } @@ -62,6 +64,8 @@ func mapRepoGetExpenseRowMulti(e repo.GetExpensesRow) Expense { Date: e.Expense.ExpDate, Shares: []ExpenseShare{}, Payments: []ExpensePayment{}, + PaidOff: e.Expense.PaidOff, + SharesEven: e.Expense.SharesEven, CreationDate: e.Expense.CreationDate, } }