[CS2113-W12-3] MagusStock #39

ngkaiwen123 · 2023-03-02T13:22:40Z

MagusStock is an inventory management system (IMS) that makes use of the command line interface for businesses to manage their stock inventory.

Added a view-account case

tsx0314

Overall good job! Everything is clear and detailed! However, many explanations are used in the picture, sometimes it is hard to read

tsx0314 · 2023-03-29T05:26:44Z

docs/UML/Category/CategoryParser.puml

The diagram is a bit hard to read. Perhaps you can omit some of the details

tsx0314 · 2023-03-29T05:32:59Z

docs/UML/History/HistoryStep1.png

The square may be removed it should be "+" and "-"

tsx0314 · 2023-03-29T05:33:27Z

docs/UML/List/ListCommand.png

Great! it is clear and easy to read!

tsx0314 · 2023-03-29T06:01:45Z

docs/UML/Alert/AlertStep1.puml

need to replace the square with -

douph810975

In general, the diagrams are clear and comprehensive.

douph810975 · 2023-03-29T07:18:17Z

docs/SequenceDiagram.png

A clear diagram here! I have a small question, why after the user calls the run function in MagusStock the MagusStock still call the run function to itself?

douph810975 · 2023-03-29T07:20:53Z

docs/ArchitectureDiagram.png

This architecture diagram is clear and easy to understand!

douph810975 · 2023-03-29T07:23:03Z

docs/UML/Sell/SellCommand.png

The picture is unable to display here. Are there any bugs here?

douph810975 · 2023-03-29T07:27:25Z

docs/UML/Restock/RestockCommand.png

A meticulous diagram! I have a small problem, why after the updateItemQuality funciton, a new activation bar is created?

chungnicholas

The Developer Guide is well done and formatting is neat. Good job!

chungnicholas · 2023-03-30T01:08:30Z

docs/DeveloperGuide.md


 ## Acknowledgements

