[CS2103T-T12-2] MedInfo

docs/DeveloperGuide.md

@@ -12,7 +12,6 @@ You can use this guide to maintain, upgrade, and evolve **MedInfo**.
 
 ## Table of contents
 
-* [Acknowledgements](#acknowledgements)
 * [Getting Started](#setting-up-getting-started)
 * [Design](#design)
     * [Architecture](#architecture)
@@ -52,12 +51,6 @@ You can use this guide to maintain, upgrade, and evolve **MedInfo**.
 * [Appendix: Planned Enhancements](#appendix-planned-enhancements)
 
 
----
-
-## Acknowledgements
-
-- {list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the original source as well}
-
 ---
 
 ## Setting up, getting started

docs/UserGuide.md

@@ -352,7 +352,6 @@ Format: `deleteward INDEX`
 - You will not be able to delete a ward that currently has patients assigned to it.
 </div>
 
-<div markdown="block" class="alert alert-info">
 
 Examples:
 

docs/team/ksunil2001.md

@@ -41,9 +41,8 @@ Given below are my contributions to the project.
 
 - **Contributions to Team-based tasks**:
     - Refactored Person to Patient throughout the code
-    - Fixed checkstyle issues
+    - Fixed checkstyle issues <br>
 
-<div style="page-break-after: always;"></div>
 
 - **Review/mentoring contributions**:
     - This link lists all the PRs I have reviewed: [Reviewed PRs](https://github.com/AY2223S2-CS2103T-T12-2/tp/pulls?q=is%3Apr+is%3Aclosed+reviewed-by%3Aksunil2001)

src/main/java/seedu/medinfo/logic/parser/ParserUtil.java

@@ -5,7 +5,6 @@
 import seedu.medinfo.commons.core.index.Index;
 import seedu.medinfo.commons.util.StringUtil;
 import seedu.medinfo.logic.commands.SortCommand;
-import seedu.medinfo.logic.commands.SortCommand.Field;
 import seedu.medinfo.logic.commands.SortCommand.Order;
 import seedu.medinfo.logic.parser.exceptions.ParseException;
 import seedu.medinfo.model.patient.Discharge;

src/main/java/seedu/medinfo/model/patient/Discharge.java

@@ -3,18 +3,18 @@
 import static java.util.Objects.requireNonNull;
 import static seedu.medinfo.commons.util.AppUtil.checkArgument;
 
+import java.text.DateFormat;
 import java.text.ParseException;
 import java.text.SimpleDateFormat;
-import java.text.DateFormat;
 import java.util.Date;
 
 /**
  * Represents a Patient's discharge date in MedInfo.
  */
 public class Discharge {
 
-    public static final String MESSAGE_CONSTRAINTS = "Discharge date-time should be a valid future date-time" +
-            " of the format dd/MM/yyyy HHmm";
+    public static final String MESSAGE_CONSTRAINTS = "Discharge date-time should be a valid future date-time"
+            + " of the format dd/MM/yyyy HHmm";
     public static final String DEFAULT_DISCHARGE = "To Be Confirmed";
     public static final String DATE_FORMAT = "dd/MM/yyyy HHmm";
 
@@ -31,7 +31,6 @@ public Discharge(String discharge) {
         value = discharge;
     }
 
-
     /**
      * Returns true if a given discharge date-time is valid.
      * @param date Date to check.

src/main/java/seedu/medinfo/model/patient/Status.java

@@ -52,14 +52,14 @@ public static boolean isValidStatus(String test) {
      */
     public String getDesc() {
         switch(value) {
-            case "GREEN":
-                return "STABLE";
-            case "YELLOW":
-                return "SERIOUS";
-            case "RED":
-                return "CRITICAL";
-            default:
-                return "UNKNOWN";
+        case "GREEN":
+            return "STABLE";
+        case "YELLOW":
+            return "SERIOUS";
+        case "RED":
+            return "CRITICAL";
+        default:
+            return "UNKNOWN";
         }
     }
 
@@ -70,14 +70,14 @@ public String getDesc() {
      */
     public Integer getValue() {
         switch ((value)) {
-            case "GREEN":
-                return 1;
-            case "YELLOW":
-                return 2;
-            case "RED":
-                return 3;
-            default:
-                return 0;
+        case "GREEN":
+            return 1;
+        case "YELLOW":
+            return 2;
+        case "RED":
+            return 3;
+        default:
+            return 0;
         }
     }
 

src/main/java/seedu/medinfo/model/ward/UniqueWardList.java

@@ -34,10 +34,10 @@
  */
 public class UniqueWardList implements Iterable<Ward> {
 
+    private static final WardName WAITING_ROOM = new WardName("Waiting Room");
     private final ObservableList<Ward> internalList = FXCollections.observableArrayList();
     private final ObservableList<Ward> internalUnmodifiableList = FXCollections
             .unmodifiableObservableList(internalList);
-    private static final WardName WAITING_ROOM = new WardName("Waiting Room");
 
     /**
      * Constructor for a UniqueWardList.
@@ -47,7 +47,7 @@ public UniqueWardList() {
     }
 
     /**
-     * Constructor for a NEW UniqueWardList with default Waiting Room ward with capacity of 10
+     * Initializes new wardlist with default Waiting Room ward with capacity of 10
      * inside.
      *
      * @return New UniqueWardList with default Waiting Room.

src/main/java/seedu/medinfo/storage/JsonAdaptedPatient.java

@@ -102,8 +102,6 @@ public Patient toModelType() throws IllegalValueException {
             throw new IllegalValueException(Discharge.MESSAGE_CONSTRAINTS);
         }
         final Discharge modelDischarge = new Discharge(discharge);
-
-
         return new Patient(modelNric, modelName, modelStatus, modelWard, modelDischarge);
     }
 

src/main/java/seedu/medinfo/ui/HelpWindow.java

@@ -70,6 +70,8 @@ public void show() {
 
     /**
      * Returns true if the help window is currently being shown.
+     *
+     * @return Boolean indicating if help window is being shown.
      */
     public boolean isShowing() {
         return getRoot().isShowing();

src/main/java/seedu/medinfo/ui/MainWindow.java

@@ -71,6 +71,11 @@ public MainWindow(Stage primaryStage, Logic logic) {
         helpWindow = new HelpWindow();
     }
 
+    /**
+     * Returns the primary stage.
+     *
+     * @return The primary stage of the app.
+     */
     public Stage getPrimaryStage() {
         return primaryStage;
     }
@@ -81,7 +86,7 @@ private void setAccelerators() {
 
     /**
      * Sets the accelerator of a MenuItem.
-     * @param keyCombination the KeyCombination value of the accelerator
+     * @param keyCombination the KeyCombination value of the accelerator.
      */
     private void setAccelerator(MenuItem menuItem, KeyCombination keyCombination) {
         menuItem.setAccelerator(keyCombination);

src/main/java/seedu/medinfo/ui/PatientCard.java

@@ -59,6 +59,13 @@ public PatientCard(Patient patient, int displayedIndex) {
         discharge.setText(patient.getDischargeString());
     }
 
+    /**
+     * Overrides equality check for PatientCard to compare two patient cards by
+     * the NRICs and the patients.
+     *
+     * @param other Object to check equality with.
+     * @return Boolean indicating whether objects are equal.
+     */
     @Override
     public boolean equals(Object other) {
         // short circuit if same object

src/main/java/seedu/medinfo/ui/ResultDisplay.java

@@ -16,10 +16,18 @@ public class ResultDisplay extends UiPart<Region> {
     @FXML
     private TextArea resultDisplay;
 
+    /**
+     * Creates a {@code ResultDisplay}.
+     */
     public ResultDisplay() {
         super(FXML);
     }
 
+    /**
+     * Sets text to feedback to the user in the result display.
+     *
+     * @param feedbackToUser String to feedback to user.
+     */
     public void setFeedbackToUser(String feedbackToUser) {
         requireNonNull(feedbackToUser);
         resultDisplay.setText(feedbackToUser);

src/main/java/seedu/medinfo/ui/Ui.java

@@ -7,7 +7,9 @@
  */
 public interface Ui {
 
-    /** Starts the UI (and the App).  */
+    /**
+     * Starts the UI (and the App).
+     */
     void start(Stage primaryStage);
 
 }

src/main/java/seedu/medinfo/ui/UiManager.java

@@ -32,6 +32,11 @@ public UiManager(Logic logic) {
         this.logic = logic;
     }
 
+    /**
+     * Start the Ui components with the given primary stage.
+     *
+     * @param primaryStage Primary stage of the app.
+     */
     @Override
     public void start(Stage primaryStage) {
         logger.info("Starting UI...");

src/test/java/seedu/medinfo/commons/util/JsonUtilTest.java

@@ -39,7 +39,4 @@ public void deserializeObjectFromJsonFile_noExceptionThrown() throws IOException
         assertEquals(serializableTestClass.getMapOfIntegerToString(), SerializableTestClass.getHashMapTestValues());
     }
 
-    //TODO: @Test jsonUtil_readJsonStringToObjectInstance_correctObject()
-
-    //TODO: @Test jsonUtil_writeThenReadObjectToJson_correctObject()
 }

src/test/java/seedu/medinfo/logic/LogicManagerTest.java

@@ -3,11 +3,7 @@
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static seedu.medinfo.commons.core.Messages.MESSAGE_ALL_PATIENTS_LISTED_OVERVIEW;
 import static seedu.medinfo.commons.core.Messages.MESSAGE_UNKNOWN_COMMAND;
-import static seedu.medinfo.logic.commands.CommandTestUtil.NAME_DESC_AMY;
-import static seedu.medinfo.logic.commands.CommandTestUtil.NRIC_DESC_AMY;
-import static seedu.medinfo.logic.commands.CommandTestUtil.STATUS_DESC_AMY;
 import static seedu.medinfo.testutil.Assert.assertThrows;
-import static seedu.medinfo.testutil.TypicalPatients.AMY;
 
 import java.io.IOException;
 import java.nio.file.Path;
@@ -16,7 +12,6 @@
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.io.TempDir;
 
-import seedu.medinfo.logic.commands.AddCommand;
 import seedu.medinfo.logic.commands.CommandResult;
 import seedu.medinfo.logic.commands.ListCommand;
 import seedu.medinfo.logic.commands.exceptions.CommandException;
@@ -25,11 +20,9 @@
 import seedu.medinfo.model.ModelManager;
 import seedu.medinfo.model.ReadOnlyMedInfo;
 import seedu.medinfo.model.UserPrefs;
-import seedu.medinfo.model.patient.Patient;
 import seedu.medinfo.storage.JsonMedInfoStorage;
 import seedu.medinfo.storage.JsonUserPrefsStorage;
 import seedu.medinfo.storage.StorageManager;
-import seedu.medinfo.testutil.PatientBuilder;
 
 public class LogicManagerTest {
     private static final IOException DUMMY_IO_EXCEPTION = new IOException("dummy exception");
@@ -55,47 +48,13 @@ public void execute_invalidCommandFormat_throwsParseException() {
         assertParseException(invalidCommand, MESSAGE_UNKNOWN_COMMAND);
     }
 
-    //    @Test
-    //    public void execute_commandExecutionError_throwsCommandException() {
-    //        String deleteCommand = "delete 9";
-    //        String expectedMessage = MESSAGE_INVALID_PATIENT_DISPLAYED_INDEX;
-    //        assertCommandException(deleteCommand, expectedMessage);
-    //    }
-
     @Test
     public void execute_validCommand_success() throws Exception {
         String expectedMessage = String.format(MESSAGE_ALL_PATIENTS_LISTED_OVERVIEW, 0);
         String listCommand = ListCommand.COMMAND_WORD;
         assertCommandSuccess(listCommand, expectedMessage, model);
     }
 
-
-    @Test
-    public void execute_storageThrowsIoException_throwsCommandException() {
-        // Setup LogicManager with JsonMedInfoIoExceptionThrowingStub
-        JsonMedInfoStorage medInfoStorage = new
-        JsonMedInfoIoExceptionThrowingStub(
-        temporaryFolder.resolve("ioExceptionMedInfo.json"));
-        JsonUserPrefsStorage userPrefsStorage = new JsonUserPrefsStorage(
-        temporaryFolder.resolve("ioExceptionUserPrefs.json"));
-        StorageManager storage = new StorageManager(medInfoStorage,
-        userPrefsStorage);
-        logic = new LogicManager(model, storage);
-
-        // Execute add command
-        String addCommand = AddCommand.COMMAND_WORD + NAME_DESC_AMY + NRIC_DESC_AMY + STATUS_DESC_AMY;
-        Patient expectedPatient = new PatientBuilder(AMY).build();
-        ModelManager expectedModel = new ModelManager();
-        try {
-            expectedModel.addPatient(expectedPatient);
-        } catch (CommandException e) {
-            System.out.println("CommandException at LogicManagerTest: "
-                + "execute_storageThrowsIoException_throwsCommandException()");
-        }
-        String expectedMessage = LogicManager.FILE_OPS_ERROR_MESSAGE + DUMMY_IO_EXCEPTION;
-        assertCommandFailure(addCommand, CommandException.class, expectedMessage, expectedModel);
-    }
-
     @Test
     public void getFilteredPersonList_modifyList_throwsUnsupportedOperationException() {
         assertThrows(UnsupportedOperationException.class, () -> logic.getFilteredPatientList().remove(0));

src/test/java/seedu/medinfo/logic/commands/AddCommandIntegrationTest.java

@@ -20,25 +20,4 @@ public void setUp() {
         model = new ModelManager(getTypicalMedInfo(), new UserPrefs());
     }
 
-    //    @Test
-    //    public void execute_newPerson_success() {
-    //        Patient validPatient = new PatientBuilder().build();
-    //
-    //        Model expectedModel = new ModelManager(model.getMedInfo(), new UserPrefs());
-    //        try {
-    //            expectedModel.addPatient(validPatient);
-    //        } catch (CommandException e) {
-    //
-    //        }
-    //
-    //        assertCommandSuccess(new AddCommand(validPatient), model,
-    //                String.format(AddCommand.MESSAGE_SUCCESS, validPatient), expectedModel);
-    //    }
-    //
-    //    @Test
-    //    public void execute_duplicatePerson_throwsCommandException() {
-    //        Patient patientInList = model.getMedInfo().getPatientList().get(0);
-    //        assertCommandFailure(new AddCommand(patientInList), model, AddCommand.MESSAGE_DUPLICATE_PATIENT);
-    //    }
-
 }

src/test/java/seedu/medinfo/logic/commands/ClearCommandTest.java

@@ -16,14 +16,4 @@ public void execute_emptyMedInfo_success() {
 
         assertCommandSuccess(new ClearCommand(), model, ClearCommand.MESSAGE_SUCCESS, expectedModel);
     }
-
-    //    @Test
-    //    public void execute_nonEmptyMedInfo_success() {
-    //        Model model = new ModelManager(getTypicalMedInfo(), new UserPrefs());
-    //        Model expectedModel = new ModelManager(getTypicalMedInfo(), new UserPrefs());
-    //        expectedModel.setMedInfo(new MedInfo());
-    //
-    //        assertCommandSuccess(new ClearCommand(), model, ClearCommand.MESSAGE_SUCCESS, expectedModel);
-    //    }
-
 }