Merge pull request #95 from AnswerConsulting/BENCH-195-update-request-models-name-ak-java

AudriusPutys · web-flow · commit a109dd677b9f · 2022-11-29T14:46:44.000Z
Bench 195 update request models name ak java
diff --git a/pom.xml b/pom.xml
@@ -158,7 +158,7 @@
 				<version>3.2.0</version>
 				<configuration>
 					<configLocation>checkstyle.xml</configLocation>
-					<includeTestSourceDirectory>true</includeTestSourceDirectory>
+					<includeTestSourceDirectory>false</includeTestSourceDirectory>
 				</configuration>
 
 				<executions>
diff --git a/src/main/java/com/answerdigital/answerking/controller/CategoryController.java b/src/main/java/com/answerdigital/answerking/controller/CategoryController.java
@@ -2,8 +2,7 @@
 
 import com.answerdigital.answerking.exception.util.ErrorResponse;
 import com.answerdigital.answerking.model.Category;
-import com.answerdigital.answerking.request.AddCategoryRequest;
-import com.answerdigital.answerking.request.UpdateCategoryRequest;
+import com.answerdigital.answerking.request.CategoryRequest;
 import com.answerdigital.answerking.response.CategoryResponse;
 import com.answerdigital.answerking.service.CategoryService;
 import io.swagger.v3.oas.annotations.Operation;
@@ -50,7 +49,7 @@ public CategoryController(final CategoryService categoryService) {
                 content = { @Content(mediaType = "application/json", schema = @Schema(implementation = ErrorResponse.class)) })
     })
     @PostMapping
-    public ResponseEntity<CategoryResponse> addCategory(@Valid @RequestBody final AddCategoryRequest categoryRequest) {
+    public ResponseEntity<CategoryResponse> addCategory(@Valid @RequestBody final CategoryRequest categoryRequest) {
         return new ResponseEntity<>(categoryService.addCategory(categoryRequest), HttpStatus.CREATED);
     }
 
@@ -109,9 +108,9 @@ public ResponseEntity<Category> removeProductFromCategory(@PathVariable @NotNull
                 content = { @Content(mediaType = "application/json", schema = @Schema(implementation = ErrorResponse.class)) })
     })
     @PutMapping("/{categoryId}")
