fixed naming and readme file

Author: Mohaned Atef

monolithic-architecture/README.md

@@ -1,3 +1,17 @@
+---
+title: "Monolithic Ecommerce App: A Cohesive Application Model"
+shortTitle: Monolithic Ecommerce
+description: "Explore the Monolithic Ecommerce application structure, its design intent, benefits, limitations, and real-world applications. Understand its simplicity and practical use cases."
+category: Architectural
+language: en
+tag:
+  - Cohesion
+  - Simplicity
+  - Scalability
+  - Deployment
+  - Maintainability
+---
+
 ## Monolithic-Ecommerce App
 * A Monolithic Ecommerce example to showcase Monolithic Architecture
 

monolithic-architecture/src/main/java/com/iluwatar/monolithic/EcommerceApp.java

@@ -24,10 +24,10 @@
  */
 package com.iluwatar.monolithic;
 
-import com.iluwatar.monolithic.controller.OrderCon;
-import com.iluwatar.monolithic.controller.ProductCon;
-import com.iluwatar.monolithic.controller.UserCon;
-import com.iluwatar.monolithic.model.Products;
+import com.iluwatar.monolithic.controller.OrderController;
+import com.iluwatar.monolithic.controller.ProductController;
+import com.iluwatar.monolithic.controller.UserController;
+import com.iluwatar.monolithic.model.Product;
 import com.iluwatar.monolithic.model.User;
 import java.nio.charset.StandardCharsets;
 import java.util.Scanner;
