Compare commits

...

13 Commits

Author SHA1 Message Date
176fadbceb Merge branch 'filter-joins' 2024-07-14 13:34:33 +02:00
86f4550b08 Finish 2024-07-14 13:17:04 +02:00
f50aaca44d ApplyQuery interface 2024-06-29 15:37:59 +02:00
f7cf63c2bf Change separator 2024-06-27 13:49:28 +02:00
30714bb3da Delete method working example 2024-06-27 13:33:05 +02:00
8a81173fc8 Update method tests 2024-06-26 16:15:33 +02:00
43824af97c Tests 2024-06-26 11:41:01 +02:00
326866dc49 Update method 2024-06-26 11:24:58 +02:00
450345ba6b Save method 2024-06-26 11:20:26 +02:00
bdc978aec1 Save method 2024-06-26 01:55:33 +02:00
3dc8d0d79f Count method 2024-06-25 01:52:50 +02:00
4615d55309 Repo options 2024-06-25 01:19:40 +02:00
c2bcbea5d2 Tests 2024-06-25 00:49:13 +02:00
19 changed files with 739 additions and 87 deletions

View File

@ -20,15 +20,31 @@ var (
) )
type CertFilter struct { type CertFilter struct {
Alive *bool `filterfield:"field=alive,operator=EQ"` Alive *bool `filterfield:"field=alive;operator=EQ"`
SerialNumber *string `filterfield:"field=serial_number,operator=NE"` SerialNumber *string `filterfield:"field=serial_number;operator=NE"`
SerialNumberContains *string `filterfield:"field=serial_number,operator=LIKE"` SerialNumberContains *string `filterfield:"field=serial_number;operator=LIKE"`
IssuerContains *string `filterfield:"field=issuer,operator=ILIKE"` IssuerContains *string `filterfield:"field=issuer;operator=ILIKE"`
Id *uuid.UUID `filterfield:"field=id,operator=EQ"` Id *uuid.UUID `filterfield:"field=id;operator=EQ"`
Ids *[]uuid.UUID `filterfield:"field=id,operator=IN"` Ids *[]uuid.UUID `filterfield:"field=id;operator=IN"`
IdsNot *[]string `filterfield:"field=id,operator=NOT_IN"` IdsNot *[]string `filterfield:"field=id;operator=NOT_IN"`
CreatedAt_Lt *time.Time `filterfield:"field=created_at,operator=LT"` CreatedAt_Lt *time.Time `filterfield:"field=created_at;operator=LT"`
Timestamps *[]time.Time `filterfield:"field=created_at,operator=IN"` Timestamps *[]time.Time `filterfield:"field=created_at;operator=IN"`
CompanyIsActive *bool
}
func (f CertFilter) ApplyQuery(query *gorm.DB) *gorm.DB {
if f.CompanyIsActive != nil {
query = query.Joins(
fmt.Sprintf(
"JOIN companies ON certificates.company_id = companies.id WHERE companies.is_active = %t",
*f.CompanyIsActive,
))
}
return query
}
type CompanyFilter struct {
IsActive *bool `filterfield:"field=is_active;operator=EQ"`
} }
func doMagic(db *gorm.DB) { func doMagic(db *gorm.DB) {
@ -73,7 +89,7 @@ func doMagic(db *gorm.DB) {
func doList(db *gorm.DB) { func doList(db *gorm.DB) {
repo := repository.RepoBase[models.Cert]{} repo := repository.RepoBase[models.Cert]{}
repo.Init(db) repo.Init(db, nil)
filter := CertFilter{ filter := CertFilter{
Alive: &TRUE, Alive: &TRUE,
@ -89,9 +105,42 @@ func doList(db *gorm.DB) {
} }
} }
func doListWithJoins(db *gorm.DB) {
repo := repository.RepoBase[models.Cert]{}
repo.Init(db, nil)
filter := CertFilter{
CompanyIsActive: &FALSE,
}
certs, err := repo.List(filter, nil)
if err != nil {
panic(err)
}
for n, cert := range *certs {
fmt.Printf(">> [%d] %+v %s (alive %t)\n", n, cert.Id, cert.CreatedAt, cert.Alive)
}
}
func doCount(db *gorm.DB) {
repo := repository.RepoBase[models.Cert]{}
repo.Init(db, nil)
filter := CertFilter{
Alive: &TRUE,
}
count, err := repo.Count(filter)
if err != nil {
panic(err)
}
fmt.Printf(">>> count: %d\n", count)
}
func doGet(db *gorm.DB) { func doGet(db *gorm.DB) {
repo := repository.RepoBase[models.Cert]{} repo := repository.RepoBase[models.Cert]{}
repo.Init(db) repo.Init(db, nil)
id, _ := uuid.Parse("db9fb837-3483-4736-819d-f427dc8cda23") id, _ := uuid.Parse("db9fb837-3483-4736-819d-f427dc8cda23")
@ -106,9 +155,43 @@ func doGet(db *gorm.DB) {
fmt.Printf(">> %+v %s (alive %t)\n", cert.Id, cert.CreatedAt, cert.Alive) fmt.Printf(">> %+v %s (alive %t)\n", cert.Id, cert.CreatedAt, cert.Alive)
} }
func doSave(db *gorm.DB) {
repo := repository.RepoBase[models.Company]{}
repo.Init(db, nil)
company := models.Company{
Name: "Test company",
Address: "Some address",
City: "Some city",
Email: "email@example.org",
Oib: "123456",
}
_, err := repo.Save(&company)
if err != nil {
panic(err)
}
fmt.Printf("New company id: %s\n", company.Id.String())
}
func doDelete(db *gorm.DB) {
repo := repository.RepoBase[models.Company]{}
repo.Init(db, nil)
filter := CompanyFilter{
IsActive: &FALSE,
}
deletedCount, err := repo.Delete(filter)
if err != nil {
panic(err)
}
fmt.Printf(">> DELETED: %d\n", deletedCount)
}
func doExists(db *gorm.DB) { func doExists(db *gorm.DB) {
repo := repository.RepoBase[models.Cert]{} repo := repository.RepoBase[models.Cert]{}
repo.Init(db) repo.Init(db, nil)
id, _ := uuid.Parse("db9fb837-3483-4736-819d-f427dc8cda23") id, _ := uuid.Parse("db9fb837-3483-4736-819d-f427dc8cda23")
@ -130,8 +213,12 @@ func main() {
db := db.InitDB() db := db.InitDB()
doMagic(db) // doMagic(db)
// doList(db) // doList(db)
doListWithJoins(db)
// doCount(db)
// doSave(db)
// doDelete(db)
// doGet(db) // doGet(db)
// doExists(db) // doExists(db)
// inheritance.DoInheritanceTest() // inheritance.DoInheritanceTest()

View File

@ -21,7 +21,7 @@ type Company struct {
UpdatedAt time.Time `faker:"-"` UpdatedAt time.Time `faker:"-"`
} }
func (m *Company) TableName() string { func (m Company) TableName() string {
return "companies" return "companies"
} }

View File

@ -0,0 +1,32 @@
package repository
import (
"repo-pattern/app/repository/smartfilter"
"gorm.io/gorm/schema"
)
type CountMethod[T schema.Tabler] struct {
repo *RepoBase[T]
}
func (m *CountMethod[T]) Init(repo *RepoBase[T]) {
m.repo = repo
}
func (m CountMethod[T]) Count(filter interface{}) (int64, error) {
var (
model T
count int64
)
query := m.repo.dbConn.Model(model)
query, err := smartfilter.ToQuery(model, filter, query)
if err != nil {
return 0, err
}
query.Count(&count)
return count, nil
}

View File

@ -0,0 +1,60 @@
package repository
import (
"fmt"
"regexp"
"testing"
"github.com/google/uuid"
"github.com/stretchr/testify/assert"
)
func TestCountMethod(t *testing.T) {
t.Run("Count without filter", func(t *testing.T) {
sqldb, db, mock := NewMockDB()
defer sqldb.Close()
repo := RepoBase[MyModel]{}
repo.Init(db, nil)
filter := MyModelFilter{}
sql := "SELECT count(*) FROM my_models"
mock.ExpectQuery(fmt.Sprintf("^%s$", regexp.QuoteMeta(sql)))
result, err := repo.Count(filter)
assert.Equal(t, result, int64(0))
assert.Nil(t, err)
if err := mock.ExpectationsWereMet(); err != nil {
t.Errorf("there were unfulfilled expectations: %s", err)
}
})
t.Run("Count with filter", func(t *testing.T) {
sqldb, db, mock := NewMockDB()
defer sqldb.Close()
repo := RepoBase[MyModel]{}
repo.Init(db, nil)
id1 := uuid.New()
id2 := uuid.New()
id3 := uuid.New()
filter := MyModelFilter{
Ids: &[]uuid.UUID{id1, id2, id3},
}
sql := "SELECT count(*) FROM my_models WHERE my_models.id IN ($1,$2,$3)"
mock.ExpectQuery(fmt.Sprintf("^%s$", regexp.QuoteMeta(sql))).
WithArgs(id1, id2, id3)
result, err := repo.Count(filter)
assert.Equal(t, result, int64(0))
assert.Nil(t, err)
if err := mock.ExpectationsWereMet(); err != nil {
t.Errorf("there were unfulfilled expectations: %s", err)
}
})
}

View File

@ -0,0 +1,31 @@
package repository
import (
"repo-pattern/app/repository/smartfilter"
"gorm.io/gorm/schema"
)
type DeleteMethod[T schema.Tabler] struct {
repo *RepoBase[T]
}
func (m *DeleteMethod[T]) Init(repo *RepoBase[T]) {
m.repo = repo
}
func (m DeleteMethod[T]) Delete(filter interface{}) (int64, error) {
var (
model T
)
query, err := smartfilter.ToQuery(model, filter, m.repo.dbConn)
if err != nil {
return 0, err
}
result := query.Delete(&model)
if result.Error != nil {
return 0, result.Error
}
return result.RowsAffected, nil
}

View File

@ -0,0 +1,73 @@
package repository
import (
"fmt"
"regexp"
"testing"
"github.com/DATA-DOG/go-sqlmock"
"github.com/google/uuid"
"github.com/stretchr/testify/assert"
)
func TestDeleteMethod(t *testing.T) {
t.Run("With filter", func(t *testing.T) {
sqldb, db, mock := NewMockDB()
defer sqldb.Close()
repo := RepoBase[MyModel]{}
repo.Init(db, nil)
id := uuid.New()
filter := MyModelFilter{
Id: &id,
}
sql := "DELETE FROM my_models WHERE my_models.id = $1"
mock.ExpectBegin()
mock.ExpectExec(fmt.Sprintf("^%s$", regexp.QuoteMeta(sql))).
WithArgs(id).
WillReturnResult(sqlmock.NewResult(1, 111))
mock.ExpectCommit()
deleted, err := repo.Delete(filter)
assert.Equal(t, int64(111), deleted)
assert.Nil(t, err)
if err := mock.ExpectationsWereMet(); err != nil {
t.Errorf("there were unfulfilled expectations: %s", err)
}
})
t.Run("With multiple filters", func(t *testing.T) {
sqldb, db, mock := NewMockDB()
defer sqldb.Close()
repo := RepoBase[MyModel]{}
repo.Init(db, nil)
id1 := uuid.New()
id2 := uuid.New()
id3 := uuid.New()
cnt := 3456
filter := MyModelFilter{
Ids: &[]uuid.UUID{id1, id2, id3},
CntGT: &cnt,
}
sql := "DELETE FROM my_models WHERE my_models.id IN ($1,$2,$3) AND my_models.cnt > $4"
mock.ExpectBegin()
mock.ExpectExec(fmt.Sprintf("^%s$", regexp.QuoteMeta(sql))).
WithArgs(id1, id2, id3, cnt).
WillReturnResult(sqlmock.NewResult(1, 123))
mock.ExpectCommit()
deleted, err := repo.Delete(filter)
assert.Equal(t, int64(123), deleted)
assert.Nil(t, err)
if err := mock.ExpectationsWereMet(); err != nil {
t.Errorf("there were unfulfilled expectations: %s", err)
}
})
}

View File

@ -9,11 +9,11 @@ import (
) )
type ExistsMethod[T schema.Tabler] struct { type ExistsMethod[T schema.Tabler] struct {
DbConn *gorm.DB repo *RepoBase[T]
} }
func (m *ExistsMethod[T]) Init(dbConn *gorm.DB) { func (m *ExistsMethod[T]) Init(repo *RepoBase[T]) {
m.DbConn = dbConn m.repo = repo
} }
func (m ExistsMethod[T]) Exists(filter interface{}) (bool, error) { func (m ExistsMethod[T]) Exists(filter interface{}) (bool, error) {
@ -21,14 +21,14 @@ func (m ExistsMethod[T]) Exists(filter interface{}) (bool, error) {
model T model T
) )
query := m.DbConn.Model(model) query := m.repo.dbConn.Model(model)
query, err := smartfilter.ToQuery(model, filter, query) query, err := smartfilter.ToQuery(model, filter, query)
if err != nil { if err != nil {
return false, err return false, err
} }
result := query.Select("*").First(&model) result := query.Select(m.repo.IdField).Take(&model)
exists := !errors.Is(result.Error, gorm.ErrRecordNotFound) && result.Error == nil exists := !errors.Is(result.Error, gorm.ErrRecordNotFound) && result.Error == nil
return exists, nil return exists, nil

View File

@ -0,0 +1,60 @@
package repository
import (
"fmt"
"regexp"
"testing"
"github.com/google/uuid"
"github.com/stretchr/testify/assert"
)
func TestExistsMethod(t *testing.T) {
t.Run("Without repo options", func(t *testing.T) {
sqldb, db, mock := NewMockDB()
defer sqldb.Close()
repo := RepoBase[MyModel]{}
repo.Init(db, nil)
id := uuid.New()
filter := MyModelFilter{
Id: &id,
}
sql := "SELECT id FROM my_models WHERE my_models.id = $1 LIMIT $2"
mock.ExpectQuery(fmt.Sprintf("^%s$", regexp.QuoteMeta(sql))).WithArgs(id, 1)
result, err := repo.Exists(filter)
assert.False(t, result)
assert.Nil(t, err)
if err := mock.ExpectationsWereMet(); err != nil {
t.Errorf("there were unfulfilled expectations: %s", err)
}
})
t.Run("With id field set in repo options", func(t *testing.T) {
sqldb, db, mock := NewMockDB()
defer sqldb.Close()
repo := RepoBase[MyModel]{}
repo.Init(db, &RepoOptions{IdField: "some_other_pk"})
id := uuid.New()
filter := MyModelFilter{
Id: &id,
}
sql := "SELECT some_other_pk FROM my_models WHERE my_models.id = $1 LIMIT $2"
mock.ExpectQuery(fmt.Sprintf("^%s$", regexp.QuoteMeta(sql))).WithArgs(id, 1)
result, err := repo.Exists(filter)
assert.False(t, result)
assert.Nil(t, err)
if err := mock.ExpectationsWereMet(); err != nil {
t.Errorf("there were unfulfilled expectations: %s", err)
}
})
}

View File

@ -3,20 +3,20 @@ package repository
import ( import (
"repo-pattern/app/repository/smartfilter" "repo-pattern/app/repository/smartfilter"
"gorm.io/gorm"
"gorm.io/gorm/schema" "gorm.io/gorm/schema"
) )
type GetOptions struct { type GetOptions struct {
Only *[]string Only *[]string
RaiseError *bool
} }
type GetMethod[T schema.Tabler] struct { type GetMethod[T schema.Tabler] struct {
DbConn *gorm.DB repo *RepoBase[T]
} }
func (m *GetMethod[T]) Init(dbConn *gorm.DB) { func (m *GetMethod[T]) Init(repo *RepoBase[T]) {
m.DbConn = dbConn m.repo = repo
} }
func (m GetMethod[T]) Get(filter interface{}, options *GetOptions) (*T, error) { func (m GetMethod[T]) Get(filter interface{}, options *GetOptions) (*T, error) {
@ -24,7 +24,7 @@ func (m GetMethod[T]) Get(filter interface{}, options *GetOptions) (*T, error) {
model T model T
) )
query, err := smartfilter.ToQuery(model, filter, m.DbConn) query, err := smartfilter.ToQuery(model, filter, m.repo.dbConn)
if err != nil { if err != nil {
return nil, err return nil, err
} }
@ -34,9 +34,12 @@ func (m GetMethod[T]) Get(filter interface{}, options *GetOptions) (*T, error) {
} }
result := query.First(&model) result := query.First(&model)
if result.Error != nil { if result.Error == nil {
return nil, result.Error return &model, nil
} }
return &model, nil if options != nil && options.RaiseError != nil && *options.RaiseError {
return nil, result.Error
}
return nil, nil
} }

View File

@ -0,0 +1,67 @@
package repository
import (
"fmt"
"regexp"
"testing"
"github.com/google/uuid"
"github.com/stretchr/testify/assert"
)
func TestGetMethod(t *testing.T) {
t.Run("With id filter, suppress errors", func(t *testing.T) {
sqldb, db, mock := NewMockDB()
defer sqldb.Close()
repo := RepoBase[MyModel]{}
repo.Init(db, nil)
id := uuid.New()
filter := MyModelFilter{
Id: &id,
}
options := GetOptions{}
sql := "SELECT * FROM my_models WHERE my_models.id = $1 ORDER BY my_models.id LIMIT $2"
mock.ExpectQuery(fmt.Sprintf("^%s$", regexp.QuoteMeta(sql))).WithArgs(id, 1)
result, err := repo.Get(filter, &options)
assert.Nil(t, result)
assert.Nil(t, err)
if err := mock.ExpectationsWereMet(); err != nil {
t.Errorf("there were unfulfilled expectations: %s", err)
}
})
t.Run("With id filter, raise error", func(t *testing.T) {
sqldb, db, mock := NewMockDB()
defer sqldb.Close()
repo := RepoBase[MyModel]{}
repo.Init(db, nil)
id := uuid.New()
raiseError := true
filter := MyModelFilter{
Id: &id,
}
options := GetOptions{
RaiseError: &raiseError,
}
sql := "SELECT * FROM my_models WHERE my_models.id = $1 ORDER BY my_models.id LIMIT $2"
mock.ExpectQuery(fmt.Sprintf("^%s$", regexp.QuoteMeta(sql))).
WithArgs(id, 1).
WillReturnError(nil)
result, err := repo.Get(filter, &options)
assert.Nil(t, result)
assert.NotNil(t, err)
if err := mock.ExpectationsWereMet(); err != nil {
t.Errorf("there were unfulfilled expectations: %s", err)
}
})
}

View File

@ -3,7 +3,6 @@ package repository
import ( import (
"repo-pattern/app/repository/smartfilter" "repo-pattern/app/repository/smartfilter"
"gorm.io/gorm"
"gorm.io/gorm/schema" "gorm.io/gorm/schema"
) )
@ -14,11 +13,11 @@ type ListOptions struct {
} }
type ListMethod[T schema.Tabler] struct { type ListMethod[T schema.Tabler] struct {
DbConn *gorm.DB repo *RepoBase[T]
} }
func (m *ListMethod[T]) Init(dbConn *gorm.DB) { func (m *ListMethod[T]) Init(repo *RepoBase[T]) {
m.DbConn = dbConn m.repo = repo
} }
func (m ListMethod[T]) List(filter interface{}, options *ListOptions) (*[]T, error) { func (m ListMethod[T]) List(filter interface{}, options *ListOptions) (*[]T, error) {
@ -27,7 +26,7 @@ func (m ListMethod[T]) List(filter interface{}, options *ListOptions) (*[]T, err
models []T models []T
) )
query, err := smartfilter.ToQuery(model, filter, m.DbConn) query, err := smartfilter.ToQuery(model, filter, m.repo.dbConn)
if err != nil { if err != nil {
return nil, err return nil, err
} }

View File

@ -33,9 +33,9 @@ func NewMockDB() (*sql.DB, *gorm.DB, sqlmock.Sqlmock) {
} }
type MyModel struct { type MyModel struct {
Id uuid.UUID Id *uuid.UUID `gorm:"type(uuid);unique"`
Value string Value string
Count int Cnt int
} }
func (m MyModel) TableName() string { func (m MyModel) TableName() string {
@ -43,9 +43,10 @@ func (m MyModel) TableName() string {
} }
type MyModelFilter struct { type MyModelFilter struct {
Id *uuid.UUID `filterfield:"field=id,operator=EQ"` Id *uuid.UUID `filterfield:"field=id;operator=EQ"`
Value *string `filterfield:"field=value,operator=EQ"` Ids *[]uuid.UUID `filterfield:"field=id;operator=IN"`
Count *int `filterfield:"field=count,operator=GT"` Value *string `filterfield:"field=value;operator=EQ"`
CntGT *int `filterfield:"field=cnt;operator=GT"`
} }
func TestListMethod(t *testing.T) { func TestListMethod(t *testing.T) {
@ -54,7 +55,7 @@ func TestListMethod(t *testing.T) {
defer sqldb.Close() defer sqldb.Close()
repo := RepoBase[MyModel]{} repo := RepoBase[MyModel]{}
repo.Init(db) repo.Init(db, nil)
filter := MyModelFilter{} filter := MyModelFilter{}
options := ListOptions{ options := ListOptions{
@ -64,13 +65,13 @@ func TestListMethod(t *testing.T) {
Direction: OrderASC, Direction: OrderASC,
}, },
{ {
Field: "count", Field: "cnt",
Direction: OrderDESC, Direction: OrderDESC,
}, },
}, },
} }
sql := "SELECT * FROM my_models ORDER BY id,count DESC" sql := "SELECT * FROM my_models ORDER BY id,cnt DESC"
mock.ExpectQuery(fmt.Sprintf("^%s$", regexp.QuoteMeta(sql))) mock.ExpectQuery(fmt.Sprintf("^%s$", regexp.QuoteMeta(sql)))
_, err := repo.List(filter, &options) _, err := repo.List(filter, &options)
@ -86,7 +87,7 @@ func TestListMethod(t *testing.T) {
defer sqldb.Close() defer sqldb.Close()
repo := RepoBase[MyModel]{} repo := RepoBase[MyModel]{}
repo.Init(db) repo.Init(db, nil)
filter := MyModelFilter{} filter := MyModelFilter{}
options := ListOptions{ options := ListOptions{
@ -112,7 +113,7 @@ func TestListMethod(t *testing.T) {
defer sqldb.Close() defer sqldb.Close()
repo := RepoBase[MyModel]{} repo := RepoBase[MyModel]{}
repo.Init(db) repo.Init(db, nil)
filter := MyModelFilter{} filter := MyModelFilter{}
options := ListOptions{ options := ListOptions{
@ -138,7 +139,7 @@ func TestListMethod(t *testing.T) {
defer sqldb.Close() defer sqldb.Close()
repo := RepoBase[MyModel]{} repo := RepoBase[MyModel]{}
repo.Init(db) repo.Init(db, nil)
filter := MyModelFilter{} filter := MyModelFilter{}
options := ListOptions{ options := ListOptions{
@ -165,7 +166,7 @@ func TestListMethod(t *testing.T) {
defer sqldb.Close() defer sqldb.Close()
repo := RepoBase[MyModel]{} repo := RepoBase[MyModel]{}
repo.Init(db) repo.Init(db, nil)
id := uuid.New() id := uuid.New()
filter := MyModelFilter{ filter := MyModelFilter{
@ -189,7 +190,7 @@ func TestListMethod(t *testing.T) {
defer sqldb.Close() defer sqldb.Close()
repo := RepoBase[MyModel]{} repo := RepoBase[MyModel]{}
repo.Init(db) repo.Init(db, nil)
id := uuid.New() id := uuid.New()
count := 456 count := 456
@ -197,10 +198,10 @@ func TestListMethod(t *testing.T) {
filter := MyModelFilter{ filter := MyModelFilter{
Id: &id, Id: &id,
Value: &value, Value: &value,
Count: &count, CntGT: &count,
} }
sql := "SELECT * FROM my_models WHERE my_models.id = $1 AND my_models.value = $2 AND my_models.count > $3" sql := "SELECT * FROM my_models WHERE my_models.id = $1 AND my_models.value = $2 AND my_models.cnt > $3"
mock.ExpectQuery(fmt.Sprintf("^%s$", regexp.QuoteMeta(sql))). mock.ExpectQuery(fmt.Sprintf("^%s$", regexp.QuoteMeta(sql))).
WithArgs(id, value, count) WithArgs(id, value, count)
@ -217,7 +218,7 @@ func TestListMethod(t *testing.T) {
defer sqldb.Close() defer sqldb.Close()
repo := RepoBase[MyModel]{} repo := RepoBase[MyModel]{}
repo.Init(db) repo.Init(db, nil)
id := uuid.New() id := uuid.New()
count := 456 count := 456
@ -225,7 +226,7 @@ func TestListMethod(t *testing.T) {
filter := MyModelFilter{ filter := MyModelFilter{
Id: &id, Id: &id,
Value: &value, Value: &value,
Count: &count, CntGT: &count,
} }
options := ListOptions{ options := ListOptions{
Pagination: &Pagination{ Pagination: &Pagination{
@ -234,7 +235,7 @@ func TestListMethod(t *testing.T) {
}, },
} }
sql := "SELECT * FROM my_models WHERE my_models.id = $1 AND my_models.value = $2 AND my_models.count > $3 LIMIT $4 OFFSET $5" sql := "SELECT * FROM my_models WHERE my_models.id = $1 AND my_models.value = $2 AND my_models.cnt > $3 LIMIT $4 OFFSET $5"
mock.ExpectQuery(fmt.Sprintf("^%s$", regexp.QuoteMeta(sql))). mock.ExpectQuery(fmt.Sprintf("^%s$", regexp.QuoteMeta(sql))).
WithArgs(id, value, count, options.Pagination.Limit, options.Pagination.Offset) WithArgs(id, value, count, options.Pagination.Limit, options.Pagination.Offset)
@ -251,17 +252,17 @@ func TestListMethod(t *testing.T) {
defer sqldb.Close() defer sqldb.Close()
repo := RepoBase[MyModel]{} repo := RepoBase[MyModel]{}
repo.Init(db) repo.Init(db, nil)
filter := MyModelFilter{} filter := MyModelFilter{}
options := ListOptions{ options := ListOptions{
Only: &[]string{ Only: &[]string{
"id", "id",
"count", "cnt",
}, },
} }
sql := "SELECT id,count FROM my_models" sql := "SELECT id,cnt FROM my_models"
mock.ExpectQuery(fmt.Sprintf("^%s$", regexp.QuoteMeta(sql))) mock.ExpectQuery(fmt.Sprintf("^%s$", regexp.QuoteMeta(sql)))
_, err := repo.List(filter, &options) _, err := repo.List(filter, &options)

View File

@ -0,0 +1,18 @@
package repository
import (
"gorm.io/gorm/schema"
)
type SaveMethod[T schema.Tabler] struct {
repo *RepoBase[T]
}
func (m *SaveMethod[T]) Init(repo *RepoBase[T]) {
m.repo = repo
}
func (m SaveMethod[T]) Save(model *T) (*T, error) {
result := m.repo.dbConn.Save(model)
return model, result.Error
}

View File

@ -0,0 +1,69 @@
package repository
import (
"fmt"
"regexp"
"testing"
"github.com/DATA-DOG/go-sqlmock"
"github.com/google/uuid"
"github.com/stretchr/testify/assert"
)
func TestSaveMethod(t *testing.T) {
t.Run("Save new model", func(t *testing.T) {
sqldb, db, mock := NewMockDB()
defer sqldb.Close()
repo := RepoBase[MyModel]{}
repo.Init(db, nil)
model := MyModel{
Value: "some value",
Cnt: 123,
}
sql := "INSERT INTO my_models (id,value,cnt) VALUES ($1,$2,$3)"
mock.ExpectBegin()
mock.ExpectExec(fmt.Sprintf("^%s$", regexp.QuoteMeta(sql))).
WithArgs(model.Id, model.Value, model.Cnt).
WillReturnResult(sqlmock.NewResult(1, 1))
mock.ExpectCommit()
_, err := repo.Save(&model)
assert.Nil(t, err)
if err := mock.ExpectationsWereMet(); err != nil {
t.Errorf("there were unfulfilled expectations: %s", err)
}
})
t.Run("Update existing model", func(t *testing.T) {
sqldb, db, mock := NewMockDB()
defer sqldb.Close()
repo := RepoBase[MyModel]{}
repo.Init(db, nil)
id := uuid.New()
model := MyModel{
Id: &id,
Value: "some value",
Cnt: 123,
}
sql := "UPDATE my_models SET value=$1,cnt=$2 WHERE id = $3"
mock.ExpectBegin()
mock.ExpectExec(fmt.Sprintf("^%s$", regexp.QuoteMeta(sql))).
WithArgs(model.Value, model.Cnt, model.Id).
WillReturnResult(sqlmock.NewResult(1, 1))
mock.ExpectCommit()
_, err := repo.Save(&model)
assert.Nil(t, err)
if err := mock.ExpectationsWereMet(); err != nil {
t.Errorf("there were unfulfilled expectations: %s", err)
}
})
}

View File

@ -0,0 +1,31 @@
package repository
import (
"repo-pattern/app/repository/smartfilter"
"gorm.io/gorm/schema"
)
type UpdateMethod[T schema.Tabler] struct {
repo *RepoBase[T]
}
func (m *UpdateMethod[T]) Init(repo *RepoBase[T]) {
m.repo = repo
}
func (m UpdateMethod[T]) Update(filter interface{}, values map[string]any) (int64, error) {
var (
model T
)
query, err := smartfilter.ToQuery(model, filter, m.repo.dbConn)
if err != nil {
return 0, err
}
result := query.Model(&model).Updates(values)
if result.Error != nil {
return 0, result.Error
}
return result.RowsAffected, nil
}

View File

@ -0,0 +1,43 @@
package repository
import (
"fmt"
"regexp"
"testing"
"github.com/DATA-DOG/go-sqlmock"
"github.com/stretchr/testify/assert"
)
func TestUpdateMethod(t *testing.T) {
t.Run("Update", func(t *testing.T) {
sqldb, db, mock := NewMockDB()
defer sqldb.Close()
repo := RepoBase[MyModel]{}
repo.Init(db, nil)
cnt := 10
filter := MyModelFilter{
CntGT: &cnt,
}
values := map[string]any{
"cnt": 111,
"value": 222,
}
sql := "UPDATE my_models SET cnt=$1,value=$2 WHERE my_models.cnt > $3"
mock.ExpectBegin()
mock.ExpectExec(fmt.Sprintf("^%s$", regexp.QuoteMeta(sql))).
WithArgs(values["cnt"], values["value"], cnt).
WillReturnResult(sqlmock.NewResult(1, 1))
mock.ExpectCommit()
_, err := repo.Update(filter, values)
assert.Nil(t, err)
if err := mock.ExpectationsWereMet(); err != nil {
t.Errorf("there were unfulfilled expectations: %s", err)
}
})
}

View File

@ -5,25 +5,55 @@ import (
"gorm.io/gorm/schema" "gorm.io/gorm/schema"
) )
type MethodInitInterface interface { const DEFAULT_ID_FIELD = "id"
Init(dbConn *gorm.DB)
type MethodInitInterface[T schema.Tabler] interface {
Init(repo *RepoBase[T])
}
type RepoOptions struct {
IdField string
} }
type RepoBase[T schema.Tabler] struct { type RepoBase[T schema.Tabler] struct {
DbConn int IdField string
dbConn *gorm.DB
ListMethod[T] ListMethod[T]
GetMethod[T] GetMethod[T]
ExistsMethod[T] ExistsMethod[T]
methods []MethodInitInterface CountMethod[T]
SaveMethod[T]
UpdateMethod[T]
DeleteMethod[T]
} }
func (b *RepoBase[T]) InitMethods(dbConn *gorm.DB) { func (repo *RepoBase[T]) InitMethods(methods []MethodInitInterface[T]) {
for _, method := range b.methods { for _, method := range methods {
method.Init(dbConn) method.Init(repo)
} }
} }
func (m *RepoBase[T]) Init(dbConn *gorm.DB) { func (m *RepoBase[T]) Init(dbConn *gorm.DB, options *RepoOptions) {
m.methods = []MethodInitInterface{&m.ListMethod, &m.GetMethod, &m.ExistsMethod} m.dbConn = dbConn
m.InitMethods(dbConn)
if options == nil {
// no options provided? set defaults
m.IdField = DEFAULT_ID_FIELD
} else {
if len(options.IdField) > 0 {
m.IdField = options.IdField
}
}
methods := []MethodInitInterface[T]{
&m.ListMethod,
&m.GetMethod,
&m.ExistsMethod,
&m.CountMethod,
&m.SaveMethod,
&m.UpdateMethod,
&m.DeleteMethod,
}
m.InitMethods(methods)
} }

View File

@ -11,11 +11,16 @@ import (
) )
const TAG_NAME = "filterfield" const TAG_NAME = "filterfield"
const TAG_PAIRS_SEPARATOR = "," const TAG_PAIRS_SEPARATOR = ";"
const TAG_LIST_SEPARATOR = ","
const TAG_KEYVALUE_SEPARATOR = "=" const TAG_KEYVALUE_SEPARATOR = "="
type handlerFunc func(query *gorm.DB, tableName string, filterField *FilterField) *gorm.DB type handlerFunc func(query *gorm.DB, tableName string, filterField *FilterField) *gorm.DB
type QueryApplier interface {
ApplyQuery(query *gorm.DB) *gorm.DB
}
var operatorHandlers = map[Operator]handlerFunc{ var operatorHandlers = map[Operator]handlerFunc{
OperatorEQ: handleOperatorEQ, OperatorEQ: handleOperatorEQ,
OperatorNE: handleOperatorNE, OperatorNE: handleOperatorNE,
@ -67,15 +72,20 @@ func getFilterFields(filter interface{}) []ReflectedStructField {
return res return res
} }
func getQueryApplierInterface(filter interface{}) QueryApplier {
queryApplier, ok := filter.(QueryApplier)
if ok {
return queryApplier
}
return nil
}
func ToQuery(model schema.Tabler, filter interface{}, query *gorm.DB) (*gorm.DB, error) { func ToQuery(model schema.Tabler, filter interface{}, query *gorm.DB) (*gorm.DB, error) {
st := reflect.TypeOf(filter) st := reflect.TypeOf(filter)
tableName := model.TableName() tableName := model.TableName()
modelName := st.Name() modelName := st.Name()
fmt.Printf("Table name: %s\n", tableName)
fmt.Printf("Model name: %s\n", modelName)
fields := getFilterFields(filter) fields := getFilterFields(filter)
for _, field := range fields { for _, field := range fields {
filterField, err := newFilterField(field.tagValue) filterField, err := newFilterField(field.tagValue)
@ -97,22 +107,36 @@ func ToQuery(model schema.Tabler, filter interface{}, query *gorm.DB) (*gorm.DB,
} }
} }
// apply custom filters, if interface exists
queryApplier := getQueryApplierInterface(filter)
if queryApplier != nil {
query = queryApplier.ApplyQuery(query)
}
return query, nil return query, nil
} }
func splitTrim(value string, separator string) []string {
var out []string = []string{}
for _, s := range strings.Split(value, separator) {
if len(s) == 0 {
continue
}
out = append(out, strings.TrimSpace(s))
}
return out
}
func newFilterField(tagValue string) (*FilterField, error) { func newFilterField(tagValue string) (*FilterField, error) {
filterField := FilterField{} filterField := FilterField{}
tagValue = strings.TrimSpace(tagValue) for _, pair := range splitTrim(tagValue, TAG_PAIRS_SEPARATOR) {
pairs := strings.Split(tagValue, TAG_PAIRS_SEPARATOR) kvs := splitTrim(pair, TAG_KEYVALUE_SEPARATOR)
for _, pair := range pairs {
kvs := strings.Split(pair, TAG_KEYVALUE_SEPARATOR)
if len(kvs) != 2 { if len(kvs) != 2 {
return nil, fmt.Errorf("invalid tag value: %s", strings.TrimSpace(pair)) return nil, fmt.Errorf("invalid tag value: %s", strings.TrimSpace(pair))
} }
key := strings.TrimSpace(kvs[0]) key := kvs[0]
value := strings.TrimSpace(kvs[1]) value := kvs[1]
switch key { switch key {
case "field": case "field":

View File

@ -6,6 +6,7 @@ import (
"time" "time"
"github.com/stretchr/testify/assert" "github.com/stretchr/testify/assert"
"gorm.io/gorm"
) )
func TestGetFilterFields(t *testing.T) { func TestGetFilterFields(t *testing.T) {
@ -101,11 +102,11 @@ func TestGetFilterFields(t *testing.T) {
t.Run("Skip nil fields", func(t *testing.T) { t.Run("Skip nil fields", func(t *testing.T) {
type TestFilter struct { type TestFilter struct {
Alive *bool `filterfield:"alive,EQ"` Alive *bool `filterfield:"alive;EQ"`
Id *int64 `filterfield:"id,EQ"` Id *int64 `filterfield:"id;EQ"`
Ids *[]uint `filterfield:"id,IN"` Ids *[]uint `filterfield:"id;IN"`
IdsNot *[]uint `filterfield:"id,NOT_IN"` IdsNot *[]uint `filterfield:"id;NOT_IN"`
FirstName *string `filterfield:"first_name,EQ"` FirstName *string `filterfield:"first_name;EQ"`
} }
filter := TestFilter{} filter := TestFilter{}
result := getFilterFields(filter) result := getFilterFields(filter)
@ -119,7 +120,7 @@ func TestGetFilterFields(t *testing.T) {
) )
type TestFilter struct { type TestFilter struct {
Alive *bool Alive *bool
Id *int64 `funnytag:"created_at,LT"` Id *int64 `funnytag:"created_at;LT"`
} }
filter := TestFilter{ filter := TestFilter{
Alive: &alive, Alive: &alive,
@ -140,7 +141,7 @@ func TestFilterField(t *testing.T) {
testCases := []TagParseTestCase{ testCases := []TagParseTestCase{
{ {
name: "Parse without spaces", name: "Parse without spaces",
tagValue: "field=field_1,operator=EQ", tagValue: "field=field_1;operator=EQ",
expected: FilterField{ expected: FilterField{
Name: "field_1", Name: "field_1",
Operator: OperatorEQ, Operator: OperatorEQ,
@ -148,7 +149,7 @@ func TestFilterField(t *testing.T) {
}, },
{ {
name: "Parse spaces between pairs", name: "Parse spaces between pairs",
tagValue: " field=field_2 , operator=LT ", tagValue: " field=field_2 ; operator=LT ",
expected: FilterField{ expected: FilterField{
Name: "field_2", Name: "field_2",
Operator: OperatorLT, Operator: OperatorLT,
@ -156,7 +157,7 @@ func TestFilterField(t *testing.T) {
}, },
{ {
name: "Parse spaces between around keys and values", name: "Parse spaces between around keys and values",
tagValue: "operator = LIKE , field = field_3", tagValue: "operator = LIKE ; field = field_3",
expected: FilterField{ expected: FilterField{
Name: "field_3", Name: "field_3",
Operator: OperatorLIKE, Operator: OperatorLIKE,
@ -174,19 +175,19 @@ func TestFilterField(t *testing.T) {
} }
t.Run("Fail on invalid tag value", func(t *testing.T) { t.Run("Fail on invalid tag value", func(t *testing.T) {
filterField, err := newFilterField("field=field_1=fail, operator=EQ") filterField, err := newFilterField("field=field_1=fail; operator=EQ")
assert.Nil(t, filterField) assert.Nil(t, filterField)
assert.EqualError(t, err, "invalid tag value: field=field_1=fail") assert.EqualError(t, err, "invalid tag value: field=field_1=fail")
}) })
t.Run("Fail on invalid operator", func(t *testing.T) { t.Run("Fail on invalid operator", func(t *testing.T) {
filterField, err := newFilterField("field=field_1, operator=FAIL") filterField, err := newFilterField("field=field_1; operator=FAIL")
assert.Nil(t, filterField) assert.Nil(t, filterField)
assert.EqualError(t, err, "unknown operator: FAIL") assert.EqualError(t, err, "unknown operator: FAIL")
}) })
t.Run("Fail on invalid value key", func(t *testing.T) { t.Run("Fail on invalid value key", func(t *testing.T) {
filterField, err := newFilterField("failkey=field_1, operator=FAIL") filterField, err := newFilterField("failkey=field_1; operator=FAIL")
assert.Nil(t, filterField) assert.Nil(t, filterField)
assert.EqualError(t, err, "invalid value key: failkey") assert.EqualError(t, err, "invalid value key: failkey")
}) })
@ -203,3 +204,26 @@ func TestFilterField(t *testing.T) {
assert.EqualError(t, err, "missing operator in tag: field=field_1") assert.EqualError(t, err, "missing operator in tag: field=field_1")
}) })
} }
type filterWithoutQueryApplier struct{}
type filterWithQueryApplier struct{}
func (f filterWithQueryApplier) ApplyQuery(query *gorm.DB) *gorm.DB {
return query
}
func TestSmartfilterApplyQuery(t *testing.T) {
t.Run("Get query applier interface - without interface", func(t *testing.T) {
f := filterWithoutQueryApplier{}
queryApplier := getQueryApplierInterface(f)
assert.Nil(t, queryApplier)
})
t.Run("Get query applier interface - with interface", func(t *testing.T) {
f := filterWithQueryApplier{}
queryApplier := getQueryApplierInterface(f)
assert.NotNil(t, queryApplier)
})
}