Merge pull request #33 from JermyTan/master

Code cleanup

Author: JermyTan

README.adoc

@@ -11,7 +11,7 @@ ifndef::env-github[]
 image::images/Ui.png[width="600"]
 endif::[]
 
-Have you ever lost track of your items' expiry dates and end up throwing the items away? Have you ever open your fridge to search for your favourite chocolate, only to realise that it has already expired? Fret not! Xpire is here to save you! With features to help you keep track of your items' expiry dates as well as to remind you of soon-expiring items, you will never have to face any expired items ever again.
+Have you ever lost track of your items' expiry dates and end up throwing the items away? Have you ever open your fridge to search for your favourite chocolate, only to realise that it has already expired? Fret not! Xpire is here to save you! With features to help you keep track of your items' expiry dates as well as to remind you of soon-expiring items, you will never have to worry about when your items are expiring again. Next time, you will be sure to eat that chocolate before it expires!
 
 Interested to try out our application? Head over to the <<UserGuide#, UserGuide>> to get started!
 

build.gradle

@@ -15,7 +15,7 @@ plugins {
 }
 
 // Specifies the entry point of the application
-mainClassName = 'seedu.address.Main'
+mainClassName = 'io.xpire.Main'
 
 sourceCompatibility = JavaVersion.VERSION_11
 targetCompatibility = JavaVersion.VERSION_11

docs/UserGuide.adoc

@@ -47,10 +47,9 @@ e.g. typing *`help`* and pressing kbd:[Enter] will open the help window.
 ====
 *Command Format*
 
-* Words that are enclosed with `<` and `>` are the parameters to be supplied by the user e.g. in `add|<item name>|<expiry date>`, `<item name>` and `<expiry date>` are parameters which can be used as `add|banana|25/09/2019`.
-* Items in square brackets are optional e.g `add|<item name>|<expiry date>|[#tag]` can be used as `add|strawberry|10/10/2019|#Fruit`.
-* Items with `…`​ after them can be used multiple times including zero times e.g. `tag|<index>|#tag...` can be used as `tag|1|#Fruit #Frozen #Cold`, `tag|1`, or `tag|1|#Fruit` etc.
-//* Parameters can be in any order e.g. if the command specifies `n/NAME p/PHONE_NUMBER`, `p/PHONE_NUMBER n/NAME` is also acceptable.
+* Words that are enclosed with `<` and `>` are the parameters to be supplied by the user e.g. in `set reminder|<index>|<threshold>`, `<index>` and `<threshold>` are parameters which can be used as `set reminder|1|7`.
+* Parameters in square brackets are optional e.g `check[|<days>]` can be used as `check|7` or `check`.
+* Optional parameters with `…`​ after them can be used multiple times including zero times e.g. `tag|<index>|[<tag>]...` can be used as `tag|1|#Fruit #Frozen #Cold`, `tag|1`, or `tag|1|#Fruit`.
 ====
 
 === Viewing help : `help`
@@ -60,7 +59,7 @@ Format: `help`
 === Adding an item: `add`
 
 Adds item to list +
-Format: `add|<item name>|<expiry date>[|#tag...]`
+Format: `add|<item name>|<expiry date>|[<tag>]...`
 
 [TIP]
 An item can have any number of tags (including 0)
@@ -102,7 +101,7 @@ Format: `view`
 === Listing expiring items : `check`
 
 Shows expiring items in the list. +
-Format: `check|<days>`
+Format: `check[|<days>]`
 
 ****
 * Lists items expiring within the specified number of `<days>`
@@ -117,7 +116,7 @@ Lists items expiring in the next 20 days.
 === Sorting all items : `sort`
 
 Sorts all items in the list by either name or date. +
-Format: `sort|<method>`
+Format: `sort|<key>`
 
 ****
 * Sorting by both name and date is done in ascending order.
@@ -133,7 +132,7 @@ Examples:
 === Searching item by name: `search`
 
 Search items whose names contain any of the given keywords. +
-Format: `search|<keyword>|[other keywords...]`
+Format: `search|<keyword>[|<other keywords>]...`
 
 ****
 * The search is case insensitive. e.g `ham` will match `Ham`
