[CS2113T-T09-4] Simplst #6

LDerpy · 2022-03-03T01:22:32Z

Simplst is a laptop app for managing warehouse inventory and processes, optimized for use via a Command Line Interface (CLI) for warehouse management workers.

khseah

Overall good implementation! One more thing to consider is to put the UML diagrams on a new line. Some UML diagrams are right after the sentence, causing formatting issues

khseah · 2022-03-31T02:09:09Z

docs/DeveloperGuide.md

+#### Description
+The goods class keeps track of the various inventory that will be input into the system through the commands class.
+The diagram below shows the model component of the orderline class.
+![Good Class Diagram](http://www.plantuml.com/plantuml/proxy?cache=no&src=https://raw.githubusercontent.com/AY2122S2-CS2113T-T09-4/tp/master/docs/diagrams/Good.puml)


I think the UML format does not really follow the standards we learnt in lecture. Eg we use "+", "-", "#" or "~" to indicate the visibilities, but in the UML diagram shown it used a red square and green circle

Also the return type should be at the end instead. Eg:
getId(): Int
instead of:
int getId()

khseah · 2022-03-31T02:09:51Z

docs/DeveloperGuide.md

 {Describe the design and implementation of the product. Use UML diagrams and short code snippets where applicable.}
+### Good Class
+#### Description
+The goods class keeps track of the various inventory that will be input into the system through the commands class.


Can consider highlighting important words to aid readability

Suggested change

The goods class keeps track of the various inventory that will be input into the system through the commands class.

The `goods` class keeps track of the various inventory that will be input into the system through the commands class.

khseah · 2022-03-31T02:16:03Z

docs/DeveloperGuide.md

+### Regex Class
+#### Description
+The Regex Class is created to simplify the use of regular expressions in Java.
+![Regex Class Diagram](http://www.plantuml.com/plantuml/proxy?cache=no&src=https://raw.githubusercontent.com/AY2122S2-CS2113T-T09-4/tp/master/docs/diagrams/Regex.puml)


This diagram indicates that a new Regex class is instantiated and the red marking shows that the activation bar is a constructor, which is not the case. You should add a dotted line before the activation bar

khseah · 2022-03-31T02:18:07Z

docs/DeveloperGuide.md

+View Good belongs as part of the Commands Class. It is used when a user would like to know more information about an inventory item has an item id linked to it in the warehouse.
+
+#### Operation
+![View Good Sequence Diagram](http://www.plantuml.com/plantuml/proxy?cache=no&src=https://raw.githubusercontent.com/AY2122S2-CS2113T-T09-4/tp/master/docs/diagrams/viewGood.puml)


Return arrows should be dotted

khseah · 2022-03-31T02:19:14Z

docs/DeveloperGuide.md

@@ -4,26 +4,162 @@

 {list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the original source as well}

-## Design & implementation
-
+## Design


Can consider giving a high level overview of the architecture first, before diving deep into explaining each detail

striage · 2022-03-31T02:07:40Z

docs/DeveloperGuide.md

+#### Description
+The goods class keeps track of the various inventory that will be input into the system through the commands class.
+The diagram below shows the model component of the orderline class.
+![Good Class Diagram](http://www.plantuml.com/plantuml/proxy?cache=no&src=https://raw.githubusercontent.com/AY2122S2-CS2113T-T09-4/tp/master/docs/diagrams/Good.puml)


Consider adding a <br> to move this diagram to a new line.

striage · 2022-03-31T02:10:39Z

docs/DeveloperGuide.md

+![Regex Class Diagram](http://www.plantuml.com/plantuml/proxy?cache=no&src=https://raw.githubusercontent.com/AY2122S2-CS2113T-T09-4/tp/master/docs/diagrams/Regex.puml)
+The Class Diagram above shows the different variables and methods associated with the regex class.
+This class takes in the regular expression as a string and the string to be matched in the class contructor, and stores the results
+in the private variable `groupValues` which is a Hash Map where the key would be the capture group name and the value as the matched results.


Consider using HashMap in a code block instead of Hash Map to make it clear that it is a class.

striage · 2022-03-31T02:13:00Z

docs/DeveloperGuide.md

+View Good belongs as part of the Commands Class. It is used when a user would like to know more information about an inventory item has an item id linked to it in the warehouse.
+
+#### Operation
+![View Good Sequence Diagram](http://www.plantuml.com/plantuml/proxy?cache=no&src=https://raw.githubusercontent.com/AY2122S2-CS2113T-T09-4/tp/master/docs/diagrams/viewGood.puml)


Consider making the return lines dotted lines.

striage · 2022-03-31T02:16:32Z

docs/DeveloperGuide.md

+      3.1.1 Lastly, the list of orders is printed to the command line.
+   3.2 Else, if the flag is `g/`, the User Interface Class will call the listGoods() method in the Warehouse class
+      3.2.1 Following that, the Warehouse class will call the getGoods() method on the Good class
+      3.2.2 Lastly, the list of goods is printed to the command line.


Consider adding <br> lines to properly format these numbered lists, as they currently appear as one big paragraph.

striage · 2022-03-31T02:18:16Z

docs/DeveloperGuide.md

+4. This method will then iterate through orderLists and sum up each quantity of each Good object in each order.
+5. The totalGoods() method will return an integer of the number of goods in the warehouse. 
+
+For more examples of how a user can use a command, refer to the [UserGuide](/UserGuide.md)


This line seems unnecessary, but it could be more useful if it linked to this command's section specifically in the User Guide. Consider changing it or removing it.

striage · 2022-03-31T02:21:22Z

docs/DeveloperGuide.md

+View Good belongs as part of the Commands Class. It is used when a user would like to know more information about an inventory item has an item id linked to it in the warehouse.
+
+#### Operation
+![View Good Sequence Diagram](http://www.plantuml.com/plantuml/proxy?cache=no&src=https://raw.githubusercontent.com/AY2122S2-CS2113T-T09-4/tp/master/docs/diagrams/viewGood.puml)


User is not a class, so the colon before User should not be included. Consider removing it.

striage · 2022-03-31T02:25:11Z

docs/DeveloperGuide.md

+
+### View Good Method
+#### Description
+View Good belongs as part of the Commands Class. It is used when a user would like to know more information about an inventory item has an item id linked to it in the warehouse.


It would be good to show the command format separately in text form as a code block, as well as an example. They are currently only visible in the sequence diagrams which makes it hard to copy and paste them, and is less obvious to the reader.

striage · 2022-03-31T02:26:54Z

docs/DeveloperGuide.md

+3. The Regex Class will then be called to match the rest of the user's input to find the values required to remove goods from the inventory.
+4. Afterwards, the User Interface class will call removeGood() method from the Commands Class
+5. This method will then reduce the quantity of a type of goods if the quantity input is not larger than the existing quantity. If the quantity input is the same as the existing quantity, the goods object will be removed from the inventory.
+6. The UI will show a message of format


Consider including more details on what methods are called and what types of objects are returned by each method, to make the implementation of this program clearer.

striage · 2022-03-31T02:31:24Z

docs/DeveloperGuide.md

+View Good belongs as part of the Commands Class. It is used when a user would like to know more information about an inventory item has an item id linked to it in the warehouse.
+
+#### Operation
+![View Good Sequence Diagram](http://www.plantuml.com/plantuml/proxy?cache=no&src=https://raw.githubusercontent.com/AY2122S2-CS2113T-T09-4/tp/master/docs/diagrams/viewGood.puml)


The stickman figures are not covered in this module, so consider replacing them with boxes.

striage · 2022-03-31T02:33:03Z

docs/DeveloperGuide.md

+View Good belongs as part of the Commands Class. It is used when a user would like to know more information about an inventory item has an item id linked to it in the warehouse.
+
+#### Operation
+![View Good Sequence Diagram](http://www.plantuml.com/plantuml/proxy?cache=no&src=https://raw.githubusercontent.com/AY2122S2-CS2113T-T09-4/tp/master/docs/diagrams/viewGood.puml)


The boxes + User at the bottom should not be present. Use an X instead to mark end of life for an object instead if necessary, or leave it empty.

darylhjd · 2022-03-31T03:19:01Z

docs/DeveloperGuide.md

+### Good Class
+#### Description
+The goods class keeps track of the various inventory that will be input into the system through the commands class.
+The diagram below shows the model component of the orderline class.


An orderline class is mentioned here, but there is no prior explanation or link to this class beforehand.

darylhjd · 2022-03-31T03:20:56Z

docs/DeveloperGuide.md

+```
+String regex = "id/(?<id>\\d*) n/(?<name>.*) q/(?<qty>\\d*) d/(?<desc>\\.*)";
+Regex regexMatch = new Regex(userInput, regex);
+HashMap<String, String> matches = regexMatch.getGroupValues();
+String id = matches.get("id");
+String name = matches.get("name");
+String quantity = matches.get("qty");
+String description = matches.get("desc");
+```


good that an example is given on how it works, but perhaps some explanation could be given for the regex pattern?

darylhjd · 2022-03-31T03:22:24Z

docs/DeveloperGuide.md

+3. Together with the previous step, the User Interface Class will check the flag followed by `list`
+   3.1 If the flag is `o/`, the User Interface Class will call the listOrders() method in the Warehouse class
+      3.1.1 Lastly, the list of orders is printed to the command line.
+   3.2 Else, if the flag is `g/`, the User Interface Class will call the listGoods() method in the Warehouse class
+      3.2.1 Following that, the Warehouse class will call the getGoods() method on the Good class
+      3.2.2 Lastly, the list of goods is printed to the command line.


maybe some formatting error here!

darylhjd · 2022-03-31T03:26:14Z

docs/DeveloperGuide.md

+#### Description
+The Commands Class is the class which contains all the available commands that can be used in the Simplst CLI application.
+![Commands Class Diagram](http://www.plantuml.com/plantuml/proxy?cache=no&src=https://raw.githubusercontent.com/AY2122S2-CS2113T-T09-4/tp/master/docs/diagrams/CommandsClass.puml)
+
+More about how each feature is run can be seen in each of the methods that can be found below.


perhaps an explanation can be given for why this design of putting all commands into a single class was chosen rather than subclassing different commands.

Lim-Shi-Han

Looks good in general, slight changes to the formatting and diagrams would make it better!:)

Lim-Shi-Han · 2022-03-31T03:18:38Z

docs/DeveloperGuide.md

 {Describe the design and implementation of the product. Use UML diagrams and short code snippets where applicable.}
+### Good Class
+#### Description
+The goods class keeps track of the various inventory that will be input into the system through the commands class.


Yes as @khseah said, I also think denoting the class names as code would be good. In addition I think it would be better to capitalise it as well (e.g. Good)

Lim-Shi-Han · 2022-03-31T03:24:53Z

docs/DeveloperGuide.md

+    > `quantity` `name` have been removed
+to show that the operation is successful.


The formatting could be improved here

Lim-Shi-Han · 2022-03-31T03:29:04Z

docs/DeveloperGuide.md

+![List sequence Diagram](http://www.plantuml.com/plantuml/proxy?cache=no&src=https://raw.githubusercontent.com/AY2122S2-CS2113T-T09-4/tp/master/docs/diagrams/List.puml)
+


The activation bar for the first condition should not spill over into the "else" condition

Lim-Shi-Han · 2022-03-31T03:39:11Z

docs/DeveloperGuide.md

+### Regex Class
+#### Description
+The Regex Class is created to simplify the use of regular expressions in Java.
+![Regex Class Diagram](http://www.plantuml.com/plantuml/proxy?cache=no&src=https://raw.githubusercontent.com/AY2122S2-CS2113T-T09-4/tp/master/docs/diagrams/Regex.puml)


I think there might be some issues with the dummyClass calling Regex, as it should be a new activation bar (and the previous activation bar should have ended prior).

Lim-Shi-Han · 2022-03-31T03:40:17Z

docs/DeveloperGuide.md

+View Good belongs as part of the Commands Class. It is used when a user would like to know more information about an inventory item has an item id linked to it in the warehouse.
+
+#### Operation
+![View Good Sequence Diagram](http://www.plantuml.com/plantuml/proxy?cache=no&src=https://raw.githubusercontent.com/AY2122S2-CS2113T-T09-4/tp/master/docs/diagrams/viewGood.puml)


Return lines should be dotted.

Branch shyun yin dg

All features should be done except storage. Small fixes here and there included

This reverts commit 29dce37.

Checkstyle and bug fixes

UG update

Branch jun leong storage

2101 userguide updates

# Conflicts: # src/main/java/seedu/simplst/Simplst.java

adding tips for UG

…into branch-Shyunyin-2101UG1 # Conflicts: # docs/UserGuide.md

Branch shyunyin 2101 ug1

Update UserGuide.md

This reverts commit e719c1d.

Revert "Update StorageTest.java"

khseah reviewed Mar 31, 2022

View reviewed changes

striage reviewed Mar 31, 2022

View reviewed changes

darylhjd reviewed Mar 31, 2022

View reviewed changes

Lim-Shi-Han reviewed Mar 31, 2022

View reviewed changes

Nnythingy and others added 26 commits April 8, 2022 00:35

Create OrderTest.java

a516d8b

Update OrderTest.java

d321421

Merge pull request #87 from Shyunyin/branch_ShyunYin-DG

4428108

Branch shyun yin dg

Merge branch 'master' into branch-Nnythingy-Version2.1

97a09e9

Order class completion + other stuff

a53e257

All features should be done except storage. Small fixes here and there included

Update Warehouse.java

29dce37

Merge branch 'master' of https://github.com/AY2122S2-CS2113T-T09-4/tp

50e798f

Update DG

fef2c42

Include exceptions for missing flags and empty non-optional fields

295190b

Edit Checkstyle

327118e

Edit checkstyle

8c4482f

Update UserGuide.md

d6fc44a

Edit MatchKeywordsTest to fit new order input

34c0ae6

Fix checkstyle

5208505

Edit MatchKeywordsTest regex for testing

4d75d18

Fix MatchKeywordTest

20b5555

Fix MatchKeywordsTest again

3b38d21

FIx MatchKeywordstest

4d8a5fe

FIx MatchKeywordstest

aa78057

Fix MatchKeywordsTest

6a8d006

Error for repeated SKU

392551f

Merge https://github.com/AY2122S2-CS2113T-T09-4/tp

3ae60cb

Update Warehouse.java

a986f54

Revert "Update Warehouse.java"

271a272

This reverts commit 29dce37.

Update remove orderline feature

fbb24ce

Update UserGuide.md

f208c33

LDerpy and others added 30 commits April 11, 2022 23:33

UG update

85d4aba

Merge pull request #110 from LDerpy/branch-LastMinuteStuffv2.1

e107c45

Checkstyle and bug fixes

Final DG Push

a377b21

Added last diagram

1c9d765

UG update

469741b

Merge branch 'master' into branch-JunLeong-storage

4308ad4

Merge pull request #119 from LDerpy/branch-UGLAST

511819f

UG update

Merge pull request #118 from hjunleon/branch-JunLeong-storage

79ee6ce

Branch jun leong storage

Typo

c52c010

Merge branch 'master' into branch-JunLeong-storage

ea91c14

Merge pull request #120 from hjunleon/branch-JunLeong-storage

079125e

Branch jun leong storage

Update UserGuide.md

e50b22f

Update UserGuide.md

9ef4b1a

Merge pull request #121 from Nnythingy/master

3e2a985

2101 userguide updates

Include class definition

e6a1d4a

Merge branch 'master' of https://github.com/AY2122S2-CS2113T-T09-4/tp

b441a02

# Conflicts: # src/main/java/seedu/simplst/Simplst.java

Edit some parts of UG

acf2f34

Update UserGuide.md

1c0b8df

Update UserGuide.md

d909d67

Include FAQ

bffc5aa

Merge pull request #125 from Nnythingy/master

4d5aba7

adding tips for UG

Merge branch 'master' of https://github.com/AY2122S2-CS2113T-T09-4/tp …

558b289

…into branch-Shyunyin-2101UG1 # Conflicts: # docs/UserGuide.md

Merge pull request #124 from Shyunyin/branch-Shyunyin-2101UG1

fd43c1d

Branch shyunyin 2101 ug1

Update UserGuide.md

1331d52

Merge remote-tracking branch 'upstream/master'

39e7498

Update UserGuide.md

2f82e17

Update StorageTest.java

e719c1d

Merge pull request #126 from Nnythingy/master

a40aea9

Update UserGuide.md

Revert "Update StorageTest.java"

5d9cf65

This reverts commit e719c1d.

Merge pull request #127 from Nnythingy/master

281be76

Revert "Update StorageTest.java"

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[CS2113T-T09-4] Simplst #6

[CS2113T-T09-4] Simplst #6

LDerpy commented Mar 3, 2022

khseah left a comment

khseah Mar 31, 2022

khseah Mar 31, 2022

khseah Mar 31, 2022

khseah Mar 31, 2022

khseah Mar 31, 2022

striage Mar 31, 2022

striage Mar 31, 2022

striage Mar 31, 2022

striage Mar 31, 2022

striage Mar 31, 2022

striage Mar 31, 2022

striage Mar 31, 2022

striage Mar 31, 2022

striage Mar 31, 2022

striage Mar 31, 2022

darylhjd Mar 31, 2022

darylhjd Mar 31, 2022

darylhjd Mar 31, 2022

darylhjd Mar 31, 2022

Lim-Shi-Han left a comment

Lim-Shi-Han Mar 31, 2022

Lim-Shi-Han Mar 31, 2022

Lim-Shi-Han Mar 31, 2022

Lim-Shi-Han Mar 31, 2022

Lim-Shi-Han Mar 31, 2022

	The goods class keeps track of the various inventory that will be input into the system through the commands class.
	The `goods` class keeps track of the various inventory that will be input into the system through the commands class.

		> `quantity` `name` have been removed
		to show that the operation is successful.

		![List sequence Diagram](http://www.plantuml.com/plantuml/proxy?cache=no&src=https://raw.githubusercontent.com/AY2122S2-CS2113T-T09-4/tp/master/docs/diagrams/List.puml)

[CS2113T-T09-4] Simplst #6

Are you sure you want to change the base?

[CS2113T-T09-4] Simplst #6

Conversation

LDerpy commented Mar 3, 2022

khseah 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

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

Lim-Shi-Han 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