-    public ResponseEntity<Category> updateCategory(@Valid @RequestBody final UpdateCategoryRequest updateCategoryRequest,
+    public ResponseEntity<Category> updateCategory(@Valid @RequestBody final CategoryRequest categoryRequest,
                                                    @PathVariable @NotNull final Long categoryId) {
-        return new ResponseEntity<>(categoryService.updateCategory(updateCategoryRequest, categoryId), HttpStatus.OK);
+        return new ResponseEntity<>(categoryService.updateCategory(categoryRequest, categoryId), HttpStatus.OK);
     }
 
     @Operation(summary = "Retire an existing category.")
diff --git a/src/main/java/com/answerdigital/answerking/mapper/CategoryMapper.java b/src/main/java/com/answerdigital/answerking/mapper/CategoryMapper.java
@@ -1,8 +1,7 @@
 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.CategoryRequest;
 import com.answerdigital.answerking.response.CategoryResponse;
 import com.answerdigital.answerking.util.DateTimeUtility;
 import org.mapstruct.Mapper;
@@ -16,10 +15,10 @@ public interface CategoryMapper {
 
     @Mapping(target = "createdOn", expression = "java(DateTimeUtility.getDateTimeAsString())")
     @Mapping(target = "lastUpdated", expression = "java(DateTimeUtility.getDateTimeAsString())")
-    Category addRequestToCategory(AddCategoryRequest addCategoryRequest);
+    Category addRequestToCategory(CategoryRequest addCategoryRequest);
 
     @Mapping(target = "lastUpdated", expression = "java(DateTimeUtility.getDateTimeAsString())")
-    Category updateRequestToCategory(@MappingTarget Category category, UpdateCategoryRequest updateCategoryRequest);
+    Category updateRequestToCategory(@MappingTarget Category category, CategoryRequest updateCategoryRequest);
 
     @Mapping(target = "productIds",
              expression = "java(category.getProducts().stream().map(product -> product.getId()).collect(Collectors.toList()) )")
diff --git a/src/main/java/com/answerdigital/answerking/model/Category.java b/src/main/java/com/answerdigital/answerking/model/Category.java
@@ -2,12 +2,12 @@
 
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonProperty;
+import lombok.AccessLevel;
 import lombok.AllArgsConstructor;
 import lombok.Builder;
 import lombok.Getter;
-import lombok.Setter;
 import lombok.NoArgsConstructor;
-import lombok.AccessLevel;
+import lombok.Setter;
 
 import javax.persistence.Entity;
 import javax.persistence.FetchType;
diff --git a/src/main/java/com/answerdigital/answerking/model/Product.java b/src/main/java/com/answerdigital/answerking/model/Product.java
@@ -3,12 +3,12 @@
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
 import com.fasterxml.jackson.annotation.JsonProperty;
+import lombok.AccessLevel;
+import lombok.AllArgsConstructor;
 import lombok.Builder;
 import lombok.Getter;
 import lombok.NoArgsConstructor;
 import lombok.Setter;
-import lombok.AccessLevel;
-import lombok.AllArgsConstructor;
 
 import javax.persistence.CascadeType;
 import javax.persistence.Column;
diff --git a/src/main/java/com/answerdigital/answerking/request/CategoryRequest.java b/src/main/java/com/answerdigital/answerking/request/CategoryRequest.java
@@ -3,7 +3,7 @@
 import javax.validation.constraints.NotBlank;
 import javax.validation.constraints.Pattern;
 
-public record AddCategoryRequest(
+public record CategoryRequest(
         @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.CategoryRequest;
 import com.answerdigital.answerking.response.CategoryResponse;
 import org.mapstruct.factory.Mappers;
 import org.springframework.beans.factory.annotation.Autowired;
@@ -35,7 +34,7 @@ public CategoryService(final ProductService productService,
         this.categoryRepository = categoryRepository;
     }
 
-    public CategoryResponse addCategory(final AddCategoryRequest categoryRequest) {
+    public CategoryResponse addCategory(final CategoryRequest categoryRequest) {
         if (categoryRepository.existsByName(categoryRequest.name())) {
             throw new NameUnavailableException(String.format("A category named '%s' already exists", categoryRequest.name()));
         }
@@ -58,7 +57,7 @@ public Set<CategoryResponse> findAll() {
                 .collect(Collectors.toSet());
     }
 
-    public Category updateCategory(final UpdateCategoryRequest updateCategoryRequest, final Long id) {
+    public Category updateCategory(final CategoryRequest 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/builder/AddCategoryRequestTestBuilder.java b/src/test/java/com/answerdigital/answerking/builder/AddCategoryRequestTestBuilder.java
@@ -1,6 +1,6 @@
 package com.answerdigital.answerking.builder;
 
-import com.answerdigital.answerking.request.AddCategoryRequest;
+import com.answerdigital.answerking.request.CategoryRequest;
 
 public class AddCategoryRequestTestBuilder {
 
@@ -23,7 +23,7 @@ public AddCategoryRequestTestBuilder withDescription(final String description) {
         return this;
     }
 
-    public AddCategoryRequest build() {
-        return new AddCategoryRequest(name, description);
+    public CategoryRequest build() {
+        return new CategoryRequest(name, description);
     }
 }
diff --git a/src/test/java/com/answerdigital/answerking/builder/UpdateCategoryRequestTestBuilder.java b/src/test/java/com/answerdigital/answerking/builder/UpdateCategoryRequestTestBuilder.java
@@ -1,6 +1,6 @@
 package com.answerdigital.answerking.builder;
 
-import com.answerdigital.answerking.request.UpdateCategoryRequest;
+import com.answerdigital.answerking.request.CategoryRequest;
 
 public class UpdateCategoryRequestTestBuilder {
 
@@ -23,7 +23,7 @@ public UpdateCategoryRequestTestBuilder withDescription(final String description
         return this;
     }
 
-    public UpdateCategoryRequest build() {
-        return new UpdateCategoryRequest(name, description);
+    public CategoryRequest build() {
+        return new CategoryRequest(name, description);
     }
 }
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.CategoryRequest;
 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);
+        CategoryRequest addCategoryRequest = new CategoryRequest(name, description);
 
         // when
-        Set<ConstraintViolation<AddCategoryRequest>> violations = validator.validate(addCategoryRequest);
+        Set<ConstraintViolation<CategoryRequest>> 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);
+        CategoryRequest updateCategoryRequest = new CategoryRequest(name, description);
 
         // when
-        Set<ConstraintViolation<UpdateCategoryRequest>> violations = validator.validate(updateCategoryRequest);
+        Set<ConstraintViolation<CategoryRequest>> 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.CategoryRequest;
 import com.answerdigital.answerking.response.CategoryResponse;
 import com.answerdigital.answerking.service.CategoryService;
 import com.fasterxml.jackson.databind.ObjectMapper;
@@ -64,7 +63,7 @@ void addCategoryTest() throws Exception {
         ObjectMapper mapper = new ObjectMapper();
 
         final String testDate = getDateTimeAsString();
-        final var addCategoryRequest =  new AddCategoryRequest("random name", "random description");
+        final var addCategoryRequest =  new CategoryRequest("random name", "random description");
         final var categoryResponse = CategoryResponse.builder()
                                                      .name(addCategoryRequest.name())
                                                      .description(addCategoryRequest.description())
@@ -118,7 +117,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 CategoryRequest("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
@@ -11,9 +11,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.CategoryRequest;
 import com.answerdigital.answerking.response.CategoryResponse;
 import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.BeforeEach;
@@ -24,7 +22,10 @@
 
 import java.util.Optional;
 
-import static org.junit.jupiter.api.Assertions.*;
+import static org.junit.jupiter.api.Assertions.assertAll;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertThrows;
 import static org.mockito.ArgumentMatchers.anyLong;
 import static org.mockito.ArgumentMatchers.anyString;
 import static org.mockito.Mockito.any;
@@ -72,7 +73,7 @@ void tearDown() {
     @Test
     void testAddCategory() {
         // given
-        final AddCategoryRequest addCategoryRequest = addCategoryRequestTestBuilder.withDefaultValues().build();
+        final CategoryRequest addCategoryRequest = addCategoryRequestTestBuilder.withDefaultValues().build();
         final Category expectedResponse = categoryTestBuilder.withDefaultValues().build();
 
         // when
@@ -93,7 +94,7 @@ void testAddCategory() {
     @Test
     void testAddCategoryThatAlreadyExists() {
         // given
-        final AddCategoryRequest addCategoryRequest = addCategoryRequestTestBuilder.withDefaultValues().build();
+        final CategoryRequest addCategoryRequest = addCategoryRequestTestBuilder.withDefaultValues().build();
 
         // when
         doReturn(true).when(categoryRepository).existsByName(anyString());
@@ -109,7 +110,7 @@ void testAddCategoryThatAlreadyExists() {
     void testUpdateCategory() {
         // given
         final Category existingCategory = categoryTestBuilder.withDefaultValues().build();
-        final UpdateCategoryRequest updateCategoryRequest = updateCategoryRequestTestBuilder.withDefaultValues().build();
+        final CategoryRequest updateCategoryRequest = updateCategoryRequestTestBuilder.withDefaultValues().build();
         final Category expectedResponse = categoryTestBuilder
                 .withDefaultValues()
                 .withName(updateCategoryRequest.name())
@@ -133,7 +134,7 @@ void testUpdateCategory() {
     @Test
     void testUpdateCategoryThatDoesNotExist() {
         // given
-        final UpdateCategoryRequest updateCategoryRequest = updateCategoryRequestTestBuilder.withDefaultValues().build();
+        final CategoryRequest updateCategoryRequest = updateCategoryRequestTestBuilder.withDefaultValues().build();
 
         // when
         doReturn(false).when(categoryRepository).existsByNameAndIdIsNot(anyString(), anyLong());
@@ -151,7 +152,7 @@ void testUpdateCategoryThatDoesNotExist() {
     void testUpdateCategoryNameToCategoryThatAlreadyExists() {
         // given
         final Category existingCategory = categoryTestBuilder.withDefaultValues().build();
-        final UpdateCategoryRequest updateCategoryRequest = updateCategoryRequestTestBuilder.withDefaultValues().build();
+        final CategoryRequest updateCategoryRequest = updateCategoryRequestTestBuilder.withDefaultValues().build();
 
         // when
         doReturn(true).when(categoryRepository).existsByNameAndIdIsNot(anyString(), anyLong());

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`package com.answerdigital.answerking.builder;`
`2`	`2`
`3`		`-import com.answerdigital.answerking.request.AddCategoryRequest;`
	`3`	`+import com.answerdigital.answerking.request.CategoryRequest;`
`4`	`4`
`5`	`5`	`public class AddCategoryRequestTestBuilder {`
`6`	`6`
`@@ -23,7 +23,7 @@ public AddCategoryRequestTestBuilder withDescription(final String description) {`
`23`	`23`	`return this;`
`24`	`24`	`}`
`25`	`25`
`26`		`- public AddCategoryRequest build() {`
`27`		`- return new AddCategoryRequest(name, description);`
	`26`	`+ public CategoryRequest build() {`
	`27`	`+ return new CategoryRequest(name, description);`
`28`	`28`	`}`
`29`	`29`	`}`