[CS2113-T13-2] Timetable Comparer

META-INF/MANIFEST.MF

@@ -0,0 +1,3 @@
+Manifest-Version: 1.0
+Main-Class: seedu.duke.Main
+

README.md

@@ -1,4 +1,4 @@
-# Duke project template
+# Timetable Comparer
 
 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.
 
@@ -20,7 +20,7 @@ Prerequisites: JDK 11 (use the exact version), update Intellij to the most recen
    |  _ \ _   _| | _____ 
    | | | | | | | |/ / _ \
    | |_| | |_| |   <  __/
-   |____/ \__,_|_|\_\___|
+   |____/ \__,_|_|\_\___
 
    What is your name?
    ```

build.gradle

@@ -26,10 +26,11 @@ test {
         showStackTraces true
         showStandardStreams = false
     }
+
 }
 
 application {
-    mainClass.set("seedu.duke.Duke")
+    mainClass.set("seedu.duke.Main")
 }
 
 shadowJar {
@@ -43,4 +44,5 @@ checkstyle {
 
 run{
     standardInput = System.in
+    enableAssertions = true
 }

docs/AboutUs.md

@@ -1,9 +1,8 @@
 # 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) | Leong Zhe Ming | [Github](https://github.com/Leong-ZM) | [Portfolio](docs/team/johndoe.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Zhang Wenqing | [Github](https://github.com/z-wenqing) | [Portfolio](docs/team/johndoe.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Zhu Sijia | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
+![](https://via.placeholder.com/100.png?text=Photo) | John Nguyen | [Github](https://github.com/john-nng) | [Portfolio](docs/team/johndoe.md)

docs/AddUserTaskSequenceDiagram.puml

@@ -0,0 +1,38 @@
+@startuml
+title changeTaskTiming Sequence Diagram
+
+participant ":Parser" as Caller
+participant ":changeTaskTiming" as Method
+participant ":changeFlexibleTaskTiming" as FlexibleMethod
+participant ":InputValidator" as InputValidator
+participant ":UserList" as UserList
+participant ":User" as User
+participant ":Timetable" as Timetable
+
+Caller -> Method: changeTaskTiming(command, userList)
+activate Method
+Method -> InputValidator: validateChangeTaskTiming(command)
+activate InputValidator
+Method -> InputValidator: command.split("\\s+")
+Method <-- InputValidator: parts[]
+Method -> InputValidator: Arrays.asList(parts)
+Method <-- InputValidator: wordList[]
+Method -> InputValidator: parts[2]
+Method -> InputValidator: parts[wordList.indexOf("/index") + 1]
+Method -> InputValidator: parts[wordList.indexOf("/from") + 1]
+Method -> InputValidator: parts[wordList.indexOf("/to") + 1]
+Method -> InputValidator: validateDay(day)
+deactivate InputValidator
+Method -> UserList: userList.getActiveUser()
+Method <-- UserList: activeUser
+Method -> User: activeUser.getTimetable()
+activate User
+Method <-- User: timetable
+Method -> FlexibleMethod: timetable.changeFlexibleTaskTiming(day, index - 1, newStartTime, newEndTime)
+activate FlexibleMethod
+FlexibleMethod <-- Timetable: successful change
+deactivate FlexibleMethod
+deactivate User
+deactivate Method
+
+@enduml

docs/DeveloperGuide.md

@@ -1,38 +1,151 @@
 # Developer Guide
 
-## Acknowledgements
+## Design & implementation
 
-{list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the original source as well}
+### Save timetable function
+The saving timetable mechanism is facilitated by the Storage class. It implements the following operations: 
+* `Storage#createFolder()`: Creates a folder in the directory where all the users' timetable will be stored in the local computer.
+* `Storage#addExistingUsers()`: Loops through the folder to add all previous saved users upon opening the app, as well as their corresponding tasks.
+* `Storage#addUserInFolder(User user)`: When a new user is added, a file with the name of the user will be created in the folder.
+* `Storage#writeTaskInFile(User user)`: when a new task of a specific user is added, it will be written into the correct file.
 
