Merge pull request #56 from CSC207-2022F-UofT/53-dialog-boxes

anthony-chen-ca · web-flow · commit 43266edc7183 · 2022-11-20T14:10:31.000-05:00
changed the StudySession failure case to throw an exception
diff --git a/src/main/java/studyMode/StudySessionInteractor.java b/src/main/java/studyMode/StudySessionInteractor.java
@@ -57,10 +57,14 @@ public StudySessionResponseModel study(StudySessionRequestModel request) {
     }
 
     @Override
-    public StudySettingsResponseModel getSetToStudy(StudySettingsRequestModel request) throws IndexOutOfBoundsException {
+    public StudySettingsResponseModel getSetToStudy(StudySettingsRequestModel request) {
         this.studier = builder.buildStudier(request.getFlashcardSetId(), request.isTermDefault());
 
-        try {
+        if (this.studier.getNumFlashcards() == 0) {
+            String error = "<html>This flashcard set is empty. Please add some flashcard to begin studying!</html>";
+            return presenter.prepareFailedStudyView(error);
+        }
+        else {
             String sortingOrder = request.getSortingOrder();
             if (sortingOrder.equals(StudySessionInteractor.shuffleSort)) {
                 studier.shuffle();
@@ -81,8 +85,5 @@ public StudySettingsResponseModel getSetToStudy(StudySettingsRequestModel reques
             return presenter.prepareSuccessStudyView(studier.getOutputText(), studier.getTitle(),
                     studier.getNumFlashcards(), studier.getFlashcardSetId());
         }
-        catch (IndexOutOfBoundsException exception) {
-            return presenter.prepareFailedStudyView();
-        }
     }
 }
diff --git a/src/main/java/studyMode/StudySessionOutputBoundary.java b/src/main/java/studyMode/StudySessionOutputBoundary.java
@@ -29,8 +29,8 @@ StudySettingsResponseModel prepareSuccessStudyView(String outputText, String tit
                                                        int numFlashcards, int flashcardSetId);
 
     /**
-     * @return a response model which specifies that creating the study view has failed
+     * @return alert the system that preparing the study view has failed
      */
-    StudySettingsResponseModel prepareFailedStudyView();
+    StudySettingsResponseModel prepareFailedStudyView(String error);
 
 }
diff --git a/src/main/java/studyMode/StudySessionPresenter.java b/src/main/java/studyMode/StudySessionPresenter.java
@@ -1,5 +1,7 @@
 package studyMode;
 
+import studyMode.screens.StudySettingsFailed;
+
 /**
  * The study session presenter.
  * <p>
@@ -20,7 +22,7 @@ public StudySettingsResponseModel prepareSuccessStudyView(String outputText, Str
     }
 
     @Override
-    public StudySettingsResponseModel prepareFailedStudyView() {
-        return new StudySettingsResponseModel();
+    public StudySettingsResponseModel prepareFailedStudyView(String error) {
+        throw new StudySettingsFailed(error);
     }
 }
diff --git a/src/main/java/studyMode/StudySessionResponseModel.java b/src/main/java/studyMode/StudySessionResponseModel.java
@@ -8,8 +8,8 @@
  * @author Lucas Prates
  */
 public class StudySessionResponseModel {
-    private String outputText;
-    private int cardNumber;
+    private final String outputText;
+    private final int cardNumber;
 
     /**
      * Creates a StudySessionResponseModel
@@ -22,13 +22,6 @@ public StudySessionResponseModel(String outputText, int cardNumber){
         this.cardNumber = cardNumber;
     }
 
-    /**
-     * Creates a StudySessionResponseModel with null values.
-     */
-    public StudySessionResponseModel() {
-
-    }
-
     /**
      * @return the output text
      */
diff --git a/src/main/java/studyMode/StudySettingsResponseModel.java b/src/main/java/studyMode/StudySettingsResponseModel.java
@@ -9,10 +9,9 @@
  */
 public class StudySettingsResponseModel extends StudySessionResponseModel {
 
-    private int numFlashcards;
-    private String title;
-    private boolean failed = false;
-    private int flashcardSetId;
+    private final int numFlashcards;
+    private final String title;
+    private final int flashcardSetId;
 
     /**
      * Creates a StudySettingsResponseModel
@@ -29,15 +28,6 @@ public StudySettingsResponseModel(String outputText, String title,
         this.flashcardSetId = flashcardSetId;
     }
 
-    /**
-     * Creates a StudySettingsResponseModel with null values, and sets
-     * hasFailed to true
-     */
-    public StudySettingsResponseModel(){
-        super();
-        this.failed = true;
-    }
-
     /**
      * @return the total number of flashcards in the current flashcard set
      */
@@ -48,13 +38,6 @@ public StudySettingsResponseModel(){
      */
     public String getTitle(){return title;}
 
-    /**
-     * @return returns true if the output data was successfully created
-     */
-    public boolean hasFailed (){
-        return failed;
-    }
-
     /**
      * @return the ID of the current flashcard set
      */
diff --git a/src/main/java/studyMode/screens/StudySettingsFailed.java b/src/main/java/studyMode/screens/StudySettingsFailed.java
@@ -0,0 +1,8 @@
+package studyMode.screens;
+
+public class StudySettingsFailed extends RuntimeException {
+    public StudySettingsFailed(String error) {
+        super(error);
+    }
+}
+
diff --git a/src/main/java/studyMode/screens/StudySettingsFailureScreen.java b/src/main/java/studyMode/screens/StudySettingsFailureScreen.java
diff --git a/src/main/java/studyMode/screens/StudySettingsScreen.java b/src/main/java/studyMode/screens/StudySettingsScreen.java
@@ -149,19 +149,19 @@ public void actionPerformed(ActionEvent e) {
                     termIsDefault, isReverse);
         }
 
-        // get the response model
-        StudySettingsResponseModel response = this.controller.getSetToStudy(request);
 
         // close this screen
         setVisible(false);
         dispose();
 
-        // open the appropriate screen
-        if (response.hasFailed()){
-            new StudySettingsFailureScreen();
-        }
-        else {
+        // get the response model
+        try {
+            StudySettingsResponseModel response = this.controller.getSetToStudy(request);
             new StudySessionScreen(this.controller, response);
         }
+        catch (StudySettingsFailed err) {
+            JOptionPane.showMessageDialog(this, err.getMessage());
+        }
+
     }
 }
diff --git a/src/test/java/studyMode/StudySessionUseCaseUnitTest.java b/src/test/java/studyMode/StudySessionUseCaseUnitTest.java
@@ -1,6 +1,7 @@
 package studyMode;
 import dataAccess.*;
 import org.junit.jupiter.api.Test;
+import studyMode.screens.StudySettingsFailed;
 
 import java.io.IOException;
 
@@ -41,7 +42,6 @@ void testTimeSort() throws IOException {
                 StudySessionController.timeSort, true, false);
 
         StudySettingsResponseModel settings = controller.getSetToStudy(request);
-        assertFalse(settings.hasFailed());
 
         assertEquals("test card 1", settings.getOutputText());
         assertEquals(1, settings.getCardNumber());
@@ -69,7 +69,6 @@ void testAlphSort() throws IOException {
                 StudySessionController.alphSort, true, false);
 
         StudySettingsResponseModel settings = controller.getSetToStudy(request);
-        assertFalse(settings.hasFailed());
 
         assertEquals("alphabetical order checker", settings.getOutputText());
         assertEquals(1, settings.getCardNumber());
@@ -97,7 +96,6 @@ void testPrevious() throws IOException {
                 StudySessionController.timeSort, true, false);
 
         StudySettingsResponseModel settings = controller.getSetToStudy(request);
-        assertFalse(settings.hasFailed());
 
         assertEquals("test card 1", settings.getOutputText());
         assertEquals(1, settings.getCardNumber());
@@ -125,7 +123,6 @@ void testFlip() throws IOException {
                 StudySessionController.timeSort, true, false);
 
         StudySettingsResponseModel settings = controller.getSetToStudy(request);
-        assertFalse(settings.hasFailed());
 
         assertEquals("test card 1", settings.getOutputText());
         assertEquals(1, settings.getCardNumber());
@@ -145,7 +142,6 @@ void testsTermNotDefault() throws IOException {
                 StudySessionController.timeSort, false, false);
 
         StudySettingsResponseModel settings = controller.getSetToStudy(request);
-        assertFalse(settings.hasFailed());
 
         assertEquals("the first test card", settings.getOutputText());
         assertEquals(1, settings.getCardNumber());
@@ -165,7 +161,6 @@ void testReverse() throws IOException {
                 StudySessionController.timeSort, true, true);
 
         StudySettingsResponseModel settings = controller.getSetToStudy(request);
-        assertFalse(settings.hasFailed());
 
         assertEquals("alphabetical order checker", settings.getOutputText());
         assertEquals(1, settings.getCardNumber());
@@ -192,7 +187,6 @@ void testEmpty() throws IOException {
         StudySettingsRequestModel request = this.setup(emptyTestSetId,
                 StudySessionController.timeSort, true, true);
 
-        StudySettingsResponseModel settings = controller.getSetToStudy(request);
-        assertTrue(settings.hasFailed());
+        assertThrows(StudySettingsFailed.class, () -> controller.getSetToStudy(request));
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -57,10 +57,14 @@ public StudySessionResponseModel study(StudySessionRequestModel request) {`
`57`	`57`	`}`
`58`	`58`
`59`	`59`	`@Override`
`60`		`- public StudySettingsResponseModel getSetToStudy(StudySettingsRequestModel request) throws IndexOutOfBoundsException {`
	`60`	`+ public StudySettingsResponseModel getSetToStudy(StudySettingsRequestModel request) {`
`61`	`61`	`this.studier = builder.buildStudier(request.getFlashcardSetId(), request.isTermDefault());`
`62`	`62`
`63`		`- try {`
	`63`	`+ if (this.studier.getNumFlashcards() == 0) {`
	`64`	`+ String error = "<html>This flashcard set is empty. Please add some flashcard to begin studying!</html>";`
	`65`	`+ return presenter.prepareFailedStudyView(error);`
	`66`	`+ }`
	`67`	`+ else {`
`64`	`68`	`String sortingOrder = request.getSortingOrder();`
`65`	`69`	`if (sortingOrder.equals(StudySessionInteractor.shuffleSort)) {`
`66`	`70`	`studier.shuffle();`
`@@ -81,8 +85,5 @@ public StudySettingsResponseModel getSetToStudy(StudySettingsRequestModel reques`
`81`	`85`	`return presenter.prepareSuccessStudyView(studier.getOutputText(), studier.getTitle(),`
`82`	`86`	`studier.getNumFlashcards(), studier.getFlashcardSetId());`
`83`	`87`	`}`
`84`		`- catch (IndexOutOfBoundsException exception) {`
`85`		`- return presenter.prepareFailedStudyView();`
`86`		`- }`
`87`	`88`	`}`
`88`	`89`	`}`
Original file line number	Diff line number	Diff line change
`@@ -29,8 +29,8 @@ StudySettingsResponseModel prepareSuccessStudyView(String outputText, String tit`
`29`	`29`	`int numFlashcards, int flashcardSetId);`
`30`	`30`
`31`	`31`	`/**`
`32`		`- * @return a response model which specifies that creating the study view has failed`
	`32`	`+ * @return alert the system that preparing the study view has failed`
`33`	`33`	`*/`
`34`		`- StudySettingsResponseModel prepareFailedStudyView();`
	`34`	`+ StudySettingsResponseModel prepareFailedStudyView(String error);`
`35`	`35`
`36`	`36`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,7 @@`
`1`	`1`	`package studyMode;`
`2`	`2`
	`3`	`+import studyMode.screens.StudySettingsFailed;`
	`4`	`+`
`3`	`5`	`/**`
`4`	`6`	`* The study session presenter.`
`5`	`7`	`* <p>`
`@@ -20,7 +22,7 @@ public StudySettingsResponseModel prepareSuccessStudyView(String outputText, Str`
`20`	`22`	`}`
`21`	`23`
`22`	`24`	`@Override`
`23`		`- public StudySettingsResponseModel prepareFailedStudyView() {`
`24`		`- return new StudySettingsResponseModel();`
	`25`	`+ public StudySettingsResponseModel prepareFailedStudyView(String error) {`
	`26`	`+ throw new StudySettingsFailed(error);`
`25`	`27`	`}`
`26`	`28`	`}`
Original file line number	Diff line number	Diff line change
`@@ -149,19 +149,19 @@ public void actionPerformed(ActionEvent e) {`
`149`	`149`	`termIsDefault, isReverse);`
`150`	`150`	`}`
`151`	`151`
`152`		`- // get the response model`
`153`		`- StudySettingsResponseModel response = this.controller.getSetToStudy(request);`
`154`	`152`
`155`	`153`	`// close this screen`
`156`	`154`	`setVisible(false);`
`157`	`155`	`dispose();`
`158`	`156`
`159`		`- // open the appropriate screen`
`160`		`- if (response.hasFailed()){`
`161`		`- new StudySettingsFailureScreen();`
`162`		`- }`
`163`		`- else {`
	`157`	`+ // get the response model`
	`158`	`+ try {`
	`159`	`+ StudySettingsResponseModel response = this.controller.getSetToStudy(request);`
`164`	`160`	`new StudySessionScreen(this.controller, response);`
`165`	`161`	`}`
	`162`	`+ catch (StudySettingsFailed err) {`
	`163`	`+ JOptionPane.showMessageDialog(this, err.getMessage());`
	`164`	`+ }`
	`165`	`+`
`166`	`166`	`}`
`167`	`167`	`}`