Project Portfolio Page – Clement Cheng

Project Nuke v2.1

Overview

Nuke v2.1 is a simple yet powerful task management application target towards NUS students. Nuke aims to provide a more efficient way to organise the user’s modules and tasks. The user interacts with Nuke using a Command Line Interface (CLI). In its latest versions, it also has a complementary Graphical User Interface version created with JavaFX, though the GUI is still in its Beta stage. Nuke is written in Java, and has about 10, 000 lines of code.

Summary of Contributions

Major Enhancements

Implemented Directory Structure of Nuke

What it does

Nuke has a directory tree structure consisting of multiple directories and sub-directories. Users can traverse about various directories (Root, Module, Category, Task and File), much like a Linux Shell.

Justification

As each item (module, category, task and file) appears to be of different hierarchy, implementing a directory tree, with each of the item as its own directory, was a decision our team has decided. Traversing about the directories not only allow users to see the overall structure of their module and task list, but also helps to shorten the command to enter, such as if adding and deleting an item in the current directory.

Highlights

Implementation of this directory structure was done about midway in the project. As such, it resulted in various changes to the way we manage the module and task entities previously. Each directory has to be attached to a parent directory, so an additional attribute needs to be considered before adding an item to its list. Considerations also need to be made to be able to obtain the current directory’s information to fill up missing attributes in the user’s commands, which was rather challenging indeed. A sudden change in the structure of the project may also implicate other features made previously, so checking needs to be done to identify any potential errors and bugs, and thereafter remedy accordingly.

Implemented Prompts on Deletion

What it does

Prompts the user to confirm the deletion of item(s), instead of deleting the items straightaway.

Justification

This implementation will greatly benefit the user, especially if they accidentally executed the delete command on the wrong item. By prompting the user to confirm the deletion, the user will have the opportunity to abort the deletion if the deletion was not intended.

Highlights

While seemingly simple, the implementation proves to be slightly difficult due to the need to manage input from prompts separately from the regular commands given by the user. Considerations need to be made to switch between parsing of regular commands and parsing of prompts. Moreover, the management of multiple deletion of matching items had been also a challenge to implement.

Supported Parsing of User Input via RegEx

What it does

Parses the user’s input by matching with Regular Expression (RegEx) patterns.

Justification

As the formats for most of Nuke’s commands contain many keywords, with a preceding prefix for most of them, manually finding each keyword via the standard String’s split and substring methods may not be ideal. Using RegEx will greatly aid the process of extracting the keywords from the user’s input by dividing each keyword into groups. RegEx also makes identifying of invalid command format or duplicated prefixes much easier.

Highlights

Using RegEx to support the parsing was challenging initially. Most commands needs to have its own unique RegEx, since they have a different command format than that of other commands. The RegEx needs to be correct, otherwise it does not serve its purpose. As such, multiple testing was done with various possible input to ensure its correctness. This had been done for each command.

Minor Enhancements

Improve the feedback messages shown to the user for invalid commands by making them more informative, so the user knows exactly where in their input was wrong.

Other Contributions

Implemented a fully functional GUI version of Nuke.

Though this was not the main focus of the project, having a GUI definitely improves the aesthetics of the application. The implementation of an auto-complete console will certainly aid the user to be able to enter their commands faster. In addition, the syntax highlighter can help user to identify mistakes in their command format at real time before they execute the command.

Project Management

• Generally oversee the progress of the entire project, and set targets for the team to complete
• Refactor code regularly

Documentation

User Guide

• Created User Guide template – #86
• Documented Add modules, categories and tasks Features – #86
• Documented Command Summary section – #198
• Documented FAQ section – #202

Developer Guide

• Created Developer Guide template – #91
• Documented Delete features including class and sequence diagrams – #93 #94 #95 #104
• Various Commands section – #205,#206, #207, #209, #210, #212
• Directory section – #219, #222, #224

Community

Bugs

• Amended bug issues in Nuke raised by other course members – #126 #129 #135 147
• Reviewed other course member’s tP – #1 #2 #3 #4 #5 #6 #7 #8 #9 #10 #11

Code Contributed

Functional and Test Code from GitHub RepoSense