@@ -179,7 +178,7 @@ Deletes the 1st item in the results of the `search` command.
 === Tagging an item : `tag`
 
 Tags an item from the list according to user input or clears item of tags. +
-Format: `tag|<index>|#tag...`
+Format: `tag|<index>|[<tag>]...`
 
 ****
 * Tags the item at the specified `<index>`.
@@ -226,21 +225,21 @@ There is no need to save manually.
 
 == Command Summary
 
-* *Add* `add|<item name>|<expiry date>` +
+* *Add* `add|<item name>|<expiry date>|[<tag>]...` +
 e.g. `add|durian|30/9/2019`
 * *Clear* : `clear`
 * *Delete* : `delete|<index>` +
 e.g. `delete|3`
 * *List* : `list`
-* *Sort* : `sort|<method>`+
+* *Sort* : `sort|<key>`+
 e.g. `sort|date`
 //* *Edit* : `edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [t/TAG]...` +
 //e.g. `edit 2 n/James Lee e/jameslee@example.com`
-* *Search* : `search|<keyword>|[other keywords...]` +
+* *Search* : `search|<keyword>[|<other keywords>]...` +
 e.g. `search|milk|tea|pearls`
-* *Tag* : `tag|<index>|#tag...`
+* *Tag* : `tag|<index>|[<tag>]...`
 * *View* : `view`
-* *Check* : `check|<days>` +
+* *Check* : `check[|<days>]` +
 e.g. `check|20`
 * *Help* : `help`
 

src/main/java/seedu/address/AppParameters.java src/main/java/io/xpire/AppParameters.java

@@ -1,14 +1,14 @@
-package seedu.address;
+package io.xpire;
 
 import java.nio.file.Path;
 import java.nio.file.Paths;
 import java.util.Map;
 import java.util.Objects;
 import java.util.logging.Logger;
 
+import io.xpire.commons.core.LogsCenter;
+import io.xpire.commons.util.FileUtil;
 import javafx.application.Application;
