Merge pull request #52 from AnswerConsulting/BENCH-153

martintaylor1635 · web-flow · commit f86873805224 · 2022-11-14T15:44:26.000Z
BENCH-153 Implement soft deletions
diff --git a/init_scripts/schema.sql b/init_scripts/schema.sql
@@ -2,16 +2,17 @@ CREATE TABLE IF NOT EXISTS product (
     id BIGINT NOT NULL AUTO_INCREMENT,
     name VARCHAR(255) NOT NULL,
     description VARCHAR(255) NOT NULL,
-    available BIT(1) NOT NULL,
+    retired BIT(1) NOT NULL,
     price DECIMAL(12,2) NOT NULL,
 
     PRIMARY KEY (id)
-    );
+);
 
 CREATE TABLE IF NOT EXISTS category (
     id BIGINT NOT NULL AUTO_INCREMENT,
     name VARCHAR(255),
     description VARCHAR(255) NOT NULL,
+    retired BIT(1) NOT NULL,
 
     PRIMARY KEY (id)
 );
diff --git a/src/main/java/com/answerdigital/academy/answerking/controller/CategoryController.java b/src/main/java/com/answerdigital/academy/answerking/controller/CategoryController.java
@@ -80,8 +80,7 @@ public ResponseEntity<Category> updateCategory(@Valid @RequestBody final UpdateC
     }
 
     @DeleteMapping("/{categoryId}")
-    public ResponseEntity<HttpStatus> deleteCategory(@PathVariable @NotNull final Long categoryId) {
-        categoryService.deleteCategoryById(categoryId);
-        return new ResponseEntity<>(HttpStatus.NO_CONTENT);
+    public ResponseEntity<Category> retireCategory(@PathVariable @NotNull final Long categoryId) {
+        return new ResponseEntity<>(categoryService.retireCategory(categoryId), HttpStatus.OK);
     }
 }
diff --git a/src/main/java/com/answerdigital/academy/answerking/controller/ProductController.java b/src/main/java/com/answerdigital/academy/answerking/controller/ProductController.java
@@ -9,12 +9,13 @@
 import org.springframework.http.ResponseEntity;
 import org.springframework.validation.Errors;
 import org.springframework.validation.annotation.Validated;
+import org.springframework.web.bind.annotation.DeleteMapping;
 import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.PathVariable;
 import org.springframework.web.bind.annotation.PostMapping;
 import org.springframework.web.bind.annotation.PutMapping;
-import org.springframework.web.bind.annotation.PathVariable;
-import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RequestBody;
+import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RestController;
 
 import javax.validation.Valid;
@@ -57,4 +58,9 @@ public ResponseEntity<Product> updateProduct(@PathVariable @NotNull final long i
         return new ResponseEntity<>(productService.updateProduct(id, productRequest),
                                             errors.hasErrors() ? HttpStatus.BAD_REQUEST : HttpStatus.OK);
     }
+
+    @DeleteMapping("/{id}")
+    public ResponseEntity<Product> retireProduct(@PathVariable @NotNull final long id) {
+        return new ResponseEntity<>(productService.retireProduct(id), HttpStatus.OK);
+    }
 }
diff --git a/src/main/java/com/answerdigital/academy/answerking/exception/custom/RetirementException.java b/src/main/java/com/answerdigital/academy/answerking/exception/custom/RetirementException.java
@@ -6,21 +6,21 @@
 import java.util.Collection;
 import java.util.List;
 
