[CS2113-W12-4] Java Ninja

META-INF/MANIFEST.MF

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

README.md

@@ -1,6 +1,6 @@
-# Duke project template
+# Java Ninja
 
-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.
+Java Ninja is a command-line interface (CLI) learning tool focused on helping beginner programmers enhance their understanding of fundamental programming concepts. This tool provides different modes of assessments with various difficulty levels as you progress.
 
 ## Setting up in Intellij
 
@@ -10,19 +10,7 @@ Prerequisites: JDK 17 (use the exact version), update Intellij to the most recen
 1. **Import the project _as a Gradle project_**, as described [here](https://se-education.org/guides/tutorials/intellijImportGradleProject.html).
 1. **Verify the setup**: After the importing is complete, locate the `src/main/java/seedu/duke/Duke.java` file, right-click it, and choose `Run Duke.main()`. If the setup is correct, you should see something like the below:
    ```
-   > Task :compileJava
-   > Task :processResources NO-SOURCE
-   > Task :classes
-
-   > Task :Duke.main()
-   Hello from
-    ____        _        
-   |  _ \ _   _| | _____ 
-   | | | | | | | |/ / _ \
-   | |_| | |_| |   <  __/
-   |____/ \__,_|_|\_\___|
-
-   What is your name?
+
    ```
    Type some word and press enter to let the execution proceed to the end.
 

build.gradle

@@ -29,18 +29,19 @@ test {
 }
 
 application {
-    mainClass.set("seedu.duke.Duke")
+    mainClass.set("seedu.javaninja.JavaNinja")
 }
 
 shadowJar {
-    archiveBaseName.set("duke")
+    archiveBaseName.set("javaninja")
     archiveClassifier.set("")
 }
 
 checkstyle {
     toolVersion = '10.2'
 }
 
-run{
+run {
     standardInput = System.in
-}
+    enableAssertions = true
+}

data/Questions.txt

@@ -0,0 +1,34 @@
+Loops | TrueFalse | Java is a programming language. | true
+Loops | TrueFalse | A while loop will execute at least once. | false
+Loops | TrueFalse | A for loop is used when the number of iterations is known. | true
+Loops | TrueFalse | A do-while loop will execute its body before checking the condition. | true
+Loops | TrueFalse | A for-each loop is primarily used for iterating over collections. | true
+Loops | TrueFalse | A while loop is best used when the number of iterations is known. | false
+Loops | TrueFalse | A break statement can be used to exit a loop early. | true
+Loops | TrueFalse | A continue statement skips the current iteration of a loop. | true
+Loops | TrueFalse | A do-while loop will never execute if the condition is false initially. | false
+Loops | TrueFalse | Infinite loops can only be created using a while loop. | false
+Loops | TrueFalse | You can nest loops inside one another in Java. | true
+Loops | Mcq | Which of the following is a loop structure in Java? | b | a) if-else | b) for | c) switch | d) try-catch
+Loops | Mcq | Which loop guarantees at least one iteration? | a | a) do-while | b) for | c) while | d) for-each
+Loops | Mcq | Which keyword is used to exit a loop early? | c | a) continue | b) return | c) break | d) stop
+Loops | Mcq | Which type of loop is used when the number of iterations is fixed? | b | a) while | b) for | c) do-while | d) foreach
+Loops | Mcq | What is the correct syntax for a for loop in Java? | a | a) for (int i = 0; i < 10; i++) | b) for (i = 0; i < 10; i++) | c) for int i : range(10) | d) foreach (int i in range(10))
+Loops | Mcq | Which of the following loop types can be infinite? | a | a) while | b) do-while | c) for | d) All of the above
+Loops | Mcq | Which of the following loops is suitable for iterating over a collection? | d | a) while | b) do-while | c) simple for | d) for-each
+Loops | Mcq | What happens if the condition in a for loop is omitted? | c | a) Compilation error | b) Infinite loop | c) The loop continues until it is explicitly broken | d) None of the above
+Loops | Mcq | Which keyword can be used to skip to the next iteration of a loop? | a | a) continue | b) skip | c) next | d) pass
+Loops | Mcq | What is the output of an infinite while loop without a condition? | b | a) Compilation error | b) Loop continues indefinitely | c) Loop runs once | d) None of the above
+FITB | FillInTheBlank | The keyword used to declare a method that does not return a value is `____`. | void
+FITB | FillInTheBlank | The `____` keyword is used to create a new object in Java. | new
+FITB | FillInTheBlank | In Java, the method that runs when the program starts is called `____`. | main
+FITB | FillInTheBlank | The access modifier `____` allows visibility within the same package and subclasses. | protected
+FITB | FillInTheBlank | The `____` statement is used to terminate the execution of a method and return a value. | return
+FITB | FillInTheBlank | To compare two strings in Java, you use the `____` method. | equals
+FITB | FillInTheBlank | In Java, arrays have a fixed `____` once they are initialized. | size
+FITB | FillInTheBlank | A `____` is a block of code that can be called with a set of arguments and performs a specific task. | method
+FITB | FillInTheBlank | The `____` keyword is used to inherit properties and methods from another class. | extends
+FITB | FillInTheBlank | The keyword `____` is used to implement an interface in a class. | implements
+FITB | FillInTheBlank | The keyword used to define a class is `____`. | class
+FITB | FillInTheBlank | A constructor in Java is used to create an instance of a `____`. | object
+FITB | FillInTheBlank | The keyword used to declare a constant in Java is ___ | final

