[CS2113-T15-4] 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

StockMasterData.txt

@@ -0,0 +1,2 @@
+1. | testItem | Qty: 1 EA | Cat: null | BuyPrice: $1.0 | SellPrice: $10.0
+2. | testItem | Qty: 1 EA | Cat: null | BuyPrice: $1.0 | SellPrice: $10.0

TransactionLogs.txt

@@ -0,0 +1,8 @@
+Date: 2024-04-01 21:32:44
+Transaction ID: 1
+Item Name: apple
+Quantity: 5
+Unit Price: 3.0
+Total Price: 15.0
+Profit: -5.0
+

build.gradle

@@ -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/DeveloperGuide.md

@@ -7,31 +7,67 @@
 ## Design & implementation
 
 {Describe the design and implementation of the product. Use UML diagrams and short code snippets where applicable.}
+### Exception
+### Itemlist
+Itemlist class is an object which contains items to be added to the stock inventory list. Able to add items, remove functions, edit items inside
+the list.
+### Item
+Item class is an object which represents an item in the stock inventory list. Stores data about the item such as item price, 
+quantity of item, and others.
+### Parser
+Parser class processes user inputs and sieves out relevant details before calling the relevant methods.
+It contains command formats that must be adhered to for the methods to be called.
+### Storage
+Storage class contains methods to write description of items to the file `./StockMasterData.txt`, 
+and retrieve information from the file when program restarts.
+### UI
 
 
 ## Product scope
+StockMaster allows users to use the following commands:
+* add: add an item, quantity, category, buy price and sell price
+* del: delete an item
+* edit: edit the quantity of an item
+* sell: sell a certain quantity of an item at a stated price
+* find: find a specific item using a keyword
+* list: list all items in the inventory
+* help: list all commands
+* exit: exit StockMaster
+
 ### Target user profile
 
-{Describe the target user profile}
+Small Business Owners who:
+* has a need to manage a significant number of inventory products
+* able to track revenue/loss of the business
+* prefer desktop apps over other types
+* can type fast
+* prefers typing to mouse interactions
+* is reasonably comfortable using CLI apps
 
 ### Value proposition
 
-{Describe the value proposition: what problem does it solve?}
+Help small business owners organise and better manage their inventory faster than 
+a typical mouse/GUI driven app
+
 
 ## User Stories
 
-|Version| As a ... | I want to ... | So that I can ...|
-|--------|----------|---------------|------------------|
-|v1.0|new user|see usage instructions|refer to them when I forget how to use the application|
-|v2.0|user|find a to-do item by name|locate a to-do without having to go through the entire list|
+|Version| As a ... | I want to ...               | So that I can ...                                          |
+|--------|----------|-----------------------------|------------------------------------------------------------|
+|v1.0|new user| see usage instructions      | refer to them when I forget how to use the application     |
+|v1.0|user| add new items               |                                                            |
+|v1.0|user| make changes to added items | change details about items such as quantity or price       |
+|v1.0|user| search for specific items   ||
+|v2.0|user| find a to-do item by name   | locate a to-do without having to go through the entire list |
 
 ## Non-Functional Requirements
 
 {Give non-functional requirements}
 
 ## Glossary
 
-* *glossary item* - Definition
+* *CLI* - Command Line Interface, where the user types commands rather than clicking options.
+* *Item* - Item to be sold at the shop, with key information such as quantity, buying/selling price, description etc.
 
 ## Instructions for manual testing
 

docs/README.md

@@ -1,6 +1,6 @@
-# Duke
+# Stock Master
 
-{Give product intro here}
+StockMaster helps small business owners manage inventory of their business. It is optimized for CLI users so that frequent tasks can be done faster by typing  in commands.
 
 Useful links:
 * [User Guide](UserGuide.md)

docs/UserGuide.md

@@ -2,41 +2,143 @@
 
 ## Introduction
 
-{Give a product intro}
+StockMaster is a platform aimed at helping SMEs track and organise their inventory.
 
 ## Quick Start
 
 {Give steps to get started quickly}
 
 1. Ensure that you have Java 11 or above installed.
