feat: trim whitespace from string fields (#900)

Author: morremeyer

pkg/models/account.go

@@ -72,11 +72,21 @@ func (a Account) BeforeUpdate(tx *gorm.DB) (err error) {
 	return nil
 }
 
-// BeforeSave sets OnBudget to false when External is true.
-func (a *Account) BeforeSave(_ *gorm.DB) (err error) {
+// BeforeSave ensures consistency for the account
+//
+// It enforces OnBudget to be false when the account
+// is external.
+//
+// It trims whitespace from all strings
+func (a *Account) BeforeSave(_ *gorm.DB) error {
 	if a.External {
 		a.OnBudget = false
 	}
+
+	a.Name = strings.TrimSpace(a.Name)
+	a.Note = strings.TrimSpace(a.Note)
+	a.ImportHash = strings.TrimSpace(a.ImportHash)
+
 	return nil
 }
 

pkg/models/account_test.go

@@ -2,6 +2,7 @@ package models_test
 
 import (
 	"strconv"
+	"strings"
 	"time"
 
 	"github.com/envelope-zero/backend/v3/internal/types"
@@ -11,6 +12,23 @@ import (
 	"github.com/stretchr/testify/assert"
 )
 
+func (suite *TestSuiteStandard) TestAccountTrimWhitespace() {
+	name := "\t Whitespace galore!   "
+	note := " Some more whitespace in the notes    "
+	importHash := "  867e3a26dc0baf73f4bff506f31a97f6c32088917e9e5cf1a5ed6f3f84a6fa70  \t"
+
+	account := suite.createTestAccount(models.AccountCreate{
+		Name:       name,
+		Note:       note,
+		ImportHash: importHash,
+		BudgetID:   suite.createTestBudget(models.BudgetCreate{}).ID,
+	})
+
+	assert.Equal(suite.T(), strings.TrimSpace(name), account.Name)
+	assert.Equal(suite.T(), strings.TrimSpace(note), account.Note)
+	assert.Equal(suite.T(), strings.TrimSpace(importHash), account.ImportHash)
+}
+
 func (suite *TestSuiteStandard) TestAccountCalculations() {
 	budget := suite.createTestBudget(models.BudgetCreate{})
 	initialBalanceDate := time.Now()

pkg/models/budget.go

@@ -2,6 +2,7 @@ package models
 
 import (
 	"fmt"
+	"strings"
 
 	"github.com/envelope-zero/backend/v3/internal/types"
 	"github.com/envelope-zero/backend/v3/pkg/database"
@@ -29,6 +30,14 @@ type BudgetCreate struct {
 	Currency string `json:"currency" example:"€" default:""`                // The currency for the budget
 }
 
+func (b *Budget) BeforeSave(_ *gorm.DB) error {
+	b.Name = strings.TrimSpace(b.Name)
+	b.Note = strings.TrimSpace(b.Note)
+	b.Currency = strings.TrimSpace(b.Currency)
+
+	return nil
+}
+
 // Balance calculates the balance for a budget.
 func (b Budget) Balance(tx *gorm.DB) (balance decimal.Decimal, err error) {
 	// Get all OnBudget accounts for the budget

pkg/models/budget_test.go

@@ -2,6 +2,7 @@ package models_test
 
 import (
 	"fmt"
+	"strings"
 	"testing"
 	"time"
 
@@ -11,6 +12,22 @@ import (
 	"github.com/stretchr/testify/assert"
 )
 
+func (suite *TestSuiteStandard) TestBudgetTrimWhitespace() {
+	name := "\t Whitespace galore!   "
+	note := " Some more whitespace in the notes    "
+	currency := "  €"
+
+	budget := suite.createTestBudget(models.BudgetCreate{
+		Name:     name,
+		Note:     note,
+		Currency: currency,
+	})
+
+	assert.Equal(suite.T(), strings.TrimSpace(name), budget.Name)
+	assert.Equal(suite.T(), strings.TrimSpace(note), budget.Note)
+	assert.Equal(suite.T(), strings.TrimSpace(currency), budget.Currency)
+}
+
 func (suite *TestSuiteStandard) TestBudgetAfterFind() {
 	budget := suite.createTestBudget(models.BudgetCreate{})
 	err := budget.AfterFind(suite.db)

pkg/models/category.go

@@ -1,6 +1,8 @@
 package models
 
 import (
+	"strings"
+
 	"github.com/google/uuid"
 	"gorm.io/gorm"
 )
@@ -24,6 +26,13 @@ func (c Category) Self() string {
 	return "Category"
 }
 
+func (c *Category) BeforeSave(_ *gorm.DB) error {
+	c.Name = strings.TrimSpace(c.Name)
+	c.Note = strings.TrimSpace(c.Note)
+
+	return nil
+}
+
 func (c *Category) AfterFind(_ *gorm.DB) (err error) {
 	// Set the Archived field to the value of Hidden
 	c.Archived = c.Hidden

pkg/models/category_test.go

@@ -1,10 +1,26 @@
 package models_test
 
 import (
+	"strings"
+
 	"github.com/envelope-zero/backend/v3/pkg/models"
 	"github.com/stretchr/testify/assert"
 )
 
+func (suite *TestSuiteStandard) TestCategoryTrimWhitespace() {
+	name := "\t Whitespace galore!   "
+	note := " Some more whitespace in the notes    "
+
+	category := suite.createTestCategory(models.CategoryCreate{
+		Name:     name,
+		Note:     note,
+		BudgetID: suite.createTestBudget(models.BudgetCreate{}).ID,
+	})
+
+	assert.Equal(suite.T(), strings.TrimSpace(name), category.Name)
+	assert.Equal(suite.T(), strings.TrimSpace(note), category.Note)
+}
+
 func (suite *TestSuiteStandard) TestCategoryArchiveArchivesEnvelopes() {
 	category := suite.createTestCategory(models.CategoryCreate{
 		BudgetID: suite.createTestBudget(models.BudgetCreate{}).ID,

pkg/models/envelope.go

@@ -2,6 +2,7 @@ package models
 
 import (
 	"sort"
+	"strings"
 	"time"
 
 	"github.com/envelope-zero/backend/v3/internal/types"
@@ -29,6 +30,13 @@ func (e Envelope) Self() string {
 	return "Envelope"
 }
 
+func (e *Envelope) BeforeSave(_ *gorm.DB) error {
+	e.Name = strings.TrimSpace(e.Name)
+	e.Note = strings.TrimSpace(e.Note)
+
+	return nil
+}
+
 func (e *Envelope) AfterFind(_ *gorm.DB) (err error) {
 	// Set the Archived field to the value of Hidden
 	e.Archived = e.Hidden

pkg/models/envelope_test.go

@@ -2,6 +2,7 @@ package models_test
 
 import (
 	"fmt"
+	"strings"
 	"testing"
 	"time"
 
@@ -11,6 +12,22 @@ import (
 	"github.com/stretchr/testify/assert"
 )
 
+func (suite *TestSuiteStandard) TestEnvelopeTrimWhitespace() {
+	name := "\t Whitespace galore!   "
+	note := " Some more whitespace in the notes    "
+
+	envelope := suite.createTestEnvelope(models.EnvelopeCreate{
+		Name: name,
+		Note: note,
+		CategoryID: suite.createTestCategory(models.CategoryCreate{
+			BudgetID: suite.createTestBudget(models.BudgetCreate{}).ID,
+		}).ID,
+	})
+
+	assert.Equal(suite.T(), strings.TrimSpace(name), envelope.Name)
+	assert.Equal(suite.T(), strings.TrimSpace(note), envelope.Note)
+}
+
 func (suite *TestSuiteStandard) TestEnvelopeMonthSum() {
 	budget := suite.createTestBudget(models.BudgetCreate{})
 

pkg/models/month_config.go

@@ -2,6 +2,7 @@ package models
 
 import (
 	"errors"
+	"strings"
 
 	"github.com/envelope-zero/backend/v3/internal/types"
 	"github.com/google/uuid"
@@ -34,6 +35,12 @@ func (m MonthConfig) Self() string {
 	return "Month Config"
 }
 
+func (m *MonthConfig) BeforeSave(_ *gorm.DB) error {
+	m.Note = strings.TrimSpace(m.Note)
+
+	return nil
+}
+
 func (m *MonthConfig) AfterFind(tx *gorm.DB) error {
 	// Check if there is an allocation for this MonthConfig. If yes, set the value.
 	// This transparently makes use of the Allocation model

pkg/models/month_config_test.go

@@ -1,10 +1,29 @@
 package models_test
 
 import (
+	"strings"
+
 	"github.com/envelope-zero/backend/v3/pkg/models"
 	"github.com/stretchr/testify/assert"
 )
 
 func (suite *TestSuiteStandard) TestMonthConfigSelf() {
 	assert.Equal(suite.T(), "Month Config", models.MonthConfig{}.Self())
 }
+
+func (suite *TestSuiteStandard) TestMonthConfigTrimWhitespace() {
+	note := " Some more whitespace in the notes    "
+
+	account := suite.createTestMonthConfig(models.MonthConfig{
+		MonthConfigCreate: models.MonthConfigCreate{
+			Note: note,
+		},
+		EnvelopeID: suite.createTestEnvelope(models.EnvelopeCreate{
+			CategoryID: suite.createTestCategory(models.CategoryCreate{
+				BudgetID: suite.createTestBudget(models.BudgetCreate{}).ID,
+			}).ID,
+		}).ID,
+	})
+
+	assert.Equal(suite.T(), strings.TrimSpace(note), account.Note)
+}