-public class ProductUnavailableException extends AnswerKingException {
+public class RetirementException extends AnswerKingException {
 
     private static final String TYPE = "https://www.rfc-editor.org/rfc/rfc7231";
 
-    private static final String TITLE = "Product Unavailable Exception";
+    private static final String TITLE = "Retirement Exception";
 
-    private static final HttpStatus STATUS = HttpStatus.BAD_REQUEST;
+    private static final HttpStatus STATUS = HttpStatus.GONE;
 
     private static final String DETAIL = null;
 
-    public ProductUnavailableException(final Collection<String> errors) {
+    public RetirementException(final Collection<String> errors) {
         super(TYPE, TITLE, STATUS, DETAIL, errors);
     }
 
-    public ProductUnavailableException(final String error) {
+    public RetirementException(final String error) {
         this(List.of(error));
     }
 }
diff --git a/src/main/java/com/answerdigital/academy/answerking/mapper/ProductMapper.java b/src/main/java/com/answerdigital/academy/answerking/mapper/ProductMapper.java
@@ -3,10 +3,12 @@
 import com.answerdigital.academy.answerking.model.Product;
 import com.answerdigital.academy.answerking.request.ProductRequest;
 import org.mapstruct.Mapper;
+import org.mapstruct.Mapping;
 import org.mapstruct.MappingTarget;
 
 @Mapper(componentModel = "spring")
 public interface ProductMapper {
+    @Mapping(target = "retired", constant = "false")
     Product addRequestToProduct(ProductRequest productRequest);
 
     Product updateRequestToProduct(@MappingTarget Product product, ProductRequest productRequest);
diff --git a/src/main/java/com/answerdigital/academy/answerking/model/Category.java b/src/main/java/com/answerdigital/academy/answerking/model/Category.java
@@ -44,6 +44,8 @@ public class Category {
             message = "Category description can only contain letters, numbers, spaces and !?-.,' punctuation")
     private String description;
 
+    private boolean retired;
+
     @ManyToMany(fetch = FetchType.LAZY)
     @JoinTable(
             name = "product_category",
@@ -55,6 +57,13 @@ public class Category {
     public Category(final AddCategoryRequest categoryRequest) {
         this.name = categoryRequest.name();
         this.description = categoryRequest.description();
+        this.retired = false;
+    }
+
+    public Category(final String name, final String description) {
+        this.name = name;
+        this.description = description;
+        this.retired = false;
     }
 
     public void addProduct(final Product product) {
@@ -65,11 +74,6 @@ public void removeProduct(final Product product) {
         products.remove(product);
     }
 
-    public Category(final String name, final String description) {
-        this.name = name;
-        this.description = description;
-    }
-
     @Override
     public boolean equals(final Object o) {
         if (this == o) return true;
diff --git a/src/main/java/com/answerdigital/academy/answerking/model/Product.java b/src/main/java/com/answerdigital/academy/answerking/model/Product.java
@@ -47,7 +47,7 @@ public class Product {
     @Column(precision = 12, scale = 2)
     private BigDecimal price;
 
-    private Boolean available;
+    private boolean retired;
 
     @JsonIgnore
     @ManyToMany(fetch = FetchType.LAZY, mappedBy = "products")
@@ -57,34 +57,24 @@ public class Product {
     @JsonIgnore
     private Set<LineItem> lineItems = new HashSet<>();
 
-    public void setPrice(final BigDecimal price) {
-        this.price = price;
-    }
-
-    public void setAvailable(final Boolean available) {
-        this.available = available;
-    }
-
     public Product(final ProductRequest productRequest){
         this.name = productRequest.name();
         this.description = productRequest.description();
         this.price = productRequest.price();
-        this.available = productRequest.available();
+        this.retired = false;
     }
 
-    public Product(final String name, final String description, final BigDecimal price, final boolean isAvailable) {
+    public Product(final String name, final String description, final BigDecimal price, final boolean isRetired) {
         this.name = name;
         this.description = description;
         this.price = price;
         this.categories = new HashSet<>();
-        this.available = isAvailable;
+        this.retired = isRetired;
     }
 
     @PreRemove
     private void removeProductsFromCategories() {
-        for (Category category : categories) {
-            category.removeProduct(this);
-        }
+        categories.forEach(category -> category.removeProduct(this));
     }
 
     public BigDecimal getPrice() {
@@ -111,7 +101,7 @@ public String toString() {
                 ", name='" + name + '\'' +
                 ", description='" + description + '\'' +
                 ", price=" + price +
-                ", available=" + available +
+                ", retired=" + retired +
                 '}';
     }
 }
diff --git a/src/main/java/com/answerdigital/academy/answerking/repository/OrderRepository.java b/src/main/java/com/answerdigital/academy/answerking/repository/OrderRepository.java
@@ -2,9 +2,11 @@
 
 import com.answerdigital.academy.answerking.model.Order;
 import org.springframework.data.repository.PagingAndSortingRepository;
+import org.springframework.stereotype.Repository;
 
 import java.util.List;
 
+@Repository
 public interface OrderRepository extends PagingAndSortingRepository<Order, Long> {
     List<Order> findAll();
 }
diff --git a/src/main/java/com/answerdigital/academy/answerking/request/ProductRequest.java b/src/main/java/com/answerdigital/academy/answerking/request/ProductRequest.java
@@ -22,9 +22,7 @@ public record ProductRequest(
         @Digits(integer = 12, fraction = 2, message = "Product price is invalid")
         @DecimalMin(value = "0.0", inclusive = false, message = "Product price is invalid")
         @NotNull
-        BigDecimal price,
-        @NotNull
-        boolean available
+        BigDecimal price
 ) {
     @Builder
     public ProductRequest {
diff --git a/src/main/java/com/answerdigital/academy/answerking/service/CategoryService.java b/src/main/java/com/answerdigital/academy/answerking/service/CategoryService.java
@@ -1,5 +1,6 @@
 package com.answerdigital.academy.answerking.service;
 
+import com.answerdigital.academy.answerking.exception.custom.RetirementException;
 import com.answerdigital.academy.answerking.exception.generic.ConflictException;
 import com.answerdigital.academy.answerking.exception.generic.NotFoundException;
 import com.answerdigital.academy.answerking.mapper.CategoryMapper;
@@ -84,8 +85,12 @@ public Category removeProductFromCategory(final Long categoryId, final Long prod
         return categoryRepository.save(category);
     }
 
-    public void deleteCategoryById(final Long categoryId) {
-        findById(categoryId);
-        categoryRepository.deleteById(categoryId);
+    public Category retireCategory(final Long categoryId) {
+        final Category category = findById(categoryId);
+        if(category.isRetired()) {
+            throw new RetirementException(String.format("The category with ID %d is already retired", categoryId));
+        }
+        category.setRetired(true);
+        return categoryRepository.save(category);
     }
 }
diff --git a/src/main/java/com/answerdigital/academy/answerking/service/OrderService.java b/src/main/java/com/answerdigital/academy/answerking/service/OrderService.java
@@ -1,7 +1,7 @@
 package com.answerdigital.academy.answerking.service;
 
+import com.answerdigital.academy.answerking.exception.custom.RetirementException;
 import com.answerdigital.academy.answerking.exception.generic.ConflictException;
-import com.answerdigital.academy.answerking.exception.custom.ProductUnavailableException;
 import com.answerdigital.academy.answerking.exception.generic.NotFoundException;
 import com.answerdigital.academy.answerking.mapper.OrderMapper;
 import com.answerdigital.academy.answerking.model.LineItem;
@@ -57,11 +57,11 @@ public Order updateOrder(final Long orderId, final OrderRequest orderRequest) {
 
     @Transactional
     public Order addProductToBasket(final Long orderId, final Long productId, final Integer quantity) {
-        final  Order order = findById(orderId);
+        final Order order = findById(orderId);
         final Product product = productService.findById(productId);
 
-        if (!product.getAvailable()) {
-            throw new ProductUnavailableException(String.format("The product with ID %d is not available.", product.getId()));
+        if (product.isRetired()) {
+            throw new RetirementException(String.format("The product with ID %d has been retired", product.getId()));
         }
 
         final Optional<LineItem> existingLineItem = order.getLineItems()
diff --git a/src/main/java/com/answerdigital/academy/answerking/service/ProductService.java b/src/main/java/com/answerdigital/academy/answerking/service/ProductService.java
@@ -1,5 +1,6 @@
 package com.answerdigital.academy.answerking.service;
 
+import com.answerdigital.academy.answerking.exception.custom.RetirementException;
 import com.answerdigital.academy.answerking.exception.generic.ConflictException;
 import com.answerdigital.academy.answerking.exception.generic.NotFoundException;
 import com.answerdigital.academy.answerking.mapper.ProductMapper;
@@ -52,4 +53,13 @@ public Product updateProduct(final long productId, final ProductRequest productR
         final Product updatedProduct = productMapper.updateRequestToProduct(findById(productId), productRequest);
         return productRepository.save(updatedProduct);
     }
+
+    public Product retireProduct(final long productId) {
+        final Product product = findById(productId);
+        if (product.isRetired()) {
+            throw new RetirementException(String.format("The product with ID %d is already retired", productId));
+        }
+        product.setRetired(true);
+        return productRepository.save(product);
+    }
 }
diff --git a/src/main/resources/schema.sql b/src/main/resources/schema.sql
@@ -2,7 +2,7 @@ CREATE TABLE IF NOT EXISTS product (
     id BIGINT NOT NULL AUTO_INCREMENT,
     name VARCHAR(255) NOT NULL,
     description VARCHAR(255) NOT NULL,
-    available BIT(1) NOT NULL,
+    retired BIT(1) NOT NULL,
     price DECIMAL(12,2) NOT NULL,
 
     PRIMARY KEY (id)
@@ -12,6 +12,7 @@ CREATE TABLE IF NOT EXISTS category (
     id BIGINT NOT NULL AUTO_INCREMENT,
     name VARCHAR(255),
     description VARCHAR(255) NOT NULL,
+    retired BIT(1) NOT NULL,
 
     PRIMARY KEY (id)
 );
diff --git a/src/main/resources/test-data.sql b/src/main/resources/test-data.sql
@@ -19,14 +19,14 @@ INSERT INTO category (id, name, description) values
                             name = name,
                             description = description;
 
-INSERT INTO product (id, name, description, available, price) values
+INSERT INTO product (id, name, description, retired, price) values
     (1, 'Answer Whopper', 'The biggest burger', true, '5.99'),
     (2, 'Chicken Burger', 'Standard chicken burger', true, '3.99'),
     (3, 'Cheese Burger', 'standard cheese burger', true, '2.99')
     ON DUPLICATE KEY UPDATE id = id,
                             name = name,
                             description = description,
-                            available = available,
+                            retired = retired,
                             price = price;
 
 INSERT INTO product_category (id, product_id, category_id) values
diff --git a/src/test/java/com/answerdigital/academy/answerking/controller/ProductControllerTest.java b/src/test/java/com/answerdigital/academy/answerking/controller/ProductControllerTest.java
@@ -58,7 +58,7 @@ public void generateProduct() {
                 .name("test")
                 .description("testDes")
                 .price(BigDecimal.valueOf(2.99))
-                .available(true)
+                .retired(false)
                 .build();
     }
 
@@ -111,7 +111,7 @@ void getProductByIdReturnsNotFoundExceptionIfIdDoesNotExist() throws Exception {
     @Test
     void addProductWithInvalidNameThrowsException() throws Exception {
         //given
-        String newProduct = "{\"name\": \"abc12\",\"description\": \"descTest\",\"price\": \"4.75\",\"available\": \"true\"}";
+        String newProduct = "{\"name\": \"abc12\",\"description\": \"descTest\",\"price\": \"4.75\"}";
         //when
         final String error = mvc.perform(post("/products")
                         .content(newProduct)
@@ -128,7 +128,7 @@ void addProductWithInvalidNameThrowsException() throws Exception {
     @Test
     void addProductWithValidObjectReturnsProductAndOkStatus() throws Exception {
         //given
-        String newProduct = "{\"name\": \"test\",\"description\": \"descTest\",\"price\": \"4.75\",\"available\": \"true\"}";
+        String newProduct = "{\"name\": \"test\",\"description\": \"descTest\",\"price\": \"4.75\"}";
         given(productService.addNewProduct(any())).willReturn(product);
 
         //when
@@ -146,7 +146,7 @@ void addProductWithValidObjectReturnsProductAndOkStatus() throws Exception {
     @Test
     void updateProductWithInvalidPriceThrowsException() throws Exception {
         //given
-        String newProduct = "{\"name\": \"abc\",\"description\": \"descTest\",\"price\": \"4.7587\",\"available\": \"true\"}";
+        String newProduct = "{\"name\": \"abc\",\"description\": \"descTest\",\"price\": \"4.7587\"}";
         //when
         final String error = mvc.perform(MockMvcRequestBuilders.put("/products/{id}", 55L)
                         .content(newProduct)
@@ -164,7 +164,7 @@ void updateProductWithInvalidPriceThrowsException() throws Exception {
     @Test
     void updateProductWithValidObjectReturnsProductAndOkStatus() throws Exception {
         //given
-        String newProduct = "{\"name\": \"test\",\"description\": \"descTest\",\"price\": \"4.75\",\"available\": \"true\"}";
+        String newProduct = "{\"name\": \"test\",\"description\": \"descTest\",\"price\": \"4.75\"}";
         given(productService.updateProduct(eq(55L), any())).willReturn(product);
         //when
 
diff --git a/src/test/java/com/answerdigital/academy/answerking/service/CategoryServiceTest.java b/src/test/java/com/answerdigital/academy/answerking/service/CategoryServiceTest.java
diff --git a/src/test/java/com/answerdigital/academy/answerking/service/OrderServiceTest.java b/src/test/java/com/answerdigital/academy/answerking/service/OrderServiceTest.java
diff --git a/src/test/java/com/answerdigital/academy/answerking/service/ProductServiceTest.java b/src/test/java/com/answerdigital/academy/answerking/service/ProductServiceTest.java

Original file line number	Diff line number	Diff line change
`@@ -80,8 +80,7 @@ public ResponseEntity<Category> updateCategory(@Valid @RequestBody final UpdateC`
`80`	`80`	`}`
`81`	`81`
`82`	`82`	`@DeleteMapping("/{categoryId}")`
`83`		`- public ResponseEntity<HttpStatus> deleteCategory(@PathVariable @NotNull final Long categoryId) {`
`84`		`- categoryService.deleteCategoryById(categoryId);`
`85`		`- return new ResponseEntity<>(HttpStatus.NO_CONTENT);`
	`83`	`+ public ResponseEntity<Category> retireCategory(@PathVariable @NotNull final Long categoryId) {`
	`84`	`+ return new ResponseEntity<>(categoryService.retireCategory(categoryId), HttpStatus.OK);`
`86`	`85`	`}`
`87`	`86`	`}`
Original file line number	Diff line number	Diff line change
`@@ -2,9 +2,11 @@`
`2`	`2`
`3`	`3`	`import com.answerdigital.academy.answerking.model.Order;`
`4`	`4`	`import org.springframework.data.repository.PagingAndSortingRepository;`
	`5`	`+import org.springframework.stereotype.Repository;`
`5`	`6`
`6`	`7`	`import java.util.List;`
`7`	`8`
	`9`	`+@Repository`
`8`	`10`	`public interface OrderRepository extends PagingAndSortingRepository<Order, Long> {`
`9`	`11`	`List<Order> findAll();`
`10`	`12`	`}`