[CS2113-W12-3] MagusStock

.gitignore

@@ -13,5 +13,6 @@ src/main/resources/docs/
 *.iml
 bin/
 
-/text-ui-test/ACTUAL.TXT
 text-ui-test/EXPECTED-UNIX.TXT
+data/InventoryData.csv
+data/AlertData.csv

.gitignore.bak

@@ -0,0 +1,17 @@
+# IDEA files
+/.idea/
+/out/
+/*.iml
+
+# Gradle build files
+/.gradle/
+/build/
+src/main/resources/docs/
+
+# MacOS custom attributes files created by Finder
+.DS_Store
+*.iml
+bin/
+
+/text-ui-test/ACTUAL.TXT
+text-ui-test/EXPECTED-UNIX.TXT

build.gradle

@@ -29,11 +29,11 @@ test {
 }
 
 application {
-    mainClass = "seedu.duke.Duke"
+    mainClass = "seedu.duke.MagusStock"
 }
 
 shadowJar {
-    archiveBaseName = "duke"
+    archiveBaseName = "magusstock"
     archiveClassifier = null
 }
 
@@ -43,4 +43,6 @@ checkstyle {
 
 run{
     standardInput = System.in
-}
+    enableAssertions = true
+    assert true;
+}

docs/AboutUs.md

@@ -1,9 +1,9 @@
 # About us
 
-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)
+| Display                                                                                                    |      Name      |              Github Profile              |           Portfolio           |
+|------------------------------------------------------------------------------------------------------------|:--------------:|:----------------------------------------:|:-----------------------------:|
+| ![](https://via.placeholder.com/100.png?text=Photo)                                                        | Yong Shan Ling |   [Github](https://github.com/ysl-28)    | [Portfolio](team/shanling.md) |
+| ![](https://via.placeholder.com/100.png?text=Photo)                                                        |    Yan Zhen    |    [Github](https://github.com/Ng-YZ)    | [Portfolio](team/yanzhen.md)  |
+| ![](https://avatars.githubusercontent.com/u/88386677?s=400&v=4)                                            |   Ng Kai Wen   | [Github](https://github.com/ngkaiwen123) | [Portfolio](team/ngkaiwen.md) |
+| ![](https://via.placeholder.com/100.png?text=Photo)                                                        |  Poh Wei Pin   |   [Github](https://github.com/firwer)    |  [Portfolio](team/pohwp.md)   |
+| ![](https://avatars.githubusercontent.com/u/24601679?s=400&u=4ff44cf4bbd34ac299fd550ce267a884df4043a7&v=4) |  Artemis Ngoh  | [Github](https://github.com/ArtemiszenN) | [Portfolio](team/artemis.md)  |

docs/README.md

@@ -1,8 +1,23 @@
-# Duke
 
-{Give product intro here}
+![Magnus Stock Logo](logo.jpg)
+
+MagusStock is a Java command-line interface (CLI) application designed for inventory management. With MagusStock, you can perform CRUD operations on inventory items, generate history reports, and read/write inventory data in CSV format.
+
+## Features
+
+- Inventory management with CSV read/write
+- CRUD operations
+- History reports
+
+## Documentation
+
+For more information on how to use MagusStock, please refer to the following documents:
 
-Useful links:
 * [User Guide](UserGuide.md)
 * [Developer Guide](DeveloperGuide.md)
-* [About Us](AboutUs.md)
+
+## About Us
+
+We are a team of CS2113 developers dedicated to creating high-quality software. For more information on our team and our projects, please refer to the [About Us](AboutUs.md) document.
+
+---

docs/SequenceDiagram.puml

@@ -0,0 +1,40 @@
+
+@startuml
+title MagusStock Class
+
+actor User
+participant MagusStock
+participant Ui
+participant SessionManager
+participant Inventory
+participant ParserHandler
+User -> MagusStock: run()
+activate MagusStock
+MagusStock -> Ui: greetUser()
+activate Ui
+Ui --> MagusStock:
+deactivate Ui
+MagusStock -> SessionManager: getSession()
+activate SessionManager
+SessionManager --> MagusStock:
+deactivate SessionManager
+MagusStock -> SessionManager: getSessionAlerts()
+activate SessionManager
+SessionManager --> MagusStock:
+deactivate SessionManager
+MagusStock -> Inventory: setAlertList()
+activate Inventory
+Inventory --> MagusStock:
+deactivate Inventory
+MagusStock -> ParserHandler: <<create>>
+activate ParserHandler
+ParserHandler --> MagusStock:
+deactivate ParserHandler
+MagusStock -> MagusStock: run()
+MagusStock -> ParserHandler: run()
+activate ParserHandler
+ParserHandler --> MagusStock:
+deactivate ParserHandler
+
+
+@enduml

docs/UML/Add/AddCommand.puml

@@ -0,0 +1,53 @@
+
+@startuml
+title AddCommand Class
+
+participant AddParser
+participant AddCommand
+AddParser -> AddCommand: run()
+
+activate AddCommand
+AddCommand -> Command:Command(inventory)
+activate Command
+Command -->AddCommand:
+deactivate Command
+participant Inventory
+participant Ui
+AddCommand -> AddCommand: addItem()
+alt upcCodes.containsKey(item.getUpc())
+AddCommand -> Ui: printDuplicateAdd()
+activate Ui
+Ui -->AddCommand:
+deactivate Ui
+else
+ref over AddCommand,Inventory:Store Item's UPC code into upcCodes
+ref over AddCommand,Inventory:Store Item into itemInventory
+AddCommand -> Ui: printSuccessAdd()
+activate Ui
+Ui -->AddCommand:
+deactivate Ui
+participant Trie
+loop iterate all item name in itemNames
+AddCommand -> Trie:add(itemName)
+activate Trie
+Trie --> AddCommand:
+deactivate Trie
+end
+participant SessionManager
+participant Storage
+opt SessionManager.getAutoSave()
+AddCommand ->SessionManager:writeSession(inventory)
+activate SessionManager
+SessionManager->Storage:writeCSV(inventory)
+activate Storage
+Storage -->SessionManager:
+deactivate Storage
+SessionManager -->AddCommand:
+deactivate SessionManager
+end
+end
+AddCommand --> AddParser:
+destroy AddCommand
+
+
+@enduml

docs/UML/Add/AddParser.puml

@@ -0,0 +1,48 @@
+
+@startuml
+title AddParser Class
+
+participant ParserHandler
+participant AddParser
+ParserHandler -> AddParser: run()
+
+activate AddParser
+participant Ui
+opt rawInput == null
+AddParser -> MissingParametersException:throw missingAddItemParameters
+
+end
+
+opt !matcher.matches
+AddParser -> Ui:printInvalidAddCommand()
+Ui --> User:
+end
+AddParser -> Item: Item()
+activate Item
+Item -->AddParser:
+deactivate Item
+
+AddParser -> AddCommand: AddCommand(inventory, newItem)
+activate AddCommand
+AddCommand -->AddParser:
+deactivate AddCommand
+
+AddParser -> AddCommand: run()
+activate AddCommand
+
+AddCommand -> Command:Command(inventory)
+activate Command
+Command -->AddCommand:
+deactivate Command
+
+AddCommand -->AddParser:
+deactivate AddCommand
+
+AddParser -> Command: run()
+activate Command
+Command -->AddParser:
+deactivate Command
+
+AddParser --> ParserHandler:
+destroy AddParser
+@enduml

docs/UML/Alert/AlertParser.puml

@@ -0,0 +1,36 @@
+@startuml
+'https://plantuml.com/sequence-diagram
+
+actor User
+User -> AlertParser
+
+group sd [AddAlertCommand running]
+alt first word of input == "add"
+    AlertParser -> AddAlertCommand: run()
+    activate AddAlertCommand
+    participant AddAlertCommand
+    AddAlertCommand -> AddAlertCommand: run()
+    end
+ alt first word of input == "remove"
+    AlertParser -> RemoveAlertCommand: run()
+    activate RemoveAlertCommand
+    RemoveAlertCommand -> RemoveAlertCommand: run()
+    end
+    participant SessionManager
+    participant Storage
+    opt SessionManager.getAutoSave()
+    AddAlertCommand ->SessionManager:writeSession(alertList)
+    activate SessionManager
+    SessionManager->Storage:writeCSV(alertList)
+    activate Storage
+    Storage --> SessionManager:
+    deactivate Storage
+    SessionManager -->AddAlertCommand:
+    deactivate SessionManager
+    destroy AddAlertCommand
+    destroy RemoveAlertCommand
+end
+
+
+
+@enduml

docs/UML/Alert/AlertStep1.puml

@@ -0,0 +1,9 @@
+@startuml
+'https://plantuml.com/object-diagram
+
+object AlertParser{
+    - rawInput = "add upc/012341 min/50"
+    - Inventory = inventory
+}
+
+@enduml

docs/UML/Alert/AlertStep3Add.puml

@@ -0,0 +1,17 @@
+@startuml
+'https://plantuml.com/object-diagram
+
+object AlertParser{
+     - rawInput = "add upc/012341 min/50"
+     - Inventory = inventory
+ }
+
+ object AddAlertCommand {
+     - Inventory = inventory
+     - Alert = newAlert
+     - AlertList = inventory.getAlertList()
+ }
+
+ AlertParser -> AddAlertCommand
+
+@enduml

docs/UML/Alert/AlertStep3Remove.puml

@@ -0,0 +1,16 @@
+@startuml
+'https://plantuml.com/object-diagram
+
+object AlertParser{
+     - rawInput = "add upc/012341 min/50"
+     - Inventory = inventory
+ }
+
+ object RemoveAlertCommand {
+     - Inventory = inventory
+     - Alert = newAlert
+     - AlertList = inventory.getAlertList()
+ }
+
+ AlertParser -> RemoveAlertCommand
+@enduml

docs/UML/Category/CategoryParser.puml

@@ -0,0 +1,65 @@
+@startuml
+'https://plantuml.com/sequence-diagram
+
+
+actor User
+User -> CategoryParser**
+activate CategoryParser
+User -> CategoryParser: run()
+alt categoryCommandType is not 'list'
+else categoryCommandType is not 'table'
+else categoryCommandType length is 0
+    ref over CategoryParser
+        Handle input error
+    end ref
+    CategoryParser --> User
+else rawInput is valid
+
+CategoryParser -> CategoryCommand**
+activate CategoryCommand
+CategoryParser -> CategoryCommand: run()
+activate CategoryCommand #cyan
+ref over CategoryCommand
+    retrieve categoryHash from inventory and process rawInput
+end ref
+participant Ui
+alt rawInput equals 'list'
+    CategoryCommand --> CategoryCommand: listAllCategories()
+    CategoryCommand --> Ui: printCategoryList(categoryHash)
+    activate Ui
+    ref over Ui
+        print list of categories
+    end ref
+    return
+else rawInput equals 'table'
+    CategoryCommand --> CategoryCommand: listCategoriesAndItems()
+    alt categoryHash is empty
+        CategoryCommand --> CategoryCommand: null
+    else categoryHash is not empty
+        CategoryCommand --> Ui : printCategory(categoryHash)
+        activate Ui
+        ref over Ui
+            print all categories and its items
+        end ref
+        return
+    end
+else find category from rawInput
+    CategoryCommand --> CategoryCommand: findCategory(rawInput)
+    alt categoryHash contains category
+        CategoryCommand --> Ui : printCategory(filteredCategoryHash)
+        activate Ui
+        ref over Ui
+            print all categories and its items
+        end ref
+        return
+    else
+        CategoryCommand --> CategoryCommand: error
+    end
+end
+return
+end
+return
+destroy CategoryCommand
+return
+destroy CategoryParser
+@enduml