Matilda Sönnergaard

domain-model-extension.md

@@ -0,0 +1,103 @@
+# Bob's Bagels -- Domain model
+
+## Class: Item
+
+### Member variables
+
+- sku: String
+- price: double
+- name: String
+- variant: String
+- size: int (e.g., fillings maybe don't take up capacity)
+
+### Methods
+
+Accessors for all fields.
+
+## Class: Basket
+
+### Member variables
+
+- capacity: static int
+- items: List<Item>
+
+### Methods
+
+| Method                                             | Scenario                                            | Result                                                      |
+|----------------------------------------------------|-----------------------------------------------------|-------------------------------------------------------------|
+| addItem(name: String, variant: String): boolean    | Basket is full                                      | Return false. Print error message, don't add item to basket |
+| addItem(item: Item): boolean                       | Basket is not full                                  | Return true. Add item to basket.                            |
+|                                                    | One or more fields are invalid (shop doesn't stock) | Return false. Print error message.                          |
+| removeItem(name: String, variant: String): boolean | Item is not found in basket                         | Return false. Print error message.                          |
+|                                                    | Item is found in basket                             | Return true. Remove item from basket.                       |
+| setCapacity(newCapacity: int): static void         | newCapacity is valid (> 0)                          | Update the basket capacity.                                 |
+|                                                    | newCapacity is not valid (<= 0)                     | Don't change the basket capacity.                           |
+| getCapacity(): int                                 |                                                     |                                                             |
+| getTotalCost(): double                             |                                                     | Calculate and return the cost of items in basket.           |
+
+## Class: ShopHandler
+
+This is the public interface that a customer or manager interacts with the Bob's Bagels system through.
+
+### Member variables
+
+- basket: Basket
+- ~~stockedItems: `List<Map<attribute (String), value (String)>>()`~~
+- - stockedItems: `List<Item>` (copy existing items when adding new items)
+
+### Methods
+
+| Method                                                                   | Scenario | Result                                                            |
+|--------------------------------------------------------------------------|----------|-------------------------------------------------------------------|
+| placeOrder(): void                                                       |          | Guide the customer through selecting items to order (interactive) |
+| showItems(): String                                                      |          | Return String of bagels and coffee w/ prices                      |
+| showFillings(): String                                                   |          | Return String of fillings w/ prices                               |
+| orderBagel(): boolean                                                    |          | Add a bagel with optional filling to basket if it's not full.     |
+| orderCoffee(): boolean                                                   |          | Add coffee with optional bagel for a discount if it's not full.   |
+| setBasketCapacity(): void                                                |          | Update the basket capacity for all baskets.                       |
+| calculateDiscounts(): double                                             |          | Apply the discounts and return savings.                           |
+| showReceiptWithDiscounts(): String                                       |          | Return String with receipt, including discounts.                  |
+| show/Fillings/Bagels/Coffees(): String                                   |          | Return String showing possible orders and prices                  |
+| Some helper functions that I don't think are important enough to mention |          |                                                                   |
+
+## Class: Coffee
+
+Inherits from: Item.
+
+### Member variables:
+- discountBagel: Bagel
+
+### Methods
+
+| Method                    | Scenario                           | Result                                        |
+|---------------------------|------------------------------------|-----------------------------------------------|
+| getSize(): int            |                                    | Returns size, includes optional discountBagel |   |                                               |
+| getPrice(): double        |                                    | includes optional discountBagel               |
+| getDiscountBagel(): Bagel | There is a bagel/there is no bagel | Returns the bagel/returns null                |
+
+## Class: Bagel
+
+Inherits from: Item
+
+### Member variables:
+
+- filling: Item
+
+### Methods
+
+| Method             | Scenario                             | Result                           |
+|--------------------|--------------------------------------|----------------------------------|
+| getSize(): int     |                                      | Returns size                     |
+| getPrice(): double |                                      | includes optional filling        |
+| getFilling(): Item | There is filling/there is no filling | Returns the filling/returns null |
+
+# Class: Main
+
+Run interactive interface to interactively place an order. (Not up to date with extensions.)
+
+# User stories (extension)
+
+- As a customer, I want to be able to have a bagel with my coffee for a discount.
+- As a customer, I want multi-priced discounts to apply at checkout.
+- As a customer, I want to get a receipt when paying.
+- As a concerned customer, I want to know how much I saved using discounts.

domain-model.md

@@ -0,0 +1,62 @@
+# Bob's Bagels -- Domain model
+
+## Class: Item
+
+### Member variables
+
+- sku: String
+- price: double
+- name: String
+- variant: String
+- size: int (e.g., fillings maybe don't take up capacity)
+
+### Methods
+
+Accessors for all fields.
+
+## Class: Basket
+
+### Member variables
+
+- capacity: static int
+- items: List<Item>
+
+### Methods
+
+| Method                                             | Scenario                                            | Result                                                      |
+|----------------------------------------------------|-----------------------------------------------------|-------------------------------------------------------------|
+| addItem(name: String, variant: String): boolean    | Basket is full                                      | Return false. Print error message, don't add item to basket |
+| addItem(item: Item): boolean                       | Basket is not full                                  | Return true. Add item to basket.                            |
+|                                                    | One or more fields are invalid (shop doesn't stock) | Return false. Print error message.                          |
+| removeItem(name: String, variant: String): boolean | Item is not found in basket                         | Return false. Print error message.                          |
+|                                                    | Item is found in basket                             | Return true. Remove item from basket.                       |
+| setCapacity(newCapacity: int): static void         | newCapacity is valid (> 0)                          | Update the basket capacity.                                 |
+|                                                    | newCapacity is not valid (<= 0)                     | Don't change the basket capacity.                           |
+| getCapacity(): int                                 |                                                     |                                                             |
+| getTotalCost(): double                             |                                                     | Calculate and return the cost of items in basket.           |
+
+## Class: ShopHandler
+
+This is the public interface that a customer or manager interacts with the Bob's Bagels system through.
+
+### Member variables
+
+- basket: Basket
+- ~~stockedItems: `List<Map<attribute (String), value (String)>>()`~~
+- - stockedItems: `List<Item>` (copy existing items when adding new items)
+
+### Methods
+
+| Method                        | Scenario | Result                                                                |
+|-------------------------------|----------|-----------------------------------------------------------------------|
+| placeOrder(): void (boolean?) |          | Guide the customer through selecting items to order.                  |
+| showItems(): String           |          | Return String of bagels and coffee w/ prices                          |
+| showFillings(): String        |          | Return String of fillings w/ prices                                   |
+| orderBagel(): void            |          | Let customer choose a bagel. Then, let customer add optional filling. |
+| orderCoffee(): void           |          | Let customer choose a variant.                                        |
+| setBasketCapacity(): void     |          | Update the basket capacity for all baskets.                           |
+| Some private helper functions |          |                                                                       |
+
+# Class: Main
+
+Run interactive interface.

src/main/java/com/booleanuk/core/Basket.java

@@ -0,0 +1,73 @@
+package com.booleanuk.core;
+
+import java.util.ArrayList;
+import java.util.List;
+
+public class Basket {
+    private static int capacity = 5;
+    private List<Item> items = new ArrayList<>();
+
+    public boolean addItem(String sku, double price, String name, String variant, int size) {
+        Item item = new Item(sku, price, name, variant, size);
+        return addItem(item);
+    }
+
+    public boolean addItem(Item item) {
+        if (canFitItem(item)) {
+            items.add(item);
+            return true;
+        }
+        return false;
+    }
+
+    public boolean canFitItem(Item item) {
+        if (items.size() + item.getSize() > capacity) {
+            System.out.println("You cannot fit more items in your basket.");
+            return false;
+        }
+        return true;
+    }
+
+    public boolean addItem(String sku, double price, String name, String variant) {
+        // Shorthand, assuming size=1
+        return addItem(sku, price, name, variant, 1);
+    }
+
+
+        public boolean removeItem(String sku) {
+        int indexToRemove = 0;
+        boolean foundItem = false;
+        for (int i=0; i<items.size(); i++) {
+            if (sku.equals(items.get(i).getSku())) {
+                indexToRemove = i;
+                foundItem = true;
+                break;
+            }
+        }
+        if (foundItem) {
+            items.remove(indexToRemove);
+            return true;
+        }
+        return false;
+    }
+
+    public double getTotalCost() {
+        double totalCost = 0;
+        for (Item item : items) {
+            totalCost += item.getPrice();
+        }
+        return totalCost;
+    }
+
+    public List<Item> getItems() {
+        return items;
+    }
+
+    public static void setCapacity(int newCapacity) {
+        capacity = newCapacity;
+    }
+
+    public static int getCapacity() {
+        return capacity;
+    }
+}

src/main/java/com/booleanuk/core/Item.java

@@ -0,0 +1,41 @@
+package com.booleanuk.core;
+
+public class Item {
+    private String sku;
+    private double price;
+    private String name;
+    private String variant;
+    private int size;
+
+    public Item(String sku, double price, String name, String variant, int size) {
+        this.sku = sku;
+        this.price = price;
+        this.name = name;
+        this.variant = variant;
+        this.size = size;
+    }
+
+    public Item(String sku, double price, String name, String variant) {
+        this(sku, price, name, variant, 1);
+    }
+
+    public String getSku() {
+        return sku;
+    }
+
+    public double getPrice() {
+        return price;
+    }
+
+    public String getName() {
+        return name;
+    }
+
+    public String getVariant() {
+        return variant;
+    }
+
+    public int getSize() {
+        return size;
+    }
+}

src/main/java/com/booleanuk/core/Main.java

@@ -0,0 +1,8 @@
+package com.booleanuk.core;
+
+public class Main {
+    public static void main(String[] args) {
+        ShopHandler sh = new ShopHandler();
+        sh.placeOrder();
+    }
+}