From e113c79a6d2d5b10ca825ed77aee6d3f24dcd50f Mon Sep 17 00:00:00 2001 From: Florian Sylvain Date: Wed, 6 Sep 2023 03:38:52 +0200 Subject: [PATCH] fix: all remaining "article" replaced by "post" All instances of the term "article" were replaced with "post" in variable names, type names, function names, etc. This was primarily to ensure consistent naming and reduce confusion going forward. The term "post" was chosen as it's a more commonly used term for the involved operations in the context of content management and blogging platforms. All tests were also updated to reflect these changes. --- adapters/secondary/gateways/postRepository.go | 32 ++++++++-------- api/dependecyInjection.go | 38 +++++++++---------- api/post.go | 10 ++--- domain/gateways/IPostRepository.go | 4 +- main/route/route.go | 2 +- test/post_test.go | 10 ++--- useCases/GetPostUseCase.go | 14 +++---- useCases/ListPostsUseCase.go | 14 +++---- 8 files changed, 62 insertions(+), 62 deletions(-) diff --git a/adapters/secondary/gateways/postRepository.go b/adapters/secondary/gateways/postRepository.go index 15a1bd9..f1ea051 100644 --- a/adapters/secondary/gateways/postRepository.go +++ b/adapters/secondary/gateways/postRepository.go @@ -20,43 +20,43 @@ func mapPostToDomain(post entity.Post) domain.Post { } func (a *PostRepository) Get(id uint32) (domain.Post, error) { - var article entity.Post - err := a.db.Model(&entity.Post{}).First(&article, id).Error + var post entity.Post + err := a.db.Model(&entity.Post{}).First(&post, id).Error if err != nil { return domain.Post{}, err } - return mapPostToDomain(article), nil + return mapPostToDomain(post), nil } -func (a *PostRepository) Create(article domain.Post) (domain.Post, error) { +func (a *PostRepository) Create(post domain.Post) (domain.Post, error) { creationResult := a.db.Create(&entity.Post{ - Title: article.Title, - Body: article.Body, + Title: post.Title, + Body: post.Body, }) if creationResult.Error != nil { return domain.Post{}, creationResult.Error } - var createdArticle entity.Post - creationResult.Scan(&createdArticle) + var createdPost entity.Post + creationResult.Scan(&createdPost) - return mapPostToDomain(createdArticle), nil + return mapPostToDomain(createdPost), nil } func (a *PostRepository) GetAll() []domain.Post { - var articles []entity.Post - err := a.db.Model(&entity.Post{}).Find(&articles).Error + var posts []entity.Post + err := a.db.Model(&entity.Post{}).Find(&posts).Error if err != nil { return []domain.Post{} } - var domainArticles = make([]domain.Post, 0) - for _, article := range articles { - domainArticles = append(domainArticles, mapPostToDomain(article)) + var domainPosts = make([]domain.Post, 0) + for _, post := range posts { + domainPosts = append(domainPosts, mapPostToDomain(post)) } - return domainArticles + return domainPosts } -var _ gateways.IArticleRepository = &PostRepository{} +var _ gateways.IPostRepository = &PostRepository{} diff --git a/api/dependecyInjection.go b/api/dependecyInjection.go index 863657c..538d1b2 100644 --- a/api/dependecyInjection.go +++ b/api/dependecyInjection.go @@ -11,34 +11,34 @@ import ( ) type LocalContainer struct { - CreateArticleUseCase *useCases.CreatePostUseCase - GetArticleUseCase *useCases.GetArticleUseCase - ListArticlesUseCase *useCases.ListArticlesUseCase - GetUserUseCase *useCases.GetUserUseCase - CreateUserUseCase *useCases.CreateUserUseCase - ListUsersUseCase *useCases.ListUsersUseCase - GetPageUseCase *useCases.GetPageUseCase + CreatePostUseCase *useCases.CreatePostUseCase + GetPostUseCase *useCases.GetPostUseCase + ListPostsUseCase *useCases.ListPostsUseCase + GetUserUseCase *useCases.GetUserUseCase + CreateUserUseCase *useCases.CreateUserUseCase + ListUsersUseCase *useCases.ListUsersUseCase + GetPageUseCase *useCases.GetPageUseCase } var Container *LocalContainer func setContainer( - createArticle *useCases.CreatePostUseCase, - getArticle *useCases.GetArticleUseCase, - listArticle *useCases.ListArticlesUseCase, + createPost *useCases.CreatePostUseCase, + getPost *useCases.GetPostUseCase, + listPost *useCases.ListPostsUseCase, getUser *useCases.GetUserUseCase, createUser *useCases.CreateUserUseCase, listUsers *useCases.ListUsersUseCase, getPage *useCases.GetPageUseCase, ) *LocalContainer { Container = &LocalContainer{ - CreateArticleUseCase: createArticle, - GetArticleUseCase: getArticle, - ListArticlesUseCase: listArticle, - GetUserUseCase: getUser, - CreateUserUseCase: createUser, - ListUsersUseCase: listUsers, - GetPageUseCase: getPage, + CreatePostUseCase: createPost, + GetPostUseCase: getPost, + ListPostsUseCase: listPost, + GetUserUseCase: getUser, + CreateUserUseCase: createUser, + ListUsersUseCase: listUsers, + GetPageUseCase: getPage, } return Container } @@ -65,8 +65,8 @@ func InitContainer() { _ = digContainer.Provide(func() *gorm.DB { return db }) _ = digContainer.Provide(func(db *gorm.DB) *useCases.CreatePostUseCase { return useCases.NewCreatePostUseCase(db) }) - _ = digContainer.Provide(func(db *gorm.DB) *useCases.GetArticleUseCase { return useCases.NewGetArticleUseCase(db) }) - _ = digContainer.Provide(func(db *gorm.DB) *useCases.ListArticlesUseCase { return useCases.NewListArticlesUseCase(db) }) + _ = digContainer.Provide(func(db *gorm.DB) *useCases.GetPostUseCase { return useCases.NewGetPostUseCase(db) }) + _ = digContainer.Provide(func(db *gorm.DB) *useCases.ListPostsUseCase { return useCases.NewListPostsUseCase(db) }) _ = digContainer.Provide(func(db *gorm.DB) *useCases.GetUserUseCase { return useCases.NewGetUserUseCase(db) }) _ = digContainer.Provide(func(db *gorm.DB) *useCases.CreateUserUseCase { return useCases.NewCreateUserUseCase(db) }) _ = digContainer.Provide(func(db *gorm.DB) *useCases.ListUsersUseCase { return useCases.NewListUsersUseCase(db) }) diff --git a/api/post.go b/api/post.go index cd97fe5..2c1348e 100644 --- a/api/post.go +++ b/api/post.go @@ -20,7 +20,7 @@ func getPost(w http.ResponseWriter, r *http.Request) { return } - post, err := Container.GetArticleUseCase.GetArticle(uint32(id)) + post, err := Container.GetPostUseCase.GetPost(uint32(id)) if err != nil { http.Error(w, "The requested resource, identified by its unique ID, could not be found on the server.", http.StatusNotFound) return @@ -44,7 +44,7 @@ func postPost(w http.ResponseWriter, r *http.Request) { return } - createdArticle, err := Container.CreateArticleUseCase.CreatePost(useCases.CreatePostCommand{ + createdPost, err := Container.CreatePostUseCase.CreatePost(useCases.CreatePostCommand{ Title: post.Title, Body: post.Body, }) @@ -52,19 +52,19 @@ func postPost(w http.ResponseWriter, r *http.Request) { http.Error(w, err.Error(), http.StatusInternalServerError) return } - postJson, _ := json.Marshal(createdArticle) + postJson, _ := json.Marshal(createdPost) _, _ = w.Write(postJson) } func listPosts(w http.ResponseWriter, _ *http.Request) { - posts := Container.ListArticlesUseCase.ListArticles() + posts := Container.ListPostsUseCase.ListPosts() postsJson, _ := json.Marshal(posts) _, _ = w.Write(postsJson) } -func NewArticleRouter() http.Handler { +func NewPostRouter() http.Handler { r := chi.NewRouter() r.Get("/{id}", getPost) r.Post("/", postPost) diff --git a/domain/gateways/IPostRepository.go b/domain/gateways/IPostRepository.go index cb7974a..569b29b 100644 --- a/domain/gateways/IPostRepository.go +++ b/domain/gateways/IPostRepository.go @@ -4,8 +4,8 @@ import ( "GohCMS2/domain/post" ) -type IArticleRepository interface { +type IPostRepository interface { Get(id uint32) (post.Post, error) GetAll() []post.Post - Create(article post.Post) (post.Post, error) + Create(post post.Post) (post.Post, error) } diff --git a/main/route/route.go b/main/route/route.go index 89ea87e..c14d837 100644 --- a/main/route/route.go +++ b/main/route/route.go @@ -46,7 +46,7 @@ func InitBackendRoutes() *chi.Mux { r.Group(func(r chi.Router) { r.Use(jwtauth.Verifier(api.TokenAuth)) r.Use(jwtauth.Authenticator) - r.Mount("/post", api.NewArticleRouter()) + r.Mount("/post", api.NewPostRouter()) }) r.Mount("/auth", api.NewAuthRouter()) diff --git a/test/post_test.go b/test/post_test.go index b663610..13aa332 100644 --- a/test/post_test.go +++ b/test/post_test.go @@ -67,12 +67,12 @@ var TestCreatePostTitleTooShort = func(t *testing.T) { var TestGetPostSuccess = func(t *testing.T) { var createdPost post.Post - var articleToCreate = post.Post{ + var postToCreate = post.Post{ Title: "Test Title", Body: "Test Body", } db := GetDb() - db.Create(&articleToCreate).Scan(&createdPost) + db.Create(&postToCreate).Scan(&createdPost) r, _ := ApiRequest("GET", "/post/"+strconv.Itoa(int(createdPost.ID)), nil) @@ -95,12 +95,12 @@ var TestGetPostSuccess = func(t *testing.T) { var TestGetAllPostsSuccess = func(t *testing.T) { var createdPost post.Post - var articleToCreate = post.Post{ + var postToCreate = post.Post{ Title: "Test Title", Body: "Test Body", } db := GetDb() - db.Create(&articleToCreate).Scan(&createdPost) + db.Create(&postToCreate).Scan(&createdPost) r, _ := ApiRequest("GET", "/post", nil) @@ -131,7 +131,7 @@ var TestPostGet = func(t *testing.T) { } var TestPostGetAll = func(t *testing.T) { - t.Run("Should return all articles", TestGetAllPostsSuccess) + t.Run("Should return all posts", TestGetAllPostsSuccess) } func TestPost(t *testing.T) { diff --git a/useCases/GetPostUseCase.go b/useCases/GetPostUseCase.go index 7c8a967..d95f507 100644 --- a/useCases/GetPostUseCase.go +++ b/useCases/GetPostUseCase.go @@ -6,16 +6,16 @@ import ( "gorm.io/gorm" ) -type GetArticleUseCase struct { - articleRepository gateways.PostRepository +type GetPostUseCase struct { + postRepository gateways.PostRepository } -func NewGetArticleUseCase(db *gorm.DB) *GetArticleUseCase { - return &GetArticleUseCase{ - articleRepository: *gateways.NewPostRepository(db), +func NewGetPostUseCase(db *gorm.DB) *GetPostUseCase { + return &GetPostUseCase{ + postRepository: *gateways.NewPostRepository(db), } } -func (g *GetArticleUseCase) GetArticle(id uint32) (post.Post, error) { - return g.articleRepository.Get(id) +func (g *GetPostUseCase) GetPost(id uint32) (post.Post, error) { + return g.postRepository.Get(id) } diff --git a/useCases/ListPostsUseCase.go b/useCases/ListPostsUseCase.go index 67ba9b4..cbb2ee0 100644 --- a/useCases/ListPostsUseCase.go +++ b/useCases/ListPostsUseCase.go @@ -6,16 +6,16 @@ import ( "gorm.io/gorm" ) -type ListArticlesUseCase struct { - articleRepository gateways.PostRepository +type ListPostsUseCase struct { + postRepository gateways.PostRepository } -func NewListArticlesUseCase(db *gorm.DB) *ListArticlesUseCase { - return &ListArticlesUseCase{ - articleRepository: *gateways.NewPostRepository(db), +func NewListPostsUseCase(db *gorm.DB) *ListPostsUseCase { + return &ListPostsUseCase{ + postRepository: *gateways.NewPostRepository(db), } } -func (g *ListArticlesUseCase) ListArticles() []post.Post { - return g.articleRepository.GetAll() +func (g *ListPostsUseCase) ListPosts() []post.Post { + return g.postRepository.GetAll() }