[CS2113-F13-3] NUSplanner

.gitignore

@@ -15,3 +15,12 @@ bin/
 
 /text-ui-test/ACTUAL.TXT
 text-ui-test/EXPECTED-UNIX.TXT
+
+/src/main/java/seedu/duke/*.class
+log.txt
+.gitignore
+
+log.txt.lck
+.gitignore
+save.json
+.vscode

build.gradle

@@ -3,13 +3,28 @@ plugins {
     id 'application'
     id 'checkstyle'
     id 'com.github.johnrengelman.shadow' version '7.1.2'
+    id 'jacoco'
+}
+
+jacoco {
+    toolVersion = '0.8.7'
+    reportsDir = file("$buildDir/customJacocoReportDir")
+}
+
+jacocoTestReport {
+    reports {
+        xml.enabled true
+        html.enabled true
+        csv.enabled false
+    }
 }
 
 repositories {
     mavenCentral()
 }
 
 dependencies {
+    implementation 'com.google.code.gson:gson:2.10.1'
     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'
 }
@@ -41,6 +56,8 @@ checkstyle {
     toolVersion = '10.2'
 }
 
+
 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) | 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) | Sel Gomez | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)

docs/README.md

@@ -1,6 +1,10 @@
-# Duke
+# NUSPlanner
 
-{Give product intro here}
+🗓️ NUSPlanner is a desktop app that allows for an *easy* and *straightforward* way for NUS students to manage their schedule ranging from person, school or external related activities. This application makes use of a desktop Command Line Interface (CLI), enabling a quick and sleek method of getting your schedule in check.
+
+⌨️ If you can type fast, NUSPlanner can get your contact management tasks done faster and more efficiently than traditional GUI apps.
+
+✅ NUSPlanner is available for download for operating systems such as Windows, Linux and OS-X.
 
 Useful links:
 * [User Guide](UserGuide.md)

docs/UML/ArchitectureDesign.puml

@@ -0,0 +1,44 @@
+@startuml
+hide circle
+hide footbox
+hide members
+allowmixing
+
+
+!define UI_COLOR #1D8900
+!define STORAGE_COLOR #A38300
+!define PARSER_COLOR #9D0012
+!define DUKE_COLOR #FF6A14
+!define EVENTLIST_COLOR #82DE09
+!define USER_COLOR #000000
+skinparam MinClassWidth 60
+skinparam actorStyle awesome
+skinparam packageStyle Rectangle
+skinparam DefaultTextAlignment center
+
+skinparam Class {
+    FontColor #FFFFFF
+    BorderThickness 1
+    BorderColor #FFFFFF
+    StereotypeFontColor #FFFFFF
+    FontName Arial
+}
+package NUSPlanner{
+    class UI UI_COLOR
+    class Parser PARSER_COLOR
+    class Storage STORAGE_COLOR
+    class Duke DUKE_COLOR
+    class EventList EVENTLIST_COLOR
+}
+
+actor :user:
+file SaveFile
+user .down.> UI
+UI -right-> Parser
+Duke -> UI
+Duke ----> Storage
+Parser -down-> EventList
+EventList ..> Storage
+Storage .> SaveFile
+Storage ..> EventList
+@enduml

docs/UML/LoadEvents.puml

@@ -0,0 +1,27 @@
+@startuml
+hide footbox
+hide circle
+
+-> ":Storage" : loadEvents()
+activate ":Storage"
+":Storage" -> ":EventListStorage" : loadEvents()
+activate ":EventListStorage"
+":EventListStorage" ->":EventListAdapter" : gson.fromJson(fileReader, ArrayList.class)
+activate ":EventListAdapter"
+":EventListAdapter" -> ":ArrayList<Event>" : ArrayList<Event>()
+activate ":ArrayList<Event>"
+":EventListAdapter" -> ":EventListAdapter" : read()
+loop events in file
+    ":EventListAdapter" -> ":EventListAdapter" : readEvent()
+    ":EventListAdapter" --> ":ArrayList<Event>" : Event
+end
+":ArrayList<Event>" --> ":EventListAdapter" : :ArrayList<Event>
+deactivate ":ArrayList<Event>"
+":EventListAdapter" --> ":EventListStorage" : :ArrayList<Event>
+deactivate ":EventListAdapter"
+":EventListStorage" --> ":Storage" : :ArrayList<Event>
+deactivate ":EventListStorage"
+<-- ":Storage" : :ArrayList<Event>
+deactivate ":Storage"
+destroy ":ArrayList<Event>"
+@enduml

docs/UML/LoadModules.puml

@@ -0,0 +1,36 @@
+@startuml
+hide circle
+hide footbox
+
+-> ":Storage" : loadModules()
+activate ":Storage"
+Alt modulesLoaded
+    ":Storage" --> ":Storage" : :HashMap<String, NusModule>
+    <-- ":Storage" : :HashMap<String, NusModule>
+else else
+    ":Storage" -> ":NusModuleLoader" : loadModules()
+    activate ":NusModuleLoader"
+    ":NusModuleLoader" -> ":ModuleAdapter" : ModuleAdapter()
+    activate ":ModuleAdapter"
+    ":ModuleAdapter" -> ":HashMap<String, NusModule>" : HashMap<String, NusModule>()
+    activate ":HashMap<String, NusModule>"
+    ":ModuleAdapter" -> ":ModuleAdapter" : read()
+    loop module in NusMods.json
+        ":ModuleAdapter" -> ":ModuleAdapter" : readModule()
+        ":ModuleAdapter" --> ":HashMap<String, NusModule>" : Module
+    end
+    ":HashMap<String, NusModule>" --> ":ModuleAdapter" : ":HashMap<String, NusModule>"
+    deactivate ":HashMap<String, NusModule>"
+    ":ModuleAdapter" --> ":NusModuleLoader" : ":HashMap<String, NusModule>"
+    deactivate ":ModuleAdapter"
+    ":NusModuleLoader" --> ":Storage" : ":HashMap<String, NusModule>"
+    deactivate ":NusModuleLoader"
+    <-- ":Storage" : ":HashMap<String, NusModule>"
+    deactivate ":Storage"
+    destroy ":HashMap<String, NusModule>"
+end
+
+
+
+
+@enduml

docs/UML/SaveToFile.puml

@@ -0,0 +1,36 @@
+@startuml
+hide footbox
+-> ":Storage" : saveToFile(EventList)
+activate ":Storage"
+    ":Storage" -> ":EventListStorage" : saveToFile(EventList)
+    activate ":EventListStorage"
+    ":EventListStorage" -> ":EventListAdapter" :  gson.toJson(eventList.getFullList())
+    activate ":EventListAdapter"
+    ":EventListAdapter" -> ":EventListAdapter" : write()
+    activate ":EventListAdapter"
+    loop Event in ArrayList<Event>
+        ":EventListAdapter" -> ":EventListAdapter" : writeEvent()
+    end
+    deactivate ":EventListAdapter"
+    ":EventListAdapter" --> ":EventListStorage" : String
+    deactivate ":EventListAdapter"
+    opt File does not exist
+        ":EventListStorage" -> ":File" : new File()
+        activate ":File"
+        ":File" --> ":EventListStorage"
+        deactivate ":File"
+    end
+    ":EventListStorage" -> ":FileWriter" : taskWriter.write(gsonData)
+    activate ":FileWriter"
+    ":FileWriter" --> ":File" : String
+    activate ":File"
+    ":File" --> ":FileWriter"
+    deactivate ":File"
+    ":FileWriter" --> ":EventListStorage"
+    deactivate ":FileWriter"
+    ":EventListStorage" --> ":Storage"
+    deactivate ":EventListStorage"
+    <-- ":Storage"
+    deactivate ":Storage"
+
+@enduml

docs/UML/StorageClass.puml

@@ -0,0 +1,67 @@
+@startuml
+hide circle
+skinparam packageStyle Rectangle
+skinparam classAttributeIconSize 0
+
+package Storage{
+    class "<<interface>>\nStorage"{
+        +saveToFile(EventList):void
+        +loadEvents():ArrayList<Schedule>
+        +loadModules():HashMap<String, NusModule>
+    }
+
+        class "<<interface>>\nEventListStorage"{
+            +saveToFile(EventList):void
+            +loadEvents():ArrayList<Schedule>
+        }
+        class JsonEventListStorage {
+        }
+        class EventListAdapter{
+        }
+
+
+
+        class "<<interface>>\nNusModuleLoader"{
+            +loadModules():HashMap<String, NusModule>
+        }
+
+        class JsonNusModuleLoader{
+        }
+
+        class ModuleAdapter{
+        }
+
+
+    class StorageManager{
+
+    }
+
+
+
+
+
+
+    "<<interface>>\nStorage" --|> "<<interface>>\nNusModuleLoader"
+    "<<interface>>\nStorage" --|>"<<interface>>\nEventListStorage"
+
+    StorageManager --> "1""<<interface>>\nNusModuleLoader"
+    StorageManager --> "1""<<interface>>\nEventListStorage"
+    StorageManager .down.> "<<interface>>\nStorage"
+
+    JsonEventListStorage .up.|> "<<interface>>\nEventListStorage"
+    JsonEventListStorage -down-> "1" EventListAdapter
+
+    JsonNusModuleLoader .up.|> "<<interface>>\nNusModuleLoader"
+    JsonNusModuleLoader -down-> "1" ModuleAdapter
+
+}
+package gson{
+    class TypeAdapter{
+    }
+}
+
+
+    EventListAdapter --|> TypeAdapter
+    ModuleAdapter --|> TypeAdapter
+
+@enduml

docs/UML/UserClass.puml

@@ -0,0 +1,14 @@
+@startuml
+
+class User {
+ -semester
+ +getSemester()
+ +setSemester()
+}
+
+class UserUtility {
+ -user
+ +getUser()
+}
+
+@enduml

docs/UML/addEvent.puml

@@ -0,0 +1,40 @@
+@startuml
+":Actor" -> ":Parser" : parseAddCommand()
+":Parser" -> Parser : addFormatChecker()
+alt event has end date
+    alt event is recurring
+        Parser -> ":EventList" : addEvent()
+        EventList -> EventList : convertToTimeInfo()
+        EventList -> EventList : convertToTimeInfo()
+        EventList -> ":Event" : new Event()
+        Event  --> EventList
+        EventList -> ":EventList" : canAddNewEvent()
+        EventList --> Parser
+    else event is non-recurring
+        Parser -> EventList : addEvent()
+        EventList -> EventList : convertToTimeInfo()
+        EventList -> EventList : convertToTimeInfo()
+        EventList -> Event : new Event()
+        Event  --> EventList
+        EventList  --> Parser
+    end
+    else event does not has end date
+        alt event is recurring
+            Parser -> EventList : addEvent()
+            EventList -> EventList : convertToTimeInfo()
+            EventList -> Event : new Event()
+            Event  --> EventList
+            EventList --> Parser
+        else event is non-recurring
+            Parser -> EventList : addEvent()
+            EventList -> EventList : convertToTimeInfo()
+            EventList -> Event : new Event()
+            Event  --> EventList
+            EventList  --> Parser
+        end
+end
+Parser -> ":Ui" : addSuccessMsg()
+":Ui" --> Parser
+Parser --> ":Actor"
+hide footbox
+@enduml

docs/UML/addModules.puml

@@ -0,0 +1,22 @@
+@startuml
+":Actor" -> Parser : parseAddCommand()
+":Parser" -> Parser : addFormatChecker()
+Parser -> NusmodConverter : loadModules()
+NusmodConverter --> Parser : HashMap<String, NusModule> nusmodules
+Parser -> NusModule : getLesson()
+NusModule --> Parser : List<Lesson> lessons
+loop lesson: Lessons
+    loop week: lesson.getWeeks()
+        Parser -> Parser : findDateOfWeek()
+        Parser -> EventList : addEvent()
+        EventList -> EventList : convertToTimeInfo()
+        EventList -> EventList : convertToTimeInfo()
+        EventList -> Event : new Event()
+        Event  --> EventList
+        EventList -> EventList : canAddNewEvent()
+        EventList --> Parser
+    end
+end
+Parser --> Actor
+hide footbox
+@enduml