nus-cs2113-AY2223S2 · kyrixn · Mar 30, 2023 · Mar 30, 2023 · Mar 30, 2023 · Mar 30, 2023
diff --git a/.gitignore b/.gitignore
@@ -15,3 +15,9 @@ bin/
 
 /text-ui-test/ACTUAL.TXT
 text-ui-test/EXPECTED-UNIX.TXT
+
+/src/main/java/seedu/duke/*.class
+
+.gitignore
+save.json
+.vscode
diff --git a/build.gradle b/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'
 }

diff --git a/docs/AboutUs.md b/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)
diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md
@@ -1,15 +1,93 @@
 # Developer Guide
+Welcome to the NUSPlanner Developer Guide!
+We hope this documents serves useful to understand the behind-the-scenes working of our product. 
+
+## Table of Contents
 
 ## Acknowledgements
 
-{list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the original source as well}
+{list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the original source as well}'
+
+## Getting started
+
+Refer to the user guide [here](https://github.com/AY2223S2-CS2113-F13-3/tp/blob/master/docs/UserGuide.md).
+
 
 ## Design & implementation
 
 {Describe the design and implementation of the product. Use UML diagrams and short code snippets where applicable.}
 
+### Parser Component
+The component will return the correct command based on what the user inputs into the application.
+
+#### How is the feature implemented?
+
+The Parser component parses the command of the user input and breaks the user input into different parts based on the flags.
+This component also ensures to validate that user input is correct.
+
+#### Why is the feature implemented this way?
+
+This component should be able to guide the user to inputting the correct format of the command to do data validation.
+It should be able to perform basic data validation checks to ensure that the user does not enter any invalid commands.
+This makes life easier to developers in the future if they wish to add new features that requires users to use new commands.
+
+### Storage Component
+API: `Storage.java`
+
+The storage component reads and writes user data from a local save in the form of a `.json` file.
+The Storage component:
+* Serializes and deserializes user data into a `.json` file format through the use of the Gson library
+* Saves and loads information from the local hard disk
+
+The class diagram below illustrates the structure of the storage package
+
+![Storage Class Diagram](UML/Images/StorageClass.png)
+
+#### How the feature is implemented:
+
+![Storage Class Diagram](UML/Images/StorageSequenceDiagram.png)
+
+When the application starts up, the storage loadEvents() function will be called to load contents in the save file. 
+Similarly, the state of the user's event list is saved when the user exits the application by calling saveToFile().
+
+#### Justification for using gson
+The Gson library was chosen as it allowed for flexible adaptation of its TypeAdapter class, allowing for custom 
+serialization and deserialization of data to be saved. 
+
+### EventList component
+
+API: `EventList.java`
+
+this component maintains a list of Schedule instance. It receives commands from Parser.java and adds/deletes/edits tasks and their information in the list according to the commands.
+
+#### How is the feature implemented:
+
+the main functions are
+
+> - add new task (accepts event without starting time/ending time/ending date).
+> - delete a single tasks / delete all tasks.
+> - edit the time information of task (starting time/ending time/ending date can be omitted).
+> - search for a event by index / description.
+> - get all the detail of a event in the list in String form.
+
+The class diagram below illustrates the structure of the EventList component.
+
+<img src="UML\Images\EventListUML.png" />
+
+And below is a sequential diagram showing a event being added, revised, checked for information and finally deleted.
+
+<img src="UML\Images\EventListSD.png" style="zoom:80%;" />
+
+
+
+
+
+
+
+#### Why implemented in this way:
+
+It is necessary to have a list which contains all the current event/class so that we can show/ batch process events more efficiently. Moreover, this component serves intermediary functions and avoids other classes access deep into the functionality of classes (Event, Schedule e.t.c) inside the ArrayList, thus reduces the coupling of the code base. Additionally, this component also converted all the String parameters parsed by Parser into various Types that required by other classes that the EventList contains, further reducing the coupling.
 
-## Product scope
 ### Target user profile
 
 {Describe the target user profile}
@@ -36,3 +114,6 @@
 ## Instructions for manual testing
 
 {Give instructions on how to do a manual product testing e.g., how to load sample data to be used for testing}
+
+
+
diff --git a/docs/README.md b/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)

diff --git a/docs/UML/Images/EventListSD.png b/docs/UML/Images/EventListSD.png
diff --git a/docs/UML/Images/EventListUML.png b/docs/UML/Images/EventListUML.png
diff --git a/docs/UML/Images/StorageClass.png b/docs/UML/Images/StorageClass.png
diff --git a/docs/UML/Images/StorageSequenceDiagram.png b/docs/UML/Images/StorageSequenceDiagram.png
diff --git a/docs/UML/StorageClass.puml b/docs/UML/StorageClass.puml
@@ -0,0 +1,40 @@
+@startuml
+!include Style.puml
+hide circle
+skinparam classAttributeIconSize 0
+
+class Storage{
+- saveLocation : String
+- builder : GsonBuilder
+- gson : Gson
++ void saveToFile(eventList)
++ ArrayList<Event> loadEvents()
+}
+
+class com.google.gson.TypeAdapter{
+}
+
+class EventListAdapter{
+- dfWithTime : DateTimeFormatter
++ void write(JsonWriter, ArrayList<Event>)
++ void writeEvent(JsonWriter, Event)
++ ArrayList<Event> read(JsonReader)
++ Event readEvent(JsonReader)
++ String readDate(JsonReader)
++ String readTime(Jsonreader)
+}
+
+
+class EventList{
+# taskList : ArrayList<Event>
+}
+
+
+
+Storage --> "1" EventListAdapter
+
+
+EventListAdapter .l> com.google.gson.TypeAdapter
+Storage . EventList : writes to <
+Storage . EventList :  > gets data from
+@enduml
diff --git a/docs/UML/StorageSequenceDiagram.puml b/docs/UML/StorageSequenceDiagram.puml
@@ -0,0 +1,82 @@
+@startuml
+hide footbox
+box Storage
+-> ":Storage" :  Storage()
+create ":Storage"
+activate ":Storage"
+create ":GsonBuilder"
+":Storage" -> ":GsonBuilder" : <<create>>
+activate ":GsonBuilder"
+create ":EventListAdapter"
+":Storage" -> ":EventListAdapter" : <<create>>
+activate ":EventListAdapter"
+":EventListAdapter" --> ":GsonBuilder"
+deactivate ":EventListAdapter"
+":GsonBuilder" --> ":Storage"
+deactivate ":GsonBuilder"
+create ":Gson"
+":Storage" -> ":Gson" : <<create>>
+activate ":Gson"
+deactivate ":GsonBuilder"
+":Gson" --> ":Storage" : gson
+deactivate ":Gson"
+deactivate ":Storage"
+end box
+box java.io
+participant ":File"
+participant ":InputStreamReader"
+participant ":FileWriter"
+end box
+":Storage" -> ":Storage" :loadEvents()
+activate ":Storage"
+create ":File"
+":Storage" -> ":File" : load file from local save
+activate ":File"
+create ":ArrayList<Event>"
+":Storage" -> ":ArrayList<Event>" : <<create>>
+activate ":ArrayList<Event>"
+alt !File.exists()
+    ":ArrayList<Event>"--> ":Storage" : empty ArrayList<Event>
+else File exists
+    create ":InputStreamReader"
+    ":File" -> ":InputStreamReader" : <<create>>
+    activate ":InputStreamReader"
+    ":InputStreamReader" -> ":Gson" : fromJson()
+    deactivate ":InputStreamReader"
+    activate ":Gson"
+    ":Gson" --> ":ArrayList<Event>"
+    deactivate ":Gson"
+    ":ArrayList<Event>" --> ":Storage"
+    deactivate ":ArrayList<Event>"
+    deactivate ":File"
+    deactivate ":Storage"
+    end
+
+":Storage"-> ":Storage" :saveToFile()
+
+activate ":Storage"
+":Storage" -> ":File" : <<create>> if file does not exist
+activate ":File"
+":Storage" -> ":ArrayList<Event>"
+activate ":ArrayList<Event>"
+":Storage" -> ":Gson"
+activate ":Gson"
+":ArrayList<Event>" --> ":Gson"
+deactivate ":ArrayList<Event>"
+
+create "gsonData : String"
+":Gson" -> "gsonData : String" : toJson()
+deactivate ":Gson"
+activate "gsonData : String"
+
+create ":FileWriter"
+":Storage" -> ":FileWriter" : <<create>>
+activate ":FileWriter"
+"gsonData : String" --> ":FileWriter"
+deactivate "gsonData : String"
+":FileWriter" --> ":File"
+deactivate ":FileWriter"
+":File" --> ":Storage"
+deactivate ":File"
+deactivate ":Storage"
+@enduml
diff --git a/docs/UML/UserClass.puml b/docs/UML/UserClass.puml
@@ -0,0 +1,14 @@
+@startuml
+
+class User {
+ -semester
+ +getSemester()
+ +setSemester()
+}
+
+class UserUtility {
+ -user
+ +getUser()
+}
+
+@enduml