feat: added GORM's SetupJoinTables function and ForeignKey struct

Author: ralvarezdev

errors.go

@@ -3,6 +3,8 @@ package go_databases
 import "errors"
 
 var (
+	ErrNilDatabase        = errors.New("database cannot be nil")
+	ErrNilForeignKey      = errors.New("foreign key cannot be nil")
 	ErrAlreadyConnected   = errors.New("connection to database already established")
 	ErrConnectionFailed   = errors.New("failed to connect to database")
 	ErrPingFailed         = errors.New("failed to ping database")

go.mod

@@ -7,12 +7,15 @@ require (
 	github.com/ralvarezdev/go-logger v0.2.2
 	go.mongodb.org/mongo-driver v1.17.1
 	golang.org/x/net v0.33.0
+	gorm.io/gorm v1.25.12
 )
 
 require (
 	github.com/cespare/xxhash/v2 v2.3.0 // indirect
 	github.com/dgryski/go-rendezvous v0.0.0-20200823014737-9f7001d12a5f // indirect
 	github.com/golang/snappy v0.0.4 // indirect
+	github.com/jinzhu/inflection v1.0.0 // indirect
+	github.com/jinzhu/now v1.1.5 // indirect
 	github.com/klauspost/compress v1.13.6 // indirect
 	github.com/montanaflynn/stats v0.7.1 // indirect
 	github.com/xdg-go/pbkdf2 v1.0.0 // indirect

gorm/foreign_key.go

@@ -0,0 +1,67 @@
+package gorm
+
+import (
+	godatabases "github.com/ralvarezdev/go-databases"
+	"gorm.io/gorm"
+)
+
+type (
+	// ForeignKey struct
+	ForeignKey struct {
+		model     interface{}
+		field     string
+		joinTable interface{}
+	}
+)
+
+// NewForeignKey creates a new foreign key
+func NewForeignKey(
+	model interface{},
+	field string,
+	joinTable interface{},
+) *ForeignKey {
+	return &ForeignKey{
+		model:     model,
+		field:     field,
+		joinTable: joinTable,
+	}
+}
+
+// SetupJoinTable create foreign key
+func SetupJoinTable(
+	database *gorm.DB,
+	foreignKey *ForeignKey,
+) error {
+	// Check if the database or the foreign key is nil
+	if database == nil {
+		return godatabases.ErrNilDatabase
+	}
+	if foreignKey == nil {
+		return godatabases.ErrNilForeignKey
+	}
+
+	return database.SetupJoinTable(
+		foreignKey.model,
+		foreignKey.field,
+		foreignKey.joinTable,
+	)
+}
+
+// SetupJoinTables create foreign keys
+func SetupJoinTables(
+	database *gorm.DB,
+	foreignKeys []*ForeignKey,
+) error {
+	for _, foreignKey := range foreignKeys {
+		err := database.SetupJoinTable(
+			foreignKey.model,
+			foreignKey.field,
+			foreignKey.joinTable,
+		)
+		if err != nil {
+			return err
+		}
+	}
+
+	return nil
+}