[CS2113-F10-2] ClubInvMgr #25

quitejasper · 2022-03-04T02:25:34Z

ClubInvMgr is a desktop CLI app for inventory management for CCA clubs, especially for fast typists who can accomplish tasks quickly by typing out commands.

heekit73098

Generally the DG is easy to read and understand

heekit73098 · 2022-03-31T02:12:08Z

docs/DeveloperGuide.md

+The `UI` component
+- Displays salutations, prompts for user input, error messages and results of queries.
+- Reads in user inputs
+- Depends on the `Messages` and `InvMgrException` classes in the `Common` component. It displays messages stored in the `Messages` class and displays an error message whenever `InvMgrException` is invoked.


Introducing this component out of the blue can be quite confusing, especially when InvMgrException is in the exceptions package instead of common

heekit73098 · 2022-03-31T02:13:47Z

docs/DeveloperGuide.md

@@ -4,26 +4,167 @@

 {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


Consider adding an overall class diagram and introduce the major components so that it would not very confusing below when components are named suddenly.

heekit73098 · 2022-03-31T02:20:05Z

docs/DeveloperGuide.md

+a `Command` class based on the user input.
+
+### Command Component
+![CommandClassDiagram](img/CommandClassDiagram.png)


Consider enlarging this diagram as the words are significantly smaller than the other diagrams

heekit73098 · 2022-03-31T02:26:19Z

docs/diagrams/UiClassDiagram.puml

+    + getRawUserInput(): String
+}
+
+InvMgr --> "1" Ui


Should this be a composition instead?

tjiarong · 2022-03-31T02:18:53Z

docs/DeveloperGuide.md

+![DescCommandSequenceDiagram](img/DescCommandSequenceDiagram.png)
+The following diagram shows the sequence diagram for retrieving the description of an item.
+
+For a user who is unaware of what an item is about, he/she can enter the command eg. `desc 2` command to extract the description for the second item in the inventory list. This command is interpreted by the `Parser` and a `DescCommand` is returned to `InvMgr`. `InvMgr` calls the execute command of `DescCommand` which retrieves the item's information from the `ItemList` and then outputs them into the `Ui` for the user to see.


In the UML diagram, the program calls writeData(ArrayList) at the end after the execution of the desc command. Not sure if this was intended as this was not explained the running of the desc command.

tjiarong · 2022-03-31T02:25:31Z

docs/DeveloperGuide.md

+| v1.0    | Manager                                | Add a new item to the inventory                 | Update my inventory                                          |
+| v1.0    | Manager                                | Remove an item from the inventory               | Update my inventory                                          |
+| v1.0    | Stocktaker                             | list out all my items                           | View all my items at a glance                                |
+| v1.0    | New user                               | List out all possible commands                  | I can familiarise myself with using the system               |
+| v1.0    | User who has not seen items physically | Get the description of a particular item        | I can visualise the item better to know if it is what i need |
+| v1.0    | As a frequent/first time user          | Write to a file containing the entire inventory | Save my inventory data to a file                             |
+| v1.0    | Stocktaker                             | Read from and load an inventory file data       | To work on and view the data                                 |


Perhaps you can update the user stories with those you have selected for V2.0?

tjiarong · 2022-03-31T02:35:49Z

docs/DeveloperGuide.md


-## Design & implementation
+## Design

-{Describe the design and implementation of the product. Use UML diagrams and short code snippets where applicable.}
+### Application Launch



Consider adding a content page or navigation bar with hyperlink to improve navigability and document formatting

tjiarong · 2022-03-31T02:38:11Z

docs/DeveloperGuide.md

+![ListCommandSequenceDiagram](img/ListCommandSequenceDiagram.png)
+
+The following diagram shows the sequence diagram of the listing of items in `itemList`.
+
+The user starts by typing a list command.
+
+1. `InvMgr` calls `parse("list")` method in `Parser` class, which returns a ListCommand object.
+2. `InvMgr` calls `execute(itemList, ui)` method in `ListCommand` object.
+3. `ListCommand` loops through every `Item` in `itemList` and prints them line by line
+   and numbers them.


Consider moving the end of lifeline cross out of the object box and at the end of the line.

tjiarong · 2022-03-31T02:40:31Z

docs/DeveloperGuide.md

-{Describe the value proposition: what problem does it solve?}
+1. Centralised management of resources that ensures accurate and timely allocation of equipment to students
+2. Increases the ease and efficiency of resource management
+3. More organised


Consider elaborating on this value proposition as it is quite vague. Could possible extend to be similiar like point 1.

cczhouqi

