Implement generic Table for basic CRUD operations & concurrent safe dequeuing

tests/database_test.go

@@ -0,0 +1,46 @@
+package pgkit_test
+
+import (
+	"context"
+
+	"github.com/goware/pgkit/v2"
+	"github.com/jackc/pgx/v5"
+)
+
+type Database struct {
+	*pgkit.DB
+
+	Accounts *accountsTable
+	Articles *articlesTable
+	Reviews  *reviewsTable
+}
+
+func initDB(db *pgkit.DB) *Database {
+	return &Database{
+		DB:       db,
+		Accounts: &accountsTable{Table: &pgkit.Table[Account, *Account, int64]{DB: db, Name: "accounts", IDColumn: "id"}},
+		Articles: &articlesTable{Table: &pgkit.Table[Article, *Article, uint64]{DB: db, Name: "articles", IDColumn: "id"}},
+		Reviews:  &reviewsTable{Table: &pgkit.Table[Review, *Review, uint64]{DB: db, Name: "reviews", IDColumn: "id"}},
+	}
+}
+
+func (db *Database) BeginTx(ctx context.Context, fn func(tx *Database) error) error {
+	return pgx.BeginFunc(ctx, db.Conn, func(pgTx pgx.Tx) error {
+		tx := db.WithTx(pgTx)
+		return fn(tx)
+	})
+}
+
+func (db *Database) WithTx(tx pgx.Tx) *Database {
+	pgkitDB := &pgkit.DB{
+		Conn:  db.Conn,
+		SQL:   db.SQL,
+		Query: db.TxQuery(tx),
+	}
+
+	return initDB(pgkitDB)
+}
+
+func (db *Database) Close() {
+	db.DB.Conn.Close()
+}

tests/helpers_test.go

@@ -8,6 +8,14 @@ import (
 	"github.com/stretchr/testify/assert"
 )
 
