From 6b782aa08d6eca81a9cdece2dd4ecf9c8727c587 Mon Sep 17 00:00:00 2001 From: Eduardo Silva Date: Thu, 18 Sep 2025 18:56:14 +0100 Subject: [PATCH] Added a filter for the expenses get all function, reduced code with that --- README.md | 9 +-- src/api/apiExpenses.go | 6 +- src/assets/htmx/overview.html | 13 ++-- src/expenses/expenses.go | 32 ++------- src/expenses/expenses_lua.go | 4 +- src/expenses/repo/expenseRepo.go.go | 18 ++++- src/expenses/repo/pg_conversions.go | 16 +++-- src/expenses/repo/pg_expenseDebtRepo.go | 2 +- src/expenses/repo/pg_expenseRepo.go | 95 +++++++++---------------- src/main.go | 4 ++ src/pages/expenses.go | 11 +-- src/pages/expensesHelper.go | 36 +++++++++- src/pages/overview.go | 14 ++-- 13 files changed, 135 insertions(+), 125 deletions(-) diff --git a/README.md b/README.md index cd5f3f0..ae059ac 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# WIP -This is a simple webapp I use to track expenses. It has many holes and things -that don't work properly, but the current feature set is: +# ExpSplitter +This is a simple webapp I use to track expenses. It's very early in development +so its far from being feature complete. The current feature set is: - Users (Authentication) - Multiple APIs: Lua API, REST API that returns JSON and of course the core `expenses` package itself that can be used separately @@ -10,7 +10,7 @@ on making the experience as seamless as possible) - Check the balance on your own expenses -There are many features to be implemented! +There are still many features to be implemented! # BUGS @@ -18,6 +18,7 @@ There are many features to be implemented! # DOING +- REST JSON API endpoints # TODO diff --git a/src/api/apiExpenses.go b/src/api/apiExpenses.go index 21af3b9..5caab46 100644 --- a/src/api/apiExpenses.go +++ b/src/api/apiExpenses.go @@ -5,6 +5,7 @@ import ( "net/http" exp "github.com/ESilva15/expenses/expenses" + "github.com/ESilva15/expenses/expenses/repo" "github.com/gin-gonic/gin" ) @@ -13,7 +14,10 @@ func getAllExpenses(c *gin.Context) { ctx := context.Background() // TODO - only get the expenses of the user // create roles tho, so an admin or someone can get way more expenses - expenses, err := exp.App.GetAllExpenses(ctx) + + eFilter := repo.NewExpFilter() + + expenses, err := exp.App.GetAllExpenses(ctx, eFilter) if err != nil { c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()}) } diff --git a/src/assets/htmx/overview.html b/src/assets/htmx/overview.html index f484b0e..521d7e5 100644 --- a/src/assets/htmx/overview.html +++ b/src/assets/htmx/overview.html @@ -1,5 +1,9 @@ {{ define "overview" }} -
+


- +