There are some minor things that can be improved (as shown in others' comments also), but generally it looks quite good 👍🏻

cczhouqi · 2022-03-31T03:29:20Z

docs/DeveloperGuide.md

+a `Command` class based on the user input.
+
+### Command Component
+![CommandClassDiagram](img/CommandClassDiagram.png)


You may also consider changing the way you arrange the boxes (to not in one line) to make the words larger but keep the diagram in a reasonable size.

cczhouqi · 2022-03-31T03:35:05Z

docs/DeveloperGuide.md

+6. `AddCommand` will converse with `Ui` to show a message that the item has been added. In this case, the item to add will be printed as the name of the item, followed by " has been added!".
+
+### Delete Command
+![DeleteCommandSequenceDiagram](img/DeleteCommandSequenceDiagram.png)


Some of the diagrams are above the "The following diagram" line while others are below. You may consider keeping it consistent :D

yanjie1017

Looks good in overall. May require some minor changes and add in the remaining sections.

yanjie1017 · 2022-03-31T03:23:29Z

docs/DeveloperGuide.md

+
+### List Command
+![ListCommandSequenceDiagram](img/ListCommandSequenceDiagram.png)
+


Should the lifeline of the object carry on if the class has been terminated?

yanjie1017 · 2022-03-31T03:30:45Z

docs/DeveloperGuide.md

+### Parser Component
+
+![ParserClassDiagram](img/ParserClassDiagram.png)
+


Consider stating the return types of the methods called in InvMgr?

yanjie1017 · 2022-03-31T03:32:37Z

docs/DeveloperGuide.md

+### Parser Component
+
+![ParserClassDiagram](img/ParserClassDiagram.png)
+


The format of attributes should be
NameOfAttribute : DataTypeOfAttribute

yanjie1017 · 2022-03-31T03:38:14Z

docs/DeveloperGuide.md

+
+### Description Command
+![DescCommandSequenceDiagram](img/DescCommandSequenceDiagram.png)
+The following diagram shows the sequence diagram for retrieving the description of an item.


Inconsistent format. Can decide whether to add the footer.

…alDate BorrowStatus had no way of being updated before. To keep the listob, listfb commands relevant to the current date, Let's - Write an adapter for BorrowRecord - Update the BorrowStatus everytime Storage loads in data

…ping dates.

Refactor CommandStubs to ItemList Stubs Added equals() check for BorrowRecords, needed for equality check in Storage tests

This is to help resolve the JSON serializer issue when storing the data.

Java, by default, adds references of objects into arraylist. This means the original Items in ItemList may be modified. This may result in a race condition! Each test are given their own threads to execute in JUnit. To fix this, we should clone the Item and add them to the list before returning the itemlist. Let's - Implement clone() for BorrowRecord, needed for deep copying - Implement a deep copy of Item() in its clone method to clone BorrowRecord - Change ItemListStubs to generate new mutable ItemLists that are clones of the specified Items.

…into branch-general-bugfix

Update BorrowRecord and BorrowCommand

…into branch-general-bugfix Adapted new code into BorrowRecordAdapter

Cloneable and clone is frowned upon. Let's remove its usages and create manual copies through a copyItem()/copyBorrowRecord() instead.

Some weird, undiagnosable behaviour happened when the lists were globally defined in ItemListStubs. Defining them locally (within the CommandTest) seems to resolve the issue

Updates DG with ReturnCommand, LostCommand and HelpCommand implementation details

…into A-UserGuide # Conflicts: # docs/UserGuide.md

…into A-DeveloperGuide # Conflicts: # docs/DeveloperGuide.md

…into A-PPP

…into ChihYing-AboutUs

…ommand Add ListFutureBookingsTest

Update DeveloperGuide

Updates portfolio links

Update to UserGuide

Update Jasper PPP (Final)

Modifies portfolio links

Updates PPP

Update user stories for v2.1

Updates to PPP: lestersimjj

Update DeveloperGuide.md for Jasper

DG

Final PPP

Update PPP link in AboutUs.md for IncompetentDev

heekit73098 reviewed Mar 31, 2022

View reviewed changes

tjiarong reviewed Mar 31, 2022

View reviewed changes

cczhouqi reviewed Mar 31, 2022

View reviewed changes

yanjie1017 reviewed Mar 31, 2022

View reviewed changes

thernturnaround and others added 26 commits April 9, 2022 18:09

Change output of SearchCommand to use original index of returned Item

8a25ff6

Fix Item print bug

8c0445d

Update BorrowCommand to not allow borrowing of lost items

c535416

Update Item class to track total quantity borrowed instead of overlap…

2ea6509

…ping dates.

Add BorrowRecords to Storage tests

d6e1051

Refactor CommandStubs to ItemList Stubs Added equals() check for BorrowRecords, needed for equality check in Storage tests

Update to UserGuide for borrow quantity

88c8608

Update ParserUtils to specify DateTimeFormatter.

92cf347

This is to help resolve the JSON serializer issue when storing the data.

Update BorrowCommandParser to enforce max 7 days borrowing.

717e371

Replace magic number for max borrow duration with constant

1502d79

Fix checkstyle errors

7c1577e

Merge branch 'master' of https://github.com/AY2122S2-CS2113-F10-2/tp …

9d8670c

…into branch-general-bugfix

Update gitignore

3df2b39

Fix a missed merge conflict marker

f7ceeff

Merge pull request #181 from lestersimjj/branch-Borrow

cefd471

Update BorrowRecord and BorrowCommand

Merge branch 'master' of https://github.com/AY2122S2-CS2113-F10-2/tp …

5e0a421

…into branch-general-bugfix Adapted new code into BorrowRecordAdapter

Fix test code to work with changes to borrowrecord

c80666f

Remove actual output test files

711adfc

Remove clone() usage.

1a600dc

Cloneable and clone is frowned upon. Let's remove its usages and create manual copies through a copyItem()/copyBorrowRecord() instead.

Catch NullPointerException when parsing goes wrong

97a69ff

Remove clone test

76ba356

Migrate ItemList Stubs to the CommandTest they are used in

5564607

Some weird, undiagnosable behaviour happened when the lists were globally defined in ItemListStubs. Defining them locally (within the CommandTest) seems to resolve the issue

Update expected data for storage test

b4b65b3

Fix checkstyle errors

291f19e

Adds ReturnCommandTest

9eeba92

chihyingho and others added 30 commits April 11, 2022 23:16

Merge pull request #204 from chihyingho/branch-DeveloperGuide

d8d07e5

Updates DG with ReturnCommand, LostCommand and HelpCommand implementation details

Merge branch 'master' of https://github.com/AY2122S2-CS2113-F10-2/tp …

49b8dca

…into A-UserGuide # Conflicts: # docs/UserGuide.md

Merge branch 'master' of https://github.com/AY2122S2-CS2113-F10-2/tp …

fd864ff

…into A-DeveloperGuide # Conflicts: # docs/DeveloperGuide.md

Merge branch 'master' of https://github.com/AY2122S2-CS2113-F10-2/tp …

d37449a

…into A-PPP

Checkstyle fixes

dd5b8c7

Merge branch 'master' of https://github.com/AY2122S2-CS2113-F10-2/tp …

23504f0

…into ChihYing-AboutUs

checkstyle fixes

d270ca0

Updates team's Portfolio links

e07a5a9

Update user stories

7ee179f

Merge pull request #222 from quitejasper/branch-ListFutureBorrowingsC…

752bf0e

…ommand Add ListFutureBookingsTest

Merge pull request #206 from lestersimjj/A-DeveloperGuide

fe1a9b5

Update DeveloperGuide

Merge pull request #223 from chihyingho/ChihYing-AboutUs

4e9be5e

Updates portfolio links

Add 2.1 to UG

2144e6b

Merge pull request #217 from lestersimjj/A-UserGuide

a01a5bd

Update to UserGuide

update PPP

b89f410

Modifies portfolio links

a73d64c

Trim lifeline

90a30f7

Merge branch 'master' into A-DeveloperGuide

363b05f

Merge pull request #221 from quitejasper/A-PPP

1de73bc

Update Jasper PPP (Final)

Merge pull request #225 from chihyingho/ChihYing-AboutUs

27852c4

Modifies portfolio links

Merge pull request #220 from chihyingho/ChihYing-PPP

a0f5ac4

Updates PPP

Update to lestersimjj PPP

6684806

Merge pull request #224 from cheshire-doge/master

0c6ef60

Update user stories for v2.1

Merge pull request #219 from lestersimjj/A-PPP

9315067

Updates to PPP: lestersimjj

Add TOC for DG

07ffe4c

PPP update

41b7a63

Merge pull request #213 from quitejasper/A-DeveloperGuide

d6d60ad

Update DeveloperGuide.md for Jasper

Merge pull request #226 from IncompetentDev/branch-finaldgug

62e448f

DG

Merge pull request #180 from IncompetentDev/branch-ppp

5bdfaca

Final PPP

Update AboutUs.md

669f0f0

Update PPP link in AboutUs.md for IncompetentDev

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[CS2113-F10-2] ClubInvMgr #25

[CS2113-F10-2] ClubInvMgr #25

quitejasper commented Mar 4, 2022

heekit73098 left a comment

heekit73098 Mar 31, 2022 •

edited

Loading

heekit73098 Mar 31, 2022

heekit73098 Mar 31, 2022

heekit73098 Mar 31, 2022

tjiarong Mar 31, 2022

tjiarong Mar 31, 2022

tjiarong Mar 31, 2022

tjiarong Mar 31, 2022

tjiarong Mar 31, 2022

cczhouqi left a comment

cczhouqi Mar 31, 2022

cczhouqi Mar 31, 2022

yanjie1017 left a comment

yanjie1017 Mar 31, 2022

yanjie1017 Mar 31, 2022

yanjie1017 Mar 31, 2022

yanjie1017 Mar 31, 2022


		### List Command
		![ListCommandSequenceDiagram](img/ListCommandSequenceDiagram.png)

		### Parser Component

		![ParserClassDiagram](img/ParserClassDiagram.png)

[CS2113-F10-2] ClubInvMgr #25

Are you sure you want to change the base?

[CS2113-F10-2] ClubInvMgr #25

Conversation

quitejasper commented Mar 4, 2022

heekit73098 left a comment

Choose a reason for hiding this comment

heekit73098 Mar 31, 2022 • edited Loading

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

cczhouqi left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yanjie1017 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

heekit73098 Mar 31, 2022 •

edited

Loading