ShannonWong - Project Portfolio

PROJECT: SHOCO

Overview

SHOCO is a desktop application used for the managing and planning of shopping lists and budget. Users interact with it through the use of a command-line interface (CLI) and the program is written in Java.

Summary of Contributions

• Major enhancement 1: Included the ability to mark and unmark items in the shopping lists.
  • What it does: Allows the users to mark items that are listed as unbought in the list. Allows users to unmark items that are listed as bought in the list as well.
  • Justification: This feature allows the user to see the items that have bought and thus filter out
  • Highlights: This features allows the user mark or unmark any item in the list based on index, making it easy to navigate. Even if the item is marked already, using the marked feature will still show the success message, providing the user assurance that it has been marked as bought already. This applies to the unmark feature.

• Minor enhancement 1: Negative indexes or indexes greater than the size of the list are not accepted. This is for a realistic approach as items that do not exist in the list cannot be marked as done in real life, neither do negative indexes exist in real life.

• Major enhancement 2: Included the ability to reset the budget.
  • What it does: Allows the users to set their budget back to the default value of $0.00
  • Justification: This helps the user to be able to start over in their budgeting so that they are better able to plan their grocery trips with a clear organisational plan and budgeting.
  • Highlights: While set budget requires the user to know the amount of budget before using, resetting the budget back to $0.00 can allow the user to see and have a better idea of how much budget they will need approximately, assuming that the items needed are recorded in the list already.

• Code contributed: [Functional code]