docs/AboutUs.md

@@ -1,9 +1,11 @@
 # 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) |    Naveen     | [Github](https://github.com/naveen42x) | [Portfolio](docs/team/naveen42x.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Zhang Zhitong | [Github](https://github.com/Zhang-Zhitong) | [Portfolio](docs/team/ZhangZhitong.md)
+![](https://via.placeholder.com/100.png?text=Photo) |   Shaun Goh   | [Github](https://github.com/shaunngoh) | [Portfolio](docs/team/shaunngoh.md)
+![](https://via.placeholder.com/100.png?text=Photo) |   Wang Yubo   | [Github](https://github.com/YubotKwng) | [Portfolio](docs/team/yubotkwng.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Jinlin Wang | [Github](https://github.com/Lucky-Yuan00) | [Portfolio](docs/team/johndoe.md)
+

docs/DeveloperGuide.md

@@ -6,6 +6,30 @@
 
 ## Design & implementation
 
+### Design 
+
+#### Architecture 
+
+Main components of the architecture:
+
+`Main` (consisting of class `JavaNinja`) is in charge of the app launch and shut down. 
+1. At app launch, it initialises the components in the correct order and connects them with each other
+2. At shut down, it shuts down the other components and invokes cleanup methods 
+
+The bulk of the app's work is done by the respective components: 
+1. `Cli`: It handles the user interface of the app 
+2. `Parser`: The command executor 
+3. `QuizManager`: Holds the data of the App in memory
+4. `Storage`: Reads data from, and writes data to, the hard disk.
+
+`Commons` represent a collection of classes used by other components.
+
+How the architecture components interact with each other: 
+
+The Sequence Diagram below shows how the components interact with each other for the scenario where the user issues the command `add Flashcard /q what's 2+3 /a 5`
+
+![image](https://github.com/user-attachments/assets/1dd443de-b538-4fb8-b4d1-3bff4643b3dd)
+
 {Describe the design and implementation of the product. Use UML diagrams and short code snippets where applicable.}
 
 

src/main/java/seedu/javaninja/Cli.java

@@ -0,0 +1,81 @@
+package seedu.javaninja;
+
+import java.io.IOException;
+import java.util.Scanner;
+
+/* Manages input by user */
+public class Cli {
+    private QuizManager quizManager;
+    private Scanner scanner;
+
+    public Cli() {
+        quizManager = new QuizManager();
+        scanner = new Scanner(System.in);
+    }
+
+    public void start() throws IOException {
+        System.out.println("Welcome to Java Ninja!");
+        System.out.println("'view' to view topics");
+        System.out.println("'select [topic]' to select a topic");
+        System.out.println("'review' to review past results");
+        System.out.println("'help' for a list of commands");
+        System.out.println("'quit' to exit the program");
+        System.out.println("'exit' to exit the quiz, activate only while doing the quiz");
+
+        while (true) {
+            System.out.print("> ");
+            String input = scanner.nextLine().trim();
+            String command = processCommand(input);
+
+            if (command.equals("quit")) {
+                break;
+            }
+
+            switch (command) {
+            case "view":
+                quizManager.printTopics();
+                break;
+            case "select":
+                selectTopic(input);
+                break;
+            case "review":
+                System.out.println("Reviewing your past results:");
+                System.out.println(quizManager.getPastResults());
+                break;
+            case "help":
+                printHelp();
+                break;
+            case "add":
+                quizManager.addQuestionByUser(input);
+                break;
+            default:
+                System.out.println("Invalid input. Type 'help' for a list of commands.");
+            }
+        }
+        System.out.println("Goodbye!");
+        scanner.close();
+    }
+
+    private void selectTopic(String input) {
+        String[] parts = input.split(" ", 2);
+        if (parts.length < 2) {
+            System.out.println("Please specify a topic to select.");
+        } else {
+            quizManager.selectTopic(parts[1], scanner);
+        }
+    }
+
+    public String processCommand(String input) {
+        return input.split(" ")[0].toLowerCase();
+    }
+
+    // Help message
+    private void printHelp() {
+        System.out.println("List of available commands:");
+        System.out.println("'view' - View available topics");
+        System.out.println("'select [topic]' - Start a quiz on a specific topic");
+        System.out.println("'review' - Review all your quiz results");
+        System.out.println("'help' - Show this help message");
+        System.out.println("'quit' - Exit the program");
+    }
+}

src/main/java/seedu/javaninja/FillInTheBlank.java

@@ -0,0 +1,35 @@
+package seedu.javaninja;
+
+public class FillInTheBlank extends Question {
+
+    public FillInTheBlank(String question, String answer) {
+        super(question, answer);
+    }
+
+    @Override
+    public boolean checkAnswer(String answer) {
+        // Normalize the user's answer and the correct answer for comparison
+        String normalizedUserAnswer = normalizeAnswer(answer);
+        String normalizedCorrectAnswer = normalizeAnswer(correctAnswer);
+        return normalizedUserAnswer.equals(normalizedCorrectAnswer);
+    }
+
+    @Override
+    public void printOptions() {
+        // No options to print for fill-in-the-blank questions
+        ;
+    }
+
+    // Method to normalize the answer for comparison
+    private String normalizeAnswer(String answer) {
+        if (answer == null) {
+            return "";
+        }
+        // Convert to lowercase and strip any leading or trailing whitespace
+        return answer.toLowerCase().trim();
+    }
+
+    public String getQuestionType() {
+        return "FITB";
+    }
+}

src/main/java/seedu/javaninja/Flashcard.java

@@ -0,0 +1,27 @@
+package seedu.javaninja;
+
+public class Flashcard extends Question {
+
+    public Flashcard(String question, String answer) {
+        super(question, answer);
+    }
+
+    @Override
+    public boolean checkAnswer(String answer) {
+        return correctAnswer.equalsIgnoreCase(answer);
+    }
+
+    @Override
+    public void printOptions() {
+        ;
+    }
+
+    public String getQuestionType () {
+        return "FC";
+    }
+
+
+
+
+
+}

src/main/java/seedu/javaninja/JavaNinja.java

@@ -0,0 +1,11 @@
+package seedu.javaninja;
+
+import java.io.IOException;
+
+public class JavaNinja {
+
+    public static void main(String[] args) throws IOException {
+        Cli cli = new Cli();
+        cli.start();
+    }
+}

src/main/java/seedu/javaninja/Mcq.java

@@ -0,0 +1,25 @@
+package seedu.javaninja;
+
+import java.util.List;
+
+public class Mcq extends Question {
+    private List<String> options;
+
+    public Mcq(String text, String correctAnswer, List<String> options) {
+        super(text, correctAnswer);
+        this.options = options;
+    }
+
+    @Override
+    public boolean checkAnswer(String answer) {
+        return correctAnswer.equalsIgnoreCase(answer);
+    }
+
+    @Override
+    public void printOptions() {
+        for (String option : options) {
+            System.out.println(option);
+        }
+    }
+
+}

src/main/java/seedu/javaninja/Question.java

@@ -0,0 +1,22 @@
+package seedu.javaninja;
+
+/* Represents a question that could be of different types (MCQ / True or False) */
+
+public abstract class Question {
+    protected String text;
+    protected String correctAnswer;
+
+    public Question(String text, String answer) {
+        this.text = text;
+        this.correctAnswer = answer;
+    }
+
+    public String getText() {
+        return this.text;
+    }
+
+    public abstract boolean checkAnswer(String answer);
+
+    public abstract void printOptions();
+
+}