Merge pull request nus-cs2113-AY2324S1#12 from wendelinwemhoener/improve-flashcard-support

wendelinwemhoener · web-flow · commit 1793052ce622 · 2023-10-17T03:41:39.000+08:00
Improve flashcard support
diff --git a/build.gradle b/build.gradle
@@ -43,4 +43,5 @@ checkstyle {
 
 run{
     standardInput = System.in
+    enableAssertions = true
 }
diff --git a/docs/team/wendelinwemhoener.md b/docs/team/wendelinwemhoener.md
@@ -1,4 +1,4 @@
-# John Doe - Project Portfolio Page
+# Wendelin Wemhoener - Project Portfolio Page
 
 ## Overview
 
diff --git a/flashcard.txt b/flashcard.txt
@@ -0,0 +1,6 @@
+dfdfdf | aaaaaaaaaaaaaaaaaaa | - | - | -
+flash1 | dfdfdf | - | - | -
+adfdf | dfdfdf | - | - | -
+dfdfdf | dfdfdfdfdf | - | - | -
+who is this | me | - | - | -
+dfdfdfdaaaaaaaaaaaaa | dd | - | - | -
diff --git a/src/main/java/seedu/duke/Duke.java b/src/main/java/seedu/duke/Duke.java
@@ -1,3 +1,5 @@
+//@@author wendelinwemhoener
+
 package seedu.duke;
 
 import seedu.duke.flashcard.Flashcard;
@@ -19,6 +21,7 @@ private void run() {
         Scanner scanner = new Scanner(System.in);
         String input;
         boolean shouldTerminate = false;
+
         while (!shouldTerminate) {
             input = scanner.nextLine();
 
diff --git a/src/main/java/seedu/duke/flashcard/Flashcard.java b/src/main/java/seedu/duke/flashcard/Flashcard.java
@@ -1,5 +1,9 @@
+//@@author wendelinwemhoener
+
 package seedu.duke.flashcard;
 
+import seedu.duke.flashcard.review.FlashcardReview;
+
 import java.time.LocalDateTime;
 import java.util.ArrayList;
 
@@ -8,7 +12,11 @@ public class Flashcard {
     private String backText;
     private ArrayList<String> tags;
     private ArrayList<FlashcardReview> reviews;
-    private LocalDateTime nextReviewOn;
+    private LocalDateTime lastReviewOn;
+
+    public void setLastReviewOn(LocalDateTime lastReviewOn) {
+        this.lastReviewOn = lastReviewOn;
+    }
 
     public Flashcard(String frontText, String backText) {
         this.frontText = frontText;
@@ -17,7 +25,7 @@ public Flashcard(String frontText, String backText) {
         tags = new ArrayList<>();
         reviews = new ArrayList<>();
 
-        nextReviewOn = null;
+        lastReviewOn = null;
     }
 
     public String getFrontText() {
@@ -29,11 +37,9 @@ public String getBackText() {
     }
 
     public String toString() {
-        return "-".repeat(80) + System.lineSeparator()
-                + "front text: " + frontText + System.lineSeparator()
+        return "front text: " + frontText + System.lineSeparator()
                 + "back text: " + backText + System.lineSeparator()
                 + "tags: " + tags.toString() + System.lineSeparator()
-                + "next review due on: " + nextReviewOn + System.lineSeparator()
-                + "-".repeat(80);
+                + "next review due on: " + lastReviewOn + System.lineSeparator();
     }
 }
diff --git a/src/main/java/seedu/duke/flashcard/FlashcardCommandParser.java b/src/main/java/seedu/duke/flashcard/FlashcardCommandParser.java
@@ -1,3 +1,5 @@
+//@@author wendelinwemhoener
+
 package seedu.duke.flashcard;
 
 import seedu.duke.flashcard.command.FlashcardCommand;
@@ -8,11 +10,13 @@
 
 public class FlashcardCommandParser {
     public FlashcardCommand parseInput(String input) {
+        assert input != null : "input is null";
+
         if (input.startsWith("create flashcard")) {
             return new CreateFlashcardCommand();
         } else if (input.startsWith("list flashcards")) {
             return new ListFlashcardsCommand();
-        } else if (input.startsWith("start review")) {
+        } else if (input.startsWith("review flashcards")) {
             return new StartReviewCommand();
         }
 
diff --git a/src/main/java/seedu/duke/flashcard/FlashcardComponent.java b/src/main/java/seedu/duke/flashcard/FlashcardComponent.java
@@ -1,3 +1,5 @@
+//@@author wendelinwemhoener
+
 package seedu.duke.flashcard;
 
 import seedu.duke.flashcard.command.FlashcardCommand;
@@ -16,6 +18,8 @@ public class FlashcardComponent {
 
     public FlashcardComponent(ArrayList<Flashcard> flashcards) {
         parser = new FlashcardCommandParser();
+
+        //@@author junhyeong0411
         storage = new FlashcardStorage("./flashcard.txt");
         try {
             flashcardList = storage.loadFlashcards();
@@ -25,9 +29,8 @@ public FlashcardComponent(ArrayList<Flashcard> flashcards) {
             flashcardList = new FlashcardList(flashcards);
         }
 
-
+        //@@author wendelinwemhoener
         ui = new FlashcardUi(flashcardList);
-
     }
 
     public boolean isResponsible(String input) {
@@ -42,9 +45,15 @@ public boolean isResponsible(String input) {
 
     public void processInput(String input) {
         FlashcardCommand command = parser.parseInput(input);
+        assert !(command instanceof UnknownCommand) : "Command cannot be " +
+                "unknown";
+
         ui.executeCommand(command);
 
+        //@@author junhyeong0411
         // save after every commands
         storage.saveFlashcards(flashcardList.getFlashcards());
+
+        //@@author wendelinwemhoener
     }
 }
diff --git a/src/main/java/seedu/duke/flashcard/FlashcardDifficulty.java b/src/main/java/seedu/duke/flashcard/FlashcardDifficulty.java
diff --git a/src/main/java/seedu/duke/flashcard/FlashcardList.java b/src/main/java/seedu/duke/flashcard/FlashcardList.java
@@ -1,3 +1,5 @@
+//@@author wendelinwemhoener
+
 package seedu.duke.flashcard;
 
 import java.util.ArrayList;
diff --git a/src/main/java/seedu/duke/flashcard/FlashcardReview.java b/src/main/java/seedu/duke/flashcard/FlashcardReview.java
diff --git a/src/main/java/seedu/duke/flashcard/FlashcardUi.java b/src/main/java/seedu/duke/flashcard/FlashcardUi.java
@@ -1,3 +1,5 @@
+//@@author wendelinwemhoener
+
 package seedu.duke.flashcard;
 
 import seedu.duke.flashcard.command.FlashcardCommand;
diff --git a/src/main/java/seedu/duke/flashcard/command/CreateFlashcardCommand.java b/src/main/java/seedu/duke/flashcard/command/CreateFlashcardCommand.java
@@ -1,3 +1,5 @@
+//@@author wendelinwemhoener
+
 package seedu.duke.flashcard.command;
 
 import seedu.duke.flashcard.Flashcard;
@@ -15,5 +17,8 @@ public void execute(Scanner scanner, FlashcardList flashcardList) {
         Flashcard flashcard = new Flashcard(frontPageText, backPageText);
 
         flashcardList.add(flashcard);
+
+        System.out.println("    Success! Flashcard has been added to your " +
+                "collection.");
     }
 }
diff --git a/src/main/java/seedu/duke/flashcard/command/FlashcardCommand.java b/src/main/java/seedu/duke/flashcard/command/FlashcardCommand.java
@@ -1,3 +1,5 @@
+//@@author wendelinwemhoener
+
 package seedu.duke.flashcard.command;
 
 import seedu.duke.flashcard.FlashcardList;
diff --git a/src/main/java/seedu/duke/flashcard/command/ListFlashcardsCommand.java b/src/main/java/seedu/duke/flashcard/command/ListFlashcardsCommand.java
@@ -1,3 +1,5 @@
+//@@author wendelinwemhoener
+
 package seedu.duke.flashcard.command;
 
 import seedu.duke.flashcard.Flashcard;
@@ -7,8 +9,12 @@
 
 public class ListFlashcardsCommand extends FlashcardCommand {
     public void execute(Scanner scanner, FlashcardList flashcardList) {
+        System.out.println("    Here is a list of all your flashcards: ");
+
+        System.out.println("-".repeat(80));
         for (Flashcard flashcard : flashcardList.getFlashcards()) {
-            System.out.println(flashcard);
+            System.out.print(flashcard);
+            System.out.println("-".repeat(80));
         }
     }
 }
diff --git a/src/main/java/seedu/duke/flashcard/command/StartReviewCommand.java b/src/main/java/seedu/duke/flashcard/command/StartReviewCommand.java
@@ -1,11 +1,63 @@
+//@@author wendelinwemhoener
+
 package seedu.duke.flashcard.command;
 
 import seedu.duke.flashcard.FlashcardList;
+import seedu.duke.flashcard.review.FlashcardReview;
+import seedu.duke.flashcard.review.RandomReviewMode;
+import seedu.duke.flashcard.review.ReviewByTagMode;
+import seedu.duke.flashcard.review.ReviewMode;
+import seedu.duke.flashcard.review.SpacedRepetitionReviewMode;
 
+import java.util.ArrayList;
+import java.util.Arrays;
 import java.util.Scanner;
 
 public class StartReviewCommand extends FlashcardCommand {
+    private final ArrayList<String> choices = new ArrayList<>(Arrays.asList(
+            "a", "b", "c"));
+
+    private String getUserChoiceReviewMode(Scanner scanner) {
+        System.out.println("    How do you want to review your flashcards?");
+        System.out.println("        a) random mode");
+        System.out.println("        b) spaced repetition mode");
+        System.out.println("        c) review by tag mode");
+
+        return scanner.nextLine();
+    }
+
     public void execute(Scanner scanner, FlashcardList flashcardList) {
-        System.out.println("");
+        String choice = getUserChoiceReviewMode(scanner);
+
+        if (!choices.contains(choice)) {
+            System.out.println("    Invalid choice! Your choice must be a, b " +
+                    "or c!");
+            return;
+        }
+
+        ReviewMode reviewMode = createReviewMode(choice, flashcardList);
+
+        if (reviewMode instanceof RandomReviewMode) {
+            reviewMode.startReviewSession(scanner);
+        } else {
+            System.out.println("This review mode hasn't yet been implemented." +
+                    " Sorry!");
+        }
+    }
+
+    private ReviewMode createReviewMode(String choice, FlashcardList flashcardList) {
+        ReviewMode reviewMode = null;
+
+        if (choice.equals("a")) {
+            reviewMode = new RandomReviewMode(flashcardList);
+        } else if (choice.equals("b")) {
+            reviewMode = new SpacedRepetitionReviewMode(flashcardList);
+        } else if (choice.equals("c")) {
+            reviewMode = new ReviewByTagMode(flashcardList);
+        }
+
+        assert reviewMode != null;
+
+        return reviewMode;
     }
 }
diff --git a/src/main/java/seedu/duke/flashcard/command/UnknownCommand.java b/src/main/java/seedu/duke/flashcard/command/UnknownCommand.java
@@ -1,3 +1,5 @@
+//@@author wendelinwemhoener
+
 package seedu.duke.flashcard.command;
 
 import seedu.duke.flashcard.FlashcardList;
diff --git a/src/main/java/seedu/duke/flashcard/review/FlashcardReview.java b/src/main/java/seedu/duke/flashcard/review/FlashcardReview.java
@@ -0,0 +1,15 @@
+//@@author wendelinwemhoener
+
+package seedu.duke.flashcard.review;
+
+import java.time.LocalDateTime;
+
+public class FlashcardReview {
+    private LocalDateTime reviewDate;
+    private ReviewDifficulty reviewDifficulty;
+
+    public FlashcardReview(LocalDateTime reviewDate, ReviewDifficulty reviewDifficulty) {
+        this.reviewDate = reviewDate;
+        this.reviewDifficulty = reviewDifficulty;
+    }
+}
diff --git a/src/main/java/seedu/duke/flashcard/review/RandomReviewMode.java b/src/main/java/seedu/duke/flashcard/review/RandomReviewMode.java
@@ -0,0 +1,26 @@
+//@@author wendelinwemhoener
+
+package seedu.duke.flashcard.review;
+
+import seedu.duke.flashcard.Flashcard;
+import seedu.duke.flashcard.FlashcardList;
+
+import java.util.ArrayList;
+import java.util.Random;
+
+public class RandomReviewMode extends ReviewMode {
+    public RandomReviewMode(FlashcardList flashcardList) {
+        super(flashcardList);
+    }
+
+    public String getReviewModeName() {
+        return "random review mode";
+    }
+
+    protected Flashcard pickFlashcard() {
+        ArrayList<Flashcard> flashcards = flashcardList.getFlashcards();
+        Random random = new Random();
+
+        return flashcards.get(random.nextInt(flashcards.size()));
+    }
+}
diff --git a/src/main/java/seedu/duke/flashcard/review/ReviewByTagMode.java b/src/main/java/seedu/duke/flashcard/review/ReviewByTagMode.java
@@ -0,0 +1,18 @@
+package seedu.duke.flashcard.review;
+
+import seedu.duke.flashcard.Flashcard;
+import seedu.duke.flashcard.FlashcardList;
+
+public class ReviewByTagMode extends ReviewMode {
+    public ReviewByTagMode(FlashcardList flashcardList) {
+        super(flashcardList);
+    }
+
+    public String getReviewModeName() {
+        return "review by tag mode";
+    }
+
+    protected Flashcard pickFlashcard() {
+        return null;
+    }
+}
diff --git a/src/main/java/seedu/duke/flashcard/review/ReviewDifficulty.java b/src/main/java/seedu/duke/flashcard/review/ReviewDifficulty.java
@@ -0,0 +1,10 @@
+//@@author wendelinwemhoener
+
+package seedu.duke.flashcard.review;
+
+public enum ReviewDifficulty {
+    EASY,
+    GOOD,
+    HARD,
+    AGAIN
+}
diff --git a/src/main/java/seedu/duke/flashcard/review/ReviewMode.java b/src/main/java/seedu/duke/flashcard/review/ReviewMode.java
diff --git a/src/main/java/seedu/duke/flashcard/review/SpacedRepetitionReviewMode.java b/src/main/java/seedu/duke/flashcard/review/SpacedRepetitionReviewMode.java

Original file line number	Diff line number	Diff line change
`@@ -43,4 +43,5 @@ checkstyle {`
`43`	`43`
`44`	`44`	`run{`
`45`	`45`	`standardInput = System.in`
	`46`	`+ enableAssertions = true`
`46`	`47`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# John Doe - Project Portfolio Page`
	`1`	`+# Wendelin Wemhoener - Project Portfolio Page`
`2`	`2`
`3`	`3`	`## Overview`
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+//@@author wendelinwemhoener`
	`2`	`+`
`1`	`3`	`package seedu.duke.flashcard;`
`2`	`4`
`3`	`5`	`import java.util.ArrayList;`