-{list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the original source as well}
+The documentation and organisation of our project follows the recommended format as shown in [SE-Education](http://se-education.org/addressbook-level3/DeveloperGuide.html)


Consider having a full stop at the end of the sentence

chungnicholas · 2023-03-30T01:09:08Z

docs/DeveloperGuide.md


-{Describe the design and implementation of the product. Use UML diagrams and short code snippets where applicable.}
+### 1.1. Architecture Design Diagram
+![Architecture Diagram](ArchitectureDiagram.png)


Nice architecture design diagram

chungnicholas · 2023-03-30T01:12:15Z

docs/DeveloperGuide.md

+### 2.1. List
+The list command is mainly handled by the `ListCommand` class, which extends the `Command` class.
+
+![ListCommand.png](UML%2FList%2FListCommand.png)
+
+
+**Step 1**. When the user executes the command `list`, the `ParserHandler` will create a new `ListParser` object and pass to it the `Inventory` where the items to be listed are stored.
+
+![ListStep1.png](UML%2FList%2FListStep1.png)
+
+**Step 2**. The `run` method in `ListParser` overrides the `run` method in `Parser` to create a new `ListCommand` object, passing to it the relevant `Inventory`.
+
+![ListStep2.png](UML%2FList%2FListStep2.png)
+
+**Step 3**. The `run` method in `ListCommand` overrides the `run` method in `Command` and calls the `listItems` method. The `listItems` method checks if the inventory is empty. If the inventory is empty, the method prints a message to inform the user that there are no items in the inventory. Otherwise, the `printTable` method from the `Ui` object is called.
+
+![ListStep3.png](UML%2FList%2FListStep3.png)
+
+**Step 4.**. If the `printTable` method is called, it takes in an `ArrayList<Item> items` aas a parameter and prints out a table showing the name, UPC, quantity and price of all items in the inventory.
+


Step by step guide is very clear and accompanied by diagrams for better visualization. Very nice!

chungnicholas · 2023-03-30T01:15:23Z

docs/DeveloperGuide.md

+## Contents
+- [Acknowledgements](#acknowledgements)
+- [Design & Implementation](#design--implementation)
+- [Implementation](#implementation)
+  - [List](#list)
+  - [Add](#add)
+  - [Edit](#edit)
+  - [Remove](#remove)
+  - [Search](#search)
+  - [Filter](#filter)
+  - [Alert](#alert)
+  - [History](#history)
+  - [Category](#category)
+- [Product Scope](#product-scope)
+  - [Target User Profile](#target-user-profile)
+  - [Value Proposition](#value-proposition)
+- [User Stories](#user-stories)
+- [Non-Functional Requirements](#non-functional-requirements)
+- [Glossary](#glossary)
+- [Instructions for Manual Testing](#instructions-for-manual-testing)



Neat table of content. Maybe could consider adding numbering here as well, corresponding to those used in the headers so the reader can navigate easier when scrolling.

For example, this could be 2.3. Edit

corresponding to this

lil1n

Sequence diagrams are very detailed, but there are some areas that can be improved, great effort overall

lil1n · 2023-03-30T01:10:10Z

docs/DeveloperGuide.md

+specific pattern. If the input doesn't match the pattern, it prints an error message and returns. If the input matches 
+the pattern, it creates a new `Item` object using the parsed parameters and creates a new `AddCommand` object using the 
+`Inventory` object and `Item` object. It then calls the `run()` method of the `AddCommand` object to execute the add command.
+![AddParser.png](UML%2FAdd%2FAddParser.png)


I think that there is an additional return arrow between AddParser and AddCommand?

lil1n · 2023-03-30T01:11:18Z

docs/DeveloperGuide.md

+specific pattern. If the input doesn't match the pattern, it prints an error message and returns. If the input matches 
+the pattern, it creates a new `Item` object using the parsed parameters and creates a new `AddCommand` object using the 
+`Inventory` object and `Item` object. It then calls the `run()` method of the `AddCommand` object to execute the add command.
+![AddParser.png](UML%2FAdd%2FAddParser.png)


not sure if it is intended, but activation bar for AddParser seems to not be deactivated

lil1n · 2023-03-30T01:13:26Z

docs/DeveloperGuide.md

+If the `SessionManager`'s `autoSave` flag is enabled, it writes the current inventory to a file using the `SessionManager`.
+
+The `run()` method of the `AddCommand` class calls the `addItem()` method to execute the add command.
+![AddCommand.png](UML%2FAdd%2FAddCommand.png)


not sure if it is intended, but I think that there is a missing activaction bar when AddCommand calls addItems() and also missing return arrow from addItem()?

lil1n · 2023-03-30T01:14:15Z

docs/DeveloperGuide.md

+If the `SessionManager`'s `autoSave` flag is enabled, it writes the current inventory to a file using the `SessionManager`.
+
+The `run()` method of the `AddCommand` class calls the `addItem()` method to execute the add command.
+![AddCommand.png](UML%2FAdd%2FAddCommand.png)


not sure if it is intended, but activation bar for AddCommand seems to not be deactivated

lil1n · 2023-03-30T01:16:40Z

docs/DeveloperGuide.md

+If the `SessionManager`'s `autoSave` flag is enabled, it writes the current inventory to a file using the `SessionManager`.
+
+The `run()` method of the `AddCommand` class calls the `addItem()` method to execute the add command.
+![AddCommand.png](UML%2FAdd%2FAddCommand.png)


not sure if add(itemName, item), writeSession(inventory), writeCSV(inventory) is correct, but I think that method calls should be methodName(parameterName : parameterType)?

lil1n · 2023-03-30T01:24:19Z

docs/DeveloperGuide.md

+
+Included below is a sequence diagram for the `RestockParser` and `RestockCommand` respectively:
+
+![RestockParser.png](UML/Restock/RestockParser.png)


not sure if it is intended, but diagram for :RestockParser, :RestockCommand, :SellParser and :SellCommand seems to be inconsistent with the rest of the diagrams as other diagrams do not have a : before the XYZParser and XYZCommand

lil1n · 2023-03-30T01:26:19Z

docs/DeveloperGuide.md

+Included below is a sequence diagram for the `SellParser` and the `SellCommand` respectively:
+
+![SellParser.png](UML/Sell/SellParser.png)
+![SellCommand.png](UML/Sell/SellCommand.png)


there seems to be a lot of self calls, maybe can abstract out?

chungnicholas · 2023-03-30T01:43:43Z

docs/DeveloperGuide.md

+
+### 1.2. UML Sequence Diagram
+
+![Sequence Diagram](SequenceDiagram.png)


Classes have a missing : at the start. For example, :MagusStock.

Activation bar for MagusStock is also missing a closing line.

chungnicholas · 2023-03-30T01:44:56Z

docs/DeveloperGuide.md

+### 2.1. List
+The list command is mainly handled by the `ListCommand` class, which extends the `Command` class.
+
+![ListCommand.png](UML%2FList%2FListCommand.png)


The alt frame is missing an else path.

chungnicholas · 2023-03-30T01:45:58Z

docs/DeveloperGuide.md

+### 2.1. List
+The list command is mainly handled by the `ListCommand` class, which extends the `Command` class.
+
+![ListCommand.png](UML%2FList%2FListCommand.png)


Missing separate sequence diagram to show details of ref frames.

chungnicholas · 2023-03-30T01:47:13Z

docs/DeveloperGuide.md

+**Step 1**. When the user executes the command `list`, the `ParserHandler` will create a new `ListParser` object and pass to it the `Inventory` where the items to be listed are stored.
+
+![ListStep1.png](UML%2FList%2FListStep1.png)
+
+**Step 2**. The `run` method in `ListParser` overrides the `run` method in `Parser` to create a new `ListCommand` object, passing to it the relevant `Inventory`.
+
+![ListStep2.png](UML%2FList%2FListStep2.png)
+
+**Step 3**. The `run` method in `ListCommand` overrides the `run` method in `Command` and calls the `listItems` method. The `listItems` method checks if the inventory is empty. If the inventory is empty, the method prints a message to inform the user that there are no items in the inventory. Otherwise, the `printTable` method from the `Ui` object is called.
+
+![ListStep3.png](UML%2FList%2FListStep3.png)
+
+**Step 4.**. If the `printTable` method is called, it takes in an `ArrayList<Item> items` aas a parameter and prints out a table showing the name, UPC, quantity and price of all items in the inventory.
+


Use of non-standard visibility notation.

HiIAmTzeKean

Overall it is a great DG!

HiIAmTzeKean · 2023-03-31T02:17:35Z

docs/DeveloperGuide.md


-{Describe the design and implementation of the product. Use UML diagrams and short code snippets where applicable.}
+### 1.1. Architecture Design Diagram
+![Architecture Diagram](ArchitectureDiagram.png)


Clear architecture design

HiIAmTzeKean · 2023-03-31T02:33:45Z

docs/DeveloperGuide.md

+- [Acknowledgements](#acknowledgements)
+- [Design & Implementation](#design--implementation)
+- [Implementation](#implementation)
+  - [List](#list)
+  - [Add](#add)
+  - [Edit](#edit)
+  - [Remove](#remove)
+  - [Search](#search)
+  - [Filter](#filter)
+  - [Alert](#alert)
+  - [History](#history)
+  - [Category](#category)
+- [Product Scope](#product-scope)
+  - [Target User Profile](#target-user-profile)
+  - [Value Proposition](#value-proposition)
+- [User Stories](#user-stories)
+- [Non-Functional Requirements](#non-functional-requirements)
+- [Glossary](#glossary)
+- [Instructions for Manual Testing](#instructions-for-manual-testing)



Clean and consise.

HiIAmTzeKean · 2023-03-31T02:36:17Z

docs/DeveloperGuide.md

+`MagusStock`: This is the entry point for the application, and it's responsible for starting the application and coordinating the interactions between the other components.
+
+`ParserHandler`: This component is responsible for handling user input and determining which parser to execute based on the input. It uses a Parser to parse the input and generate a corresponding Command object.
+
+`Parser`: This component is responsible for parsing the user input and generating a Command object. The ParserHandler uses the Parser to parse the input and determine which Command object to create.
+
+`SessionManager`: This component is responsible for managing the inventory data persistence. It's connected to the Storage component, which reads and writes inventory data to and from a CSV file.
+
+`Storage`: This component is responsible for reading and writing inventory data to a CSV file. It's connected to the SessionManager, which uses it to manage the inventory data persistence.
+
+`Ui`: This component is responsible for displaying information to the user. It receives messages and data from the other components and displays them to the user.


Great short summary of each component

HiIAmTzeKean · 2023-03-31T02:46:16Z

docs/DeveloperGuide.md

+#### 2.2.2. AddCommand Class
+The `AddCommand` class is a command class that extends the `Command` abstract class. It represents the command to add an 
+item to the inventory. It contains a constructor that takes in an `Inventory` object and an `Item` object as parameters. 
+The constructor sets the `Inventory` object to be the inventory of the `Command` class, and the `Item` object to be the item 
+to be added to the inventory. The class also contains a private method called `addItem()` that adds the `Item` object to 
+the inventory. The `addItem()` method checks if the item already exists in the inventory using its unique UPC 
+(Universal Product Code) code. If the item already exists, it prints a message stating that the item is a duplicate. 
+Otherwise, it adds the item to the inventory, updates the item name hash, and adds the item to the UPC code history. 
+If the `SessionManager`'s `autoSave` flag is enabled, it writes the current inventory to a file using the `SessionManager`.
+


I like the way the classes are elaborated in segments so that developers can search a certain segment they want to read more about.

Enforcement of valid range & UG clarity

Add printing of alert warnings when alerts are created

…ter category test

Update EditCommand for duplicate printing of category bug

add add and alert sample formats

DG: Update diagrams and text

Update personal PPP

Sync db storage status with actual status

DG, UG, PPP Edits

docs add profile pic

Update PPP

Fix checkstyle and add javadoc

vishnuvk47 pushed a commit to vishnuvk47/tp that referenced this pull request Mar 15, 2023

Merge pull request nus-cs2113-AY2223S2#39 from vishnuvk47/new_feat

bf6b481

Added a view-account case

tsx0314 reviewed Mar 29, 2023

View reviewed changes

douph810975 reviewed Mar 29, 2023

View reviewed changes

chungnicholas reviewed Mar 30, 2023

View reviewed changes

lil1n reviewed Mar 30, 2023

View reviewed changes

chungnicholas reviewed Mar 30, 2023

View reviewed changes

HiIAmTzeKean reviewed Mar 31, 2023

View reviewed changes

Ng-YZ and others added 23 commits April 4, 2023 16:06

Modify filter category function and revert category (list/table)

fd14107

Merge branch 'master' of https://github.com/AY2223S2-CS2113-W12-3/tp

19b8649

Merge pull request #203 from firwer/master

dbca6a6

Enforcement of valid range & UG clarity

Fix merge conflict

932d40d

Update category-related UG information

38893f8

User Guide reformatting for Sell/Restock/Dashboard Command.

871787f

UG: Update sample outputs for anything printed in tables

cecc15e

Merge branch 'master' into master

028c0f8

Edit 'Uncategorized' to 'uncategorized' to pass tests

d0648e8

no message

f159db7

Edit UG

c22039f

Add printing of alert warnings when alerts are created

14c6199

Clean up category code

aff2771

-Edit command added OutfRange Checking Capability.

d80495d

Simplify remove function, edit junit tests with RemoveCommand used

c1abed6

-Added assertions for edit command testing

cdd98a4

modify UG anchors

5900520

Merge pull request #213 from ysl-28/master

f0649cd

Add printing of alert warnings when alerts are created

Simplify remove command further, remove redundant ui methods, add fil…

24577dc

…ter category test

Fix merge conflict, clean up redundant ui variables

a1af74b

-Updating PPP document

f399e19

Update tables in UG to show index column

34952e8

Update help function's list of commands

5a36b15

ysl-28 and others added 30 commits April 10, 2023 17:19

Merge pull request #274 from Ng-YZ/master

dc895a7

Update EditCommand for duplicate printing of category bug

add add and alert sample formats

0c88260

small new line fix

76ff073

fix test

f73ceb0

Merge pull request #277 from ArtemiszenN/newMaster

64444ae

add add and alert sample formats

DG: Edit UML diagram

e947791

Update PPP

cd4a605

Merge branch 'master' of https://github.com/ngkaiwen123/tp

36fc343

Merge pull request #278 from Ng-YZ/master

c21a10e

DG: Update diagrams and text

Merge branch 'AY2223S2-CS2113-W12-3:master' into master

dc906cf

Sync db storage status with actual status

e6feee6

Merge pull request #279 from ngkaiwen123/master

6c449d4

Update personal PPP

DG Spacing

9ff8e4c

Merge branch 'master' of https://github.com/firwer/tp

648d7d8

Merge pull request #280 from ArtemiszenN/newMaster

048c4b6

Sync db storage status with actual status

DG update

069d133

Merge branch 'AY2223S2-CS2113-W12-3:master' into master

41e2a24

PPP addon

a65c090

PPP edit 2.0

35052c6

Merge pull request #281 from firwer/master

ed82c65

DG, UG, PPP Edits

docs add profile pic

6f1a77b

Merge pull request #282 from firwer/master

4a0927f

docs add profile pic

Update PPP

20a976e

Merge branch 'master' of https://github.com/AY2223S2-CS2113-W12-3/tp

7460a4c

Merge pull request #283 from ysl-28/master

7c51e04

Update PPP

Update PPP

44803da

Update PPP

1a24d73

Fix checkstyle and javadoc

13537e1

Merge branch 'master' of https://github.com/AY2223S2-CS2113-W12-3/tp

d3783ed

Merge pull request #284 from ysl-28/master

6105262

Fix checkstyle and add javadoc

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[CS2113-W12-3] MagusStock #39

[CS2113-W12-3] MagusStock #39

ngkaiwen123 commented Mar 2, 2023 •

edited

Loading

tsx0314 left a comment

tsx0314 Mar 29, 2023

tsx0314 Mar 29, 2023

tsx0314 Mar 29, 2023

tsx0314 Mar 29, 2023

douph810975 left a comment

douph810975 Mar 29, 2023

douph810975 Mar 29, 2023

douph810975 Mar 29, 2023

douph810975 Mar 29, 2023

chungnicholas left a comment

chungnicholas Mar 30, 2023

chungnicholas Mar 30, 2023

chungnicholas Mar 30, 2023

chungnicholas Mar 30, 2023

lil1n left a comment

lil1n Mar 30, 2023

lil1n Mar 30, 2023

lil1n Mar 30, 2023

lil1n Mar 30, 2023

lil1n Mar 30, 2023

lil1n Mar 30, 2023

lil1n Mar 30, 2023

chungnicholas Mar 30, 2023

chungnicholas Mar 30, 2023

chungnicholas Mar 30, 2023

chungnicholas Mar 30, 2023

HiIAmTzeKean left a comment

HiIAmTzeKean Mar 31, 2023

HiIAmTzeKean Mar 31, 2023

HiIAmTzeKean Mar 31, 2023

HiIAmTzeKean Mar 31, 2023


		Included below is a sequence diagram for the `RestockParser` and `RestockCommand` respectively:

		![RestockParser.png](UML/Restock/RestockParser.png)


		### 1.2. UML Sequence Diagram

		![Sequence Diagram](SequenceDiagram.png)

[CS2113-W12-3] MagusStock #39

Are you sure you want to change the base?

[CS2113-W12-3] MagusStock #39

Conversation

ngkaiwen123 commented Mar 2, 2023 • edited Loading

tsx0314 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

douph810975 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

chungnicholas left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lil1n left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

HiIAmTzeKean left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ngkaiwen123 commented Mar 2, 2023 •

edited

Loading