+func truncateAllTables(t *testing.T) {
+	truncateTable(t, "accounts")
+	truncateTable(t, "reviews")
+	truncateTable(t, "logs")
+	truncateTable(t, "stats")
+	truncateTable(t, "articles")
+}
+
 func truncateTable(t *testing.T, tableName string) {
 	_, err := DB.Conn.Exec(context.Background(), fmt.Sprintf(`TRUNCATE TABLE %q CASCADE`, tableName))
 	assert.NoError(t, err)

tests/pgkit_test.go

@@ -307,8 +307,16 @@ func TestRecordsWithJSONB(t *testing.T) {
 func TestRecordsWithJSONStruct(t *testing.T) {
 	truncateTable(t, "articles")
 
+	account := &Account{
+		Name: "TestRecordsWithJSONStruct",
+	}
+	err := DB.Query.QueryRow(context.Background(), DB.SQL.InsertRecord(account).Suffix(`RETURNING "id"`)).Scan(&account.ID)
+	assert.NoError(t, err)
+	assert.True(t, account.ID > 0)
+
 	article := &Article{
-		Author: "Gary",
+		AccountID: account.ID,
+		Author:    "Gary",
 		Content: Content{
 			Title: "How to cook pizza",
 			Body:  "flour+water+salt+yeast+cheese",
@@ -319,7 +327,7 @@ func TestRecordsWithJSONStruct(t *testing.T) {
 	cols, _, err := pgkit.Map(article)
 	assert.NoError(t, err)
 	sort.Strings(cols)
-	assert.Equal(t, []string{"alias", "author", "content"}, cols)
+	assert.Equal(t, []string{"account_id", "alias", "author", "content", "deleted_at"}, cols)
 
 	// Insert record
 	q1 := DB.SQL.InsertRecord(article, "articles")

tests/schema_test.go

@@ -1,6 +1,7 @@
 package pgkit_test
 
 import (
+	"fmt"
 	"time"
 
 	"github.com/goware/pgkit/v2/dbtype"
@@ -11,19 +12,85 @@ type Account struct {
 	Name      string    `db:"name"`
 	Disabled  bool      `db:"disabled"`
 	CreatedAt time.Time `db:"created_at,omitempty"` // ,omitempty will rely on postgres DEFAULT
+	UpdatedAt time.Time `db:"updated_at,omitempty"` // ,omitempty will rely on postgres DEFAULT
 }
 
-func (a *Account) DBTableName() string {
-	return "accounts"
+func (a *Account) DBTableName() string      { return "accounts" }
+func (a *Account) GetID() int64             { return a.ID }
+func (a *Account) SetUpdatedAt(t time.Time) { a.UpdatedAt = t }
+
+func (a *Account) Validate() error {
+	if a.Name == "" {
+		return fmt.Errorf("name is required")
+	}
+
+	return nil
+}
+
+type Article struct {
+	ID        uint64     `db:"id,omitempty"`
+	Author    string     `db:"author"`
+	Alias     *string    `db:"alias"`
+	Content   Content    `db:"content"` // using JSONB postgres datatype
+	AccountID int64      `db:"account_id"`
+	CreatedAt time.Time  `db:"created_at,omitempty"` // ,omitempty will rely on postgres DEFAULT
+	UpdatedAt time.Time  `db:"updated_at,omitempty"` // ,omitempty will rely on postgres DEFAULT
+	DeletedAt *time.Time `db:"deleted_at"`
+}
+
+func (a *Article) GetID() uint64            { return a.ID }
+func (a *Article) SetUpdatedAt(t time.Time) { a.UpdatedAt = t }
+func (a *Article) SetDeletedAt(t time.Time) { a.DeletedAt = &t }
+
+func (a *Article) Validate() error {
+	if a.Author == "" {
+		return fmt.Errorf("author is required")
+	}
+
+	return nil
+}
+
+type Content struct {
+	Title string `json:"title"`
+	Body  string `json:"body"`
+	Views int64  `json:"views"`
 }
 
 type Review struct {
-	ID        int64     `db:"id,omitempty"`
-	Name      string    `db:"name"`
-	Comments  string    `db:"comments"`
-	CreatedAt time.Time `db:"created_at"` // if unset, will store Go zero-value
+	ID          uint64       `db:"id,omitempty"`
+	Comment     string       `db:"comment"`
+	Status      ReviewStatus `db:"status"`
+	Sentiment   int64        `db:"sentiment"`
+	AccountID   int64        `db:"account_id"`
+	ArticleID   uint64       `db:"article_id"`
+	ProcessedAt *time.Time   `db:"processed_at"`
+	CreatedAt   time.Time    `db:"created_at,omitempty"` // ,omitempty will rely on postgres DEFAULT
+	UpdatedAt   time.Time    `db:"updated_at,omitempty"` // ,omitempty will rely on postgres DEFAULT
+	DeletedAt   *time.Time   `db:"deleted_at"`
 }
 
+func (r *Review) GetID() uint64            { return r.ID }
+func (r *Review) SetUpdatedAt(t time.Time) { r.UpdatedAt = t }
+func (r *Review) SetDeletedAt(t time.Time) { r.DeletedAt = &t }
+
+func (r *Review) Validate() error {
+	if len(r.Comment) < 3 {
+		return fmt.Errorf("comment too short")
+	}
+
+	return nil
+}
+
+type ReviewStatus int64
+
+const (
+	ReviewStatusPending ReviewStatus = iota
+	ReviewStatusProcessing
+	ReviewStatusApproved
+	ReviewStatusRejected
+	ReviewStatusFailed
+)
+
 type Log struct {
 	ID      int64  `db:"id,omitempty"`
 	Message string `db:"message"`
@@ -38,16 +105,3 @@ type Stat struct {
 	Num    dbtype.BigInt `db:"big_num"` // using NUMERIC(78,0) postgres datatype
 	Rating dbtype.BigInt `db:"rating"`  // using NUMERIC(78,0) postgres datatype
 }
-
-type Article struct {
-	ID      int64   `db:"id,omitempty"`
-	Author  string  `db:"author"`
-	Alias   *string `db:"alias"`
-	Content Content `db:"content"` // using JSONB postgres datatype
-}
-
-type Content struct {
-	Title string `json:"title"`
-	Body  string `json:"body"`
-	Views int64  `json:"views"`
-}