Refactor: Rename orders entity to order

Author: muhammad-keyvalue

src/main/java/com/sample/ecommerce/order/controller/OrderController.java

@@ -13,7 +13,7 @@
 import org.springframework.web.bind.annotation.RestController;
 
 import com.sample.ecommerce.order.dto.OrderDto;
-import com.sample.ecommerce.order.model.Orders;
+import com.sample.ecommerce.order.model.Order;
 import com.sample.ecommerce.order.service.OrderService;
 
 import jakarta.validation.Valid;
@@ -30,21 +30,21 @@ public class OrderController {
    */
 
    @PostMapping()
-   public Orders create(@Valid @RequestBody OrderDto createOrder){
+   public Order create(@Valid @RequestBody OrderDto createOrder){
     return service.create(createOrder);
    }
 
    @GetMapping("/{id}")
-   public Orders findOne(@PathVariable int id){
+   public Order findOne(@PathVariable int id){
     return service.findOne(id);
    }
    @GetMapping()
-   public List<Orders> findAll(){
+   public List<Order> findAll(){
     return service.findAll();
    }
 
    @PutMapping("/{id}")
-   public Orders update(@PathVariable int id, @Valid @RequestBody OrderDto updateOrder){
+   public Order update(@PathVariable int id, @Valid @RequestBody OrderDto updateOrder){
     return service.update(id,updateOrder);
    }
 

src/main/java/com/sample/ecommerce/order/model/Customer.java

@@ -54,6 +54,6 @@ public class Customer {
 
   @OneToMany(mappedBy = "customer")
   @JsonBackReference
-  private List<Orders> orders;
+  private List<Order> orders;
 
 }

src/main/java/com/sample/ecommerce/order/model/Orders.java renamed to src/main/java/com/sample/ecommerce/order/model/Order.java

@@ -5,6 +5,7 @@
 import jakarta.persistence.JoinColumn;
 import jakarta.persistence.ManyToOne;
 import jakarta.persistence.OneToMany;
+import jakarta.persistence.Table;
 import jakarta.persistence.GenerationType;
 
 import java.time.LocalDateTime;
@@ -33,7 +34,8 @@
 @NoArgsConstructor
 @Builder(toBuilder=true)
 @Entity
-public class Orders {
+@Table(name="\"order\"")
+public class Order {
 
   @Id
   @GeneratedValue(strategy = GenerationType.IDENTITY)

src/main/java/com/sample/ecommerce/order/model/OrderItem.java

@@ -35,7 +35,7 @@ public class OrderItem {
   @ManyToOne
   @JoinColumn(name = "order_id")
   @JsonBackReference
-  private Orders order;
+  private Order order;
 
   @ManyToOne
   @JoinColumn(name = "product_id")

src/main/java/com/sample/ecommerce/order/repository/OrderRepository.java

@@ -1,8 +1,8 @@
 package com.sample.ecommerce.order.repository;
 
 import org.springframework.data.jpa.repository.JpaRepository;
-import com.sample.ecommerce.order.model.Orders;
+import com.sample.ecommerce.order.model.Order;
 
-public interface OrderRepository extends JpaRepository<Orders, Integer> {
+public interface OrderRepository extends JpaRepository<Order, Integer> {
 
 }

src/main/java/com/sample/ecommerce/order/service/OrderService.java

@@ -10,7 +10,7 @@
 import com.sample.ecommerce.order.dto.OrderDto;
 import com.sample.ecommerce.order.dto.OrderItemDto;
 import com.sample.ecommerce.order.exception.ObjectNotFoundException;
-import com.sample.ecommerce.order.model.Orders;
+import com.sample.ecommerce.order.model.Order;
 import com.sample.ecommerce.order.model.Customer;
 import com.sample.ecommerce.order.model.OrderItem;
 import com.sample.ecommerce.order.model.Product;
@@ -34,20 +34,20 @@ public class OrderService {
   ProductRepository productRepository;
 
 
-  public Orders create(OrderDto orderDto) {
+  public Order create(OrderDto orderDto) {
 
     if(customerRepository.findById(orderDto.getCustomerId()).isEmpty())
       throw new ObjectNotFoundException(Customer.class);
 
     log.info("Creating order for customer - {}" , orderDto.getCustomerId());
-    Orders order= createOrderfromDto(new Orders(),orderDto);
-    Orders createdOrder = repository.save(order);
+    Order order= createOrderfromDto(new Order(),orderDto);
+    Order createdOrder = repository.save(order);
     log.info("Order details : order_id - {}, total_price - {}, total_quantity - {}, customer_id - {}, order_status - {}" ,order.getId(),order.getTotalPrice(),order.getTotalQuantity(),orderDto.getCustomerId(),order.getStatus());
     return createdOrder;
   }
 
 
-  public Orders createOrderfromDto(Orders order,OrderDto orderDto) {
+  public Order createOrderfromDto(Order order,OrderDto orderDto) {
     int totalQuantity = 0;
     int totalPrice = 0;
     List<OrderItem> orderItems = new ArrayList<OrderItem>();
@@ -76,30 +76,30 @@ public Orders createOrderfromDto(Orders order,OrderDto orderDto) {
 
   }
 
-  public Orders findOne(int id) {
+  public Order findOne(int id) {
     try{
     return repository.findById(id).get();
     }
     catch(Exception e)
     {
-      throw new ObjectNotFoundException(Orders.class,"order");
+      throw new ObjectNotFoundException(Order.class,"order");
     }
 
   }
-  public List<Orders> findAll() {
+  public List<Order> findAll() {
     return repository.findAll();
   }
 
   public void delete(int id){
-    Orders order = this.findOne(id);
+    Order order = this.findOne(id);
     repository.delete(order);
     log.info("Deleted order with order_id - {}",id);
   }
 
-  public Orders update(Integer orderId, OrderDto updateOrderDto) {
-    Orders order = this.findOne(orderId);
+  public Order update(Integer orderId, OrderDto updateOrderDto) {
+    Order order = this.findOne(orderId);
     log.info("Updating order with order_id - {} ",orderId);
-    Orders updatedOrder= createOrderfromDto(order, updateOrderDto);
+    Order updatedOrder= createOrderfromDto(order, updateOrderDto);
     log.info("Order details : order_id - {}, total_price - {}, total_quantity - {}, customer_id - {}, order_status - {}" ,order.getId(),order.getTotalPrice(),order.getTotalQuantity(),order.getCustomer().getId(),order.getStatus());
     return repository.save(updatedOrder);
   }

src/main/resources/db/migration/V1.1__create_tables.sql

@@ -1,9 +1,9 @@
-create table orders.category (id serial not null, name varchar(255), parent_category integer, primary key (id));
-create table orders.customer (id serial not null, city varchar(255), country_code varchar(255), created_at timestamp(6) default(current_timestamp), email varchar(255), name varchar(255), phone varchar(255), profile_pic varchar(255), state varchar(255), street varchar(255), primary key (id));
-create table orders.orders (id serial not null, created_at timestamp(6) default(current_timestamp), status varchar(255), updated_at timestamp(6) default(current_timestamp), customer_id integer, total_quantity integer, total_price integer, primary key (id));
-create table orders.order_item (id serial not null, quantity integer, order_id integer, product_id integer, primary key (id));
-create table orders.product (id serial not null, description varchar(255), image varchar(255), name varchar(255), unit_price integer, category_id integer, primary key (id));
-alter table if exists orders.orders add constraint FKb8tboo4d95mh8gavvovwbb7vg foreign key (customer_id) references orders.customer;
-alter table if exists order_item add constraint FKt6wv8m7eshksp5kp8w4b2d1dm foreign key (order_id) references orders.orders;
-alter table if exists order_item add constraint FK551losx9j75ss5d6bfsqvijna foreign key (product_id) references orders.product;
-alter table if exists product add constraint FK1mtsbur82frn64de7balymq9s foreign key (category_id) references orders.category;
+create table category (id serial not null, name varchar(255), parent_category integer, primary key (id));
+create table customer (id serial not null, city varchar(255), country_code varchar(255), created_at timestamp(6), email varchar(255), name varchar(255), phone varchar(255), profile_pic varchar(255), state varchar(255), street varchar(255), primary key (id));
+create table "order" (id serial not null, created_at timestamp(6), status varchar(255), total_price integer not null, total_quantity integer not null, updated_at timestamp(6), customer_id integer, primary key (id));
+create table order_item (id serial not null, quantity integer, order_id integer, product_id integer, primary key (id));
+create table product (id serial not null, description varchar(255), image varchar(255), name varchar(255), unit_price integer, category_id integer, primary key (id));
+alter table if exists "order" add constraint FK1oduxyuuo3n2g98l3j7754vym foreign key (customer_id) references customer;
+alter table if exists order_item add constraint FKs234mi6jususbx4b37k44cipy foreign key (order_id) references "order";
+alter table if exists order_item add constraint FK551losx9j75ss5d6bfsqvijna foreign key (product_id) references product;
+alter table if exists product add constraint FK1mtsbur82frn64de7balymq9s foreign key (category_id) references category;

src/test/java/com/sample/ecommerce/order/OrderServiceTests.java

@@ -23,7 +23,7 @@
 import com.sample.ecommerce.order.exception.ObjectNotFoundException;
 import com.sample.ecommerce.order.model.Category;
 import com.sample.ecommerce.order.model.Customer;
-import com.sample.ecommerce.order.model.Orders;
+import com.sample.ecommerce.order.model.Order;
 import com.sample.ecommerce.order.model.OrderItem;
 import com.sample.ecommerce.order.model.Product;
 import com.sample.ecommerce.order.repository.CustomerRepository;
@@ -53,14 +53,14 @@ void getOrderByIdTest() {
     int randomId = 2;
     final int totalPrice = 20;
     final int quantity = 4;
-    Orders order = Orders.builder()
+    Order order = Order.builder()
         .id(randomId)
         .totalQuantity(quantity)
         .totalPrice(totalPrice)
         .build();
 
     Mockito.when(orderRepository.findById(anyInt())).thenReturn(Optional.of(order));
-    Orders obtainedOrder = orderService.findOne(1);
+    Order obtainedOrder = orderService.findOne(1);
     assertEquals(obtainedOrder, order);
   }
 
@@ -78,7 +78,7 @@ void createdOrderTest(){
     Mockito.when(productRepository.findById(productId))
     .thenReturn(Optional.of(getSampleProduct(productId)));
 
-    Orders order = Orders.builder()
+    Order order = Order.builder()
     .id(randomId)
     .customer(getSampleCustomer(customerId))
     .status(OrderStatus.INITIATED)
@@ -96,7 +96,7 @@ void createdOrderTest(){
                         .build();
 
     Mockito.when(orderRepository.save(any())).thenReturn(order);
-    Orders obtainedOrder = orderService.create(orderDto);
+    Order obtainedOrder = orderService.create(orderDto);
     assertEquals(obtainedOrder, order);
 }
 
@@ -157,7 +157,7 @@ private Category getSampleCategory(){
         .build();
 }
 
-private List<OrderItem> getSampleOrderItems(Orders order,int productId, int quantity){
+private List<OrderItem> getSampleOrderItems(Order order,int productId, int quantity){
   List<OrderItem> orderItems = new ArrayList<OrderItem>();
   orderItems.add(OrderItem.builder().order(order).quantity(quantity).product(getSampleProduct(productId)).build());
 return orderItems;