-## Design & implementation
+The following sequence diagram shows how the operations in the Storage class goes through when the app is opened and it loads data from history:
+![Storage UML](diagram%2FStorageUML.png)
+
+
+## Parser Component
+
+Here is a general guide of how Parse Class looks like in sequence diagram.
+
+![Parse.png](diagram%2FParse.png)
+
+Here is a class diagram for the method changeTaskTiming method in Parser Class.
+
+![changeTaskTimingClassDiagram.png](diagram%2FchangeTaskTimingClassDiagram.png)
+
+The following sequence diagram of changeTaskTiming shows the interactions with other objects.
+
+![changeTaskTiming_Sequence_Diagram.png](diagram%2FchangeTaskTiming_Sequence_Diagram.png)
+
+Here is how this method works:
+
+1. The Parser calls the changeTaskTiming method with a command and the UserList. It calls InputValidator.
+
+2. The InputValidator validates the command, ensuring that it meets the required format in days and index.
+
+3. If validation is successful, the User calls the timetable and calls its changeFlexibleTaskTiming method with the specified parameters.
+
+4. The Timetable updates the timing of the flexible task.
+
+5. If successful, the InputValidator sends a success message back to the Parser. Otherwise, it throws a RuntimeException.
+
+## Timetable Component
+Here is a sequence diagram of changeTaskType method in Timetable class. It shows the interactions with other objects.
+![changeTaskType.png](diagram%2FchangeTaskType.png)
+
+Here is how this method works:
+1. The sequence starts with the Parser sending a request to the Timetable to change the type of a task.
+
+2. The Timetable activates and processes the changeTaskType method.
+
+3. Within the Timetable, the dayOfWeek parameter is capitalized to ensure consistency.
+
+4. The Timetable calls the list of tasks associated with the specified day (dayOfWeek). It activates the Task object to fetch the task at the specified index (index).
 
-{Describe the design and implementation of the product. Use UML diagrams and short code snippets where applicable.}
+5. The Task object modifies the type of the task to the new type specified by the Parser.
 
+6. Finally, the modified task or any relevant status information is returned to the Parser.
 
+## Next Command
+
+Proposed implementation
+
+The next command displays the next task of the current user based on the current time. Given below is how it works. 
+
+Step 1: The user launches the application, creates a user, and creates several tasks for the user. 
+
+Step 2: The user types the command 'next' to see their next task. 
+
+Step 3: The next command is triggered. It first determines the current day and takes the arraylist of tasks of the user's timetable on that day. 
+
+Step 4: It then loops through the tasks on that day, starting from the back (the later tasks), until the task's start time is before the current time. 
+
+Step 5: It displays the last task it looped though, or a special message if there is no task that day. 
+
+![NextCommand UML](diagram%2FNextCommand.png)
+
+# Appendix: Project Requirements
 ## Product scope
 ### Target user profile
 
-{Describe the target user profile}
+People who
+* have busy timetables
+* wish to be able to compare theirs with their friends' easily
+* prefer desktop apps over other types
+* can type fast
+* prefer typing to mouse interactions
+* are reasonably comfortable using CLI apps
 
 ### Value proposition
 
-{Describe the value proposition: what problem does it solve?}
+The app can store multiple timetables and easily display and compare them automatically, saving the time and effort of doing so by hand. 
 
 ## User Stories
 
-|Version| As a ... | I want to ... | So that I can ...|
-|--------|----------|---------------|------------------|
-|v1.0|new user|see usage instructions|refer to them when I forget how to use the application|
-|v2.0|user|find a to-do item by name|locate a to-do without having to go through the entire list|
+| Version | As a ... | I want to ...             | So that I can ...                                                |
+|---------|----------|---------------------------|------------------------------------------------------------------|
+| v1.0    | new user | see usage instructions    | refer to them when I forget how to use the application           |
+|         | user     | add a new user            | store my timetable                                               |
+|         | user     | switch users              | interact with my own timetable                                   |
+|         | user     | add a task                |                                                                  |
+|         | user     | compare two timetables    | see the common time between them                                 |
+| v2.0    | user     | find a to-do item by name | locate a to-do without having to go through the entire list      |
+|         | user     | specify task importance   | remember if a task is important or not                           |
+|         | user     | compare all timetables    | view a summarized timetable comprising of all current timetables |
+
 
 ## Non-Functional Requirements
 
-{Give non-functional requirements}
+1. Should work on any mainstream OS (Windows, Linux, Unix, MacOS) as long as it has Java 11 or above installed.
+2. Should be able to hold up to 10 persons without a noticeable sluggishness in performance for typical usage.
+3. A user with above average typing speed for regular English text (i.e. not code, not system admin commands) should be able to accomplish most of the tasks faster using commands than using the mouse.
 
 ## Glossary
 