-import seedu.address.commons.core.LogsCenter;
-import seedu.address.commons.util.FileUtil;
 
 /**
  * Represents the parsed command-line parameters given to the application.

src/main/java/seedu/address/Main.java src/main/java/io/xpire/Main.java

@@ -1,4 +1,4 @@
-package seedu.address;
+package io.xpire;
 
 import javafx.application.Application;
 

src/main/java/seedu/address/MainApp.java src/main/java/io/xpire/MainApp.java

@@ -1,35 +1,35 @@
-package seedu.address;
+package io.xpire;
 
 import java.io.IOException;
 import java.nio.file.Path;
 import java.util.Optional;
 import java.util.logging.Logger;
 
+import io.xpire.commons.core.Config;
+import io.xpire.commons.core.LogsCenter;
+import io.xpire.commons.core.Version;
+import io.xpire.commons.exceptions.DataConversionException;
+import io.xpire.commons.util.ConfigUtil;
+import io.xpire.commons.util.StringUtil;
+import io.xpire.logic.Logic;
+import io.xpire.logic.LogicManager;
+import io.xpire.model.Model;
+import io.xpire.model.ModelManager;
+import io.xpire.model.ReadOnlyUserPrefs;
+import io.xpire.model.ReadOnlyXpire;
+import io.xpire.model.UserPrefs;
+import io.xpire.model.Xpire;
+import io.xpire.model.util.SampleDataUtil;
+import io.xpire.storage.JsonUserPrefsStorage;
+import io.xpire.storage.JsonXpireStorage;
+import io.xpire.storage.Storage;
+import io.xpire.storage.StorageManager;
+import io.xpire.storage.UserPrefsStorage;
+import io.xpire.storage.XpireStorage;
+import io.xpire.ui.Ui;
+import io.xpire.ui.UiManager;
 import javafx.application.Application;
 import javafx.stage.Stage;
-import seedu.address.commons.core.Config;
-import seedu.address.commons.core.LogsCenter;
-import seedu.address.commons.core.Version;
-import seedu.address.commons.exceptions.DataConversionException;
-import seedu.address.commons.util.ConfigUtil;
-import seedu.address.commons.util.StringUtil;
-import seedu.address.logic.Logic;
-import seedu.address.logic.LogicManager;
-import seedu.address.model.ExpiryDateTracker;
-import seedu.address.model.Model;
-import seedu.address.model.ModelManager;
-import seedu.address.model.ReadOnlyExpiryDateTracker;
-import seedu.address.model.ReadOnlyUserPrefs;
-import seedu.address.model.UserPrefs;
-import seedu.address.model.util.SampleDataUtil;
-import seedu.address.storage.ExpiryDateTrackerStorage;
-import seedu.address.storage.JsonExpiryDateTrackerStorage;
-import seedu.address.storage.JsonUserPrefsStorage;
-import seedu.address.storage.Storage;
-import seedu.address.storage.StorageManager;
-import seedu.address.storage.UserPrefsStorage;
-import seedu.address.ui.Ui;
-import seedu.address.ui.UiManager;
 
 /**
  * Runs the application.
@@ -48,18 +48,18 @@ public class MainApp extends Application {
 
     @Override
     public void init() throws Exception {
-        logger.info("=============================[ Initializing ExpiryDateTracker ]===========================");
+        logger.info("=============================[ Initializing Xpire ]===========================");
         super.init();
 
         AppParameters appParameters = AppParameters.parse(getParameters());
         config = initConfig(appParameters.getConfigPath());
 
         UserPrefsStorage userPrefsStorage = new JsonUserPrefsStorage(config.getUserPrefsFilePath());
         UserPrefs userPrefs = initPrefs(userPrefsStorage);
-        ExpiryDateTrackerStorage expiryDateTrackerStorage = new JsonExpiryDateTrackerStorage(
-                userPrefs.getExpiryDateTrackerFilePath()
+        XpireStorage xpireStorage = new JsonXpireStorage(
+                userPrefs.getXpireFilePath()
         );
-        storage = new StorageManager(expiryDateTrackerStorage, userPrefsStorage);
+        storage = new StorageManager(xpireStorage, userPrefsStorage);
 
         initLogging(config);
 
@@ -77,20 +77,20 @@ public void init() throws Exception {
      * {@code storage}'s expiry date tracker.
      */
     private Model initModelManager(Storage storage, ReadOnlyUserPrefs userPrefs) {
-        Optional<ReadOnlyExpiryDateTracker> expiryDateTrackerOptional;
-        ReadOnlyExpiryDateTracker initialData;
+        Optional<ReadOnlyXpire> expiryDateTrackerOptional;
+        ReadOnlyXpire initialData;
         try {
-            expiryDateTrackerOptional = storage.readExpiryDateTracker();
+            expiryDateTrackerOptional = storage.readXpire();
             if (!expiryDateTrackerOptional.isPresent()) {
                 logger.info("Data file not found. Will be starting with a sample Expiry Date Tracker");
             }
-            initialData = expiryDateTrackerOptional.orElseGet(SampleDataUtil::getSampleExpiryDateTracker);
+            initialData = expiryDateTrackerOptional.orElseGet(SampleDataUtil::getSampleXpire);
         } catch (DataConversionException e) {
             logger.warning("Data file not in the correct format. Will be starting with an empty Expiry Date Tracker");
-            initialData = new ExpiryDateTracker();
+            initialData = new Xpire();
         } catch (IOException e) {
             logger.warning("Problem while reading from the file. Will be starting with an empty Expiry Date Tracker");
-            initialData = new ExpiryDateTracker();
+            initialData = new Xpire();
         }
 
         return new ModelManager(initialData, userPrefs);
@@ -170,13 +170,13 @@ protected UserPrefs initPrefs(UserPrefsStorage storage) {
 
     @Override
     public void start(Stage primaryStage) {
-        logger.info("Starting ExpiryDateTracker " + MainApp.VERSION);
+        logger.info("Starting Xpire " + MainApp.VERSION);
         ui.start(primaryStage);
     }
 
     @Override
     public void stop() {
-        logger.info("============================ [ Stopping ExpiryDateTracker ] =============================");
+        logger.info("============================ [ Stopping Xpire ] =============================");
         try {
             storage.saveUserPrefs(model.getUserPrefs());
         } catch (IOException e) {

src/main/java/seedu/address/commons/core/Config.java src/main/java/io/xpire/commons/core/Config.java

@@ -1,4 +1,4 @@
-package seedu.address.commons.core;
+package io.xpire.commons.core;
 
 import java.nio.file.Path;
 import java.nio.file.Paths;
@@ -17,34 +17,32 @@ public class Config {
     private Path userPrefsFilePath = Paths.get("preferences.json");
 
     public Level getLogLevel() {
-        return logLevel;
+        return this.logLevel;
     }
 
     public void setLogLevel(Level logLevel) {
         this.logLevel = logLevel;
     }
 
     public Path getUserPrefsFilePath() {
-        return userPrefsFilePath;
+        return this.userPrefsFilePath;
     }
 
     public void setUserPrefsFilePath(Path userPrefsFilePath) {
         this.userPrefsFilePath = userPrefsFilePath;
     }
 
     @Override
-    public boolean equals(Object other) {
-        if (other == this) {
+    public boolean equals(Object obj) {
+        if (obj == this) {
             return true;
+        } else if (!(obj instanceof Config)) {
+            return true;
+        } else {
+            Config other = (Config) obj;
+            return Objects.equals(this.logLevel, other.logLevel)
+                    && Objects.equals(this.userPrefsFilePath, other.userPrefsFilePath);
         }
-        if (!(other instanceof Config)) { //this handles null as well.
-            return false;
-        }
-
-        Config o = (Config) other;
-
-        return Objects.equals(logLevel, o.logLevel)
-                && Objects.equals(userPrefsFilePath, o.userPrefsFilePath);
     }
 
     @Override
@@ -55,9 +53,8 @@ public int hashCode() {
     @Override
     public String toString() {
         StringBuilder sb = new StringBuilder();
-        sb.append("Current log level : " + logLevel);
-        sb.append("\nPreference file Location : " + userPrefsFilePath);
+        sb.append("Current log level : " + logLevel + "\n");
+        sb.append("Preference file Location : " + userPrefsFilePath);
         return sb.toString();
     }
-
 }

src/main/java/io/xpire/commons/core/GuiSettings.java

@@ -0,0 +1,71 @@
+package io.xpire.commons.core;
+
+import java.awt.Point;
+import java.io.Serializable;
+import java.util.Objects;
+
+/**
+ * A Serializable class that contains the GUI settings.
+ * Guarantees: immutable.
+ */
+public class GuiSettings implements Serializable {
+
+    private static final double DEFAULT_HEIGHT = 600;
+    private static final double DEFAULT_WIDTH = 740;
+
+    private final double windowWidth;
+    private final double windowHeight;
+    private final Point windowCoordinates;
+
+    public GuiSettings() {
+        this.windowWidth = DEFAULT_WIDTH;
+        this.windowHeight = DEFAULT_HEIGHT;
+        this.windowCoordinates = null; // null represent no coordinates
+    }
+
+    public GuiSettings(double windowWidth, double windowHeight, int xPosition, int yPosition) {
+        this.windowWidth = windowWidth;
+        this.windowHeight = windowHeight;
+        this.windowCoordinates = new Point(xPosition, yPosition);
+    }
+
+    public double getWindowWidth() {
+        return this.windowWidth;
+    }
+
+    public double getWindowHeight() {
+        return this.windowHeight;
+    }
+
+    public Point getWindowCoordinates() {
+        return this.windowCoordinates != null ? new Point(this.windowCoordinates) : null;
+    }
+
+    @Override
+    public boolean equals(Object obj) {
+        if (obj == this) {
+            return true;
+        } else if (!(obj instanceof GuiSettings)) {
+            return false;
+        } else {
+            GuiSettings other = (GuiSettings) obj;
+            return this.windowWidth == other.windowWidth
+                    && this.windowHeight == other.windowHeight
+                    && Objects.equals(this.windowCoordinates, other.windowCoordinates);
+        }
+    }
+
+    @Override
+    public int hashCode() {
+        return Objects.hash(this.windowWidth, this.windowHeight, this.windowCoordinates);
+    }
+
+    @Override
+    public String toString() {
+        StringBuilder sb = new StringBuilder();
+        sb.append("Width : " + this.windowWidth + "\n");
+        sb.append("Height : " + this.windowHeight + "\n");
+        sb.append("Position : " + this.windowCoordinates);
+        return sb.toString();
+    }
+}