[CS2113T-F11-1] nocap

.gitignore

@@ -13,5 +13,8 @@ src/main/resources/docs/
 *.iml
 bin/
 
+# Data files
+data/*
+
 /text-ui-test/ACTUAL.txt
 text-ui-test/EXPECTED-UNIX.TXT

META-INF/MANIFEST.MF

@@ -0,0 +1,3 @@
+Manifest-Version: 1.0
+Main-Class: command.NoCap
+

build.gradle

@@ -12,6 +12,12 @@ repositories {
 dependencies {
     testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter-api', version: '5.5.0'
     testRuntimeOnly group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: '5.5.0'
+    implementation group: 'com.fasterxml.jackson.core', name: 'jackson-databind', version: '2.13.0'
+    implementation group: 'com.fasterxml.jackson.datatype', name: 'jackson-datatype-jsr310', version: '2.13.0'
+    // https://mvnrepository.com/artifact/com.fasterxml.jackson.core/jackson-annotations
+    implementation group: 'com.fasterxml.jackson.core', name: 'jackson-annotations', version: '2.13.0'
+
+
 }
 
 test {
@@ -29,11 +35,11 @@ test {
 }
 
 application {
-    mainClassName = "seedu.duke.Duke"
+    mainClassName = "command.NoCap"
 }
 
 shadowJar {
-    archiveBaseName = "duke"
+    archiveBaseName = "NoCap"
     archiveClassifier = null
 }
 
@@ -43,4 +49,5 @@ checkstyle {
 
 run{
     standardInput = System.in
+    enableAssertions = true
 }

docs/AboutUs.md

@@ -2,8 +2,8 @@
 
 Display | Name | Github Profile | Portfolio 
 --------|:----:|:--------------:|:---------:
-![](https://via.placeholder.com/100.png?text=Photo) | John Doe | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Nai Jie | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
 ![](https://via.placeholder.com/100.png?text=Photo) | Don Joe | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
 ![](https://via.placeholder.com/100.png?text=Photo) | Ron John | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
 ![](https://via.placeholder.com/100.png?text=Photo) | John Roe | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
-![](https://via.placeholder.com/100.png?text=Photo) | Don Roe | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Zeng Jiexiong | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)

docs/README.md

@@ -1,8 +1,142 @@
-# Duke
+# User Guide
 
-{Give product intro here}
+NoCap (NC) is a **desktop app for managing modules taken in NUS, optimized for use via a Command Line Interface** (CLI). If you can type fast, NC can get your module management tasks done faster than traditional GUI apps. It is the perfect app for NUS students!
+
+* Features
+    * Viewing help : `help`
+    * Adding a module: `add <module>`
+    * Deleting a module : `delete <module>`
+    * Adding tasks for a module : `/m <module> addtask <description>`
+    * Adding grade for a module : `/m <module> addgrade <grade letter>`
+    * Adding classes for a module : `/m <module> addclass <description> /on <day> /at <period>`
+    * Deleting tasks for a module : `/m <module> deletetask`
+    * Deleting grade for a module : `/m <module> deletegrade`
+    * Deleting classes for a module : `/m <module> deleteclass `
+    * Show mod info : `/m <module> info`
+    * Show timetable : `timetable`
+    * Show modules : `list module`
+    * Show tasks : `list task`
+    * Exit : `exit`
+
+
+
+# Quick start
+
+1. Ensure you have Java `11` or above installed in your Computer. If you are unsure, follow this link: [https://java.com/en/download/help/version_manual.html](https://java.com/en/download/help/version_manual.html). If you do not have Java 11 installed you can download the latest version of java from this link: [https://www.oracle.com/java/technologies/downloads/#java11](https://www.oracle.com/java/technologies/downloads/#java11)
+2. Download the latest version of NoCap from this link here : <span style="text-decoration:underline;">link</span>
+3. Copy the file to the folder you want to use as the _home directory _for your NoCap.
+4. Open Command prompt and change directory to the home directory for NoCap using the `cd` command.
+5. Launch NoCap using the command `java NoCap`
+6. Type the command in the command box and press Enter to execute it. e.g. typing `help` and pressing Enter will open the help window. \
+   Some example commands you can try:
+    * `timetable` Shows timetable for the semester
+    * `'list` task Shows all the tasks what you have
+    * `/m <module name> info` Shows all module related information
+7. Refer to the <span style="color:blue">Features</span> below for details of each command.
+
+
+# Features
+
+### **Command format:**
+
+* Words in `UPPER_CASE` are the parameters to be supplied by the user. \
+  e.g. `add MODULENAME` MODULENAME is the name of the module supplied by the user.
+* Items in curved brackets describe the input format. \
+  e.g.` MODULENAME addtask DESCRIPTION /by DATE(DDMMYY)` DDMMYY refers to the date-month-year of the description.
+* Parameters must be in the exact order as seen in the user guide. \
+  e.g. if the command specifies `CS2113 addclass tutorial /on Wednesday /at 23:00, CS2113 addclass /at 23:00 tutorial /on Wednesday` is not acceptable.
+* Extraneous parameters for commands that do not take in parameters (such as `help`, `timetable `and `exit`) is not acceptable. \
+  e.g. if the command specifies `help 123`, there will be an error.
+
+## Viewing help : `help`
+Shows a message explaining how to use NoCap  
+Format: `help`
+
+## Adding module: `add <module>`
+Adds a module  
+Format: `add MODULENAME`  
+Examples:
+* `add CS2113T`
+* `add MA1508`
+
+## Delete module: `delete <module>`
+Deletes a module
+Format: `delete MODULE`
+Examples:
+* `delete CS2101`
+* `delete CS2113T`
+
+## Add class : `/m <module> addclass`
+Adds a class to a module  
+Format: `MODULENAME addclass DAY/STARTIME/LOCATON/COMMENTS`  
+Examples:
+* `CS2113 addclass MON/0800/E4-02/LAB`
+* `MA1508 addclass WED/1000/ZOOM/TUTORIAL`
+
+## Add task : `/m <module> addtask `
+Adds a task to a module  
+Format: `/m MODULENAME addtask DESCRIPTION /by DATE(DDMMYY)`  
+Examples:
+* `/m CS2113 addtask finish tutorial hwk /by 030321`
+* `/m MA1508 addtask do assignment 4 /by 240921`
+
+## Add grade : `/m <module> addgrade `
+Adds a grade to a module   
+Format: `/m MODULENAME addgrade DESCRIPTION`  
+Examples:
+* `/m CS2113 addgrade A`
+* `/m MA1508 addgrade B-`
+
+## Add credit : `/m <module> addcredit`
+Adds a credit to a module   
+Format: `/m MODULENAME addcredit DESCRIPTION`  
+Examples:
+* `/m CS2113 addcredit 4`
+* `/m CG1111 addcredit 6`
+
+## Delete classes: `/m <module> deleteclass`
+Deletes all classes from a module  
+Format: `/m MODULENAME deleteclass`  
+Example:
+* `/m CS2113 deleteclass`
+
+## Delete tasks: `/m <module> deletetask`
+Deletes all tasks from a module  
+Format: `/m MODULENAME deletetask`  
+Example:
+* `/m CS2113 deletetask`
+
+## Delete grade: `/m <module> deletegrade`
+Deletes grade from a module   
+Format: `/m MODULENAME deletegrade`  
+Examples:
+* `/m CS2113 deletegrade`
+
+## Listing tasks : `list task`
+Shows a list of all tasks   
+Format: `list task`
+
+## Listing module : `list module`
+Shows a list of all modules   
+Format: `list module`
+
+## Show module information : `/m <module> info`
+Prints out information regarding the module. Information includes undone tasks, class information and grades attained so far.   
+Format: `/m MODULE info`  
+Examples:
+* `/m CS1010 info`
+```
+**EXAMPLE**
+```
+
+## Show timetable : `timetable`
+Prints out timetable.   
+Format: `timetable`
+```
+**OUTPUT EXAMPLE**
+```
+
+## Exiting the program : `exit`
+Exits the program.   
+Format: `exit`
 
-Useful links:
-* [User Guide](UserGuide.md)
-* [Developer Guide](DeveloperGuide.md)
-* [About Us](AboutUs.md)

docs/UserGuide.md

@@ -3,6 +3,7 @@
 ## Introduction
 
 {Give a product intro}
+NoCap is your personal 
 
 ## Quick Start
 

docs/_config.yml

@@ -0,0 +1 @@
+theme: jekyll-theme-cayman

docs/media/OverallTaskClassDiagram.drawio

@@ -0,0 +1 @@
+<mxfile host="Electron" modified="2021-10-25T14:01:31.421Z" agent="5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/15.4.0 Chrome/91.0.4472.164 Electron/13.5.0 Safari/537.36" etag="WCsu1tbhl6FkZwzfvHFW" version="15.4.0" type="device"><diagram id="C5RBs43oDa-KdzZeNtuy" name="Page-1">7Vptc+I2EP41zKSdoeMXTMhHDAnXO+5KLumlX4UtjIpsObYIIb++K1t+wwIcApfJlU+glbSS9nm0Wq3VMgf+8yhC4fwrczFtGZr73DKHLcPQNaMDP0KyTiXWlZEKvIi4slEhuCMvOOsppUvi4rjSkDNGOQmrQocFAXZ4RYaiiK2qzWaMVkcNkYdrgjsH0br0gbh8nkp7xmUh/4SJN89G1rtXaY2PssZyJfEcuWxVEpnXLXMQMcbTf/7zAFNhvMwuD3+uH+h40R19vo0f0d/2l/tvP9qpspvXdMmXEOGAH6z6ZTG7+fSj8+8/4eTmdqWN+tPPbdlFe0J0Ke311xOOEKX3KF6MSczl0vk6s2e8Ij5FAZTsGQv4nawBa9iIEi+A/w5ME0cgAFWcABR9WcFZCFJnTqg7Rmu2FIuJOXIWWcmes4i8gFpEoUoHAVRHXLLK6FZa3ImeINZAGuEY2kwyC+m5aIxiLts4jFIUxmSaTFg08VHkkcBmnDM/U8SWgYtdWcohTwo8YoucRKJ/Q1wkfsIa+LnESonTCDMf82gNTbLansRF7jm9I8urgsGGJmXzMnstuTmR3DVerjsf7jvsMhR4YIR8PMPcP57eVYwHiFSGQxSADxDHtjBjXOYj/CkttRAlLH0FYzs1xtYoSklCzzn3CxZtQpdxleIZVzDVJ64r1NlxiBwSePeCucO2XkjGScehWUi+S7uYCY044ihlmuAORVNMJywmnDChP0rb2iEjAU+MZ9kta5hIIj5gAcwYkYRVGBi8woLFCr7t3NT7+bauwriPXr3t5KrAvANTfEseB0bviZqPj7PbwJ08aF/aVwpMYbHahi+68Jm7pDhxS2a/JZwwTNzUhYG/5lW/1fgAVuA5CQaMMvBNw4ClPoxQuiHaQ43UiVVZ0KmzQIgY9J3RxIHMgVA4UDCjygAb1jTQ/rAEF4wBlPWi3JAeNdibMmYrPcxOM3p0uifih17jR1sM47p9SgvgBU3iixInNulS5kgieGIw7Jktx2VLr+FZdTK2mFu8SRiBDfqpO4kvzhQ4HQX0pgfKZvxwCAeU89MvdwW2TYNa7RzUHi+otbReNcjUFI5CNxQkudIOCWot6+MEtXpPecLBxdmJSJjEjBDtJA7rjoMb87a5rA/uivb6nXxfvym2VbLsVMdR/cKSQAt8yjEdM8BoCJJ74uNfFNpDTpkU7a3QZpfdd4PWUkJL4qGICzJwp4xRjIIzrE1hvey9M6xdJazpbeIb8gtof2lffAJkdU1xk/yp0NbDwnTHjiLkpsY8b9lDgDWbxnKnAlYdQJF4LM7ZM6gHgWr9xNBJOUFDdZU/J3vfGBHrvYZx0xHSvWpYVTn8jXwvlC64+E32bioZ1HJ7yWlcOoq35n4/+O4+BQuuGrpsa8ft+21Z3frHRyUNPHk23+d0KPFgVK4UDNH+X8w4gd83VF8bT8UMtYOoR+A1+HDg9sXzACixMLH1nrxWNQkG3W8IzY4M7Ho4S/phOmWr60JgJwKoyKjx6hxZzJaRg3esV9qRo8jDTXa5mO7OPS4JIahUToF15IQiTBEnT9UXEjuyaxPB2kKtufl5OnsSkqlIFyx7FVyoKbI6exSlFtmvqL2hyNzQw2azGFdUHCtzZ9RvFBnqBVeTrG3JC+zxOVOZu00DCRs5Cy8h7+aXCJGpTpPIutX8qMg2l3xwI6fVyp+5NM/ott9Ip7Wywwmxql8Sfm+MVRbEHQGs3nuAdZyt367m8Dtvhw6KxROqtHnxEM28/g8=</diagram></mxfile>

docs/media/OverallTaskConstructorGradableTaskSourceSequenceDiagram.txt

@@ -0,0 +1,7 @@
+title OverallTask Constructor
+
+participant ":OverallTask" as OverallTask
+[->*OverallTask: new OverallTask(Gradable Task, Module Name)
+activate OverallTask
+OverallTask -->[:
+deactivate OverallTask

docs/media/OverallTaskConstructorTaskSequenceDiagramSource.txt

@@ -0,0 +1,7 @@
+title OverallTask Constructor
+
+participant ":OverallTask" as OverallTask
+[->*OverallTask: new OverallTask(Task, Module Name)
+activate OverallTask
+OverallTask -->[:
+deactivate OverallTask

docs/media/OverallTaskListConstructorSequenceDiagramSource.txt

@@ -0,0 +1,12 @@
+title Constructor
+
+participant ":OverallTaskList" as OverallTaskList
+
+[->*OverallTaskList: new OverallTaskList(module list)
+activate OverallTaskList
+OverallTaskList->OverallTaskList:addAllModuleListTasks()
+activate OverallTaskList
+OverallTaskList-->OverallTaskList:
+deactivate OverallTaskList
+OverallTaskList -->[:
+deactivate OverallTaskList

docs/media/ParserClassDiagram.drawio.xml

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<mxfile host="app.diagrams.net" modified="2021-10-25T07:20:01.553Z" agent="5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/95.0.4638.54 Safari/537.36" etag="yjQIaG1W3Es8PBli0DQY" version="15.5.9" type="google" pages="2"><diagram id="kgpKYQtTHZ0yAKxKKP6v" name="Class Diagram">7VrbctowEP0aHtPBNr7wmJCETHNtSSdNXjqqLbCKbFFZBMjXVw5yfJG4NBiLdvKEtVrb0jmro12ZltWL5n0KJuE1CSBume1g3rJOW6Zp2IbHf1LLYmnx2sIwoigQTrlhgF6gMLaFdYoCmJQcGSGYoUnZ6JM4hj4r2QClZFZ2GxJcfusEjKBkGPgAy9YHFLBQzMJu5/YLiEZh9majLXoikDkLQxKCgMwKJuusZfUoIWx5Fc17EKfgZbgs7ztf0fs2MApjts0N9CmkJ6Ob6y9g0R32neT3528PRxnMzwBPxYzFaNkig4CSaRzA9CntlnUyCxGDgwnw094ZJ53bQhZh3jL4pTwqMdBnSBmcF0xilH1IIsjogruIXssVgxIh0+mI9iwnwPKELSyAb2VQA0H66O3ZOS78QkDzNzBZEiow4HEimoSykIxIDPBZbj0p45b7XBEyEWj9gowtRNCDKSNlLOEcse/p7Z9s0Xos9JzOxZNfG4usEfP5Fm5Km4/Fvvy211Z230reEjKlPlyHjViVgI4gW+PXWfqluK2NAgoxYOi5vP7qZ1SK+xvS48GsO/g7Rjn4LUXwG6Yi+J19xb4lIcVVfsrx0Q2VWYGq4zUI1ctFuOg/3gUoGpzdh93+8dEROJK180Mlyqu/qBJKCA1dKnHZv/zx5NPx2LGHtxQ/xVcDopnQAp05uRsINUp05uyuJbSCdm0Mr9YTXbLfkcTsDtAEUu1iVtX9RsVMCZUtQXUKGDwQuOxuGS5HO1yGo1MrjPdoRfs9WvEeaXC2lIbuQaWIpt6kvwH1Tzgj7DitkrnBxyBJkJ+ZzxF+G1IcZE4xieHSIvqbCQxttYMyR7E3yF9t69j9BxayEqHDqvUcaSe7Qgk70J2s0Y1fmfS6hyN72y6Aiu65Daa9rrwklKhqrWOy5LLAaW0cmXviqBxSCaNkDHsEE8otARyCKWZ7Z1Lp5+nUMlfSsqWO9ULojxPtalYtY/Tn5Z4EWJ+CAPzE8B4kY+2AVQ+xbO2AdSXAbvl0AMYpXunGqR0z7+BqZUM+Ts7Si3YvzauhvDT5ZFkZmrLGiVR7yPPsiglgNIp50+cQ8ldYJyl0yAf4WHREKAhet2UVF2W26shgrM3faxwFG1YNbNzY+PLGv/0y6AZfn7x79+pi0FEseeP/Rb9b+VrWNZtDX5n7f3wqWwnNtp/KXGVWoyt57GgltI5c09xPPbATx01lkep6QBbEIqdC6Q6rqNtIYr0lwrbkai321g2ysP31SBSBONCeuFWrg0aT3XUHVQWsDjbLbRQsdVTr3Qlq2NqNDRJSOOnOj8Pzw245TdxVZVarxxZbiL2jyrzeyucLFgWHCUExSwpPvksNhYK1km+6XuVvZxV/x17rzy+WI8jD8m0qO0SqclnXsaSl9augeOtif5+nI7yZ/7dwiWv+D03r7A8=</diagram><diagram id="GpTZoK-_EEyQiMjIXh8K" name="splitString">7Zldb5swFIZ/TaTtohLYIQmX+WjXm0qVsqlSbyYXO+DV2Mg4TdJfP7uY8GHarB9hUptWiuAF2/L7nAMnJwM4T7c/JMqSK4EJGwAPbwdwMQAgDAP9aYRdIfgesEosKbZaJSzpIylvtOqaYpI3blRCMEWzphgJzkmkGhqSUmyat60Ea66aoZg4wjJCzFVvKFZJoU7AuNIvCY2TcmV/FBZXUlTebHeSJwiLTU2C5wM4l0Ko4ijdzgkz5pW+nJ3BJZj+SX6PxttFNl/ni834rJjs4jVD9luQhKs3T72YXt3eXU4fb6YL/vgruAsuprd2iPeA2Nr6ZfeqdqWBm4QqssxQZM43OkgGcJaolOkzXx+iPCuwreiW6KVmuZLinswFE1KrXHA9bmaXIVKRbYvLgU35e6d1iBKREiV3elw5ize2W7DxCaA931SwR0OrJTXQexHZAIv3k1cm6gPr4ys89R1PGc2ViXuU3xtvhVR3O4wUcbyWYs2xcXHhadMOOL8SXJU2Y7JCa6Yc+yt9RRlz1aNx8YMmFzh2ucBJF5djYQHPYPkyCIaBi8AHfSKADoKvlBIgPMwDdD6qjsVj6PD4EiCGoAkiKEuaemL4fYIInkmMT4ugnQv/H8GoE8HPXeZmgjZDNb3urHnqlg4AXAXm31RMjMZca5F2kOiLM+Mv1RXr1F5IKcZmrU7CzRioQ9ZrFH9HfalMWg+x0AU36uAGj8Vt3MltQfJI0kxRwU/4avjgMGjh66gJYJ/8Jqe8+ydwfhNc0FFP95p34SnvXlNyQO8gvrBPfOW79aVv/oTjqenAVGwwypMnE/0mSKNfI6W58CcFeHCPt+y6gBcptGsOgp22ztsI1AwOOgwuNUkYUvShuWaX63aFa0G5qr8XW4CH7fZCLtYyInZYvU3TnikYHZhJIRkT5cz0FAb7jb8jMtz+xSkyPjAyAvBRkeHMdOzIcFsoecaoWipJefztuxmf6w/9TGYapWnWStP2Sog5prJogtH0nd8t+20wOunod1RMvXZRfLeN8jKGAkBOIsHxZyDQVbN+EAF9WjX0i7ypfhaB538B</diagram></mxfile>

docs/media/ParserSequenceDiagramSource.txt

@@ -0,0 +1,52 @@
+title Parser
+
+actor Actor
+participant NoCap
+participant parse Parser
+participant list ListParser
+participant allTaskList OverallTaskList
+
+activate NoCap
+NoCap->*parse Parser:Parser()
+activate parse Parser
+parse Parser->*list ListParser:ListParser()
+activate list ListParser
+parse Parser<--list ListParser:
+deactivate list ListParser
+parse Parser-->NoCap:
+deactivate parse Parser
+
+Actor->NoCap: Input
+loop !parse.isExit()
+NoCap->parse Parser:chooseTask()
+activate parse Parser
+
+parse Parser->parse Parser:splitInput()
+activate parse Parser
+parse Parser-->parse Parser:
+deactivate parse Parser
+
+parse Parser->parse Parser:splitInput()
+activate parse Parser
+parse Parser-->parse Parser:
+deactivate parse Parser
+
+parse Parser->list ListParser:overallListParser()
+activate list ListParser
+
+list ListParser->*allTaskList OverallTaskList:OverallTaskList()
+activate allTaskList OverallTaskList
+list ListParser<--allTaskList OverallTaskList:
+deactivate allTaskList OverallTaskList
+
+list ListParser->allTaskList OverallTaskList:sortByDateAndPrint()
+activate allTaskList OverallTaskList
+list ListParser<--allTaskList OverallTaskList:
+deactivate allTaskList OverallTaskList
+
+list ListParser-->parse Parser:
+deactivate list ListParser
+parse Parser-->NoCap:
+deactivate parse Parser
+
+end

docs/media/StorageDecoderSequenceDiagramSource.txt

@@ -0,0 +1,45 @@
+title StorageDecoder
+
+
+participant "<<Class>> \n StorageDecoder" as StorageDecoder
+
+participant ":ObjectMapper" as ObjectMapper
+
+participant ":SemesterList" as SemesterList
+
+StorageDecoder<-[: DecodeJsonToSemesterList()
+
+activate StorageDecoder
+
+alt No save file found
+StorageDecoder->*SemesterList: SemesterList()
+activate SemesterList
+SemesterList-->StorageDecoder:
+deactivate SemesterList
+StorageDecoder-->[: new semester list
+
+else else
+StorageDecoder->*ObjectMapper:new ObjectMapper()
+activate ObjectMapper
+ObjectMapper-->StorageDecoder:
+deactivate ObjectMapper
+
+StorageDecoder->ObjectMapper:readValue()
+activate ObjectMapper
+ObjectMapper-->StorageDecoder:decoded semester list
+deactivate ObjectMapper
+destroyafter ObjectMapper
+StorageDecoder-->[: decoded semester list
+end 
+deactivateafter StorageDecoder
+
+
+
+
+
+
+
+
+
+
+