-* *glossary item* - Definition
+* **User** - A person using this app.
+* **Timetable** - A number of tasks belonging to a specific user.
+* **Task** - An event in a timetable, with a description, start time, end time, and type.
 
 ## 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}
+Given below are instructions to test the app manually.
+
+### Launch and Shutdown
+
+1. Initial launch
+
+Download the jar file and copy into an empty folder. Double-click the jar file. Expected: Shows the GUI with a list of commands. The window size may not be optimum; adjust it as necessary.
+
+2. Shutdown
+
+Enter 'bye'. The app should close and all current data should be saved in a data folder. 
+
+### Add user
+
+Prerequisites: None
+
+* Valid command: `adduser User1`. Expected: Confirmation that user was added. 
+* Invalid command: `adduser`. Expected: Error message shown. 
+* Invalid command: `adduser User1`, where User1 already exists. Expected: Error message shown. 
+
+### Add task
+
+Prerequisites: At least one user has been added 
+
+* Valid command: `addtask /on Monday /task test1 /from 9:00 /to 11:00 /type f`. Expected: Confirmation that task was added. 
+* Invalid commands. Expected: Error message shown detailing expected format. 
+  * `addtask /on Monday`
+  * `addtask /on Monday /task description`
+  * `addtask /on Monday /task description /from 09:00 /to 11:00`
+  * `addtask Monday description 09:00 11:00`
+  * `addtask /on MONDAY /task description /from 09:00 /to 11:00`

docs/NextCommand.puml

@@ -0,0 +1,43 @@
+@startuml
+autonumber
+
+participant ":Main" as Main
+participant ":Parser" as Parser
+participant ":DayOfWeek" as DayOfWeek
+participant ":Timetable" as Timetable
+participant ":UI" as UI
+
+
+Main -> Parser: (parseCommand("next", userList))
+activate Parser
+DayOfWeek -> Parser: dayOfWeek
+Parser -> Parser: capitalizeDay(dayOfWeek)
+activate Parser
+Parser --> Parser: result
+deactivate Parser
+
+Parser -> Timetable: getWeeklyTasks(dayOfWeek)
+activate Timetable
+Timetable --> Parser: tasksOfDay
+deactivate Timetable
+Parser -> Parser: tasksOfDay.size()
+activate Parser
+Parser --> Parser: result
+deactivate Parser
+
+alt numOfTasks == 0
+    Parser -> UI: printNoTasks()
+    activate UI
+    UI --> Main: display no text
+    deactivate UI
+else
+    loop numOfTasks
+        alt currentTime < task.startTime
+            Parser -> UI: nextTask()
+            activate UI
+
+            deactivate UI
+        end
+    end
+end
+@enduml

docs/Parse.puml

@@ -0,0 +1,43 @@
+@startuml
+participant ":UI" as UI
+participant ":Parser" as Parser
+participant ":UserList" as UserList
+participant ":Timetable" as Timetable
+participant ":InputValidator" as InputValidator
+
+UI -> Parser: parseCommand(command, userList)
+activate Parser
+
+Parser -> UserList: setActiveUser(user)
+activate UserList
+UserList --> Parser: Confirmation
+
+alt command = "changeTaskType"
+    Parser -> InputValidator: validateChangeTaskType(command)
+    activate InputValidator
+    InputValidator -> Timetable: changeTaskType(dayOfWeek, index, newType)
+    activate Timetable
+    Timetable --> Parser: Success message
+    deactivate Timetable
+    InputValidator --> Parser: No exceptions thrown
+    deactivate InputValidator
+    Parser --> UI: "Task type changed successfully."
+else command = "deleteTask"
+    Parser -> InputValidator: validateDeleteTaskInput(command)
+    activate InputValidator
+    InputValidator -> Timetable: deleteUserTask(day, index)
+    activate Timetable
+    Timetable --> Parser: Success message
+    deactivate Timetable
+    InputValidator --> Parser: No exceptions thrown
+    deactivate InputValidator
+    Parser --> UI: Success message
+else
+    note right of Parser
+        Other command cases handled similarly
+    end note
+    Parser --> UI: Output message
+end
+
+deactivate Parser
+@enduml

docs/README.md

@@ -1,8 +1,3 @@
-# Duke
+# TimetableComparer
 
-{Give product intro here}
-
-Useful links:
-* [User Guide](UserGuide.md)
-* [Developer Guide](DeveloperGuide.md)
-* [About Us](AboutUs.md)
+Refer to UserGuide: [User Guide](https://ay2324s2-cs2113-t13-2.github.io/tp/UserGuide.html)