[CS2113-T15-4] StockMaster

.gitignore

@@ -3,6 +3,18 @@
 /out/
 /*.iml
 
+#Compiled class files
+*.class
+
+#Logger files
+logs
+*.log
+
+#Generated storage text files
+PromotionStorage.txt
+StockMasterData.txt
+TransactionLogs.txt
+
 # Gradle build files
 /.gradle/
 /build/

META-INF/MANIFEST.MF

@@ -0,0 +1,3 @@
+Manifest-Version: 1.0
+Main-Class: seedu.duke.StockMaster
+

README.md

@@ -1,4 +1,4 @@
-# Duke project template
+# Stock Master
 
 This is a project template for a greenfield Java project. It's named after the Java mascot _Duke_. Given below are instructions on how to use it.
 
@@ -35,11 +35,11 @@ Prerequisites: JDK 11 (use the exact version), update Intellij to the most recen
 
 ### I/O redirection tests
 
-* To run _I/O redirection_ tests (aka _Text UI tests_), navigate to the `text-ui-test` and run the `runtest(.bat/.sh)` script.
+* To run _I/O redirection_ tests (aka _Text UI tests_), navigate to the `text-ui-itemlist` and run the `runtest(.bat/.sh)` script.
 
 ### JUnit tests
 
-* A skeleton JUnit test (`src/test/java/seedu/duke/DukeTest.java`) is provided with this project template. 
+* A skeleton JUnit itemlist (`src/itemlist/java/seedu/duke/DukeTest.java`) is provided with this project template. 
 * If you are new to JUnit, refer to the [JUnit Tutorial at se-education.org/guides](https://se-education.org/guides/tutorials/junit.html).
 
 ## Checkstyle

build.gradle

@@ -29,7 +29,7 @@ test {
 }
 
 application {
-    mainClass.set("seedu.duke.Duke")
+    mainClass.set("seedu.duke.StockMaster")
 }
 
 shadowJar {
@@ -43,4 +43,5 @@ checkstyle {
 
 run{
     standardInput = System.in
-}
+    enableAssertions = 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) | Low Tjun Lym  |    [Github](https://github.com/LowTL)    | [Portfolio](docs/team/johndoe.md)
+![](https://via.placeholder.com/100.png?text=Photo) |   Fu Xueer    |   [Github](https://github.com/fxe025)    | [Portfolio](docs/team/johndoe.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Heng Shu Hong | [Github](https://github.com/HengShuHong) | [Portfolio](docs/team/johndoe.md)
+![](https://via.placeholder.com/100.png?text=Photo) |   Joel Lim    |  [Github](https://github.com/joellimjr)  | [Portfolio](docs/team/johndoe.md)
+![](https://via.placeholder.com/100.png?text=Photo) |  Min Guanlin  |   [Github](https://github.com/Fureimi)   | [Portfolio](docs/team/johndoe.md)

docs/Diagrams/PUML files/ArchitectureDiagram.puml

@@ -0,0 +1,41 @@
+@startuml
+!include Style.puml
+
+package "" as f {
+Class TextUi #LightBlue
+Class Parser #Magenta
+Class Main #SkyBlue
+Class Storage #Green
+Class Command #Grey
+Class Cashier #Orange
+Class PromotionList #Gold
+Class Itemlist #Tan
+}
+
+Class User #IndianRed
+file "Storage" as File #DarkOliveGreen {
+}
+file "TransactionLogs" as File2 #DarkOliveGreen {
+}
+file "PromotionStorage"" as File3 #DarkOliveGreen {
+}
+
+User -d-> TextUi
+TextUi --> Parser
+TextUi <--> Main
+TextUi <--> Storage
+Main --> Storage
+Main -l-> Parser
+Main --> Command
+Parser --> Command
+Command --> Cashier
+Command --> Itemlist
+Command --> PromotionList
+Itemlist <--> PromotionList
+Itemlist <--> Cashier
+
+Storage <-d-> File
+Storage <-r-> File2
+Storage <-d-> File3
+
+@enduml

docs/Diagrams/PUML files/Cashier/BestsellerCommand_SequenceDiagram.puml

@@ -0,0 +1,15 @@
+@startuml
+!include ../Style.puml
+
+participant ":BestsellerCommand" as BestsellerCommand
+participant ":Cashier" as Cashier
+participant ":TextUi" as TextUi
+
+BestsellerCommand -> Cashier: getBestseller()
+activate Cashier
+Cashier -> Cashier: Retrieve bestseller
+Cashier --> BestsellerCommand: itemName
+deactivate Cashier
+BestsellerCommand -> TextUi: replyToUser("The current best-selling item is {itemName}")
+
+@enduml

docs/Diagrams/PUML files/Cashier/CashierClassDiagram.puml

@@ -0,0 +1,68 @@
+@startuml
+!include ../Style.puml
+
+class BestsellerCommand #LightGreen {
++ execute()
+}
+class TotalProfitCommand #LightGreen {
+command: CommandType
++ TotalProfitCommand(command)
++ execute()
+}
+class ListCommand #LightGreen {
+- transactionList: ArrayList<Transaction>
++ execute()
+}
+class SellCommand #LightGreen {
++execute()
+}
+
+class TextUi #Tan {
++replyToUser(text: String)
+}
+
+class Cashier #MistyRose {
+    - transactions: ArrayList<Transaction>
+    + addItem(transaction: Transaction): void
+    + getTransactions(): ArrayList<Transaction>
+    + getTransactions(item: Item): ArrayList<Transaction>
+    + getTransaction(index: int): Transaction
+    + getTotalRevenue(): float
+    + getTotalProfit(): float
+    + getBestseller(): Item
+}
+
+class Transaction #LightSkyBlue {
+    - dateTime: String
+    - totalPrice: float
+    - profit: float
+    - item: String
+    - quantity: int
+    - buyPrice: float
+    - sellPrice: float
+
+    + Transaction(String, int, float, float)
+    + Transaction(String, int, float, float, String)
+}
+
+class Item #LightBlue {
+    + isMark: boolean
+    + isOOS: boolean
+    - itemName: String
+    - quantity: int
+    - unitOfMeasurement: String
+    - category: String
+    - buyPrice: float
+    - sellPrice: float
+    +Item(String, int, String, String, float, float)
+}
+
+BestsellerCommand -d->"uses" Cashier
+TotalProfitCommand-d->"uses" Cashier
+SellCommand-d->"uses" Cashier
+ListCommand-d->"uses" Cashier
+Cashier -r->TextUi
+Cashier --> Transaction : has 1..*
+Transaction --> Item : has 1
+
+@enduml

docs/Diagrams/PUML files/Cashier/CashierSequenceDiagram.puml

@@ -0,0 +1,50 @@
+@startuml
+!include ../Style.puml
+participant ":Command" as Command
+participant ":TextUi" as TextUi
+participant ":Cashier" as Cashier
+
+-> Command: execute()
+activate Command
+Command -> Cashier: addItem(transaction)
+activate Cashier
+Cashier -> Cashier: transactions.add(transaction)
+return
+Command -> TextUi: showSellMessage()
+activate TextUi
+return
+alt if itemName is not given
+Command -> Cashier: getAllTransactions()
+activate Cashier
+return transactions
+Command -> TextUi : showTransactionsList();
+activate TextUi
+return
+else if itemName is given
+Command -> Cashier: getTransactions(itemName)
+activate Cashier
+Cashier -> Cashier: Filter transactions
+return transactions
+Command -> TextUi: showTransactionsList()
+activate TextUi
+return
+end
+
+Command -> Cashier: getTransaction(index)
+activate Cashier
+Cashier -> Cashier: transactions.get(index)
+return transaction
+Command -> TextUi: showTransactionsList()
+activate TextUi
+return
+
+alt Revenue
+    ref over Command, Cashier: getTotalRevenue
+else Profit
+    ref over Command, Cashier: getTotalProfit
+end
+
+ref over Command, Cashier: getBestseller
+
+return
+@enduml

docs/Diagrams/PUML files/Cashier/TotalProfitCommand_SequenceDiagram.puml

@@ -0,0 +1,26 @@
+@startuml
+!include ../Style.puml
+
+participant ":TotalProfitCommand" as TotalProfitCommand
+participant ":Cashier" as Cashier
+participant ":TextUi" as TextUi
+
+
+mainframe sd
+alt get total revenue
+    TotalProfitCommand -> Cashier: getTotalRevenue()
+    activate Cashier
+    Cashier -> Cashier: Calculate total revenue
+    Cashier --> TotalProfitCommand: totalRevenue
+    deactivate Cashier
+    TotalProfitCommand -> TextUi: replyToUser("You have earned {totalRevenue} in revenue so far.")
+else get total profit
+    TotalProfitCommand -> Cashier: getTotalProfit()
+    activate Cashier
+    Cashier -> Cashier: Calculate total profit
+    Cashier --> TotalProfitCommand: totalProfit
+    deactivate Cashier
+    TotalProfitCommand -> TextUi: replyToUser("You have earned {totalProfit} in profits so far.")
+end
+
+@enduml

docs/Diagrams/PUML files/Itemlist/AddCommand_SequenceDiagram.puml

@@ -0,0 +1,32 @@
+@startuml
+!include ../Style.puml
+
+actor User
+participant ":Parser" as Parser
+participant ":AddCommand" as AddCommand
+participant ":Itemlist" as Itemlist
+participant ":EditCommand" as EditCommand
+
+User -> Parser: add command
+activate Parser
+
+Parser -> AddCommand: prepareAdd(userInput)
+activate AddCommand
+activate Itemlist
+alt Item exists
+    AddCommand -> EditCommand: edit Item
+    activate EditCommand
+    EditCommand -> Itemlist: editQuantity(index, newQuantity)
+    deactivate EditCommand
+    Itemlist --> AddCommand
+    AddCommand -> User: Output success message
+else Item does not exist
+    AddCommand -> Itemlist: addItem(item)
+    Itemlist --> AddCommand
+
+AddCommand -> User: Output success message
+deactivate AddCommand
+end
+deactivate Itemlist
+deactivate Parser
+@enduml

docs/Diagrams/PUML files/Itemlist/EditCommand_ClassDiagram.puml

@@ -0,0 +1,55 @@
+@startuml
+!include ../Style.puml
+class EditCommand {
+    - itemName : String
+    - newItemName : String
+    - newQuantity : int
+    - newUnitOfMeasurement : String
+    - newCategory : String
+    - newBuyPrice : float
+    - newSellPrice : float
+    + EditCommand(...)
+    + execute() : void
+}
+
+class Item {
+    - itemName : String
+    - quantity : int
+    - unitOfMeasurement : String
+    - category : String
+    - buyPrice : float
+    - sellPrice : float
+}
+
+class Itemlist {
+    + getItems() : List<Item>
+    + getItem(index: int) : Item'
+}
+
+class Promotion {
+    - itemName : String
+    + setItemName(newItemName: String) : void
+}
+
+class Promotionlist {
+    + itemIsOnPromo(itemName: String) : boolean
+    + getPromotion(itemName: String) : Promotion
+    + getAllPromotion() : List<Promotion>
+}
+
+class Storage {
+    + overwriteFile(items: List<Item>) : void
+}
+
+class PromotionStorage {
+    + overwritePromotionFile(promotions: List<Promotion>) : void
+}
+
+EditCommand -> Item
+EditCommand --> Itemlist
+EditCommand --> Promotion : uses >
+EditCommand --> Promotionlist
+Storage <-- EditCommand
+PromotionStorage <-- EditCommand
+
+@enduml