nus-cs2113-AY2324S1 · yeo-menghan · Oct 31, 2023 · Oct 31, 2023 · Oct 31, 2023 · Oct 31, 2023
diff --git a/.gitignore b/.gitignore
@@ -2,6 +2,7 @@
 /.idea/
 /out/
 /*.iml
+META-INF/MANIFEST.MF
 
 # Gradle build files
 /.gradle/
@@ -15,3 +16,8 @@ bin/
 
 /text-ui-test/ACTUAL.TXT
 text-ui-test/EXPECTED-UNIX.TXT
+
+*.class
+
+questionlist.txt
+tasklist.txt
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# Duke project template
+# QuizHub project template
 
 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.
 

diff --git a/build.gradle b/build.gradle
@@ -11,6 +11,7 @@ repositories {
 
 dependencies {
     testImplementation group: 'org.junit.jupiter', name: 'junit-jupiter-api', version: '5.10.0'
+    testImplementation 'junit:junit:4.13.1'
     testRuntimeOnly group: 'org.junit.jupiter', name: 'junit-jupiter-engine', version: '5.10.0'
 }
 
@@ -29,11 +30,11 @@ test {
 }
 
 application {
-    mainClass.set("seedu.duke.Duke")
+    mainClass.set("Quizhub")
 }
 
 shadowJar {
-    archiveBaseName.set("duke")
+    archiveBaseName.set("quizhub")
     archiveClassifier.set("")
 }
 
@@ -43,4 +44,5 @@ checkstyle {
 
 run{
     standardInput = System.in
+    enableAssertions = true
 }
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://www.comp.nus.edu.sg/~stevenha/images/sh7.jpg) | James Hong Jey | [Github](https://github.com/James-Hong-Jey)  | [Portfolio](docs/team/jameshong.md)
+![](https://via.placeholder.com/100.png?text=Photo) |   Guan Xiao    |   [Github](https://github.com/StevenGX12)    | [Portfolio](docs/team/guanxiao.md)
+![](https://avatars.githubusercontent.com/u/111041948?s=400&u=6619a8328eba45edbc88fe01cf54efeb1f986d11&v=4) |  Man Juncheng  | [Github](https://github.com/spinoandraptos)  | [Portfolio](docs/team/juncheng.md)
+![](https://i.redd.it/6do158vk2ue61.png) |  Li Sizhuang   | [Github](https://github.com/lisizhuang-0121) | [Portfolio](docs/team/johndoe.md)
+![](https://via.placeholder.com/100.png?text=Photo) |  Yeo Meng Han  |   [Github](https://github.com/yeo-menghan)   | [Portfolio](https://linkedin.com/in/yeo-meng-han/)
diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md
diff --git a/docs/DeveloperGuide.md.rej b/docs/DeveloperGuide.md.rej
@@ -0,0 +1,114 @@
+diff a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md	(rejected hunks)
+@@ -1,29 +1,104 @@
+ # Developer Guide
+
++## Table of Contents
++* [Acknowledgements](#acknowledgements)
++* [Design and Implementation](#design--implementation)
++  * [Application Lifecycle](#application-lifecycle)
++* [Product Scope](#product-scope)
++* [Non Functional Requirements](#non-functional-requirements)
++* [Glossary](#glossary)
++* [Instructions for Manual Testing](#instructions-for-manual-testing)
++
+ ## Acknowledgements
+
+-{list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the original source as well}
++1. For the main structure of the program, we have adapted the project structure
++from the Individual Project of Man JunCheng at [Link](https://github.com/spinoandraptos/ip/tree/master) </li>
++2. For JUnit testing, we have adapted the testing codes from the AddressBook level-2
++codes at [Link](https://github.com/se-edu/addressbook-level2)</li>
++3. For the developer's guide, we have reverenced the developer's guide from AddressBook
++level-3 [Link](https://se-education.org/addressbook-level3/DeveloperGuide.html)
+
+ ## Design & implementation
+
+-{Describe the design and implementation of the product. Use UML diagrams and short code snippets where applicable.}
++### Architecture
++The main execution of the QuizHub application will concern 4 components which
++are the QuizHub, Ui, Parser and Command packages.
++
++![](./UML/architecture.jpg)
++
++`Quizhub` is the "main" class, which is responsible for starting the program, 
++initialising all other objects, executing commands, and shutting down.
++
++`UI` is the component that interacts with the user, taking inputs and displaying 
++the results of the executed commands.
++
++`Parser` acts as a multiplexer to determine which command to run, and what parameters
++it has, based on the user input.
++
++`Commands` refer to a package of individual commands with complex and specific
++logic, which is later executed in Quizhub and displayed in Utility.
+
++`Storage` is the class through which questions can be stored on the hard drive and `Utility Classes` 
++refer to any miscellaneous utility classes used by all the components.
++
++### Application Lifecycle
++
++![](./UML/lifecycle.jpg)
++
++The program will begin through the `run()` call to QuizHub class, with the
++necessary classes to be interacted throughout the execution.
++
++The `run` function contains a loop that accepts user inputs through the `Ui`
++class. The input is captured and passed to the `parseCommand()` function of the
++Parser class. A command object is returned by the Parser class to be executed.
++If the command is of Exit type, the Loop will exit.
+
+ ## Product scope
++
++### Our Product
++QuizHub
++
+ ### Target user profile
+
+-{Describe the target user profile}
++Our target users are 
++* NUS Students preparing for exams
++* Like to take notes in class
++* Fear to miss out of important knowledge
++* Like to test their understanding of knowledge
++* Want to be better prepared for exams
++* Majoring in computing or engineering where there are lots of exams
++* Coders and tech geeks who enjoy using the CLI interface
+
+ ### Value proposition
+
+-{Describe the value proposition: what problem does it solve?}
++Allow NUS Students to easily take notes in class and allow them to 
++generate quizzes to test their knowledge of understanding. By using the 
++QuizHub application, students can input notes taken in class in a question form,
++which they could use to take quizzes to ensure their understanding of the topic.
+
+ ## 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 student user                      | I can access the tutorial on how to operate the app                               | Easily use the app effectively for my studies                             |
++| v1.0    | Efficient student                     | I can add a question and its answer easily to my question and answer bank         | Build my question and answer bank quickly                                 |
++| v1.0    | Organized student                     | I can view all the questions and answers in my question and answer bank           | Review my study materials comprehensively                                 |
++| v1.0    | Detail-oriented student               | I can edit the content of a question or its answer                                | Correct any mistakes or make improvements                                 |
++| v1.0    | Student focused on clarity            | I can delete a question and its answer from my question and answer bank           | Maintain a clean and relevant set of questions for revision               |
++| v1.0    | Student focused on revising for tests | I can start and end a quiz which tests me on questions in my question bank        | Consolidate understanding of my learnt knowledge through rigorous testing |
++| v1.0    | Student focused on revising for tests | I can see my final quiz score and whether I have answered each question correctly | Identify areas of weakness to be improved upon for my tests               |
++| v2.0    | User seeking efficiency               | I can search for a specific question within a flashcard deck                      | locate information quickly.                                               |
++| v2.0    | User with diverse interests           | I can categorize questions by topic or subject                                    | tailor my quizzes                                                         |
++| v2.0    | User seeking variety                  | I can shuffle the order of questions in a flashcard deck                          | keep my quizzes engaging.                                                 |
++| v2.0    | User aiming for improvement           | I can mark a question as "difficult" or "easy" for later review                   | optimize my learning.                                                     |
++| v2.0    | User seeking a challenge              | I can practice questions in a random order                                        | test my knowledge comprehensively.                                        |
++| v2.0    | User seeking structure                | I can practice questions in a sequential order                                    | follow a specific learning path.                                          |
++| v2.1    | user aiming for accuracy              | I can see how many questions I've answered correctly                              | track my proficiency.                                                     |
++| v2.1    | user tracking progress                | I can reset the progress of a specific flashcard deck                             | start fresh.                                                              |
++| v2.1    | time-conscious user                   | I can set a timer for each flashcard question during practice                     | manage my study sessions effectively.                                     |
++| v2.1    | goal-oriented user                    | I can view my overall progress and performance statistics                         | gauge my improvement.                                                     |
++| v2.1    | user aiming for improvement           | I can see how many questions I've answered incorrectly                            | focus on weak areas.                                                      |
++| v2.1    | user committed to learning            | I can review the questions I've answered incorrectly                              | reinforce my knowledge.                                                   |
+
+ ## Non-Functional Requirements
+
diff --git a/docs/UML/AddShortCommand.jpg b/docs/UML/AddShortCommand.jpg
diff --git a/docs/UML/CommandAddShort.pptx b/docs/UML/CommandAddShort.pptx
diff --git a/docs/UML/CommandStart.pptx b/docs/UML/CommandStart.pptx
diff --git a/docs/UML/CommandStart_Class.jpg b/docs/UML/CommandStart_Class.jpg
diff --git a/docs/UML/CommandStart_Sequence.jpg b/docs/UML/CommandStart_Sequence.jpg
diff --git a/docs/UML/Commands/Initial State.png b/docs/UML/Commands/Initial State.png
diff --git a/docs/UML/Commands/Initial State.puml b/docs/UML/Commands/Initial State.puml
@@ -0,0 +1,16 @@
+!include Style.puml
+@startuml
+title Initial State
+
+object ":QuestionList" as QuestionList
+
+object ":Question1" as Question1
+
+object ":Question2" as Question2
+
+object ":Question3" as Question3
+
+QuestionList -->  Question1
+QuestionList --> Question2
+QuestionList --> Question3
+@enduml
diff --git a/docs/UML/Commands/ShuffleToStorage-Shuffle_to_Storage_Flow.png b/docs/UML/Commands/ShuffleToStorage-Shuffle_to_Storage_Flow.png
diff --git a/docs/UML/Commands/ShuffleToStorage.puml b/docs/UML/Commands/ShuffleToStorage.puml
@@ -0,0 +1,31 @@
+@startuml
+!theme plain
+title Shuffle to Storage Flow
+
+class QuestionList {
+  - allQns: List<Question>
+  + addQuestion(question: Question)
+  + removeQuestion(question: Question)
+  + shuffleQuestions()
+  + saveToFile()
+  + loadFromFile()
+}
+
+class Question {
+  - text: String
+  - answer: String
+  + getText()
+  + getAnswer()
+}
+
+QuestionList --|> Question
+
+class Database {
+  - data: ArrayList<Question>  // Represents your data storage mechanism
+  + saveData(question: Question, answer: getAnswer)
+  + loadData(key: Question): getAnswer
+}
+
+QuestionList --|> Database : Data Storage
+
+@enduml
diff --git a/docs/UML/Commands/commandAddState.png b/docs/UML/Commands/commandAddState.png
diff --git a/docs/UML/Commands/commandAddState.puml b/docs/UML/Commands/commandAddState.puml
@@ -0,0 +1,19 @@
+!include Style.puml
+@startuml
+title After Command "short qn4/ans4/module/difficulty"
+
+object ":QuestionList" as QuestionList
+
+object ":Question1" as Question1
+
+object ":Question2" as Question2
+
+object ":Question3" as Question3
+
+object ":Question4" as Question4
+
+QuestionList -->  Question1
+QuestionList --> Question2
+QuestionList --> Question3
+QuestionList --> Question4 : Add new question
+@enduml
diff --git a/docs/UML/Commands/commandDeleteQuestion.png b/docs/UML/Commands/commandDeleteQuestion.png
diff --git a/docs/UML/Commands/commandDeleteQuestion.puml b/docs/UML/Commands/commandDeleteQuestion.puml
@@ -0,0 +1,16 @@
+!include Style.puml
+@startuml
+title After Command "delete 2"
+
+object ":QuestionList" as QuestionList
+
+object ":Question1" as Question1
+
+object ":Question3" as Question3
+
+object ":Question4" as Question4
+
+QuestionList -->  Question1
+QuestionList --> Question3
+QuestionList --> Question4
+@enduml
diff --git a/docs/UML/Commands/commandEdit.puml b/docs/UML/Commands/commandEdit.puml
@@ -0,0 +1,23 @@
+@startuml
+!theme plain
+title Command Edit Sequence Diagram
+
+actor User
+participant Parser
+participant CommandEdit
+participant QuestionList
+participant Question
+
+User -> Parser: Enters "edit [question number] /description [description] or /answer [answer]"
+Parser -> CommandEdit: Calls parseEditCommand(userInput)
+CommandEdit -> Parser: Returns CommandEdit instance
+Parser -> CommandEdit: Executes executeCommand(ui, dataStorage, questions)
+CommandEdit -> QuestionList: Calls editQuestionByIndex(index, newDescription, newAnswer)
+QuestionList -> Question: Calls editQuestion(newDescription, newAnswer)
+Question -> Question: Edits question description and/or answer
+Question --> QuestionList: Notifies edit completion
+QuestionList --> CommandEdit: Notifies edit completion
+CommandEdit --> Parser: Notifies edit completion
+Parser --> User: Displays edit completion message
+
+@enduml
diff --git a/docs/UML/Commands/commandEditSequence.png b/docs/UML/Commands/commandEditSequence.png
diff --git a/docs/UML/Commands/commandEditStages.png b/docs/UML/Commands/commandEditStages.png
diff --git a/docs/UML/Commands/commandEditStages.puml b/docs/UML/Commands/commandEditStages.puml
@@ -0,0 +1,20 @@
+@startuml
+!theme plain
+title Command Edit Flow
+start
+
+:User initiates question edit;
+:Retrieve the question to edit;
+if (Choose "Edit Description" or "Edit Answer") then (Description)
+  :User selects "Edit Description";
+  :Enter new description;
+elseif (Answer)
+  :User selects "Edit Answer";
+  :Enter new answer;
+endif
+
+:Update the question with new information;
+:Display confirmation message;
+stop
+
+@enduml
diff --git a/docs/UML/Commands/commandExit.puml b/docs/UML/Commands/commandExit.puml
@@ -0,0 +1,18 @@
+@startuml
+!theme plain
+title Command Exit Sequence Diagram
+
+actor User
+participant Ui
+participant CommandExit
+participant Storage
+
+User -> Ui: Decides to exit the application
+Ui -> CommandExit: Executes "bye" command
+CommandExit -> Ui: Signals the program to exit
+Ui -> Storage: Saves any unsaved data
+Storage --> Ui: Data saved successfully
+Ui -> Ui: Displays exit message
+Ui --> User: Displays exit message
+
+@enduml
diff --git a/docs/UML/Commands/commandExitSequence.png b/docs/UML/Commands/commandExitSequence.png
diff --git a/docs/UML/Commands/commandMarkDiff.puml b/docs/UML/Commands/commandMarkDiff.puml
@@ -0,0 +1,22 @@
+@startuml
+!theme plain
+
+title Mark Difficulty Sequence Diagram
+actor User
+participant Parser
+participant CommandMarkDifficulty
+participant QuestionList
+participant Question
+
+User -> Parser: Enters "markdiff [question number] /[question difficulty]"
+Parser -> CommandMarkDifficulty: Calls parseMarkDiffCommand(userInput)
+CommandMarkDifficulty -> Parser: Returns CommandMarkDifficulty instance
+Parser -> CommandMarkDifficulty: Executes executeCommand(ui, dataStorage, questions)
+CommandMarkDifficulty -> QuestionList: Calls markQuestionDifficulty(index, qnDifficulty, showMessage)
+QuestionList -> Question: Calls markDifficulty(qnDifficulty)
+Question --> QuestionList: Notifies difficulty marked
+QuestionList --> CommandMarkDifficulty: Notifies difficulty marked
+CommandMarkDifficulty --> Parser: Notifies difficulty marked
+Parser --> User: Displays confirmation message
+
+@enduml
diff --git a/docs/UML/Commands/commandMarkDiffClass.png b/docs/UML/Commands/commandMarkDiffClass.png