nus-cs2113-AY2122S1 · alvintan01 · Nov 1, 2021 · Nov 1, 2021 · Nov 1, 2021 · Nov 1, 2021
diff --git a/build.gradle b/build.gradle
@@ -43,4 +43,5 @@ checkstyle {
 
 run{
     standardInput = System.in
+    enableAssertions = true
 }
diff --git a/config/checkstyle/checkstyle.xml b/config/checkstyle/checkstyle.xml
@@ -185,7 +185,7 @@
             <property name="caseIndent" value="0"/>
             <property name="throwsIndent" value="4"/>
             <property name="lineWrappingIndentation" value="4"/>
-            <property name="arrayInitIndent" value="4"/>
+            <property name="arrayInitIndent" value="8"/>
         </module>
         <module name="AbbreviationAsWordInName">
             <property name="ignoreFinal" value="false"/>

diff --git a/data/order.txt b/data/order.txt
@@ -0,0 +1,7 @@
+1|PANADOL|100|09-10-2021|PENDING
+2|VICODIN|30|09-10-2021|PENDING
+3|VICODIN|50|10-10-2021|DELIVERED
+4|SIMVASTATIN|20|11-10-2021|PENDING
+5|LISINOPRIL|200|12-10-2021|PENDING
+6|AZITHROMYCIN|100|13-10-2021|PENDING
+7|PANADOL|50|13-10-2021|PENDING
diff --git a/data/order_archive.txt b/data/order_archive.txt
@@ -0,0 +1 @@
+[ORDER ID: 3] 50 VICODIN WAS ORDERED ON 10-10-2021. STATUS: DELIVERED
diff --git a/data/prescription.txt b/data/prescription.txt
@@ -0,0 +1,5 @@
+1|PANADOL|10|S1234567A|09-10-2021|Jane|1
+2|VICODIN|10|S2345678B|10-10-2021|Peter|3
+3|SIMVASTATIN|10|S1234567A|11-10-2021|Sam|4
+4|LISINOPRIL|10|S3456789C|12-10-2021|Jane|5
+5|AZITHROMYCIN|10|S2345678B|13-10-2021|Peter|6
diff --git a/data/prescription_archive.txt b/data/prescription_archive.txt
@@ -0,0 +1,2 @@
+[PRESCRIPTION ID: 1] 10 PANADOL [STOCK ID: 1] WAS PRESCRIBED BY JANE TO S1234567A ON 09-10-2021
+[PRESCRIPTION ID: 2] 10 VICODIN [STOCK ID: 3] WAS PRESCRIBED BY PETER TO S2345678B ON 10-10-2021
diff --git a/data/stock.txt b/data/stock.txt
@@ -0,0 +1,6 @@
+1|PANADOL|20.0|20|13-09-2021|BEST MEDICINE TO CURE HEADACHES, FEVER AND PAINS|1000|false
+2|PANADOL|20.0|10|14-09-2021|BEST MEDICINE TO CURE HEADACHES, FEVER AND PAINS|1000|false
+3|VICODIN|10.0|20|30-09-2021|POPULAR DRUG FOR TREATING ACUTE OR CHRONIC MODERATE TO MODERATELY SEVERE PAIN|500|false
+4|SIMVASTATIN|20.0|25|10-10-2021|TREATS HIGH CHOLESTEROL AND REDUCES THE RISK OF STROKE|800|false
+5|LISINOPRIL|20.0|25|15-10-2021|USED FOR TREATING HYPOTHYROIDISM|800|false
+6|AZITHROMYCIN|20.0|35|15-10-2021|USED FOR TREATING EAR, THROAT, AND SINUS INFECTIONS|100|false
diff --git a/docs/AboutUs.md b/docs/AboutUs.md
@@ -2,8 +2,10 @@
 
 Display | Name | Github Profile | Portfolio 
 --------|:----:|:--------------:|:---------:
-![](https://via.placeholder.com/100.png?text=Photo) | John Doe | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
-![](https://via.placeholder.com/100.png?text=Photo) | Don Joe | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
-![](https://via.placeholder.com/100.png?text=Photo) | Ron John | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
-![](https://via.placeholder.com/100.png?text=Photo) | John Roe | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
-![](https://via.placeholder.com/100.png?text=Photo) | Don Roe | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Alvin Tan Guo Hao | [Github](https://github.com/alvintan01) | [Portfolio](team/alvintan01.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Deon Chung Hui | [Github](https://github.com/deonchung) | [Portfolio](team/deonchung.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Jiang Weichen | [Github](https://github.com/jiangweichen835) | [Portfolio](team/jiangweichen835.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Teo Chin Kai Remus | [Github](https://github.com/RemusTeo) | [Portfolio](team/remusteo.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Teo Phing Huei, Aeron | [Github](https://github.com/a-tph) | [Portfolio](team/a-tph.md)
+
+
diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md
diff --git a/docs/README.md b/docs/README.md
@@ -1,8 +1,10 @@
-# Duke
+# MediVault
 
-{Give product intro here}
+MediVault is a Command Line Interface (CLI) application that will help to manage medication supplies within a pharmacy.
+It is an integrated solution that provides real-time tracking of stocks, prescriptions and orders.
 
 Useful links:
+
 * [User Guide](UserGuide.md)
 * [Developer Guide](DeveloperGuide.md)
 * [About Us](AboutUs.md)
diff --git a/docs/UserGuide.md b/docs/UserGuide.md
diff --git a/docs/_config.yml b/docs/_config.yml
@@ -0,0 +1,3 @@
+theme: jekyll-theme-cayman
+gems:
+  - jemoji
diff --git a/docs/diagrams/AddOrderSequenceDiagram.puml b/docs/diagrams/AddOrderSequenceDiagram.puml
@@ -0,0 +1,56 @@
+@startuml AddOrderSequenceDiagram
+'https://plantuml.com/sequence-diagram
+
+!include style.puml
+
+box Command COLOR_COMMAND_BOX
+    participant ":AddOrderCommand" as addorder COLOR_COMMAND
+end box
+
+box Utilities COLOR_UTILITIES_BOX
+    participant "<<class>>\n:Ui" as ui COLOR_UTILITIES
+    participant ":OrderManager" as ordermanager COLOR_UTILITIES
+    participant ":StockManager" as stockmanager COLOR_UTILITIES
+end box
+
+autoactivate on
+mainFrame sd Logic for AddOrderCommand
+activate addorder
+alt orderQuantity != 0
+    alt nameExistsInOrder && !nameExistsInStock
+        alt orderQuantity < maxQuantity
+           addorder -> addorder : addDate(dateToAdd)
+           addorder --> addorder
+           addorder -> addorder : addOrder(ui: Ui, medicines: ArrayList<Medicine>, name: String, \nquantity: int, date: Date)
+           addorder --> addorder
+        else !orderQuantity < maxQuantity
+           addorder -> ui : print()
+           addorder <-- ui
+        end
+    else nameExistsInOrder && nameExistsInStock
+        addorder -> ordermanager : getTotalOrderQuantity()
+        addorder <-- ordermanager : TotalOrderQuantity
+        addorder -> stockmanager : getTotalStockQuantity()
+        addorder <-- stockmanager : TotalStockQuantity
+        addorder -> stockmanager : getMaxStockQuantity()
+        addorder <-- stockmanager : MaxStockQuantity
+        alt orderQuantity + totalExistingQuantity <= maxQuantity
+           addorder -> addorder : addDate(dateToAdd)
+           addorder --> addorder
+           addorder -> addorder : addOrder(ui: Ui, medicines: ArrayList<Medicine>, name: String, \nquantity: int, date: Date)
+           addorder --> addorder
+        else !orderQuantity + totalExistingQuantity <= maxQuantity
+            addorder -> ui : print()
+            addorder <-- ui
+        end
+    note right
+        This diagram shows the process for
+        adding order when medicine exist in
+        orders.
+        It does not include the process by
+        which medicine does not exist in
+        orders.    
+    end note
+end
+deactivate addorder
+@enduml
diff --git a/docs/diagrams/AddPrescriptionSequenceDiagram.puml b/docs/diagrams/AddPrescriptionSequenceDiagram.puml
@@ -0,0 +1,64 @@
+@startuml AddPrescriptionSequenceDiagram
+'https://plantuml.com/sequence-diagram
+
+!include style.puml
+
+box Command COLOR_COMMAND_BOX
+    participant ":AddPrescriptionCommand" as addprescription COLOR_COMMAND
+end box
+
+box Utilities COLOR_UTILITIES_BOX
+    participant "<<class>>\n:PrescriptionManager" as prescriptionManager COLOR_UTILITIES
+    participant "<<class>>\n:StockManager" as stockManager COLOR_UTILITIES
+    participant ":StockComparator" as stockcomparator COLOR_UTILITIES
+end box
+
+box Inventory COLOR_INVENTORY_BOX
+    participant ":Stock" as stock COLOR_INVENTORY
+end box
+
+autoactivate on
+mainframe sd AddPrescriptionCommand
+activate addprescription
+    addprescription -> stockManager: getFilteredStocksByName(medicines: ArrayList<Medicine>, stockName: String)
+    addprescription <-- stockManager: filteredStocks
+    create stockcomparator
+    addprescription -> stockcomparator : new StockComparator()
+    addprescription <-- stockcomparator : filteredStocks
+
+    addprescription -> prescriptionManager: getNotExpiredStockQuantity(medicines: ArrayList<Medicine>, \nname: String, prescribeDate: Date)
+    addprescription <-- prescriptionManager: totalStock
+
+
+
+    deactivate stockcomparator
+    addprescription -> addprescription : checkExpiredMedication(ui: Ui, filteredStocks: ArrayList<Stock>, \nprescriptionQuantity: int)
+
+    loop stock : filteredStocks
+        opt existingExpiry.after(prescribeDate) || prescribeDateString.equals(expiryString)
+            opt existingQuantity == quantityToPrescribe
+                addprescription -> addprescription : prescribe(ui: Ui, medicines: ArrayList<Medicine>, medicationName: String, \ncustomerId: String, staffName: String, quantityToPrescribe: int, prescribeDate: Date, \nstock: Stock, existingId: int, existingExpiry: Date, setStockValue: int)
+                addprescription -> stock : setQuantity()
+                addprescription <-- stock
+                addprescription --> addprescription
+            end
+
+            opt existingQuantity > quantityToPrescribe
+                addprescription -> addprescription : prescribe(ui: Ui, medicines: ArrayList<Medicine>, medicationName: String, \ncustomerId: String, staffName: String, quantityToPrescribe: int, prescribeDate: Date, \nstock: Stock, existingId: int, existingExpiry: Date, setStockValue: int)
+                addprescription -> stock : setQuantity()
+                addprescription <-- stock
+                addprescription --> addprescription
+            end
+            opt existingQuantity < quantityToPrescribe
+                addprescription -> addprescription : prescribe(ui: Ui, medicines: ArrayList<Medicine>, medicationName: String, \ncustomerId: String, staffName: String, quantityToPrescribe: int, prescribeDate: Date, \nstock: Stock, existingId: int, existingExpiry: Date, setStockValue: int)
+                addprescription -> stock : setQuantity()
+                addprescription <-- stock
+                addprescription --> addprescription
+            end
+        end
+    end
+        addprescription --> addprescription
+
+
+
+@enduml
diff --git a/docs/diagrams/AddStockSequenceDiagram.puml b/docs/diagrams/AddStockSequenceDiagram.puml
@@ -0,0 +1,65 @@
+@startuml AddStockSequenceDiagram
+'https://plantuml.com/sequence-diagram
+
+!include style.puml
+
+box Command COLOR_COMMAND_BOX
+    participant ":AddStockCommand" as addstock COLOR_COMMAND
+end box
+
+box Utilities COLOR_UTILITIES_BOX
+    participant ":StockValidator" as stockvalidator COLOR_UTILITIES
+    participant "<<class>>\n:StockManager" as stockmanager COLOR_UTILITIES
+end box
+
+box Inventory COLOR_INVENTORY_BOX
+    participant ":Stock" as stock COLOR_INVENTORY
+end box
+
+autoactivate on
+mainFrame sd Logic for AddStockCommand
+activate addstock
+addstock -> addstock : checkExpiryDate(ui: Ui, expiryDate: String)
+addstock --> addstock :
+
+    addstock -> stockmanager: getTotalStockQuantity()
+    addstock <-- stockmanager: totalStock
+    addstock -> addstock : isExpiryExist(ui: Ui, stockValidator: StockValidator, \nfilteredStock: ArrayList<Stock>, quantityToAdd: String, \nformatExpiry: Date, totalStock: int)
+    loop stock : filteredStocks
+        opt isValidQuantity
+            addstock -> addstock : isValidQuantity(ui:Ui, stockValidator: StockValidator, \nmaxQuantity: int, quantity: int)
+            addstock -> stockvalidator : quantityValidityChecker(ui: Ui, quantity: int, maxQuantity: int)
+            addstock <-- stockvalidator : isValidQuantity
+            addstock --> addstock :
+            opt formatExpiry.equals(stock.getExpiry())
+                addstock -> stock : getQuantity()
+                addstock <-- stock : getQuantity
+                addstock -> stock : setQuantity()
+                addstock <-- stock :
+            end
+        end
+    end
+    addstock --> addstock :
+    addstock -> addstock : checkValidParametersAndValues(ui: Ui, parameters: LinkedHashMap<String, String>, \nmedicines: ArrayList<Medicine>, requiredParameters: String[], optionalParameters: String[])
+    addstock -> addstock : addSameMedicine(ui: Ui, medicines: ArrayList<Medicine>, nameToAdd: String, \nstockValidator: StockValidator, filteredStocks: ArrayList<Stock>, quantityToAdd: String, \nformatExpiry: Date, totalStock: int)
+    loop stock : filteredStocks
+        opt isValidQuantity
+        addstock -> addstock : isValidQuantity(ui:Ui, stockValidator: StockValidator, \nmaxQuantity: int, quantity: int)
+        addstock -> stockvalidator : quantityValidityChecker(ui: Ui, quantity: int, maxQuantity: int)
+        addstock <-- stockvalidator : isValidQuantity
+        addstock --> addstock :
+        addstock -> addstock : addMedicine(ui: Ui, medicines: ArrayList<Medicine>, name: String, \ndescription: String, price: Double, quantity: int, expiryDate: Date, maxQuantity: int)
+        addstock --> addstock :
+        end
+        addstock --> addstock :
+    end
+    addstock --> addstock :
+    note right
+        This diagram shows the process for adding medication
+        where medication exists.
+        It does not include the process whereby medication does
+        not exist in stock.
+    end note
+deactivate addstock
+
+@enduml
diff --git a/docs/diagrams/ArchitectureDiagram.puml b/docs/diagrams/ArchitectureDiagram.puml
@@ -0,0 +1,31 @@
+@startuml ArchitectureDiagram
+!include <office/Concepts/documents>
+!include <office/Users/user>
+!include style.puml
+
+' hide the circles in the diagram
+hide circle
+hide empty members
+
+package " "<<Rectangle>>{
+    class MediVault COLOR_MEDIVAULT
+    class Utilities COLOR_UTILITIES
+    class Errors COLOR_ERRORS
+    class Command COLOR_COMMAND
+    class Inventory COLOR_INVENTORY
+}
+
+class "<$user>" as User COLOR_SPARE
+class "<$documents>" as Files COLOR_SPARE1
+
+User .[COLOR_SPARE].> Utilities
+MediVault -[COLOR_MEDIVAULT]> Utilities
+Errors --[COLOR_ERRORS]up> Utilities
+Utilities .[COLOR_UTILITIES]right>Files
+Utilities --[COLOR_UTILITIES]> Command
+MediVault --[COLOR_COMMAND]> Command
+Command --[COLOR_COMMAND]> Inventory
+Inventory --[COLOR_INVENTORY]> Utilities
+
+
+@enduml
diff --git a/docs/diagrams/ArchiveOrderCommand.puml b/docs/diagrams/ArchiveOrderCommand.puml
@@ -0,0 +1,28 @@
+@startuml DeleteStockSequenceDiagram
+'https://plantuml.com/sequence-diagram
+
+!include style.puml
+
+box Command COLOR_COMMAND_BOX
+    participant ":ArchiveOrderCommand" as archiveOrder COLOR_COMMAND
+end box
+
+box Utilities COLOR_UTILITIES_BOX
+    participant "<<class>>\n:DateParser" as dateParser COLOR_UTILITIES
+    participant "<<class>>\n:Storage" as storage COLOR_UTILITIES
+end box
+
+autoactivate on
+mainFrame sd Logic for ArchiveOrderCommand
+activate archiveOrder
+archiveOrder -> dateParser : stringToDate(date: String)
+archiveOrder <-- dateParser : date
+archiveOrder -> archiveOrder : ordersToArchive(medicines: ArrayList<Medicine>,\n orderArchiveDate: Date)
+archiveOrder --> archiveOrder : filteredOrders
+archiveOrder -> archiveOrder : removeFromOrders(medicines: ArrayList<Medicine>,\n filteredOrders: ArrayList<Medicine>)
+archiveOrder --> archiveOrder
+archiveOrder -> storage : getInstance()
+archiveOrder <-- storage
+archiveOrder -> storage : archiveData(filteredOrders: ArrayList<Medicine>)
+archiveOrder <-- storage
+@enduml
diff --git a/docs/diagrams/ArchivePrescriptionCommand.puml b/docs/diagrams/ArchivePrescriptionCommand.puml
@@ -0,0 +1,28 @@
+@startuml DeleteStockSequenceDiagram
+'https://plantuml.com/sequence-diagram
+
+!include style.puml
+
+box Command COLOR_COMMAND_BOX
+    participant ":ArchivePrescriptionCommand" as archivePrescription COLOR_COMMAND
+end box
+
+box Utilities COLOR_UTILITIES_BOX
+    participant "<<class>>\n:DateParser" as dateParser COLOR_UTILITIES
+    participant "<<class>>\n:Storage" as storage COLOR_UTILITIES
+end box
+
+mainFrame sd Logic for ArchivePrescriptionCommand
+autoactivate on
+activate archivePrescription
+archivePrescription -> dateParser : stringToDate(date: String)
+archivePrescription <-- dateParser : date
+archivePrescription -> archivePrescription : prescriptionsToArchive(medicines: ArrayList<Medicine>,\n prescriptionArchiveDate: Date)
+archivePrescription --> archivePrescription : filteredPrescriptions
+archivePrescription -> archivePrescription : removeFromPrescriptions(medicines: ArrayList<Medicine>,\n filteredPrescriptions: ArrayList<Medicine>)
+archivePrescription --> archivePrescription
+archivePrescription -> storage : getInstance()
+archivePrescription <-- storage
+archivePrescription -> storage : archiveData(filteredPrescriptions: ArrayList<Medicine>)
+archivePrescription <-- storage
+@enduml
-Original file line number
+Diff line change
@@ Expand Up / @@ -43,4 +43,5 @@ checkstyle { @@
     run{
         standardInput = System.in
+        enableAssertions = true
     }
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		[ORDER ID: 3] 50 VICODIN WAS ORDERED ON 10-10-2021. STATUS: DELIVERED
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		[PRESCRIPTION ID: 1] 10 PANADOL [STOCK ID: 1] WAS PRESCRIBED BY JANE TO S1234567A ON 09-10-2021
		[PRESCRIPTION ID: 2] 10 VICODIN [STOCK ID: 3] WAS PRESCRIBED BY PETER TO S2345678B ON 10-10-2021