diff --git a/src/expenses/expenses.go b/src/expenses/expenses.go index 04698fb..6ca5122 100644 --- a/src/expenses/expenses.go +++ b/src/expenses/expenses.go @@ -2,19 +2,19 @@ package expenses import ( "context" - "log" - "time" mod "github.com/ESilva15/expenses/expenses/models" + "github.com/ESilva15/expenses/expenses/repo" "github.com/shopspring/decimal" ) // GetAllExpenses returns the list of Expenses in which the 'user' participates -func (a *ExpApp) GetAllExpenses(ctx context.Context) ([]mod.Expense, error) { +func (a *ExpApp) GetAllExpenses(ctx context.Context, filter repo.ExpFilter, +) ([]mod.Expense, error) { user := *ctx.Value("user").(*mod.User) - expenses, err := a.ExpRepo.GetAll(ctx, user.UserID) + expenses, err := a.ExpRepo.GetAll(ctx, filter, user.UserID) if err != nil { return []mod.Expense{}, err } @@ -22,28 +22,8 @@ func (a *ExpApp) GetAllExpenses(ctx context.Context) ([]mod.Expense, error) { return expenses, nil } -// TODO - make the GetAllExpenses and this function be only one -// GetExpensesRanged returns the list of Expenses in which the 'user' participates -func (a *ExpApp) GetExpensesRanged( - ctx context.Context, startDate string, endDate string) ([]mod.Expense, error) { - startDateTime, err := time.ParseInLocation("02-Jan-2006 15:04:05", startDate, time.UTC) - if err != nil { - log.Printf("error startDate: %v", err) - return []mod.Expense{}, nil - } - - endDateTime, err := time.ParseInLocation("02-Jan-2006 15:04:05", endDate, time.UTC) - if err != nil { - log.Printf("error endDate: %v", err) - return []mod.Expense{}, nil - } - - user := *ctx.Value("user").(*mod.User) - return a.ExpRepo.GetExpensesRange(ctx, startDateTime, endDateTime, user.UserID) -} - // TODO - we should only be able to access them if the user participates in them -// GetExpense returns a given expense by ID +// GetExpense returns a given expense by ID. func (a *ExpApp) GetExpense(id int32) (mod.Expense, error) { ctx := context.Background() @@ -109,6 +89,7 @@ func mapPayments(e *mod.Expense) map[mod.User]decimal.Decimal { return payments } +// TODO - move to the models func ExpenseTotalPayed(exp *mod.Expense) decimal.Decimal { total := decimal.NewFromFloat(0.0) for _, p := range exp.Payments { @@ -118,6 +99,7 @@ func ExpenseTotalPayed(exp *mod.Expense) decimal.Decimal { return total } +// TODO - move to the models func ExpenseIsEvenlyShared(exp *mod.Expense) bool { shares := mapShares(exp) payments := mapPayments(exp) diff --git a/src/expenses/expenses_lua.go b/src/expenses/expenses_lua.go index fbede95..052d233 100644 --- a/src/expenses/expenses_lua.go +++ b/src/expenses/expenses_lua.go @@ -5,6 +5,7 @@ import ( "encoding/json" mod "github.com/ESilva15/expenses/expenses/models" + "github.com/ESilva15/expenses/expenses/repo" lua "github.com/yuin/gopher-lua" ) @@ -25,7 +26,8 @@ func (a *ExpApp) prepareExpense(exp *mod.Expense) error { func (a *ExpApp) luaGetAllExpenses(l *lua.LState) int { ctx := context.Background() // TODO - what do we do about the LUA API - expenses, err := a.ExpRepo.GetAll(ctx, 1) + qFilter := repo.NewExpFilter() + expenses, err := a.ExpRepo.GetAll(ctx, qFilter, 1) if err != nil { return returnWithError(l, err.Error()) } diff --git a/src/expenses/repo/expenseRepo.go.go b/src/expenses/repo/expenseRepo.go.go index 98f0925..503233a 100644 --- a/src/expenses/repo/expenseRepo.go.go +++ b/src/expenses/repo/expenseRepo.go.go @@ -8,13 +8,25 @@ import ( mod "github.com/ESilva15/expenses/expenses/models" ) +// ExpFilter has the fields required to query the database. +type ExpFilter struct { + Start *time.Time + End *time.Time +} + +// NewExpFilter returns a newly initialized ExpFilter. +func NewExpFilter() ExpFilter { + return ExpFilter{ + Start: nil, + End: nil, + } +} + // ExpenseRepository defines the repository for the expense data model. type ExpenseRepository interface { // Direct expense methods Get(ctx context.Context, id int32) (mod.Expense, error) - GetAll(ctx context.Context, uID int32) (mod.Expenses, error) - GetExpensesRange(ctx context.Context, start time.Time, - end time.Time, uID int32) (mod.Expenses, error) + GetAll(ctx context.Context, filter ExpFilter, uID int32) (mod.Expenses, error) Update(ctx context.Context, exp mod.Expense) error Insert(ctx context.Context, exp mod.Expense) error Delete(ctx context.Context, id int32) error diff --git a/src/expenses/repo/pg_conversions.go b/src/expenses/repo/pg_conversions.go index 259012a..d7583e6 100644 --- a/src/expenses/repo/pg_conversions.go +++ b/src/expenses/repo/pg_conversions.go @@ -1,9 +1,10 @@ package repo import ( + "time" + "github.com/jackc/pgx/v5/pgtype" dec "github.com/shopspring/decimal" - "time" ) func decimalToNumeric(d dec.Decimal) (pgtype.Numeric, error) { @@ -28,11 +29,16 @@ func boolToPgBool(v bool) (pgtype.Bool, error) { return b, nil } -func timeToTimestamp(t time.Time) (pgtype.Timestamp, error) { +func timeToTimestamp(t *time.Time) (pgtype.Timestamp, error) { var ts pgtype.Timestamp - err := ts.Scan(t) - if err != nil { - return pgtype.Timestamp{}, err + + if t == nil { + ts.Valid = false + } else { + err := ts.Scan(*t) + if err != nil { + return pgtype.Timestamp{}, err + } } return ts, nil diff --git a/src/expenses/repo/pg_expenseDebtRepo.go b/src/expenses/repo/pg_expenseDebtRepo.go index 5037661..a89739a 100644 --- a/src/expenses/repo/pg_expenseDebtRepo.go +++ b/src/expenses/repo/pg_expenseDebtRepo.go @@ -13,7 +13,7 @@ import ( func (p PgExpRepo) SettleDebt( ctx context.Context, eID int32, payment mod.Payment, credit mod.Payment, ) error { - return withTx(p.DB, ctx, func(q *pgsqlc.Queries) error { + return withTx(ctx, p.DB, func(q *pgsqlc.Queries) error { err := p.insertPayment(ctx, q, eID, payment) if err != nil { return err diff --git a/src/expenses/repo/pg_expenseRepo.go b/src/expenses/repo/pg_expenseRepo.go index 03d90f3..035e077 100644 --- a/src/expenses/repo/pg_expenseRepo.go +++ b/src/expenses/repo/pg_expenseRepo.go @@ -3,13 +3,11 @@ package repo import ( "context" "fmt" - "time" mod "github.com/ESilva15/expenses/expenses/models" "github.com/ESilva15/expenses/expenses/repo/pgdb/pgsqlc" "github.com/jackc/pgx/v5" - "github.com/jackc/pgx/v5/pgtype" "github.com/jackc/pgx/v5/pgxpool" ) @@ -28,10 +26,10 @@ func (p PgExpRepo) Close() { } func withTx( - pgPool *pgxpool.Pool, ctx context.Context, - fn func(q *pgsqlc.Queries) error) error { - + pgPool *pgxpool.Pool, + fn func(q *pgsqlc.Queries) error, +) error { tx, err := pgPool.BeginTx(ctx, pgx.TxOptions{}) if err != nil { return err @@ -46,29 +44,30 @@ func withTx( return tx.Commit(ctx) } -func (p *PgExpRepo) getAll( - ctx context.Context, q *pgsqlc.Queries, uId int32) (mod.Expenses, error) { - // We want to select all here, no timestamps - var start pgtype.Timestamp - start.Valid = false - var end pgtype.Timestamp - end.Valid = false - - expenses, err := q.GetExpenses(ctx, pgsqlc.GetExpensesParams{ - Startdate: start, - Enddate: end, - UserID: uId, - }) +// GetAll fetches all expenses. +func (p PgExpRepo) GetAll(ctx context.Context, filter ExpFilter, uID int32, +) (mod.Expenses, error) { + startPg, err := timeToTimestamp(filter.Start) if err != nil { - return []mod.Expense{}, err + return mod.Expenses{}, err } - return mapRepoGetExpensesRows(expenses), err -} + endPg, err := timeToTimestamp(filter.End) + if err != nil { + return mod.Expenses{}, err + } -// GetAll fetches all expenses. -func (p PgExpRepo) GetAll(ctx context.Context, uID int32) (mod.Expenses, error) { - return p.getAll(ctx, pgsqlc.New(p.DB), uID) + queries := pgsqlc.New(p.DB) + expenses, err := queries.GetExpenses(ctx, pgsqlc.GetExpensesParams{ + Startdate: startPg, + Enddate: endPg, + UserID: uID, + }) + if err != nil { + return mod.Expenses{}, err + } + + return mapRepoGetExpensesRows(expenses), nil } func (p *PgExpRepo) get(ctx context.Context, q *pgsqlc.Queries, id int32) (mod.Expense, error) { @@ -88,9 +87,9 @@ func (p PgExpRepo) Get(ctx context.Context, id int32) (mod.Expense, error) { // Update updates a given expense. func (p PgExpRepo) Update( ctx context.Context, - exp mod.Expense) error { - - return withTx(p.DB, ctx, func(q *pgsqlc.Queries) error { + exp mod.Expense, +) error { + return withTx(ctx, p.DB, func(q *pgsqlc.Queries) error { value, err := decimalToNumeric(exp.Value) if err != nil { return err @@ -106,7 +105,7 @@ func (p PgExpRepo) Update( return err } - expDate, err := timeToTimestamp(exp.Date) + expDate, err := timeToTimestamp(&exp.Date) if err != nil { return err } @@ -167,9 +166,9 @@ func (p PgExpRepo) Update( func (p PgExpRepo) Insert( ctx context.Context, - exp mod.Expense) error { - - return withTx(p.DB, ctx, func(q *pgsqlc.Queries) error { + exp mod.Expense, +) error { + return withTx(ctx, p.DB, func(q *pgsqlc.Queries) error { value, err := decimalToNumeric(exp.Value) if err != nil { return err @@ -185,12 +184,12 @@ func (p PgExpRepo) Insert( return err } - expDate, err := timeToTimestamp(exp.Date) + expDate, err := timeToTimestamp(&exp.Date) if err != nil { return err } - creationDate, err := timeToTimestamp(exp.CreationDate) + creationDate, err := timeToTimestamp(&exp.CreationDate) if err != nil { return err } @@ -243,33 +242,3 @@ func (p PgExpRepo) Delete(ctx context.Context, id int32) error { return nil } - -// GetExpensesRange fetches all expenses in a given time frame. -func (p PgExpRepo) GetExpensesRange( - ctx context.Context, - start time.Time, - end time.Time, - uID int32) (mod.Expenses, error) { - - startPg, err := timeToTimestamp(start) - if err != nil { - return mod.Expenses{}, err - } - - endPg, err := timeToTimestamp(end) - if err != nil { - return mod.Expenses{}, err - } - - queries := pgsqlc.New(p.DB) - expenses, err := queries.GetExpenses(ctx, pgsqlc.GetExpensesParams{ - Startdate: startPg, - Enddate: endPg, - UserID: uID, - }) - if err != nil { - return mod.Expenses{}, err - } - - return mapRepoGetExpensesRows(expenses), nil -} diff --git a/src/main.go b/src/main.go index d835caa..cc01d75 100644 --- a/src/main.go +++ b/src/main.go @@ -3,12 +3,16 @@ package main import ( "log" + "os" "github.com/ESilva15/expenses/cmd" "github.com/ESilva15/expenses/expenses" ) func main() { + log.SetOutput(os.Stdout) + log.SetFlags(log.Ldate | log.Ltime | log.Lshortfile) + if err := expenses.StartApp(); err != nil { log.Fatal("failed to start app:", err.Error()) } diff --git a/src/pages/expenses.go b/src/pages/expenses.go index 21d524b..ec170c7 100644 --- a/src/pages/expenses.go +++ b/src/pages/expenses.go @@ -11,6 +11,7 @@ import ( exp "github.com/ESilva15/expenses/expenses" experr "github.com/ESilva15/expenses/expenses/errors" mod "github.com/ESilva15/expenses/expenses/models" + "github.com/ESilva15/expenses/expenses/repo" fatqr "github.com/ESilva15/gofatqr" "github.com/gin-gonic/gin" @@ -28,7 +29,8 @@ func expensesPartial(c *gin.Context) { return } - expenses, err := exp.App.GetAllExpenses(ctx) + eFilter := repo.NewExpFilter() + expenses, err := exp.App.GetAllExpenses(ctx, eFilter) if err != nil { c.Header("HX-Redirect", "/500") return @@ -46,7 +48,8 @@ func expensesGlobalPage(c *gin.Context) { return } - expenses, err := exp.App.GetAllExpenses(ctx) + eFilter := repo.NewExpFilter() + expenses, err := exp.App.GetAllExpenses(ctx, eFilter) if err != nil { log.Println("error:", err) ServerErrorView(c, "Could not get logged in user") @@ -190,7 +193,7 @@ func createExpense(c *gin.Context) { return } - newExp, err := expenseFromForm(c, ctx) + newExp, err := expenseFromForm(ctx, c) if err != nil { // TODO - Change this to something the user can see c.Header("HX-Redirect", "/500") @@ -220,7 +223,7 @@ func updateExpense(c *gin.Context) { return } - newExp, err := expenseFromForm(c, ctx) + newExp, err := expenseFromForm(ctx, c) if err != nil { // TODO - Change this to something the user can see c.Header("HX-Redirect", "/500") diff --git a/src/pages/expensesHelper.go b/src/pages/expensesHelper.go index cce3747..3f3aafa 100644 --- a/src/pages/expensesHelper.go +++ b/src/pages/expensesHelper.go @@ -2,21 +2,51 @@ package pages import ( "context" + "log" "time" "github.com/ESilva15/expenses/expenses" mod "github.com/ESilva15/expenses/expenses/models" + "github.com/ESilva15/expenses/expenses/repo" "github.com/gin-gonic/gin" "github.com/shopspring/decimal" ) +func expenseFilterFromQuery(c *gin.Context) (repo.ExpFilter, error) { + var err error + var start, end time.Time + filter := repo.NewExpFilter() + + startDate := c.Query("range-start") + " 00:00:00" + if startDate != "" { + start, err = time.ParseInLocation("02-Jan-2006 15:04:05", startDate, time.UTC) + if err != nil { + log.Printf("error startDate: %v", err) + return repo.ExpFilter{}, nil + } + filter.Start = &start + } + + endDate := c.Query("range-end") + " 23:59:59" + if endDate != "" { + end, err = time.ParseInLocation("02-Jan-2006 15:04:05", endDate, time.UTC) + if err != nil { + log.Printf("error endDate: %v", err) + return repo.ExpFilter{}, nil + } + filter.End = &end + } + + return filter, nil +} + func processFormShares(c *gin.Context) ([]mod.Share, error) { - userIDS := c.PostFormArray("shares-user-ids[]") + userIDs := c.PostFormArray("shares-user-ids[]") shareIDs := c.PostFormArray("shares-ids[]") shares := c.PostFormArray("shares-percent[]") - return expenses.ParseFormShares(userIDS, shares, shareIDs) + return expenses.ParseFormShares(userIDs, shares, shareIDs) } func processFormPayments(c *gin.Context) ([]mod.Payment, error) { @@ -27,7 +57,7 @@ func processFormPayments(c *gin.Context) ([]mod.Payment, error) { return expenses.ParseFormPayments(userIDs, paymentIDs, values) } -func expenseFromForm(c *gin.Context, ctx context.Context) (*mod.Expense, error) { +func expenseFromForm(ctx context.Context, c *gin.Context) (*mod.Expense, error) { newDescription := c.PostForm("expense-desc") newDate := c.PostForm("expense-date") newQR := c.PostForm("expense-qr") diff --git a/src/pages/overview.go b/src/pages/overview.go index 3acb472..7e3e37f 100644 --- a/src/pages/overview.go +++ b/src/pages/overview.go @@ -41,10 +41,12 @@ func getResults(c *gin.Context) { return } - startDate := c.PostForm("range-start") + " 00:00:00" - endDate := c.PostForm("range-end") + " 23:59:59" + filter, err := expenseFilterFromQuery(c) + if err != nil { + log.Println("error ") + } - queriedExpenses, err := exp.App.GetExpensesRanged(ctx, startDate, endDate) + queriedExpenses, err := exp.App.GetAllExpenses(ctx, filter) if err != nil { log.Printf("getting expenses: %v", err) return @@ -69,10 +71,6 @@ func getResults(c *gin.Context) { log.Printf("failed to get debts: %v", err) return } - - log.Println(queriedExpenses[k].Shares) - log.Println(queriedExpenses[k].Payments) - log.Println(queriedExpenses[k].Debts) } userDebtSummary := make(map[mod.User]decimal.Decimal) @@ -98,5 +96,5 @@ func RouteOverview(router *gin.RouterGroup) { router.GET("/overview", overviewPage) router.POST("/overview", overviewPartialPage) - router.POST("/overview/ranged", getResults) + router.GET("/overview/ranged", getResults) }