Enhanced model structs with DTOs

2023-03-17 14:56:39 +01:00
--- a/internal/models/gist.go
+++ b/internal/models/gist.go
@@ -8,13 +8,13 @@ import (
 type Gist struct {
 	ID              uint `gorm:"primaryKey"`
 	Uuid            string
-	Title           string `validate:"max=50" form:"title"`
+	Title           string
 	Preview         string
 	PreviewFilename string
-	Description     string `validate:"max=150" form:"description"`
-	Private         bool   `form:"private"`
+	Description     string
+	Private         bool
 	UserID          uint
-	User            User `validate:"-"`
+	User            User
 	NbFiles         int
 	NbLikes         int
 	NbForks         int
@@ -25,7 +25,7 @@ type Gist struct {
 	Forked   *Gist  `gorm:"foreignKey:ForkedID;constraint:OnUpdate:CASCADE,OnDelete:SET NULL"`
 	ForkedID uint

-	Files []File `gorm:"-" validate:"min=1,dive"`
+	Files []File `gorm:"-"`
 }

 type File struct {
@@ -42,11 +42,11 @@ type Commit struct {
 	Files     []File
 }

-func (g *Gist) BeforeDelete(tx *gorm.DB) error {
+func (gist *Gist) BeforeDelete(tx *gorm.DB) error {
 	// Decrement fork counter if the gist was forked
 	err := tx.Model(&Gist{}).
 		Omit("updated_at").
-		Where("id = ?", g.ForkedID).
+		Where("id = ?", gist.ForkedID).
 		UpdateColumn("nb_forks", gorm.Expr("nb_forks - 1")).Error
 	return err
 }
@@ -83,14 +83,14 @@ func GetAllGistsForCurrentUser(currentUserId uint, offset int, sort string, orde
 }

 func GetAllGists(offset int) ([]*Gist, error) {
-	var all []*Gist
+	var gists []*Gist
 	err := db.Preload("User").
 		Limit(11).
 		Offset(offset * 10).
 		Order("id asc").
-		Find(&all).Error
+		Find(&gists).Error

-	return all, err
+	return gists, err
 }

 func GetAllGistsFromUser(fromUser string, currentUserId uint, offset int, sort string, order string) ([]*Gist, error) {
@@ -106,30 +106,30 @@ func GetAllGistsFromUser(fromUser string, currentUserId uint, offset int, sort s
 	return gists, err
 }

-func CreateGist(gist *Gist) error {
+func (gist *Gist) Create() error {
 	// avoids foreign key constraint error because the default value in the struct is 0
 	return db.Omit("forked_id").Create(&gist).Error
 }

-func CreateForkedGist(gist *Gist) error {
+func (gist *Gist) CreateForked() error {
 	return db.Create(&gist).Error
 }

-func UpdateGist(gist *Gist) error {
+func (gist *Gist) Update() error {
 	return db.Omit("forked_id").Save(&gist).Error
 }

-func DeleteGist(gist *Gist) error {
+func (gist *Gist) Delete() error {
 	return db.Delete(&gist).Error
 }

-func GistLastActiveNow(gistID uint) error {
+func (gist *Gist) SetLastActiveNow() error {
 	return db.Model(&Gist{}).
-		Where("id = ?", gistID).
+		Where("id = ?", gist.ID).
 		Update("updated_at", time.Now().Unix()).Error
 }

-func AppendUserLike(gist *Gist, user *User) error {
+func (gist *Gist) AppendUserLike(user *User) error {
 	err := db.Model(&gist).Omit("updated_at").Update("nb_likes", gist.NbLikes+1).Error
 	if err != nil {
 		return err
@@ -138,7 +138,7 @@ func AppendUserLike(gist *Gist, user *User) error {
 	return db.Model(&gist).Omit("updated_at").Association("Likes").Append(user)
 }

-func RemoveUserLike(gist *Gist, user *User) error {
+func (gist *Gist) RemoveUserLike(user *User) error {
 	err := db.Model(&gist).Omit("updated_at").Update("nb_likes", gist.NbLikes-1).Error
 	if err != nil {
 		return err
@@ -147,11 +147,11 @@ func RemoveUserLike(gist *Gist, user *User) error {
 	return db.Model(&gist).Omit("updated_at").Association("Likes").Delete(user)
 }

-func IncrementGistForkCount(gist *Gist) error {
+func (gist *Gist) IncrementForkCount() error {
 	return db.Model(&gist).Omit("updated_at").Update("nb_forks", gist.NbForks+1).Error
 }

-func GetForkedGist(gist *Gist, user *User) (*Gist, error) {
+func (gist *Gist) GetForkParent(user *User) (*Gist, error) {
 	fork := new(Gist)
 	err := db.Preload("User").
 		Where("forked_id = ? and user_id = ?", gist.ID, user.ID).
@@ -159,7 +159,7 @@ func GetForkedGist(gist *Gist, user *User) (*Gist, error) {
 	return fork, err
 }

-func GetUsersLikesForGist(gist *Gist, offset int) ([]*User, error) {
+func (gist *Gist) GetUsersLikes(offset int) ([]*User, error) {
 	var users []*User
 	err := db.Model(&gist).
 		Where("gist_id = ?", gist.ID).
@@ -169,7 +169,7 @@ func GetUsersLikesForGist(gist *Gist, offset int) ([]*User, error) {
 	return users, err
 }

-func GetUsersForksForGist(gist *Gist, currentUserId uint, offset int) ([]*Gist, error) {
+func (gist *Gist) GetForks(currentUserId uint, offset int) ([]*Gist, error) {
 	var gists []*Gist
 	err := db.Model(&gist).Preload("User").
 		Where("forked_id = ?", gist.ID).
@@ -182,6 +182,32 @@ func GetUsersForksForGist(gist *Gist, currentUserId uint, offset int) ([]*Gist,
 	return gists, err
 }

-func UserCanWrite(user *User, gist *Gist) bool {
+func (gist *Gist) CanWrite(user *User) bool {
 	return !(user == nil) && (gist.UserID == user.ID)
 }
+
+// -- DTO -- //
+
+type GistDTO struct {
+	Title       string `validate:"max=50" form:"title"`
+	Description string `validate:"max=150" form:"description"`
+	Private     bool   `form:"private"`
+	Files       []File `validate:"min=1,dive"`
+}
+
+func (dto *GistDTO) ToGist() *Gist {
+	return &Gist{
+		Title:       dto.Title,
+		Description: dto.Description,
+		Private:     dto.Private,
+		Files:       dto.Files,
+	}
+}
+
+func (dto *GistDTO) ToExistingGist(gist *Gist) *Gist {
+	gist.Title = dto.Title
+	gist.Description = dto.Description
+	gist.Private = dto.Private
+	gist.Files = dto.Files
+	return gist
+}
--- a/internal/models/sshkey.go
+++ b/internal/models/sshkey.go
@@ -3,9 +3,9 @@ package models
 import "time"

 type SSHKey struct {
-	ID         uint   `gorm:"primaryKey"`
-	Title      string `form:"title" validate:"required,max=50"`
-	Content    string `form:"content" validate:"required"`
+	ID         uint `gorm:"primaryKey"`
+	Title      string
+	Content    string
 	SHA        string
 	CreatedAt  int64
 	LastUsedAt int64
@@ -41,11 +41,11 @@ func GetSSHKeyByContent(sshKeyContent string) (*SSHKey, error) {
 	return sshKey, err
 }

-func AddSSHKey(sshKey *SSHKey) error {
+func (sshKey *SSHKey) Create() error {
 	return db.Create(&sshKey).Error
 }

-func RemoveSSHKey(sshKey *SSHKey) error {
+func (sshKey *SSHKey) Delete() error {
 	return db.Delete(&sshKey).Error
 }

@@ -54,3 +54,17 @@ func SSHKeyLastUsedNow(sshKeyID uint) error {
 		Where("id = ?", sshKeyID).
 		Update("last_used_at", time.Now().Unix()).Error
 }
+
+// -- DTO -- //
+
+type SSHKeyDTO struct {
+	Title   string `form:"title" validate:"required,max=50"`
+	Content string `form:"content" validate:"required"`
+}
+
+func (dto *SSHKeyDTO) ToSSHKey() *SSHKey {
+	return &SSHKey{
+		Title:   dto.Title,
+		Content: dto.Content,
+	}
+}
--- a/internal/models/user.go
+++ b/internal/models/user.go
@@ -2,13 +2,12 @@ package models

 import (
 	"gorm.io/gorm"
-	"strconv"
 )

 type User struct {
 	ID        uint   `gorm:"primaryKey"`
-	Username  string `form:"username" gorm:"uniqueIndex" validate:"required,max=24,alphanum,notreserved"`
-	Password  string `form:"password" validate:"required"`
+	Username  string `gorm:"uniqueIndex"`
+	Password  string
 	IsAdmin   bool
 	CreatedAt int64

@@ -17,7 +16,7 @@ type User struct {
 	Liked   []Gist   `gorm:"many2many:likes;constraint:OnUpdate:CASCADE,OnDelete:CASCADE"`
 }

-func (u *User) BeforeDelete(tx *gorm.DB) error {
+func (user *User) BeforeDelete(tx *gorm.DB) error {
 	// Decrement likes counter for all gists liked by this user
 	// The likes will be automatically deleted by the foreign key constraint
 	err := tx.Model(&Gist{}).
@@ -25,7 +24,7 @@ func (u *User) BeforeDelete(tx *gorm.DB) error {
 		Where("id IN (?)", tx.
 			Select("gist_id").
 			Table("likes").
-			Where("user_id = ?", u.ID),
+			Where("user_id = ?", user.ID),
 		).
 		UpdateColumn("nb_likes", gorm.Expr("nb_likes - 1")).
 		Error
@@ -39,57 +38,43 @@ func (u *User) BeforeDelete(tx *gorm.DB) error {
 		Where("id IN (?)", tx.
 			Select("forked_id").
 			Table("gists").
-			Where("user_id = ?", u.ID),
+			Where("user_id = ?", user.ID),
 		).
 		UpdateColumn("nb_forks", gorm.Expr("nb_forks - 1")).
 		Error
 }

-func DoesUserExists(userName string, count *int64) error {
-	return db.Table("users").
-		Where("username like ?", userName).
-		Count(count).Error
+func UserExists(username string) (bool, error) {
+	var count int64
+	err := db.Model(&User{}).Where("username like ?", username).Count(&count).Error
+	return count > 0, err
 }

 func GetAllUsers(offset int) ([]*User, error) {
-	var all []*User
+	var users []*User
 	err := db.
 		Limit(11).
 		Offset(offset * 10).
 		Order("id asc").
-		Find(&all).Error
+		Find(&users).Error

-	return all, err
+	return users, err
 }

-func GetLoginUser(user *User) error {
-	return db.
-		Where("username like ?", user.Username).
+func GetUserByUsername(username string) (*User, error) {
+	user := new(User)
+	err := db.
+		Where("username like ?", username).
 		First(&user).Error
+	return user, err
 }

-func GetLoginUserById(user *User) error {
-	return db.
-		Where("id = ?", user.ID).
+func GetUserById(userId uint) (*User, error) {
+	user := new(User)
+	err := db.
+		Where("id = ?", userId).
 		First(&user).Error
-}
-
-func CreateUser(user *User) error {
-	return db.Create(&user).Error
-}
-
-func DeleteUser(userid string) error {
-	// trigger hook with a user ID
-	intId, err := strconv.ParseUint(userid, 10, 64)
-	if err != nil {
-		return err
-	}
-	var user = &User{ID: uint(intId)}
-	return db.Where("id = ?", userid).Delete(&user).Error
-}
-
-func SetAdminUser(user *User) error {
-	return db.Model(&user).Update("is_admin", true).Error
+	return user, err
 }

 func GetUserBySSHKeyID(sshKeyId uint) (*User, error) {
@@ -103,7 +88,19 @@ func GetUserBySSHKeyID(sshKeyId uint) (*User, error) {
 	return user, err
 }

-func UserHasLikedGist(user *User, gist *Gist) (bool, error) {
+func (user *User) Create() error {
+	return db.Create(&user).Error
+}
+
+func (user *User) Delete() error {
+	return db.Delete(&user).Error
+}
+
+func (user *User) SetAdmin() error {
+	return db.Model(&user).Update("is_admin", true).Error
+}
+
+func (user *User) HasLiked(gist *Gist) (bool, error) {
 	association := db.Model(&gist).Where("user_id = ?", user.ID).Association("Likes")
 	if association.Error != nil {
 		return false, association.Error
@@ -114,3 +111,17 @@ func UserHasLikedGist(user *User, gist *Gist) (bool, error) {
 	}
 	return true, nil
 }
+
+// -- DTO -- //
+
+type UserDTO struct {
+	Username string `form:"username" validate:"required,max=24,alphanum,notreserved"`
+	Password string `form:"password" validate:"required"`
+}
+
+func (dto *UserDTO) ToUser() *User {
+	return &User{
+		Username: dto.Username,
+		Password: dto.Password,
+	}
+}