added commands for reminders in UG and amended DG for MoneyGoWhere #95

minpyaemoe · 2019-10-23T10:56:25Z

No description provided.

Nanosync

please also upload the new png files for the diagrams

Nanosync · 2019-10-23T13:45:19Z

docs/DeveloperGuide.adoc

 * does not depend on any of the other three components.

 [NOTE]
-As a more OOP model, we can store a `Tag` list in `Address Book`, which `Person` can reference. This would allow `Address Book` to only require one `Tag` object per unique `Tag`, instead of each `Person` needing their own `Tag` object. An example of how such a model may look like is given below. +
+As a more OOP model, we can store a `Tag` list in `Moneygowhere`, which `Spending` can reference. This would allow `Spending Book` to only require one `Tag` object per unique `Tag`, instead of each `Spending` needing their own `Tag` object. An example of how such a model may look like is given below. +


Spending Book

Nanosync · 2019-10-23T13:45:30Z

docs/DeveloperGuide.adoc

@@ -157,56 +157,56 @@ This section describes some noteworthy details on how certain features are imple
 === [Proposed] Undo/Redo feature
 ==== Proposed Implementation

-The undo/redo mechanism is facilitated by `VersionedAddressBook`.
-It extends `AddressBook` with an undo/redo history, stored internally as an `addressBookStateList` and `currentStatePointer`.
+The undo/redo mechanism is facilitated by `VersionedMoneygowhere`.


VersionedSpendingBook

Nanosync · 2019-10-23T13:45:51Z

docs/DeveloperGuide.adoc

-The undo/redo mechanism is facilitated by `VersionedAddressBook`.
-It extends `AddressBook` with an undo/redo history, stored internally as an `addressBookStateList` and `currentStatePointer`.
+The undo/redo mechanism is facilitated by `VersionedMoneygowhere`.
+It extends `Moneygowhere` with an undo/redo history, stored internally as an `addressBookStateList` and `currentStatePointer`.


SpendingBook
spendingBookStateList

Nanosync · 2019-10-23T13:46:13Z

docs/DeveloperGuide.adoc

+* `Versionedmoneygowhere#commit()` -- Saves the current address book state in its history.
+* `Versionedmoneygowhere#undo()` -- Restores the previous address book state from its history.
+* `Versionedmoneygowhere#redo()` -- Restores a previously undone address book state from its history.


VersionedSpendingBook

replace address book to spending book

Nanosync · 2019-10-23T13:46:41Z

docs/DeveloperGuide.adoc


-These operations are exposed in the `Model` interface as `Model#commitAddressBook()`, `Model#undoAddressBook()` and `Model#redoAddressBook()` respectively.
+These operations are exposed in the `Model` interface as `Model#commitmoneygowhere()`, `Model#undomoneygowhere()` and `Model#redomoneygowhere()` respectively.


commitSpendingBook
undoSpendingBook
redoSpendingBook

Nanosync · 2019-10-23T13:48:30Z

docs/DeveloperGuide.adoc


 The following sequence diagram shows how the undo operation works:

 image::UndoSequenceDiagram.png[]

 NOTE: The lifeline for `UndoCommand` should end at the destroy marker (X) but due to a limitation of PlantUML, the lifeline reaches the end of diagram.

-The `redo` command does the opposite -- it calls `Model#redoAddressBook()`, which shifts the `currentStatePointer` once to the right, pointing to the previously undone state, and restores the address book to that state.
+The `redo` command does the opposite -- it calls `Model#redomoneygowhere()`, which shifts the `currentStatePointer` once to the right, pointing to the previously undone state, and restores the address book to that state.


same as above

Nanosync · 2019-10-23T13:48:36Z

docs/DeveloperGuide.adoc


 [NOTE]
-If the `currentStatePointer` is at index `addressBookStateList.size() - 1`, pointing to the latest address book state, then there are no undone address book states to restore. The `redo` command uses `Model#canRedoAddressBook()` to check if this is the case. If so, it will return an error to the user rather than attempting to perform the redo.
+If the `currentStatePointer` is at index `moneygowhereStateList.size() - 1`, pointing to the latest address book state, then there are no undone address book states to restore. The `redo` command uses `Model#canRedomoneygowhere()` to check if this is the case. If so, it will return an error to the user rather than attempting to perform the redo.


same as above

Nanosync · 2019-10-23T13:48:39Z

docs/DeveloperGuide.adoc


-Step 5. The user then decides to execute the command `list`. Commands that do not modify the address book, such as `list`, will usually not call `Model#commitAddressBook()`, `Model#undoAddressBook()` or `Model#redoAddressBook()`. Thus, the `addressBookStateList` remains unchanged.
+Step 5. The user then decides to execute the command `list`. Commands that do not modify the address book, such as `list`, will usually not call `Model#commitMoneygowhere()`, `Model#undoMoneygowhere()` or `Model#redoMoneygowhere()`. Thus, the `MoneygowhereStateList` remains unchanged.


Nanosync · 2019-10-23T13:48:42Z

docs/DeveloperGuide.adoc


 image::UndoRedoState4.png[]

