[CS2113-T11-2] peNUS

.gitignore

@@ -15,3 +15,5 @@ bin/
 
 /text-ui-test/ACTUAL.TXT
 text-ui-test/EXPECTED-UNIX.TXT
+
+/data/

.vscode/settings.json

@@ -0,0 +1,10 @@
+{
+    "java.configuration.updateBuildConfiguration": "disabled",
+    "java.debug.settings.onBuildFailureProceed": true,
+    "java.project.referencedLibraries": [
+        {
+            "scope": "java",
+            "path": "src/main/resources"
+        }
+   ]
+}

build.gradle

@@ -12,6 +12,8 @@ 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'
+    // https://mvnrepository.com/artifact/com.googlecode.json-simple/json-simple
+    implementation group: 'com.googlecode.json-simple', name: 'json-simple', version: '1.1.1'
 }
 
 test {
@@ -28,12 +30,20 @@ test {
     }
 }
 
+sourceSets {
+    main {
+        resources {
+            srcDirs = ['src/main/resources']
+        }
+    }
+}
+
 application {
-    mainClass = "seedu.duke.Duke"
+    mainClass = "seedu.penus.Penus"
 }
 
 shadowJar {
-    archiveBaseName = "duke"
+    archiveBaseName = "penus"
     archiveClassifier = null
 }
 
