[CS2113T-T10-3] Mod Happy

.github/workflows/gradle.yml

@@ -32,19 +32,3 @@ jobs:
 
       - name: Build and check with Gradle
         run: ./gradlew check
-
-      - name: Perform IO redirection test (*NIX)
-        if: runner.os == 'Linux'
-        working-directory:  ${{ github.workspace }}/text-ui-test
-        run: ./runtest.sh
-
-      - name: Perform IO redirection test (MacOS)
-        if: always() && runner.os == 'macOS'
-        working-directory:  ${{ github.workspace }}/text-ui-test
-        run: ./runtest.sh
-
-      - name: Perform IO redirection test (Windows)
-        if: always() && runner.os == 'Windows'
-        working-directory:  ${{ github.workspace }}/text-ui-test
-        shell: cmd
-        run: runtest.bat

.gitignore

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

README.md

@@ -1,4 +1,5 @@
-# Duke project template
+# Duke project template. 
+test
 
 This is a project template for a greenfield Java project. It's named after the Java mascot _Duke_. Given below are instructions on how to use it.
 
@@ -9,7 +10,7 @@ Prerequisites: JDK 11 (use the exact version), update Intellij to the most recen
 1. **Ensure Intellij JDK 11 is defined as an SDK**, as described [here](https://www.jetbrains.com/help/idea/sdk.html#set-up-jdk) -- this step is not needed if you have used JDK 11 in a previous Intellij project.
    * In the same dialog, you _may have to set the Project language level_ field to the SDK default option.
 2. **Import the project _as a Gradle project_**, as described [here](https://se-education.org/guides/tutorials/intellijImportGradleProject.html).
-3. **Verify the set up**: After the importing is complete, locate the `src/main/java/seedu/duke/Duke.java` file, right-click it, and choose `Run Duke.main()`. If the setup is correct, you should see something like the below:
+3. **Verify the setup**: After the importing is complete, locate the `src/main/java/seedu/duke/Duke.java` file, right-click it, and choose `Run Duke.main()`. If the setup is correct, you should see something like the below:
    ```
    > Task :compileJava
    > Task :processResources NO-SOURCE
@@ -36,7 +37,7 @@ Prerequisites: JDK 11 (use the exact version), update Intellij to the most recen
 
 ### I/O redirection tests
 
-* To run _I/O redirection_ tests (aka _Text UI tests_), navigate to the `text-ui-test` and run the `runtest(.bat/.sh)` script.
+* To run _I/O redirection_ tests (aka _Text UI tests_), navigate to the `text-seedu.duke.ui-test` and run the `runtest(.bat/.sh)` script.
 
 ### JUnit tests
 

build.gradle

@@ -12,6 +12,7 @@ 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 'com.google.code.gson:gson:2.8.5'
 }
 
 test {
@@ -29,7 +30,7 @@ test {
 }
 
 application {
-    mainClassName = "seedu.duke.Duke"
+    mainClassName = "seedu.duke.Main"
 }
 
 shadowJar {
@@ -43,4 +44,5 @@ checkstyle {
 
 run{
     standardInput = System.in
+	enableAssertions = true
 }

docs/AboutUs.md

@@ -1,9 +1,9 @@
 # About us
 
-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) | 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)
+| Display                                             |     Name      |              Github Profile               |            Portfolio             |
+|-----------------------------------------------------|:-------------:|:-----------------------------------------:|:--------------------------------:|
+| ![](https://via.placeholder.com/100.png?text=Photo) |  Mu Changrui  | [Github](https://github.com/Ch40gRv1-Mu)  | [Portfolio](team/ch40grv1-mu.md) |
+| ![](https://via.placeholder.com/100.png?text=Photo) |  Yang Zikun   |    [Github](https://github.com/Yzkkk)     |    [Portfolio](team/yzkkk.md)    |
+| ![](https://via.placeholder.com/100.png?text=Photo) | Ng Yong Sheng |   [Github](https://github.com/ngys117)    |   [Portfolio](team/ngys117.md)   |
+| ![](https://via.placeholder.com/100.png?text=Photo) |  Choo Yi Kai  |  [Github](https://github.com/chooyikai/)  |  [Portfolio](team/chooyikai.md)  |
+| ![](https://via.placeholder.com/100.png?text=Photo) | Bang Hee Kit  | [Github](https://github.com/heekit73098/) | [Portfolio](team/heekit73098.md) |

docs/ClassDiagrams/CommandClassDiagram.puml

@@ -0,0 +1,66 @@
+@startuml
+'https://plantuml.com/class-diagram
+
+!define ABSTRACT {abstract}
+
+skinparam classAttributeIconSize 0
+skinparam shadowing false
+skinparam classFontSize 12
+skinparam classAttributeFontSize 12
+hide circle
+
+package command {
+    class "ABSTRACT\nCommand" as Command
+    class DeleteCommand
+    class TextUi
+    class ExitCommand
+
+    Command <|-- DeleteCommand
+    Command <|-- ExitCommand
+    DeleteCommand ..> CommandResult :creates >
+    ExitCommand ..> CommandResult :creates >
+
+    DeleteCommand ..> TextUi :uses >
+
+    class Command {
+        +execute(): CommandResult ABSTRACT
+    }
+
+    class DeleteCommand {
+    -moduleCode: String
+    -taskModule: String
+    -taskIndex: int
+    +DeleteCommand(moduleCode: String)
+    +DeleteCommand(taskModule: String, index: int)
+    +execute(): CommandResult
+    +getUserConfirmation(): String {static}
+    }
+
+    class TextUi {
+    +getUserCommand(): String {static}
+    +showMessage(): void {static}
+    }
+
+    class ExitCommand {
+    +execute(): CommandResult
+    }
+
+    class CommandResult {
+    +CommandResult(result: String)
+    +toString(): String
+    }
+}
+
+note top of command
+Note:
+This class diagram only illustrates two
+example command types for simplicity.
+end note
+
+note left of DeleteCommand
+Note:
+Dependency on TextUi is
+unique to DeleteCommand.
+end note
+
+@enduml

docs/ClassDiagrams/Components.puml

@@ -0,0 +1,13 @@
+@startuml
+
+actor user
+user --> [Ui]
+[Ui] --> [Main]
+[Main] --> [Parser]
+[Parser] --> [Command]: produces >
+[Main] --> [Command]: executes >
+[Command] --> [Main]: returns feedback to >
+[Command] --> [Storage]: writes to >
+[Command] --> [Data]: manipulates >
+[Main] --> [Storage]: reads from >
+@enduml

docs/ClassDiagrams/Data.puml

@@ -0,0 +1,87 @@
+@startuml
+
+!define ABSTRACT {abstract}
+
+skinparam classAttributeIconSize 0
+skinparam shadowing false
+skinparam classFontSize 12
+skinparam classAttributeFontSize 12
+hide circle
+
+package data {
+    class ModuleList {
+        --
+        + addModule(m: Module): Module
+        + removeModule(moduleCode: String): Module
+        + getModule(moduleCode: String): Module
+    }
+
+    class Module {
+        - moduleCode: String
+        - moduleDescription: String
+        - isGeneralTask: boolean
+        - modularCredit: int
+        --
+        + addTask(task: Task): void
+    }
+
+    class TaskList {
+        --
+        + addTask(task: Task): Task
+        + removeTask(index: int): Task
+        + addTag(tagDescription: String, index: int): Task
+        + deleteTag(tagDescription: String, index: int): Task
+    }
+
+    class Task {
+        - taskName: String
+        - taskDescription: String
+        - isTaskDone: boolean
+        - workingTime: String
+        - tags: ArrayList<String>
+        --
+        + getTaskParameterStatus(): TaskParameters
+        + toString(): String
+    }
+
+    enum "<<enumeration>>\nTaskParameters" as TaskParameters {
+        DESCRIPTION_AND_WORKING_TIME
+        DESCRIPTION_ONLY
+        WORKING_TIME_ONLY
+        NO_DESCRIPTION_OR_WORKING_TIME
+    }
+}
+
+note top of data
+Note:
+Some methods have been
+omitted from this class diagram.
+end note
+
+ModuleList --> "1..*" Module
+
+Module -r> "1" TaskList
+TaskList -r> "*" Task
+Task --u> "1" TaskParameters
+
+class Main
+hide Main attributes
+hide Main methods
+
+Main --> "1" ModuleList
+
+class Command
+hide Command attributes
+hide Command methods
+
+Command ..> ModuleList
+
+class Storage
+hide Storage attributes
+hide Storage methods
+
+Storage ..> ModuleList
+
+hide TaskParameters methods
+
+@enduml

docs/ClassDiagrams/DataAlternative.puml

@@ -0,0 +1,16 @@
+@startuml
+
+skinparam classAttributeIconSize 0
+skinparam shadowing false
+skinparam classFontSize 12
+skinparam classAttributeFontSize 12
+hide circle
+hide attributes
+hide methods
+
+ModuleList --> "*" Module
+ModuleList --> "1" TaskList
+Module -l> "1" TaskList
+TaskList -l> "*" Task
+
+@enduml

docs/ClassDiagrams/Parser.puml

@@ -0,0 +1,60 @@
+@startuml
+
+!define ABSTRACT {abstract}
+
+skinparam classAttributeIconSize 0
+skinparam shadowing false
+skinparam classFontSize 12
+skinparam classAttributeFontSize 12
+hide circle
+
+package parsers {
+    class "ABSTRACT\nParser" as Parser {
+        commandFormat: String
+        groupNames: HashSet<String>
+        parsedCommand: HashMap<String, String>
+        --
+        + parseString(str: String): HashMap<String, String>
+    }
+
+    class XYZParser {
+        + parseCommand(userInput: String): Command
+    }
+
+    class ModHappyParser {
+        - getCommandParser(commandWord: String): Parser
+        + parseCommand(userInput: String): Command
+    }
+}
+
+note top of XYZParser
+    XYZParser is any command-specific
+    parser (e.g. AddParser, TagParser)
+end note
+
+Parser <|-u- ModHappyParser
+XYZParser <. ModHappyParser: uses <
+ModHappyParser <-u- Main
+
+hide Main methods
+hide Main attributes
+
+Parser <|-- XYZParser
+
+class "ABSTRACT\nCommand" as Command {
+}
+hide Command methods
+hide Command attributes
+
+XYZCommand <.u. ModHappyParser: returns <
+Command <|-- XYZCommand
+
+hide XYZCommand methods
+hide XYZCommand attributes
+
+note bottom of XYZCommand
+    XYZCommand is any command
+    (e.g. AddCommand, TagCommand)
+end note
+
+@enduml