[CS2113-W12-3] MagusStock#39
Conversation
Added a view-account case
tsx0314
left a comment
tsx0314
left a comment
There was a problem hiding this comment.
Overall good job! Everything is clear and detailed! However, many explanations are used in the picture, sometimes it is hard to read
There was a problem hiding this comment.
The diagram is a bit hard to read. Perhaps you can omit some of the details
There was a problem hiding this comment.
The square may be removed it should be "+" and "-"
douph810975
left a comment
douph810975
left a comment
There was a problem hiding this comment.
In general, the diagrams are clear and comprehensive.
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
This architecture diagram is clear and easy to understand!
There was a problem hiding this comment.
The picture is unable to display here. Are there any bugs here?
There was a problem hiding this comment.
A meticulous diagram! I have a small problem, why after the updateItemQuality funciton, a new activation bar is created?
chungnicholas
left a comment
chungnicholas
left a comment
There was a problem hiding this comment.
The Developer Guide is well done and formatting is neat. Good job!
| ## 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) |
There was a problem hiding this comment.
Consider having a full stop at the end of the sentence
|
|
||
| {Describe the design and implementation of the product. Use UML diagrams and short code snippets where applicable.} | ||
| ### 1.1. Architecture Design Diagram | ||
|  |
There was a problem hiding this comment.
Nice architecture design diagram
| ### 2.1. List | ||
| The list command is mainly handled by the `ListCommand` class, which extends the `Command` class. | ||
|
|
||
|  | ||
|
|
||
|
|
||
| **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. | ||
|
|
||
|  | ||
|
|
||
| **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`. | ||
|
|
||
|  | ||
|
|
||
| **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. | ||
|
|
||
|  | ||
|
|
||
| **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. | ||
|
|
There was a problem hiding this comment.
Step by step guide is very clear and accompanied by diagrams for better visualization. Very nice!
| ## 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) | ||
|
|
There was a problem hiding this comment.
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
left a comment
lil1n
left a comment
There was a problem hiding this comment.
Sequence diagrams are very detailed, but there are some areas that can be improved, great effort overall
| 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. | ||
|  |
There was a problem hiding this comment.
I think that there is an additional return arrow between AddParser and AddCommand?
| 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. | ||
|  |
There was a problem hiding this comment.
not sure if it is intended, but activation bar for AddParser seems to not be deactivated
| 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. | ||
|  |
There was a problem hiding this comment.
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()?
| 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. | ||
|  |
There was a problem hiding this comment.
not sure if it is intended, but activation bar for AddCommand seems to not be deactivated
| 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. | ||
|  |
There was a problem hiding this comment.
not sure if add(itemName, item), writeSession(inventory), writeCSV(inventory) is correct, but I think that method calls should be methodName(parameterName : parameterType)?
|
|
||
| Included below is a sequence diagram for the `RestockParser` and `RestockCommand` respectively: | ||
|
|
||
|  |
There was a problem hiding this comment.
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
| Included below is a sequence diagram for the `SellParser` and the `SellCommand` respectively: | ||
|
|
||
|  | ||
|  |
There was a problem hiding this comment.
there seems to be a lot of self calls, maybe can abstract out?
|
|
||
| ### 1.2. UML Sequence Diagram | ||
|
|
||
|  |
There was a problem hiding this comment.
Classes have a missing : at the start. For example, :MagusStock.
Activation bar for MagusStock is also missing a closing line.
| ### 2.1. List | ||
| The list command is mainly handled by the `ListCommand` class, which extends the `Command` class. | ||
|
|
||
|  |
There was a problem hiding this comment.
The alt frame is missing an else path.
| ### 2.1. List | ||
| The list command is mainly handled by the `ListCommand` class, which extends the `Command` class. | ||
|
|
||
|  |
There was a problem hiding this comment.
Missing separate sequence diagram to show details of ref frames.
| **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. | ||
|
|
||
|  | ||
|
|
||
| **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`. | ||
|
|
||
|  | ||
|
|
||
| **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. | ||
|
|
||
|  | ||
|
|
||
| **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. | ||
|
|
There was a problem hiding this comment.
Use of non-standard visibility notation.
|
|
||
| {Describe the design and implementation of the product. Use UML diagrams and short code snippets where applicable.} | ||
| ### 1.1. Architecture Design Diagram | ||
|  |
| - [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) | ||
|
|
| `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. |
There was a problem hiding this comment.
Great short summary of each component
| #### 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`. | ||
|
|
There was a problem hiding this comment.
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
10 participants
MagusStock is an inventory management system (IMS) that makes use of the command line interface for businesses to manage their stock inventory.