[CS2113-T17-3] Stocker by TeoHaoZhi · Pull Request #15 · nus-cs2113-AY2324S1/tp

TeoHaoZhi · 2023-10-05T08:31:00Z

Stocker is a desktop app that will provide quick access to currently available stock, track incoming stock and expiration dates, and categorize drugs based on different labels. It is optimized for use via a Command Line Interface (CLI). If you can type fast, Stocker can get your inventory management tasks done faster than traditional GUI apps.

Add JUnit Test

YongbinWang

Overall a very good job. There is no major code quality issues that I can spot, code looks well abstracted and structured. Do take note of making sure your naming conventions are clear and similar throughout the project.

Do let me know if you need clarifications or disagree with my comments.

YongbinWang · 2023-10-29T03:54:17Z

+        users = new HashMap<>();
+        loginStatus = false;
+        this.in = new Scanner(System.in);
+        interactor = new Ui();


Consider using a more straightforward name for your Ui object.

YongbinWang · 2023-10-29T03:55:32Z

+                if (choice.equals("register")) {
+                    return "register";
+                } else if (choice.equals("login")) {
+                    return "login";


You can consider making your checks not case sensitive if the users types "Register" or "Login", up to your team's discretion.

YongbinWang · 2023-10-29T03:59:52Z

+        interactor.showPasswordMessage();
+        String password = in.nextLine();
+
+        while (password.equals("")) {


You can consider creating a constant value for empty string.
static final String EMPTY_STRING = "";

YongbinWang · 2023-10-29T04:04:14Z

+        while ((line = reader.readLine()) != null) {
+            String[] parts = line.split(":", 2);
+            if (parts.length >= 2) {


Avoid use of magic literals such as ":".

YongbinWang · 2023-10-29T04:21:31Z

+     * @throws IOException if file is not found
+     */
+    public void loadFileContents(String filePath) throws IOException, InvalidDrugFormatException {
+        File holder = new File("./drugs.txt");


Consider avoiding magic literals here.

YongbinWang · 2023-10-29T04:37:36Z

+            return new CommandResult<>(String.format(MESSAGE_INVALID_COMMAND_FORMAT, MESSAGE_USAGE));
+        }
+
+        List<StockEntry> entries = inventory.getStockEntries();


Maybe allEntries would be a better name.

YongbinWang · 2023-10-29T04:38:38Z

+    /**
+     * Usage message for the 'find' command.
+     */
+    public static final String MESSAGE_USAGE = COMMAND_WORD + " /n" + ": Finds drug in inventory using name." +


Unusually long constant. You can consider abstracting out some parts into smaller constants then combining them again,

YongbinWang · 2023-10-29T04:40:17Z

+public class Drug {
+
+    public String name;
+    String expiryDate;


Is there supposed to be an access modifier here?

YongbinWang · 2023-10-29T04:40:45Z

+    public String toString() {
+        return "Name: " + name + ", Expiry Date: " + expiryDate;


Consider avoiding magic literals here.

YongbinWang · 2023-10-29T04:43:26Z

+        assert inventory != null : "Inventory should be initialised before executing ListCommand.";
+        // Retrieve the list of drugs from the inventory
+        List<StockEntry> stockEntries = inventory.getStockEntries();


"stockEntries" variable name different from FindCommand class. There should be similar naming convention across the project.

Karishma vendor supply

added parser diagram

J0shuaLeong · 2023-11-01T04:14:54Z

+| \* \* \* | v1.0    | Receptionist         | View a list of products of that category             | Easily obtain an overview of the products                   |
+| \* \* \* | v1.0    | First-time user      | See a list of all available actions                  | Better understand how to use the application                |
+| \* \* \* | v1.0    | Inventory Manager    | Find a specific drug currently in the system         | Check up its details and quantities specifically            |
+| \* \* \* | v2.0    | user                 | Find a to-do item by name                            | Locate a to-do without having to go through the entire list |


Just a small consideration to organise based on v1.0 then v2.0 so it looks more organised

J0shuaLeong · 2023-11-01T04:17:56Z


-{list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the original source as well}
+1. Reference to AB-3 Developer Guide
+


Overall well done! Very organised and neat developer guide. The guide explains the application clearly with sufficient details and diagrams. I am sure more diagrams such as class diagrams would be added later on. Would also be good to add an embedded link to the java file for that specific component or command. For example, in the find command, can link the code file for quick access to the findcommand code.

J0shuaLeong · 2023-11-01T04:18:47Z

+- Parser : Makes sense of user input
+- Commands : List of various commands
+- CommandResult : Execution of various commands
+


Just a tip: Can try adding links to each component so the reader can quickly jump to that section instead of having to scroll through.

J0shuaLeong · 2023-11-01T04:23:58Z

+
+The Parser class is designed to handle these considerations through a well-structured parsing process. Here's how it
+works:
+


Would be clearer to reader if you bold "Splitting User Input", "Command Recognition" etc.

J0shuaLeong · 2023-11-01T04:24:32Z

+---
+
+### Parser Component
+


Might want to add a class diagram. Just a thought

Agreed here. Could use a diagram here

James-Hong-Jey

Overall well done DG. Diagrams are well placed and detailed.

James-Hong-Jey · 2023-11-01T04:11:09Z

+
+The following sequence diagram shows how the login system class works when the program is launched.
+
+<img src="UML Diagrams/StockerToLoginSystem.png" width="280">


Very comprehensive and clear sequence diagram

Should the image be sized larger instead?

The parser diagram look neat and correct

James-Hong-Jey · 2023-11-01T04:13:40Z

+## 5. Save Command
+
+The save command was made as a means to backup user entered drug data into the hard drive of the computer to ensure
+previously entered data is saved and accessable whenever the app is launched.


Would a diagram demonstrating the Saving mechanism be helpful?

James-Hong-Jey · 2023-11-01T04:17:41Z

+
+The following sequence diagram shows how the Find Command function works.
+
+<img src="UML Diagrams/FindCommandDiagram.png" width="350">


Are the activation bars meant to terminate at that point? Or is the diagram cut off / incomplete?

James-Hong-Jey · 2023-11-01T04:24:02Z

+management system.
+
+The following sequence diagram shows how the parser class works when the program is running.
+<img src="UML Diagrams/ParserDiagram.png" width="500">


Is the 2nd Incorrect Command activation meant to be there? If so, is it intended to be in an Opt box?

J0shuaLeong · 2023-11-01T04:26:58Z

+
+The following sequence diagram shows how the parser class works when the program is running.
+<img src="UML Diagrams/ParserDiagram.png" width="500">
+


I think the creating of incorrect command is wrong. There should be a constructor and should return from the IncorrectCommand class instead of a self invocation.

J0shuaLeong · 2023-11-01T04:32:28Z

+---
+
+## 3. Delete Command
+


can consider adding sequence diagram for this command and the following commands as well except help and save. But i am guessing it is suppose to be done just haven't done it

J0shuaLeong · 2023-11-01T04:35:08Z

+The architecture diagram given above explains the high level design of the application. The diagram depicts the key
+component of the application that enables it to provide its functionalities.
+
+Majority of the app's work is done by the following components


I think storage should be one of the components as well. Can add a sequence and class diagram for storage component.

update UG

Update UG

Add Command Result in Developer Guide

Update FindCommand Junit Test for serial number

Modify delete DG

onx001 · 2023-11-02T09:19:02Z

+
+The following sequence diagram shows how the login system class works when the program is launched.
+
+<img src="UML Diagrams/StockerToLoginSystem.png" width="280">


Should the image be sized larger instead?

onx001 · 2023-11-02T09:28:43Z

+The following sequence diagram shows how the Find Command function works.
+
+<img src="UML Diagrams/ListCommandDiagram.png" width="350">
+


Does the ListCommand persist after displaying results?

onx001 · 2023-11-02T09:30:13Z

+
+The following sequence diagram shows how the Command Result function works.
+
+<img src="UML Diagrams/CommandResultDiagram.png" width="350">


Do the command results and commands persist after calling?

onx001 · 2023-11-02T09:32:13Z

+   and criterion as input.
+
+3. **Search Process:** The method processes the search by iterating through the list of `StockEntry` objects in the
+   inventory.


Simple search algorithm that minimises errors and allows for better scoping. Very apt and functional!

Karishma developer guide

Fix PPP

updated PPP

Update PPP

Update ppp

…master Update

Update PPP, UML diagrams, UG and DG

Update PPP

Update User Guide

Changedstuff

fix ppp link

ppp

parser diagram

Update PPP

Brian030601 added a commit to Brian030601/tp that referenced this pull request Oct 18, 2023

Merge pull request nus-cs2113-AY2324S1#15 from Brian030601/master

0de5270

Add JUnit Test

YongbinWang reviewed Oct 29, 2023

View reviewed changes

TeoHaoZhi and others added 3 commits October 31, 2023 20:34

Merge pull request #127 from karishma-t/karishma-VendorSupply

57ee8fc

Karishma vendor supply

added parser diagram

daf87ec

Merge pull request #128 from Barbaracwx/DG-parser

72f9902

added parser diagram

J0shuaLeong reviewed Nov 1, 2023

View reviewed changes

James-Hong-Jey reviewed Nov 1, 2023

View reviewed changes

J0shuaLeong reviewed Nov 1, 2023

View reviewed changes

update UG

d84e998

J0shuaLeong reviewed Nov 1, 2023

View reviewed changes

Barbaracwx and others added 14 commits November 1, 2023 15:25

update UG

5a4a03d

Merge pull request #129 from Barbaracwx/branch-updateUG

407d2dd

update UG

Update UG

806511b

Merge pull request #130 from karishma-t/karishma-updateUG

dd17f9b

Update UG

Add Command Result in Developer Guide

975a03f

Merge pull request #131 from azfarulmatin/AzfarulMatin-CalculatePrice

6c56dc7

Add Command Result in Developer Guide

Update Junit Test for find command using serial number

f342fa4

Update ListCommand Junit Test

2354792

Merge pull request #132 from azfarulmatin/AzfarulMatin-CalculatePrice

13d04c0

Update FindCommand Junit Test for serial number

Modify delete DG

2b8fc42

Add addVendorSupply dg

e1c9c8a

Merge pull request #133 from karishma-t/karishma-Developer-Guide

f73462e

Modify delete DG

Remove all throwing methods in the main class

425255d

Try to resolve various warning

4867382

onx001 reviewed Nov 2, 2023

View reviewed changes

TeoHaoZhi and others added 10 commits November 13, 2023 22:40

Merge pull request #288 from karishma-t/karishma-Developer-Guide

43f8027

Karishma developer guide

updated PPP

661ffa6

Merge pull request #289 from TeoHaoZhi/PPPUpdates

526fbcc

Fix PPP

Merge pull request #290 from Barbaracwx/changedstuff

7cb107f

updated PPP

Update PPP

425b700

Merge pull request #291 from TeoHaoZhi/PPPUpdates

f9b5fbc

Update PPP

Update PPP

acd83aa

Merge pull request #292 from TeoHaoZhi/PPPUpdates

27df923

Update PPP

Update ppp

c80efd1

Merge pull request #293 from karishma-t/karishma-Developer-Guide

83621e4

Update ppp

Brian030601 pushed a commit to Brian030601/tp that referenced this pull request Nov 13, 2023

Merge pull request nus-cs2113-AY2324S1#15 from AY2324S1-CS2113-F11-3/…

5c38987

…master Update

azfarulmatin and others added 19 commits November 14, 2023 01:08

Update PPP, UML diagrams, UG and DG

88d04ba

Merge pull request #295 from azfarulmatin/master

aa88c22

Update PPP, UML diagrams, UG and DG

Update PPP

f88a613

Merge pull request #296 from azfarulmatin/master

868fef8

Update PPP

Update User Guide

10440fe

Merge pull request #297 from azfarulmatin/master

cfb9e0c

Update User Guide

changed parser diagram

e5bdfe1

changed parser diagram

feb2bf5

fix ppp link

1afa454

Merge pull request #298 from Barbaracwx/changedstuff

39e38e3

Changedstuff

Merge pull request #299 from karishma-t/karishma-updateUG

6ca21e1

fix ppp link

spacing for ppp

5be8b0e

modify spacing for ppp

442d4db

parser diagram

128a97e

edited ppp

c3ba10d

Merge pull request #301 from karishma-t/karishma-updateUG

68fcf8b

ppp

Merge pull request #300 from Barbaracwx/master

86116f6

parser diagram

Update PPP

ab087ee

Merge pull request #302 from azfarulmatin/master

d804ad8

Update PPP

		public String toString() {
		return "Name: " + name + ", Expiry Date: " + expiryDate;


		{list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the original source as well}
		1. Reference to AB-3 Developer Guide


		The Parser class is designed to handle these considerations through a well-structured parsing process. Here's how it
		works:


		The following sequence diagram shows how the login system class works when the program is launched.

		<img src="UML Diagrams/StockerToLoginSystem.png" width="280">


		The following sequence diagram shows how the Find Command function works.

		<img src="UML Diagrams/FindCommandDiagram.png" width="350">


		The following sequence diagram shows how the parser class works when the program is running.
		<img src="UML Diagrams/ParserDiagram.png" width="500">

		The following sequence diagram shows how the Find Command function works.

		<img src="UML Diagrams/ListCommandDiagram.png" width="350">


		The following sequence diagram shows how the Command Result function works.

		<img src="UML Diagrams/CommandResultDiagram.png" width="350">

		---

		### Parser Component

Uh oh!

Conversation

TeoHaoZhi commented Oct 5, 2023

Uh oh!

YongbinWang left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

J0shuaLeong Nov 1, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

James-Hong-Jey left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

J0shuaLeong Nov 1, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

YongbinWang left a comment •

edited

Loading

J0shuaLeong Nov 1, 2023 •

edited

Loading

J0shuaLeong Nov 1, 2023 •

edited

Loading