Merged AddCategoryRequest & UpdateCategoryRequest

MohammadIqbalAD · MohammadIqbalAD · commit f74aabe0481a · 2022-11-25T14:45:03.000Z
Merged and renamed references to AddCategoryRequest &amp; UpdateCategoryRequest.
diff --git a/src/main/java/com/answerdigital/answerking/controller/CategoryController.java b/src/main/java/com/answerdigital/answerking/controller/CategoryController.java
@@ -1,8 +1,7 @@
 package com.answerdigital.answerking.controller;
 
 import com.answerdigital.answerking.model.Category;
-import com.answerdigital.answerking.request.AddCategoryRequest;
-import com.answerdigital.answerking.request.UpdateCategoryRequest;
+import com.answerdigital.answerking.request.RequestModelsCategory;
 import com.answerdigital.answerking.service.CategoryService;
 import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.media.Content;
@@ -41,7 +40,7 @@ public CategoryController(final CategoryService categoryService) {
     }
 
     @PostMapping
-    public ResponseEntity<Category> addCategory(@Valid @RequestBody final AddCategoryRequest categoryRequest) {
+    public ResponseEntity<Category> addCategory(@Valid @RequestBody final RequestModelsCategory categoryRequest) {
         return new ResponseEntity<>(categoryService.addCategory(categoryRequest), HttpStatus.CREATED);
     }
 
@@ -74,7 +73,7 @@ public ResponseEntity<Category> removeProductFromCategory(@PathVariable @NotNull
     }
 
     @PutMapping("/{categoryId}")
-    public ResponseEntity<Category> updateCategory(@Valid @RequestBody final UpdateCategoryRequest updateCategoryRequest,
+    public ResponseEntity<Category> updateCategory(@Valid @RequestBody final RequestModelsCategory updateCategoryRequest,
                                                    @PathVariable @NotNull final Long categoryId) {
         return new ResponseEntity<>(categoryService.updateCategory(updateCategoryRequest, categoryId), HttpStatus.OK);
     }
diff --git a/src/main/java/com/answerdigital/answerking/mapper/CategoryMapper.java b/src/main/java/com/answerdigital/answerking/mapper/CategoryMapper.java
@@ -1,14 +1,13 @@
 package com.answerdigital.answerking.mapper;
 
 import com.answerdigital.answerking.model.Category;
-import com.answerdigital.answerking.request.AddCategoryRequest;
-import com.answerdigital.answerking.request.UpdateCategoryRequest;
+import com.answerdigital.answerking.request.RequestModelsCategory;
 import org.mapstruct.Mapper;
 import org.mapstruct.MappingTarget;
 
 @Mapper(componentModel = "spring")
 public interface CategoryMapper {
-    Category addRequestToCategory(AddCategoryRequest addCategoryRequest);
+    Category addRequestToCategory(RequestModelsCategory addCategoryRequest);
 
-    Category updateRequestToCategory(@MappingTarget Category category, UpdateCategoryRequest updateCategoryRequest);
+    Category updateRequestToCategory(@MappingTarget Category category, RequestModelsCategory updateCategoryRequest);
 }
diff --git a/src/main/java/com/answerdigital/answerking/model/Category.java b/src/main/java/com/answerdigital/answerking/model/Category.java
@@ -1,6 +1,6 @@
 package com.answerdigital.answerking.model;
 
-import com.answerdigital.answerking.request.AddCategoryRequest;
+import com.answerdigital.answerking.request.RequestModelsCategory;
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import lombok.AllArgsConstructor;
 import lombok.Builder;
@@ -54,7 +54,7 @@ public class Category {
     @JsonIgnore
     private Set<Product> products = new HashSet<>();
 
-    public Category(final AddCategoryRequest categoryRequest) {
+    public Category(final RequestModelsCategory categoryRequest) {
         this.name = categoryRequest.name();
         this.description = categoryRequest.description();
         this.retired = false;
diff --git a/src/main/java/com/answerdigital/answerking/request/RequestModelsCategory.java b/src/main/java/com/answerdigital/answerking/request/RequestModelsCategory.java
@@ -3,7 +3,7 @@
 import javax.validation.constraints.NotBlank;
 import javax.validation.constraints.Pattern;
 
-public record AddCategoryRequest(
+public record RequestModelsCategory(
         @NotBlank
         @Pattern(regexp = "^[a-zA-Z\s-]*",
                 message = "Category name must only contain letters, spaces and dashes")
diff --git a/src/main/java/com/answerdigital/answerking/request/UpdateCategoryRequest.java b/src/main/java/com/answerdigital/answerking/request/UpdateCategoryRequest.java
diff --git a/src/main/java/com/answerdigital/answerking/service/CategoryService.java b/src/main/java/com/answerdigital/answerking/service/CategoryService.java
@@ -8,8 +8,7 @@
 import com.answerdigital.answerking.model.Category;
 import com.answerdigital.answerking.model.Product;
 import com.answerdigital.answerking.repository.CategoryRepository;
-import com.answerdigital.answerking.request.AddCategoryRequest;
-import com.answerdigital.answerking.request.UpdateCategoryRequest;
+import com.answerdigital.answerking.request.RequestModelsCategory;
 import org.mapstruct.factory.Mappers;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.stereotype.Service;
@@ -33,7 +32,7 @@ public CategoryService(final ProductService productService,
         this.categoryRepository = categoryRepository;
     }
 
-    public Category addCategory(final AddCategoryRequest categoryRequest) {
+    public Category addCategory(final RequestModelsCategory categoryRequest) {
         if (categoryRepository.existsByName(categoryRequest.name())) {
             throw new NameUnavailableException(String.format("A category named '%s' already exists", categoryRequest.name()));
         }
@@ -51,7 +50,7 @@ public Set<Category> findAll() {
         return categoryRepository.findAll();
     }
 
-    public Category updateCategory(final UpdateCategoryRequest updateCategoryRequest, final Long id) {
+    public Category updateCategory(final RequestModelsCategory updateCategoryRequest, final Long id) {
         // check that the category isn't being renamed to a category name that already exists
         if (categoryRepository.existsByNameAndIdIsNot(updateCategoryRequest.name(), id)) {
             throw new NameUnavailableException(String.format("A category named %s already exists", updateCategoryRequest.name()));
diff --git a/src/test/java/com/answerdigital/answerking/controller/CategoryControllerRequestValidatorTest.java b/src/test/java/com/answerdigital/answerking/controller/CategoryControllerRequestValidatorTest.java
@@ -1,7 +1,6 @@
 package com.answerdigital.answerking.controller;
 
-import com.answerdigital.answerking.request.AddCategoryRequest;
-import com.answerdigital.answerking.request.UpdateCategoryRequest;
+import com.answerdigital.answerking.request.RequestModelsCategory;
 import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.params.ParameterizedTest;
@@ -49,10 +48,10 @@ private static Stream<Arguments> provideInvalidStringsForAddCategory() {
     @MethodSource("provideInvalidStringsForAddCategory")
     void addCategoryWithInvalidRequest(String name, String description) {
         // given
-        AddCategoryRequest addCategoryRequest = new AddCategoryRequest(name, description);
+        RequestModelsCategory addCategoryRequest = new RequestModelsCategory(name, description);
 
         // when
-        Set<ConstraintViolation<AddCategoryRequest>> violations = validator.validate(addCategoryRequest);
+        Set<ConstraintViolation<RequestModelsCategory>> violations = validator.validate(addCategoryRequest);
 
         // then
         assertFalse(violations.isEmpty());
@@ -74,10 +73,10 @@ private static Stream<Arguments> provideInvalidStringsForUpdateCategory() {
     @MethodSource("provideInvalidStringsForUpdateCategory")
     void updateCategoryWithInvalidRequest(String name, String description) {
         // given
-        UpdateCategoryRequest updateCategoryRequest = new UpdateCategoryRequest(name, description);
+        RequestModelsCategory updateCategoryRequest = new RequestModelsCategory(name, description);
 
         // when
-        Set<ConstraintViolation<UpdateCategoryRequest>> violations = validator.validate(updateCategoryRequest);
+        Set<ConstraintViolation<RequestModelsCategory>> violations = validator.validate(updateCategoryRequest);
 
         // then
         assertFalse(violations.isEmpty());
diff --git a/src/test/java/com/answerdigital/answerking/controller/CategoryControllerTest.java b/src/test/java/com/answerdigital/answerking/controller/CategoryControllerTest.java
@@ -1,8 +1,7 @@
 package com.answerdigital.answerking.controller;
 
 import com.answerdigital.answerking.model.Category;
-import com.answerdigital.answerking.request.AddCategoryRequest;
-import com.answerdigital.answerking.request.UpdateCategoryRequest;
+import com.answerdigital.answerking.request.RequestModelsCategory;
 import com.answerdigital.answerking.service.CategoryService;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import org.junit.jupiter.api.Test;
@@ -60,7 +59,7 @@ void removeProductFromCategoryTest() throws Exception {
     @Test
     void addCategoryTest() throws Exception {
         ObjectMapper mapper = new ObjectMapper();
-        final var addCategoryRequest =  new AddCategoryRequest("random name", "random description");
+        final var addCategoryRequest = new RequestModelsCategory("random name", "random description");
         final var category = new Category(addCategoryRequest);
         final var categoryRequest = "{\"name\": \"random name\",\"description\": \"random description\"}";
 
@@ -109,7 +108,7 @@ void addCategoryWithInvalidCategoryRequestDescTest() throws Exception {
     @Test
     void updateCategoryTest() throws Exception {
         ObjectMapper mapper = new ObjectMapper();
-        final var updateCategoryRequest =  new UpdateCategoryRequest("random name", "random description");
+        final var updateCategoryRequest = new RequestModelsCategory("random name", "random description");
         final var newRandomName = "new random name";
         final var newRandomDesc = "new random description";
         final var category = new Category(newRandomName, newRandomDesc);
diff --git a/src/test/java/com/answerdigital/answerking/service/CategoryServiceTest.java b/src/test/java/com/answerdigital/answerking/service/CategoryServiceTest.java
@@ -7,8 +7,7 @@
 import com.answerdigital.answerking.model.Category;
 import com.answerdigital.answerking.model.Product;
 import com.answerdigital.answerking.repository.CategoryRepository;
-import com.answerdigital.answerking.request.AddCategoryRequest;
-import com.answerdigital.answerking.request.UpdateCategoryRequest;
+import com.answerdigital.answerking.request.RequestModelsCategory;
 
 import java.math.BigDecimal;
 
@@ -57,7 +56,7 @@ void tearDown() {
     @Test
     void testAddCategory() {
         // given
-        AddCategoryRequest addCategoryRequest = new AddCategoryRequest("Drinks", "Our selection of drinks");
+        RequestModelsCategory addCategoryRequest = new RequestModelsCategory("Drinks", "Our selection of drinks");
         Category expectedResponse = new Category("Drinks", "Our selection of drinks");
 
         // when
@@ -74,7 +73,7 @@ void testAddCategory() {
     @Test
     void testAddCategoryThatAlreadyExists() {
         // given
-        AddCategoryRequest addCategoryRequest = new AddCategoryRequest("Drinks", "Our selection of drinks");
+        RequestModelsCategory addCategoryRequest = new RequestModelsCategory("Drinks", "Our selection of drinks");
 
         // when
         doReturn(true).when(categoryRepository).existsByName(anyString());
@@ -91,7 +90,7 @@ void testUpdateCategory() {
         Category existingCategory = new Category("Drinks", "Our selection of drinks");
         existingCategory.setId(CATEGORY_ID);
 
-        UpdateCategoryRequest updateCategoryRequest = new UpdateCategoryRequest(
+        RequestModelsCategory updateCategoryRequest = new RequestModelsCategory(
                 "DrinksUpdated",
                 "Our updated selection of drinks");
 
@@ -115,7 +114,7 @@ void testUpdateCategory() {
     @Test
     void testUpdateCategoryThatDoesNotExist() {
         // given
-        UpdateCategoryRequest updateCategoryRequest = new UpdateCategoryRequest(
+        RequestModelsCategory updateCategoryRequest = new RequestModelsCategory(
                 "DrinksUpdated",
                 "Our updated selection of drinks");
 
@@ -136,7 +135,7 @@ void testUpdateCategoryNameToCategoryThatAlreadyExists() {
         Category existingCategory = new Category("Drinks", "Our selection of drinks");
         existingCategory.setId(CATEGORY_ID);
 
-        UpdateCategoryRequest updateCategoryRequest = new UpdateCategoryRequest(
+        RequestModelsCategory updateCategoryRequest = new RequestModelsCategory(
                 "Burgers",
                 "Our updated selection of drinks");
 

Original file line number	Diff line number	Diff line change
`@@ -1,8 +1,7 @@`
`1`	`1`	`package com.answerdigital.answerking.controller;`
`2`	`2`
`3`	`3`	`import com.answerdigital.answerking.model.Category;`
`4`		`-import com.answerdigital.answerking.request.AddCategoryRequest;`
`5`		`-import com.answerdigital.answerking.request.UpdateCategoryRequest;`
	`4`	`+import com.answerdigital.answerking.request.RequestModelsCategory;`
`6`	`5`	`import com.answerdigital.answerking.service.CategoryService;`
`7`	`6`	`import io.swagger.v3.oas.annotations.Operation;`
`8`	`7`	`import io.swagger.v3.oas.annotations.media.Content;`
`@@ -41,7 +40,7 @@ public CategoryController(final CategoryService categoryService) {`
`41`	`40`	`}`
`42`	`41`
`43`	`42`	`@PostMapping`
`44`		`- public ResponseEntity<Category> addCategory(@Valid @RequestBody final AddCategoryRequest categoryRequest) {`
	`43`	`+ public ResponseEntity<Category> addCategory(@Valid @RequestBody final RequestModelsCategory categoryRequest) {`
`45`	`44`	`return new ResponseEntity<>(categoryService.addCategory(categoryRequest), HttpStatus.CREATED);`
`46`	`45`	`}`
`47`	`46`
`@@ -74,7 +73,7 @@ public ResponseEntity<Category> removeProductFromCategory(@PathVariable @NotNull`
`74`	`73`	`}`
`75`	`74`
`76`	`75`	`@PutMapping("/{categoryId}")`
`77`		`- public ResponseEntity<Category> updateCategory(@Valid @RequestBody final UpdateCategoryRequest updateCategoryRequest,`
	`76`	`+ public ResponseEntity<Category> updateCategory(@Valid @RequestBody final RequestModelsCategory updateCategoryRequest,`
`78`	`77`	`@PathVariable @NotNull final Long categoryId) {`
`79`	`78`	`return new ResponseEntity<>(categoryService.updateCategory(updateCategoryRequest, categoryId), HttpStatus.OK);`
`80`	`79`	`}`