• Other contributions:

  • Documentation:

    • Wrote details about developer and user guide (creators & date) (Pull request #167)
    • Rearranged and synced the order of both developer and user guide (Pull request #167 and #166)

  • Developer Guide:

    • Wrote the overview description for the developer guide (Pull request #131)
    • Wrote the sections outlining the interactions between different classes for the mark, unmark and reset budget features, including design considerations for the features mentioned (Pull request #103 and #166)
    • Added sequence diagrams to mark, unmark and reset budget features (Pull request #103 and #166)
    • Wrote to appendix B (Pull request #103)
    • Edited Help feature sequence diagram, removed activation bar. (Pull request #166)
    • Wrote test instructions for mark, unmark and reset budget features. (Pull request #167)

  • Team-based tasks:

    • Resolved Checkstyle violations in some parts of the code. (Pull request #46)
    • Added in the Display feature inside the Help Command. (Pull request #81)
    • Edited the expected output test file to reflect the change of the help command output. (Pull request #81)

  • Review/Mentoring contribution:

    • PRs reviewed, some with suggestions for changes. (Pull requests #38, #92 and #120)

  • Beyond the project team:

    • Reported feature flaws, documentation bugs and functionality bugs of varying severity for other project teams. (Pull requests #1 - #7)

Contributions to the User Guide

Shown below are the sections that I have contributed to the User Guide. They showcase my ability to write documentation targeting end-users.

By: Team SHOCOTech

Since: Feb 2020

Creators: Tan Kok Joon, Labi Trisha Angelica Vergara, Loh Ching Wei, Joshua, Phoon Jia Juin, Wong Jin En, Shannon

Marking an item as bought: MARK

Marks an item from the list at the specified index as bought. When first added initially, the item will have the status [X] to indicate that it is un-marked. After marking the item as bought, the status of item becomes [B].

Format: MARK INDEX

• The INDEX should be a positive whole number.
• The INDEX should not be out of bounds of the shopping list.
  • Out of bounds indices include negative indices & indices that are greater than the size of the shopping list.
• Indices that are not numbers or are out of bounds will produce an error message indicating the error of the index.
• Marking an item whose status was previously [B] will be successful, assuring the success of the mark command executed.

Example of the usage:

1. MARK 5
   • This marks the 5th item in your list as bought.
   • The status of the 5th item is now [B]

🠝 back to top

Un-marking a marked item: UNMARK

Un-marks a marked-as-bought item from the list at the specified index. After being marked as bought, the item will have the status [B] to indicate that it is marked as bought. After un-marking the marked-as-bought item, the status of the item becomes [X].

Format: UNMARK INDEX

• The INDEX should be a positive whole number.
• The INDEX should not be out of bounds of the shopping list.
  • Out of bounds indices include negative indices & indices that are greater than the size of the shopping list.
• Indices that are not numbers or are out of bounds will produce an error message indicating the error of the index.
• Un-marking an item whose status was previously [X] will be successful, assuring the success of the un-mark command executed.

Example of the usage:

1. UNMARK 3
   • This marks the 3rd item in your list as not bought yet.
   • The status of the 3rd item is now [X]

Resetting a budget: RES

Resets the budget to be $0.00 for the user.

Format: RES

Contributions to the Developer Guide

Shown below are sections I contributed to the Developer Guide. They showcase my ability to write technical documentation and the technical depth of my contributions to the project.

By: Team SHOCOTech

Since: Feb 2020

Creators: Tan Kok Joon, Labi Trisha Angelica Vergara, Loh Ching Wei, Joshua, Phoon Jia Juin, Wong Jin En, Shannon

2. Overview of the SHOCO application

The overview of the main classes in the application are shown in the class diagram below. Omitted are the classes for the features implemented, the LoadData class, WriteData class, FileUtil class and CommandLineTable class.

3.6 Mark and Unmark feature

3.6.1 Current Implementation

The mark and unmark feature is implemented using the MarkCommand and UnmarkCommand class which extends the main Command class with an index representing that of the item to be marked or unmarked as bought in the list.

The process is as follows:

1. Duke first receives user input from Ui
2. Duke creates a Parser object and calls its Parser#parseCommand() method to instantiate a MarkCommand / UnmarkCommand object based on the user input
3. Duke then calls the MarkCommand#execute() / UnmarkCommand#execute() method.
4. MarkCommand#execute() / UnmarkCommand#execute() makes a call to the ShoppingList#markAsBought() / ShoppingList#unmarkAsBought() method with the specified index.

The following sequence diagram below shows how the Mark feature (Diagram 1) and Unmark feature (Diagram 2) works. Note the Ui class is omitted in the sequence diagram to emphasise on the other classes:

Diagram 1:

Diagram 2:

3.6.2 Design Considerations

Aspect: Data structure to support the Mark and Unmark Feature

• Alternative 1 (current choice): Object-oriented style with a separate class for MarkCommand and UnmarkCommand

  • Pros: Easy to edit and add the mark and unmark feature without having to change the logic of the code in multiple files

  • Cons: Might significantly increase the code base with another class being added

• Alternative 2: Implement the mark and unmark feature in either the Duke or Parser class

  • Pros: Will have less code and classes to deal with, without having to create a whole new object to execute the command.

  • Cons: Code becomes harder to navigate and understand since the command is all handled under one class, thus makes having to edit the mark and unmark feature difficult.

Reasons for choosing alternative 1: By having an individual class on it’s own, any bugs found in the mark and unmark feature can be found easier and therefore helps to resolve the issue more efficiently. Also, with the feature being implemented in an object-oriented style, reading and tracing the application code would be easier, thus making adding future features to the mark and unmark feature easier as well.

3.10 Reset budget feature

3.10.1 Current implementation

The reset budget feature is implemented using a ResetBudgetCommand class which extends the main Command class with a variable representing the budget amount.

The process is as follows:

1. Duke first receives user input from the Ui class.
2. Duke creates a Parser object and calls Parser#parseCommand() method to instantiate a ResetBudgetCommand object based on that user input.
3. Duke then calls the ResetBudget#execute() method.
4. ResetBudget#execute() makes a call to the Budget#resetBudget() method to set the existing budget to $0.00.

The following sequence diagram below shows how the reset budget feature works. Note the Ui class is omitted in the sequence diagram to emphasise on the other classes:

3.10.2 Design considerations

Aspect: Data structure to support the reset budget feature

• Alternative 1 (current choice): Object-oriented style with a separate class for ResetBudgetCommand.

  • Pros: Easy to add the reset budget feature without having to change the logic of the code much as each command object is treated as a black box.

  • Cons: Might significantly increase the code base with another class being added.

• Alternative 2: Implement reset budget feature in the Duke or Parser class.

  • Pros: Will have less code to deal with as a new method is simply created in the Duke class.

  • Cons: Code becomes less organised since for every other command that we have implemented, Duke class simply executes those commands as black boxes, without worrying about their internal details.

Reason for choosing alternative 1: By implementing each command type in a separate class, any bugs associated with a particular functionality will not affect other functionalities that significantly. It would also make it easier for us to work in parallel.

Appendix D: Instructions for Manual Testing

Set and Reset a budget

1. Reset the budget

   i. Test case: RES

    Expected: Budget has been reset to $0.00
   

    

   ii. Other incorrect reset budget commands to try: RES xxx (where xxx is not a number).

    Expected: An error message and the correct usage of the RES command is shown.
   

Mark and Un-mark an item

1. Marking an item

   Assumption: there are more than 5 but less than a hundred items in the list.

   i. Test case: MARK 5

    Expected: The fifth item in the list is mark as bought, denoted as [B].
   

    

   ii. Test case: MARK -10

    Expected: An error message stating that the item does not exist in the list is shown.
   

    

   iii. Test case: MARK 100

    Expected: An error message stating that the item does not exist in the list is shown.
   

    

   iv. Other incorrect MARK commands to try: MARK xxx (where xxx is not a number).

     Expected: An error message stating to provide a single numerical index number is shown.
   

    

2. Un-marking an item

   Assumption: there are more than 5 and less than a hundred items in the list.

   i. Test case: UNMARK 5

     Expected: The fifth item in the list is marked as not bought yet, denoted as [X].
   

    

   ii. Test case: UNMARK -10

   Expected: An error message stating that the item does not exist in the list is shown.
   

    

   iii. Test case: UNMARK 100

   Expected: An error message stating that the item does not exist in the list is shown.
   

    

   iv. Other incorrect UNMARK commands to try: UNMARK xxx (where xxx is not a number).

    Expected: An error message stating to provide a single numerical index number is shown.