Added a filter for the expenses get all function, reduced code with that

This commit is contained in:
2025-09-18 18:56:14 +01:00
parent 09296d989b
commit 6b782aa08d
13 changed files with 135 additions and 125 deletions
+5 -4
View File
@@ -1,6 +1,6 @@
# WIP # ExpSplitter
This is a simple webapp I use to track expenses. It has many holes and things This is a simple webapp I use to track expenses. It's very early in development
that don't work properly, but the current feature set is: so its far from being feature complete. The current feature set is:
- Users (Authentication) - Users (Authentication)
- Multiple APIs: Lua API, REST API that returns JSON and of course the core - Multiple APIs: Lua API, REST API that returns JSON and of course the core
`expenses` package itself that can be used separately `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 - Check the balance on your own expenses
There are many features to be implemented! There are still many features to be implemented!
# BUGS # BUGS
@@ -18,6 +18,7 @@ There are many features to be implemented!
# DOING # DOING
- REST JSON API endpoints
# TODO # TODO
+5 -1
View File
@@ -5,6 +5,7 @@ import (
"net/http" "net/http"
exp "github.com/ESilva15/expenses/expenses" exp "github.com/ESilva15/expenses/expenses"
"github.com/ESilva15/expenses/expenses/repo"
"github.com/gin-gonic/gin" "github.com/gin-gonic/gin"
) )
@@ -13,7 +14,10 @@ func getAllExpenses(c *gin.Context) {
ctx := context.Background() ctx := context.Background()
// TODO - only get the expenses of the user // TODO - only get the expenses of the user
// create roles tho, so an admin or someone can get way more expenses // 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 { if err != nil {
c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()}) c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
} }
+6 -7
View File
@@ -1,5 +1,9 @@
{{ define "overview" }} {{ define "overview" }}
<form> <form
hx-get="/overview/ranged"
hx-target="#query-results"
hx-swap="innerHTML"
>
<p> <p>
<label for="range-start">Start date:</label> <label for="range-start">Start date:</label>
<input <input
@@ -14,12 +18,7 @@
value="" id="expense-date"><br> value="" id="expense-date"><br>
</p> </p>
<button <button type="submit" id="expenses">QUERY</button>
type="submit"
hx-post="/overview/ranged"
hx-target="#query-results"
hx-swap="innerHTML"
id="expenses">QUERY</button>
</form> </form>
<br> <br>
+7 -25
View File
@@ -2,19 +2,19 @@ package expenses
import ( import (
"context" "context"
"log"
"time"
mod "github.com/ESilva15/expenses/expenses/models" mod "github.com/ESilva15/expenses/expenses/models"
"github.com/ESilva15/expenses/expenses/repo"
"github.com/shopspring/decimal" "github.com/shopspring/decimal"
) )
// GetAllExpenses returns the list of Expenses in which the 'user' participates // 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) 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 { if err != nil {
return []mod.Expense{}, err return []mod.Expense{}, err
} }
@@ -22,28 +22,8 @@ func (a *ExpApp) GetAllExpenses(ctx context.Context) ([]mod.Expense, error) {
return expenses, nil 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 // 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) { func (a *ExpApp) GetExpense(id int32) (mod.Expense, error) {
ctx := context.Background() ctx := context.Background()
@@ -109,6 +89,7 @@ func mapPayments(e *mod.Expense) map[mod.User]decimal.Decimal {
return payments return payments
} }
// TODO - move to the models
func ExpenseTotalPayed(exp *mod.Expense) decimal.Decimal { func ExpenseTotalPayed(exp *mod.Expense) decimal.Decimal {
total := decimal.NewFromFloat(0.0) total := decimal.NewFromFloat(0.0)
for _, p := range exp.Payments { for _, p := range exp.Payments {
@@ -118,6 +99,7 @@ func ExpenseTotalPayed(exp *mod.Expense) decimal.Decimal {
return total return total
} }
// TODO - move to the models
func ExpenseIsEvenlyShared(exp *mod.Expense) bool { func ExpenseIsEvenlyShared(exp *mod.Expense) bool {
shares := mapShares(exp) shares := mapShares(exp)
payments := mapPayments(exp) payments := mapPayments(exp)
+3 -1
View File
@@ -5,6 +5,7 @@ import (
"encoding/json" "encoding/json"
mod "github.com/ESilva15/expenses/expenses/models" mod "github.com/ESilva15/expenses/expenses/models"
"github.com/ESilva15/expenses/expenses/repo"
lua "github.com/yuin/gopher-lua" 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 { func (a *ExpApp) luaGetAllExpenses(l *lua.LState) int {
ctx := context.Background() ctx := context.Background()
// TODO - what do we do about the LUA API // 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 { if err != nil {
return returnWithError(l, err.Error()) return returnWithError(l, err.Error())
} }
+15 -3
View File
@@ -8,13 +8,25 @@ import (
mod "github.com/ESilva15/expenses/expenses/models" 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. // ExpenseRepository defines the repository for the expense data model.
type ExpenseRepository interface { type ExpenseRepository interface {
// Direct expense methods // Direct expense methods
Get(ctx context.Context, id int32) (mod.Expense, error) Get(ctx context.Context, id int32) (mod.Expense, error)
GetAll(ctx context.Context, uID int32) (mod.Expenses, error) GetAll(ctx context.Context, filter ExpFilter, uID int32) (mod.Expenses, error)
GetExpensesRange(ctx context.Context, start time.Time,
end time.Time, uID int32) (mod.Expenses, error)
Update(ctx context.Context, exp mod.Expense) error Update(ctx context.Context, exp mod.Expense) error
Insert(ctx context.Context, exp mod.Expense) error Insert(ctx context.Context, exp mod.Expense) error
Delete(ctx context.Context, id int32) error Delete(ctx context.Context, id int32) error
+11 -5
View File
@@ -1,9 +1,10 @@
package repo package repo
import ( import (
"time"
"github.com/jackc/pgx/v5/pgtype" "github.com/jackc/pgx/v5/pgtype"
dec "github.com/shopspring/decimal" dec "github.com/shopspring/decimal"
"time"
) )
func decimalToNumeric(d dec.Decimal) (pgtype.Numeric, error) { func decimalToNumeric(d dec.Decimal) (pgtype.Numeric, error) {
@@ -28,11 +29,16 @@ func boolToPgBool(v bool) (pgtype.Bool, error) {
return b, nil return b, nil
} }
func timeToTimestamp(t time.Time) (pgtype.Timestamp, error) { func timeToTimestamp(t *time.Time) (pgtype.Timestamp, error) {
var ts pgtype.Timestamp var ts pgtype.Timestamp
err := ts.Scan(t)
if err != nil { if t == nil {
return pgtype.Timestamp{}, err ts.Valid = false
} else {
err := ts.Scan(*t)
if err != nil {
return pgtype.Timestamp{}, err
}
} }
return ts, nil return ts, nil
+1 -1
View File
@@ -13,7 +13,7 @@ import (
func (p PgExpRepo) SettleDebt( func (p PgExpRepo) SettleDebt(
ctx context.Context, eID int32, payment mod.Payment, credit mod.Payment, ctx context.Context, eID int32, payment mod.Payment, credit mod.Payment,
) error { ) 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) err := p.insertPayment(ctx, q, eID, payment)
if err != nil { if err != nil {
return err return err
+32 -63
View File
@@ -3,13 +3,11 @@ package repo
import ( import (
"context" "context"
"fmt" "fmt"
"time"
mod "github.com/ESilva15/expenses/expenses/models" mod "github.com/ESilva15/expenses/expenses/models"
"github.com/ESilva15/expenses/expenses/repo/pgdb/pgsqlc" "github.com/ESilva15/expenses/expenses/repo/pgdb/pgsqlc"
"github.com/jackc/pgx/v5" "github.com/jackc/pgx/v5"
"github.com/jackc/pgx/v5/pgtype"
"github.com/jackc/pgx/v5/pgxpool" "github.com/jackc/pgx/v5/pgxpool"
) )
@@ -28,10 +26,10 @@ func (p PgExpRepo) Close() {
} }
func withTx( func withTx(
pgPool *pgxpool.Pool,
ctx context.Context, 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{}) tx, err := pgPool.BeginTx(ctx, pgx.TxOptions{})
if err != nil { if err != nil {
return err return err
@@ -46,29 +44,30 @@ func withTx(
return tx.Commit(ctx) return tx.Commit(ctx)
} }
func (p *PgExpRepo) getAll( // GetAll fetches all expenses.
ctx context.Context, q *pgsqlc.Queries, uId int32) (mod.Expenses, error) { func (p PgExpRepo) GetAll(ctx context.Context, filter ExpFilter, uID int32,
// We want to select all here, no timestamps ) (mod.Expenses, error) {
var start pgtype.Timestamp startPg, err := timeToTimestamp(filter.Start)
start.Valid = false
var end pgtype.Timestamp
end.Valid = false
expenses, err := q.GetExpenses(ctx, pgsqlc.GetExpensesParams{
Startdate: start,
Enddate: end,
UserID: uId,
})
if err != nil { 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. queries := pgsqlc.New(p.DB)
func (p PgExpRepo) GetAll(ctx context.Context, uID int32) (mod.Expenses, error) { expenses, err := queries.GetExpenses(ctx, pgsqlc.GetExpensesParams{
return p.getAll(ctx, pgsqlc.New(p.DB), uID) 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) { 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. // Update updates a given expense.
func (p PgExpRepo) Update( func (p PgExpRepo) Update(
ctx context.Context, ctx context.Context,
exp mod.Expense) error { exp mod.Expense,
) error {
return withTx(p.DB, ctx, func(q *pgsqlc.Queries) error { return withTx(ctx, p.DB, func(q *pgsqlc.Queries) error {
value, err := decimalToNumeric(exp.Value) value, err := decimalToNumeric(exp.Value)
if err != nil { if err != nil {
return err return err
@@ -106,7 +105,7 @@ func (p PgExpRepo) Update(
return err return err
} }
expDate, err := timeToTimestamp(exp.Date) expDate, err := timeToTimestamp(&exp.Date)
if err != nil { if err != nil {
return err return err
} }
@@ -167,9 +166,9 @@ func (p PgExpRepo) Update(
func (p PgExpRepo) Insert( func (p PgExpRepo) Insert(
ctx context.Context, ctx context.Context,
exp mod.Expense) error { exp mod.Expense,
) error {
return withTx(p.DB, ctx, func(q *pgsqlc.Queries) error { return withTx(ctx, p.DB, func(q *pgsqlc.Queries) error {
value, err := decimalToNumeric(exp.Value) value, err := decimalToNumeric(exp.Value)
if err != nil { if err != nil {
return err return err
@@ -185,12 +184,12 @@ func (p PgExpRepo) Insert(
return err return err
} }
expDate, err := timeToTimestamp(exp.Date) expDate, err := timeToTimestamp(&exp.Date)
if err != nil { if err != nil {
return err return err
} }
creationDate, err := timeToTimestamp(exp.CreationDate) creationDate, err := timeToTimestamp(&exp.CreationDate)
if err != nil { if err != nil {
return err return err
} }
@@ -243,33 +242,3 @@ func (p PgExpRepo) Delete(ctx context.Context, id int32) error {
return nil 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
}
+4
View File
@@ -3,12 +3,16 @@ package main
import ( import (
"log" "log"
"os"
"github.com/ESilva15/expenses/cmd" "github.com/ESilva15/expenses/cmd"
"github.com/ESilva15/expenses/expenses" "github.com/ESilva15/expenses/expenses"
) )
func main() { func main() {
log.SetOutput(os.Stdout)
log.SetFlags(log.Ldate | log.Ltime | log.Lshortfile)
if err := expenses.StartApp(); err != nil { if err := expenses.StartApp(); err != nil {
log.Fatal("failed to start app:", err.Error()) log.Fatal("failed to start app:", err.Error())
} }
+7 -4
View File
@@ -11,6 +11,7 @@ import (
exp "github.com/ESilva15/expenses/expenses" exp "github.com/ESilva15/expenses/expenses"
experr "github.com/ESilva15/expenses/expenses/errors" experr "github.com/ESilva15/expenses/expenses/errors"
mod "github.com/ESilva15/expenses/expenses/models" mod "github.com/ESilva15/expenses/expenses/models"
"github.com/ESilva15/expenses/expenses/repo"
fatqr "github.com/ESilva15/gofatqr" fatqr "github.com/ESilva15/gofatqr"
"github.com/gin-gonic/gin" "github.com/gin-gonic/gin"
@@ -28,7 +29,8 @@ func expensesPartial(c *gin.Context) {
return return
} }
expenses, err := exp.App.GetAllExpenses(ctx) eFilter := repo.NewExpFilter()
expenses, err := exp.App.GetAllExpenses(ctx, eFilter)
if err != nil { if err != nil {
c.Header("HX-Redirect", "/500") c.Header("HX-Redirect", "/500")
return return
@@ -46,7 +48,8 @@ func expensesGlobalPage(c *gin.Context) {
return return
} }
expenses, err := exp.App.GetAllExpenses(ctx) eFilter := repo.NewExpFilter()
expenses, err := exp.App.GetAllExpenses(ctx, eFilter)
if err != nil { if err != nil {
log.Println("error:", err) log.Println("error:", err)
ServerErrorView(c, "Could not get logged in user") ServerErrorView(c, "Could not get logged in user")
@@ -190,7 +193,7 @@ func createExpense(c *gin.Context) {
return return
} }
newExp, err := expenseFromForm(c, ctx) newExp, err := expenseFromForm(ctx, c)
if err != nil { if err != nil {
// TODO - Change this to something the user can see // TODO - Change this to something the user can see
c.Header("HX-Redirect", "/500") c.Header("HX-Redirect", "/500")
@@ -220,7 +223,7 @@ func updateExpense(c *gin.Context) {
return return
} }
newExp, err := expenseFromForm(c, ctx) newExp, err := expenseFromForm(ctx, c)
if err != nil { if err != nil {
// TODO - Change this to something the user can see // TODO - Change this to something the user can see
c.Header("HX-Redirect", "/500") c.Header("HX-Redirect", "/500")
+33 -3
View File
@@ -2,21 +2,51 @@ package pages
import ( import (
"context" "context"
"log"
"time" "time"
"github.com/ESilva15/expenses/expenses" "github.com/ESilva15/expenses/expenses"
mod "github.com/ESilva15/expenses/expenses/models" mod "github.com/ESilva15/expenses/expenses/models"
"github.com/ESilva15/expenses/expenses/repo"
"github.com/gin-gonic/gin" "github.com/gin-gonic/gin"
"github.com/shopspring/decimal" "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) { 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[]") shareIDs := c.PostFormArray("shares-ids[]")
shares := c.PostFormArray("shares-percent[]") 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) { 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) 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") newDescription := c.PostForm("expense-desc")
newDate := c.PostForm("expense-date") newDate := c.PostForm("expense-date")
newQR := c.PostForm("expense-qr") newQR := c.PostForm("expense-qr")
+6 -8
View File
@@ -41,10 +41,12 @@ func getResults(c *gin.Context) {
return return
} }
startDate := c.PostForm("range-start") + " 00:00:00" filter, err := expenseFilterFromQuery(c)
endDate := c.PostForm("range-end") + " 23:59:59" if err != nil {
log.Println("error ")
}
queriedExpenses, err := exp.App.GetExpensesRanged(ctx, startDate, endDate) queriedExpenses, err := exp.App.GetAllExpenses(ctx, filter)
if err != nil { if err != nil {
log.Printf("getting expenses: %v", err) log.Printf("getting expenses: %v", err)
return return
@@ -69,10 +71,6 @@ func getResults(c *gin.Context) {
log.Printf("failed to get debts: %v", err) log.Printf("failed to get debts: %v", err)
return return
} }
log.Println(queriedExpenses[k].Shares)
log.Println(queriedExpenses[k].Payments)
log.Println(queriedExpenses[k].Debts)
} }
userDebtSummary := make(map[mod.User]decimal.Decimal) userDebtSummary := make(map[mod.User]decimal.Decimal)
@@ -98,5 +96,5 @@ func RouteOverview(router *gin.RouterGroup) {
router.GET("/overview", overviewPage) router.GET("/overview", overviewPage)
router.POST("/overview", overviewPartialPage) router.POST("/overview", overviewPartialPage)
router.POST("/overview/ranged", getResults) router.GET("/overview/ranged", getResults)
} }