-1. Down the latest version of `Duke` from [here](http://link.to/duke).
+2. Download the latest version of `StockMaster` from [here](http://link.to/duke).
+3. 
 
 ## Features 
 
 {Give detailed description of each feature}
 
-### Adding a todo: `todo`
-Adds a new item to the list of todo items.
+### Adding an item: `add`
+Adds a new item to the list of items.
 
-Format: `todo n/TODO_NAME d/DEADLINE`
+Format: `add ITEM_NAME qty/ITEM_QUANTITY /UNIT_OF_MEASUREMENT [cat/CATEGORY] buy/[BUY_PRICE] sell/[SELL_PRICE]`
 
-* The `DEADLINE` can be in a natural language format.
-* The `TODO_NAME` cannot contain punctuation.  
+* `CATEGORY` is an optional field. If blank, it will default to `N/A`.
+
+> [ !NOTE ]
+> 
+> Addition of an item with the same `ITEM_NAME` will edit the `ITEM_QUANTITY` instead
 
 Example of usage: 
+```
+add Apple qty/50 /pieces cat/fruits buy/4 sell/5
+add Phone qty/5 /pieces cat/Electronics buy/100 sell/500
+```
+
+### Deleting an item: `del`
+Deletes the item from the list of items.
+
+Format: `del ITEM_NAME`
+
+Example of usage:
+```
+del Apples
+```
+
+### Selling an item: `sell`
+Sells a quantity of an item from the list of items at a stated price.
+
+Format: `sell [ITEM_NAME] qty/[SELL_QUANTITY] price/[SELL_PRICE]`
+
+* `SELL_PRICE` is an optional field. If blank, it will default to the item's set sell price.
+
+Example of usage:
+```
+sell Apple qty/20 price/6
+sell Phone qty/1
+```
+
+### Editing an item: `edit`
+Edits the parameters of the item.
+
+Format: `edit [ITEM_NAME] name/[NEW_NAME] qty/[NEW_QUANTITY] uom/[NEW_UOM] cat/[NEW_CATEGORY] buy/[NEW_BUY_PRICE] sell/[NEW_SELL_PRICE]`<br/>`
+
+Example of usage:
+```
+`edit apple name/green apple qty/10 uom/pieces cat/fruit buy/1.00 sell/2.00`
+`edit fish name/Salmon qty/1 uom/pieces cat/fish device buy/1.00 sell/10.00`
+```
+User can choose to edit at least 1 parameter up to all available parameters.
+
+Example of usage:
+```
+edit apple buy/1.00 sell/2.00
+edit fish name/Salmon qty/1 cat/fish
+```
+
+### Finding an item: `find`
+Finds all items that contains `KEYWORD` 
 
-`todo n/Write the rest of the User Guide d/next week`
+Format: `find [/filter1/filter2] KEYWORD`
 
-`todo n/Refactor the User Guide to remove passive voice d/13/04/2020`
+* Filter will specify the parameters that is being searched.
+* If no filter is applied, it will search all items that contains `KEYWORD.
+* The search is case-insensitive e.g. `apple` will match `Apple`.
+* Partial words will be matched e.g. `app` will match `Apple`.
+
+Example of usage:
+```
+find /qty/cat Apple //search for `Apple` under `ITEM_QUANTITY` and `CATEGORY`
+find Apple //search all items that contains `Apple`
+```
+
+### Listing all items: `list`
+Lists all stored items.
+
+Format: `list [cat/CATEGORY]`
+
+* `CATEGORY` is an optional field. By default, it will list all the stored items.
+
+Example of usage:
+```
+list
+list Electronics
+```
+
+### List all available commands: `help`
+Lists all commands as per the command summary below.
+
+Format: `help [c/COMMAND]`
+
+* `COMMAND` is optional. Specifying the command will give a more comprehensive
+  description of the command.
+
+Example of usage:
+```
+help
+help c/add
+```
+
+
+### Closing the app: `exit`
+Saves and closes the app safely.
+
+Format: `exit`
 
 ## FAQ
 
 **Q**: How do I transfer my data to another computer? 
 
-**A**: {your answer here}
+**A**: Simply copy and paste the saved folder that is created upon launch of 
+the application.
 
 ## Command Summary
 
-{Give a 'cheat sheet' of commands here}
-
-* Add todo `todo n/TODO_NAME d/DEADLINE`
+| Action      | Format, Examples                                                                                                                                                                                                        |
+|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Add Item    | `add ITEM_NAME qty/ITEM_QUANTITY /UNIT_OF_MEASUREMENT [cat/CATEGORY] buy/[BUY_PRICE] sell/[SELL_PRICE]`<br/> `e.g. add apple qty/50 /pieces cat/fruits buy/4.50 sell/5`                                                 |
+| Delete Item | `del ITEM_NAME`<br/> `e.g. del Apple`                                                                                                                                                                                   |
+| Edit Item   | `edit [ITEM_NAME] name/[NEW_NAME] qty/[NEW_QUANTITY] uom/[NEW_UOM] cat/[NEW_CATEGORY] buy/[NEW_BUY_PRICE] sell/[NEW_SELL_PRICE]`<br/>`e.g. edit apple name/green apple qty/10 uom/pieces cat/fruit buy/1.00 sell/2.00`  |
+| Find Item   | `find KEYWORD`<br/> `e.g. find University`                                                                                                                                                                              |
+| Sell Item   | `sell [ITEM_NAME] qty/[SELL_QUANTITY] price/[SELL_PRICE]`<br/> `e.g. sell apple qty/50 price/4.50`                                                                                                                      |
+| List        | `list`                                                                                                                                                                                                                  |
+| Help        | `help`                                                                                                                                                                                                                  |
+| Exit        | `exit`                                                                                                                                                                                                                  |

src/main/java/command/AddCommand.java

@@ -0,0 +1,80 @@
+package command;
+
+import item.Item;
+import itemlist.Itemlist;
+import storage.Storage;
+
+public class AddCommand extends Command {
+
+    public static final String MESSAGE_SUCCESS = "added: ";
+    protected String itemName;
+    protected int quantity;
+    protected String unitOfMeasurement;
+    protected String category;
+    protected float buyPrice;
+    protected float sellPrice;
+    private final Item toAdd;
+
+    public AddCommand(String itemName, int quantity, String unitOfMeasurement, String category, float buyPrice,
+            float sellPrice) {
+        this.itemName = itemName;
+        this.quantity = quantity;
+        this.unitOfMeasurement = unitOfMeasurement;
+        this.category = category;
+        this.buyPrice = buyPrice;
+        this.sellPrice = sellPrice;
+        this.toAdd = new Item(itemName, quantity, unitOfMeasurement, category, buyPrice, sellPrice);
+    }
+
+    public String getItemName() {
+        return itemName;
+    }
+    public int getQuantity() {
+        return quantity;
+    }
+    public String getCategory() {
+        return category;
+    }
+    public String getUnitOfMeasurement() {
+        return unitOfMeasurement;
+    }
+    public float getBuyPrice() {
+        return buyPrice;
+    }
+    public float getSellPrice() {
+        return sellPrice;
+    }
+
+    @Override
+    public void execute() {
+        if (Itemlist.itemIsExist(itemName)) {
+            updateQuantity(itemName);
+        } else {
+            Itemlist.addItem(toAdd);
+            System.out.print(MESSAGE_SUCCESS + getItemName() + " (Qty: " + getQuantity() + " " + getUnitOfMeasurement()
+                    + ", Buy: $" + getBuyPrice() + ", Sell: $" + getSellPrice() + ")");
+            Storage.addToFile(Itemlist.getItems());
+            if (!category.equals("NA")) {
+                System.out.println(" to " + getCategory());
+            } else {
+                System.out.println();
+                assert category.equals("NA");
+            }
+        }
+    }
+
+    public void updateQuantity(String itemName) {
+        System.out.println("Item already exists and quantity has been changed");
+        int indexOfItem = -1;
+        for (Item item : Itemlist.getItems()) {
+            if (item.getItemName().toLowerCase().equals(itemName)) {
+                indexOfItem = Itemlist.getIndex(item);
+            }
+        }
+        assert indexOfItem != -1;
+        int currentQty = Itemlist.getItem(indexOfItem).getQuantity();
+        int newQty = getQuantity() + currentQty;
+        new EditCommand(getItemName(), "NA", newQty, "NA", "NA", -1,
+                -1).execute();
+    }
+}

src/main/java/command/Command.java

@@ -0,0 +1,8 @@
+package command;
+
+import exceptions.CommandFormatException;
+
+public abstract class Command  {
+
+    public abstract void execute() throws CommandFormatException;
+}