@@ -43,4 +53,6 @@ checkstyle {
 
 run{
     standardInput = System.in
+    enableAssertions = true
 }
+

data/penus.txt

@@ -0,0 +1,4 @@
+User ### jy ### Biomedical Engineering
+Taken ### EG1311 ### 2 ### 2 ### A
+Plan ### EE2211 ### 3 ### 1
+Taken ### GESS1004 ### 1 ### 1 ### A

docs/AboutUs.md

@@ -1,9 +1,10 @@
 # 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) |    Tay Jiun Yuan    |         [Github](https://github.com/)         | [Portfolio](docs/team/johndoe.md)
+![](https://via.placeholder.com/100.png?text=Photo) |    Chia Yu Xuan     |    [Github](https://github.com/chiayuxuan)    | [Portfolio](docs/team/johndoe.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Lee Jun Hui Ansenn  |      [Github](https://github.com/ansenn)      | [Portfolio](docs/team/johndoe.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Senthilkumar Sriram | [Github](https://github.com/sriram-senthilkr) | [Portfolio](docs/team/johndoe.md)
+![](https://via.placeholder.com/100.png?text=Photo) |    Benjamin Toh     |    [Github](https://github.com/bentohset)     | [Portfolio](docs/team/johndoe.md)
+

docs/README.md

@@ -1,4 +1,4 @@
-# Duke
+# PENUS
 
 {Give product intro here}
 

docs/UserGuide.md

@@ -1,42 +1,95 @@
-# User Guide
+# 📜 PENUS User Guide
 
 ## Introduction
 
 {Give a product intro}
 
-## Quick Start
+## Table of Contents 📔
+- [Quick Start](#quick-start-⚙️)
+- [Features](#features-👾)
+    + [Initialisation: `init`](#initialisation-init)
+    + [Help: `help`](#help-help)
+    + [Add taken modules: `taken`](#add-taken-modules-taken)
+    + [Plan untaken modules: `plan`](#plan-untaken-modules-plan)
+    + [Remove a module: `remove`](#remove-a-module-remove)
+    + [Mark module as taken: `mark`](#mark-module-as-taken-mark)
+    + [View modules: `list`](#view-modules-list)
+    + [View graduation status: `status`](#view-graduation-status-status)
+    + [View module details: `details`](#view-module-details-details)
+    + [Exit: `exit`](#exit-the-program-exit)
+    + [Saving the data](#saving-the-data)
+    + [Editing the data file](#editing-the-data-file)
+- [FAQ](#faq-💻)
+- [Command Summary](#command-summary-🔑)
+
+## Quick Start ⚙️
 
 {Give steps to get started quickly}
 
 1. Ensure that you have Java 11 or above installed.
-1. Down the latest version of `Duke` from [here](http://link.to/duke).
+1. Download the latest version of `PENUS` from [here](http://link.to/duke).
 
-## Features 
+## Features 👾
 
-{Give detailed description of each feature}
+### Initialisation: `init`
 
-### Adding a todo: `todo`
-Adds a new item to the list of todo items.
 
-Format: `todo n/TODO_NAME d/DEADLINE`
+### Help: `help`
 
-* The `DEADLINE` can be in a natural language format.
-* The `TODO_NAME` cannot contain punctuation.  
 
-Example of usage: 
+### Add taken modules: `taken`
 
-`todo n/Write the rest of the User Guide d/next week`
 
-`todo n/Refactor the User Guide to remove passive voice d/13/04/2020`
+### Plan untaken modules: `plan`
 
-## FAQ
+
+### Remove a module: `remove`
+
+
+### Mark module as taken: `mark`
+
+
+### View modules: `list`
+
+
+### View graduation status: `status`
+
+
+### View module details: `details`
+
+
+### Exit the program: `exit`
+
+
+### Saving the data
+PENUS's data are saved in the hard disk automatically after exiting the program. 
+There is no need to save manually.
+
+
+### Editing the data file
+PENUS's data are saved as a .txt file in `[JAR file location]/data/penus.txt`. 
+Edits must be made according to the formatting of the data.
+
+
+
+## FAQ 💻
 
 **Q**: How do I transfer my data to another computer? 
 
-**A**: {your answer here}
+**A**: Install the app in the other computer and overwrite the empty data file it creates with the file in `/data/penus.txt` that contains the data of your previous PENUS application.
 
-## Command Summary
 
-{Give a 'cheat sheet' of commands here}
+## Command Summary 🔑
 
-* Add todo `todo n/TODO_NAME d/DEADLINE`
+| Command      | Format                                        |
+|--------------|-----------------------------------------------|
+| **init**     | `init`                                        |
+| **help**     | `help`                                        |
+| **taken**    | `taken MODULE_CODE y/YEAR s/SEMESTER g/GRADE` |
+| **plan**     | `plan MODULE_CODE y/YEAR s/SEMESTER`          |
+| **remove**   | `remove MODULE_CODE`                          |
+| **mark**     | `mark MODULE_CODE`                            |
+| **list**     | `list`                                        |
+| **status**   | `status`                                      |
+| **details**  | `details MODULE_CODE`                         |
+| **exit**     | `exit`                                        |

docs/uml/sourcecode/AddModSequence.puml

@@ -0,0 +1,63 @@
+@startuml
+participant User
+
+activate Ui
+User -> Ui: getUserCommand() "plan CS2113 y/1 s/2"
+box "Logic" #LightBlue
+Ui -> LogicManager: getCommand()
+activate LogicManager
+
+
+LogicManager -> Parser: parseCommand()
+activate Parser
+
+
+create PlanCommand
+Parser -> PlanCommand
+activate PlanCommand
+
+PlanCommand --> Parser: PlanCommand()
+deactivate PlanCommand
+
+
+Parser --> LogicManager: Command()
+deactivate Parser
+
+
+LogicManager -> PlanCommand: execute()
+activate PlanCommand
+participant CommandResult
+end box
+
+box "Model" #LightPink
+PlanCommand -> ModelManager: addModule()
+activate ModelManager
+
+ModelManager -> ModuleList: addModule()
+activate ModuleList
+
+ModuleList -> ModuleList: add()
+
+ModuleList --> ModelManager: 
+deactivate ModuleList
+
+ModelManager --> PlanCommand
+deactivate ModelManager
+
+create CommandResult
+PlanCommand -> CommandResult
+activate CommandResult
+CommandResult --> PlanCommand
+deactivate CommandResult
+
+
+PlanCommand --> LogicManager: result
+deactivate PlanCommand
+
+LogicManager --> Ui: printResult()
+deactivate LogicManager
+
+Ui --> User
+deactivate Ui
+
+@enduml

docs/uml/sourcecode/Architecture.puml

@@ -0,0 +1,50 @@
+@startuml
+!include <office/Concepts/globe_internet>
+!include <office/Concepts/documents>
+!include <office/Users/user>
+
+skinparam classAttributeIconSize 0
+hide empty members
+hide circle
+
+class "<$user>" as User 
+
+class "<$globe_internet>" as Web
+
+class "<$documents>" as Harddisk
+
+package PENUS <<rectangle>> {
+    class UI #LightGreen {
+
+    }
+    class Logic #LightBlue {
+
+    }
+    class Model #LightPink {
+
+    }
+    class Main {
+
+    } 
+    class Storage #LightYellow {
+
+    }
+    class Commons #LightCyan {
+
+    }
+}
+
+User ..> UI
+UI --> Logic
+UI --> Model
+Logic --> Model
+Logic --> Storage
+Main -> Storage
+Main -> UI
+Main -> Logic
+Main -> Model
+Web --> Commons
+Storage ..> Model
+Storage ..> Harddisk
+
+@enduml

docs/uml/sourcecode/LogicClass.puml

@@ -0,0 +1,31 @@
+@startuml
+hide empty members
+hide circle
+
+package Logic {
+    class LogicManager
+    class XYZCommand
+    class Parser
+    class "{abstract}\nCommand" as Command
+    class CommandResult
+}
+
+package Storage {}
+
+package Model {}
+
+class Main #FFFFFF
+
+Main ..> LogicManager
+LogicManager -right-> Model
+LogicManager -right-> Storage
+
+LogicManager .right.> Command : executes >
+LogicManager -left->"1" Parser
+Parser ..> XYZCommand : creates >
+Command .up.> CommandResult : produces >
+LogicManager .down.> CommandResult
+XYZCommand -up-|> Command
+note right of XYZCommand: XYZCommand = PlanCommand, \nRemoveCommand, etc
+
+@enduml