@@ -53,13 +53,13 @@
 public class EcommerceApp implements CommandLineRunner {
 
   private static final Logger log = LogManager.getLogger(EcommerceApp.class);
-  private final UserCon userService;
-  private final ProductCon productService;
-  private final OrderCon orderService;
+  private final UserController userService;
+  private final ProductController productService;
+  private final OrderController orderService;
   /**
   * Initilizing controllers as services.
   * */
-  public EcommerceApp(UserCon userService, ProductCon productService, OrderCon orderService) {
+  public EcommerceApp(UserController userService, ProductController productService, OrderController orderService) {
     this.userService = userService;
     this.productService = productService;
     this.orderService = orderService;
@@ -129,7 +129,7 @@ protected void addProduct(Scanner scanner) {
     double price = scanner.nextDouble();
     log.info("Stock: ");
     int stock = scanner.nextInt();
-    Products product = new Products(null, name, description, price, stock);
+    Product product = new Product(null, name, description, price, stock);
     scanner.nextLine();
     productService.addProduct(product);
     log.info("Product added successfully!");

monolithic-architecture/src/main/java/com/iluwatar/monolithic/controller/OrderCon.java renamed to monolithic-architecture/src/main/java/com/iluwatar/monolithic/controller/OrderController.java

@@ -26,36 +26,36 @@
 import com.iluwatar.monolithic.exceptions.InsufficientStockException;
 import com.iluwatar.monolithic.exceptions.NonExistentProductException;
 import com.iluwatar.monolithic.exceptions.NonExistentUserException;
-import com.iluwatar.monolithic.model.Orders;
-import com.iluwatar.monolithic.model.Products;
+import com.iluwatar.monolithic.model.Order;
+import com.iluwatar.monolithic.model.Product;
 import com.iluwatar.monolithic.model.User;
-import com.iluwatar.monolithic.repository.OrderRepo;
-import com.iluwatar.monolithic.repository.ProductRepo;
-import com.iluwatar.monolithic.repository.UserRepo;
+import com.iluwatar.monolithic.repository.OrderRepository;
+import com.iluwatar.monolithic.repository.ProductRepository;
+import com.iluwatar.monolithic.repository.UserRepository;
 import org.springframework.stereotype.Service;
 /**
- * OrderCon is a controller class for managing Order operations.
+ * OrderController is a controller class for managing Order operations.
  * */
 @Service
-public class OrderCon {
-  private final OrderRepo orderRepository;
-  private final UserRepo userRepository;
-  private final ProductRepo productRepository;
+public class OrderController {
+  private final OrderRepository orderRepository;
+  private final UserRepository userRepository;
+  private final ProductRepository productRepository;
   /**
    * This function handles the initializing of the controller.
    * */
-  public OrderCon(OrderRepo orderRepository, UserRepo userRepository, ProductRepo productRepository) {
+  public OrderController(OrderRepository orderRepository, UserRepository userRepository, ProductRepository productRepository) {
     this.orderRepository = orderRepository;
     this.userRepository = userRepository;
     this.productRepository = productRepository;
   }
   /**
    * This function handles placing orders with all of its cases.
    * */
-  public Orders placeOrder(Long userId, Long productId, Integer quantity) {
+  public Order placeOrder(Long userId, Long productId, Integer quantity) {
     final User user = userRepository.findById(userId).orElseThrow(() -> new NonExistentUserException("User with ID " + userId + " not found"));
 
-    final Products product = productRepository.findById(productId).orElseThrow(() -> new NonExistentProductException("Product with ID " + productId + " not found"));
+    final Product product = productRepository.findById(productId).orElseThrow(() -> new NonExistentProductException("Product with ID " + productId + " not found"));
 
     if (product.getStock() < quantity) {
       throw new InsufficientStockException("Not enough stock for product " + productId);
@@ -64,7 +64,7 @@ public Orders placeOrder(Long userId, Long productId, Integer quantity) {
     product.setStock(product.getStock() - quantity);
     productRepository.save(product);
 
-    final Orders order = new Orders(null, user, product, quantity, product.getPrice() * quantity);
+    final Order order = new Order(null, user, product, quantity, product.getPrice() * quantity);
     return orderRepository.save(order);
   }
 }

monolithic-architecture/src/main/java/com/iluwatar/monolithic/controller/ProductCon.java renamed to monolithic-architecture/src/main/java/com/iluwatar/monolithic/controller/ProductController.java

@@ -24,8 +24,8 @@
  */
 package com.iluwatar.monolithic.controller;
 
-import com.iluwatar.monolithic.model.Products;
-import com.iluwatar.monolithic.repository.ProductRepo;
+import com.iluwatar.monolithic.model.Product;
+import com.iluwatar.monolithic.repository.ProductRepository;
 import java.util.List;
 import org.springframework.stereotype.Service;
 
@@ -35,24 +35,24 @@
 
 
 @Service
-public class ProductCon {
-  private final ProductRepo productRepository;
+public class ProductController {
+  private final ProductRepository productRepository;
   /**
  * Linking Controller to DB.
  * */
-  public ProductCon(ProductRepo productRepository) {
+  public ProductController(ProductRepository productRepository) {
     this.productRepository = productRepository;
   }
   /**
  * Adds a product to the DB.
  * */
-  public Products addProduct(Products product) {
+  public Product addProduct(Product product) {
     return productRepository.save(product);
   }
   /**
- * Returns all relevant Products.
+ * Returns all relevant Product.
  * */
-  public List<Products> getAllProducts() {
+  public List<Product> getAllProducts() {
     return productRepository.findAll();
   }
 }

monolithic-architecture/src/main/java/com/iluwatar/monolithic/controller/UserCon.java renamed to monolithic-architecture/src/main/java/com/iluwatar/monolithic/controller/UserController.java

@@ -25,18 +25,18 @@
 package com.iluwatar.monolithic.controller;
 
 import com.iluwatar.monolithic.model.User;
-import com.iluwatar.monolithic.repository.UserRepo;
+import com.iluwatar.monolithic.repository.UserRepository;
 import org.springframework.stereotype.Service;
 /**
- * UserCon is a controller class for managing user operations.
+ * UserController is a controller class for managing user operations.
  */
 @Service
-public class UserCon {
-  private final UserRepo userRepository;
+public class UserController {
+  private final UserRepository userRepository;
   /**
  * Linking Controller to DB.
  */
-  public UserCon(UserRepo userRepository) {
+  public UserController(UserRepository userRepository) {
     this.userRepository = userRepository;
   }
   /**

monolithic-architecture/src/main/java/com/iluwatar/monolithic/model/Orders.java renamed to monolithic-architecture/src/main/java/com/iluwatar/monolithic/model/Order.java

@@ -34,13 +34,13 @@
 import lombok.NoArgsConstructor;
 
 /**
- * Represents a Database in which Orders are stored.
+ * Represents a Database in which Order are stored.
  */
 @Entity
 @Data
 @NoArgsConstructor
 @AllArgsConstructor
-public class Orders {
+public class Order {
   @Id
   @GeneratedValue(strategy = GenerationType.IDENTITY)
   private Long id;
@@ -49,7 +49,7 @@ public class Orders {
   private User user;
 
   @ManyToOne
-  private Products product;
+  private Product product;
 
   private Integer quantity;
 

monolithic-architecture/src/main/java/com/iluwatar/monolithic/model/Products.java renamed to monolithic-architecture/src/main/java/com/iluwatar/monolithic/model/Product.java

@@ -39,7 +39,7 @@
 @Data
 @NoArgsConstructor
 @AllArgsConstructor
-public class Products {
+public class Product {
   @Id
   @GeneratedValue(strategy = GenerationType.IDENTITY)
   private Long id;

monolithic-architecture/src/main/java/com/iluwatar/monolithic/repository/OrderRepo.java renamed to monolithic-architecture/src/main/java/com/iluwatar/monolithic/repository/OrderRepository.java

@@ -24,10 +24,10 @@
  */
 package com.iluwatar.monolithic.repository;
 
-import com.iluwatar.monolithic.model.Orders;
+import com.iluwatar.monolithic.model.Order;
 import org.springframework.data.jpa.repository.JpaRepository;
 /**
  * This interface allows JpaRepository to generate queries for the required tables.
  */
-public interface OrderRepo extends JpaRepository<Orders, Long> {
+public interface OrderRepository extends JpaRepository<Order, Long> {
 }

monolithic-architecture/src/main/java/com/iluwatar/monolithic/repository/ProductRepo.java renamed to monolithic-architecture/src/main/java/com/iluwatar/monolithic/repository/ProductRepository.java

@@ -24,10 +24,10 @@
  */
 package com.iluwatar.monolithic.repository;
 
-import com.iluwatar.monolithic.model.Products;
+import com.iluwatar.monolithic.model.Product;
 import org.springframework.data.jpa.repository.JpaRepository;
 /**
  * This interface allows JpaRepository to generate queries for the required tables.
  */
-public interface ProductRepo extends JpaRepository<Products, Long> {
+public interface ProductRepository extends JpaRepository<Product, Long> {
 }

monolithic-architecture/src/main/java/com/iluwatar/monolithic/repository/UserRepo.java renamed to monolithic-architecture/src/main/java/com/iluwatar/monolithic/repository/UserRepository.java

@@ -29,7 +29,7 @@
 /**
  * This interface allows JpaRepository to generate queries for the required tables.
  */
-public interface UserRepo extends JpaRepository<User, Long> {
+public interface UserRepository extends JpaRepository<User, Long> {
   /**
    * Utilizes JpaRepository functionalities to generate a function which looks up in the User table using emails.
    * */