-Step 6. The user executes `clear`, which calls `Model#commitAddressBook()`. Since the `currentStatePointer` is not pointing at the end of the `addressBookStateList`, all address book states after the `currentStatePointer` will be purged. We designed it this way because it no longer makes sense to redo the `add n/David ...` command. This is the behavior that most modern desktop applications follow.
+Step 6. The user executes `clear`, which calls `Model#commitMoneygowhere()`. Since the `currentStatePointer` is not pointing at the end of the `MoneygowhereStateList`, all address book states after the `currentStatePointer` will be purged. We designed it this way because it no longer makes sense to redo the `add n/David ...` command. This is the behavior that most modern desktop applications follow.


Nanosync · 2019-10-23T13:48:55Z

docs/DeveloperGuide.adoc

 ** Cons: We must ensure that the implementation of each individual command are correct.

 ===== Aspect: Data structure to support the undo/redo commands

 * **Alternative 1 (current choice):** Use a list to store the history of address book states.
 ** Pros: Easy for new Computer Science student undergraduates to understand, who are likely to be the new incoming developers of our project.
-** Cons: Logic is duplicated twice. For example, when a new command is executed, we must remember to update both `HistoryManager` and `VersionedAddressBook`.
+** Cons: Logic is duplicated twice. For example, when a new command is executed, we must remember to update both `HistoryManager` and `VersionedMoneygowhere`.


same as above

…ntation

Nanosync · 2019-10-23T16:31:50Z

docs/diagrams/AddReminderSequenceDiagram.puml

+[-> LogicManager : execute("reminder d/today m/Pay bill")
+activate LogicManager
+
+LogicManager -> MoneyGoWhereParser : parseCommand("reminder d/today m/Pay bill")


SpendingBookParser

Nanosync · 2019-10-23T16:32:47Z

docs/DeveloperGuide.adoc

+[NOTE]
+The above sequence diagram demonstrates how a new reminder is constructed from valid user input.
+
+Following is the activity diagram including the series of actions performed by MoneyGOWhere when it receives `DeleteReminderCommand`


MoneyGoWhere typo

…the configuration

minpyaemoe added 2 commits October 23, 2019 18:54

added commands for reminders in UG and amended DG for MoneyGoWhere

4da1351

fixed Merge conflict in User Guide

3d73b6f

minpyaemoe added the type.Documentation Improvements or additions to documentation label Oct 23, 2019

Nanosync requested changes Oct 23, 2019

View reviewed changes

minpyaemoe added 2 commits October 24, 2019 00:08

fixed overlooked discrepencies in DG and added reminder feature imple…

df0c3aa

…ntation

added new line for two new activity diagram

7fe834b

Nanosync reviewed Oct 23, 2019

View reviewed changes

amended according to review and and shifts the reminde feature below …

ddd5af5

…the configuration

Nanosync approved these changes Oct 24, 2019

View reviewed changes

Nanosync merged commit 404e929 into AY1920S1-CS2103T-F13-3:master Oct 24, 2019

nus-se-bot mentioned this pull request Oct 25, 2019

Feedback on week 10 project progress for CS2103T-F13-3 #111

Open

23 tasks

choongyx added this to the v1.3 milestone Oct 30, 2019

nus-se-bot mentioned this pull request Oct 31, 2019

Feedback on week 11 project progress for CS2103T-F13-3 #151

Open

27 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

added commands for reminders in UG and amended DG for MoneyGoWhere #95

added commands for reminders in UG and amended DG for MoneyGoWhere #95

minpyaemoe commented Oct 23, 2019

Nanosync left a comment

Nanosync Oct 23, 2019

Nanosync Oct 23, 2019

Nanosync Oct 23, 2019

Nanosync Oct 23, 2019

Nanosync Oct 23, 2019

Nanosync Oct 23, 2019

Nanosync Oct 23, 2019

Nanosync Oct 23, 2019

Nanosync Oct 23, 2019

Nanosync Oct 23, 2019

Nanosync Oct 23, 2019

Nanosync Oct 23, 2019


		These operations are exposed in the `Model` interface as `Model#commitAddressBook()`, `Model#undoAddressBook()` and `Model#redoAddressBook()` respectively.
		These operations are exposed in the `Model` interface as `Model#commitmoneygowhere()`, `Model#undomoneygowhere()` and `Model#redomoneygowhere()` respectively.


		Step 5. The user then decides to execute the command `list`. Commands that do not modify the address book, such as `list`, will usually not call `Model#commitAddressBook()`, `Model#undoAddressBook()` or `Model#redoAddressBook()`. Thus, the `addressBookStateList` remains unchanged.
		Step 5. The user then decides to execute the command `list`. Commands that do not modify the address book, such as `list`, will usually not call `Model#commitMoneygowhere()`, `Model#undoMoneygowhere()` or `Model#redoMoneygowhere()`. Thus, the `MoneygowhereStateList` remains unchanged.

added commands for reminders in UG and amended DG for MoneyGoWhere #95

added commands for reminders in UG and amended DG for MoneyGoWhere #95

Conversation

minpyaemoe commented Oct 23, 2019

Nanosync 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