Merge pull request #165 from sheexiong/master

Create a new UserPrefs class for both features and update DG for listamount function.

Author: sheexiong

docs/DeveloperGuide.adoc

@@ -299,7 +299,7 @@ image::activityDiagram_for_expensesplitter.png[]
 
 The following is a detailed explanation of the operations `DeleteItemCommand` performs. +
 
-1. The `DeieteItemCommand#execute(Model model)` method is executed and it validates that the specified `INDEX` to delete
+1. The `DeleteItemCommand#execute(Model model)` method is executed and it validates that the specified `INDEX` to delete
 is within range. If valid, the item to be deleted will be retrieved from Receipt using its I`Index`.
 
 2. The method `Model#deleteEntry(int Index) will then be called to remove the Item from the Receipt.
@@ -326,6 +326,21 @@ The following
 
 ==== List Amount Command
 
+*Implementation*
+
+The following is a detailed explanation of the operations `ListAmountCommand` performs. +
+
+1. The `ListAmountCommand#execute(Model model)` method is executed.
+
+2. The method `Model#listAmount()` will then be called to return the list of person with amount.
+
+3. `PersonAmountBook#toString()` will convert list of person in the list to the expected format.
+
+The following is a sample sequence diagram of the ListAmountCommand.
+
+image::ExpenseSplitterListAmountCommandSequenceDiagram.png[]
+
+
 ==== Paid Command
 
 ==== Back Command

docs/UserGuide.adoc

@@ -193,14 +193,14 @@ EYLAH will calculate the rest for you!
 Add item and the person involved in the splitting for that item.
 
 Format: +
-`addfood -i ITEMNAME -p PRICE -n ALL` +
-`addfood -i ITEMNAME -p PRICE -n NAME [-n NAME]...` +
+`additem -i ITEMNAME -p PRICE -n ALL` +
+`additem -i ITEMNAME -p PRICE -n NAME [-n NAME]...` +
 
 NOTE: Entering `ALL` will split that item with all Person(s) currently in PersonList.
 
 Example: +
-`addfood -i pizza -p 30 -n all` +
-`addfood -i pasta -p 19.90 -n john -n bob -n daniel`
+`additem -i pizza -p 30 -n all` +
+`additem -i pasta -p 19.90 -n john -n bob -n daniel`
 
 ==== Delete item  `deleteitem`
 Delete the item(s) in a receipt:
@@ -214,7 +214,7 @@ Use `listreceipt` to view your item indices before deletion.
 Example: +
 `deleteitem 3`
 
-==== List person(s) `listamount`
+==== List person's amount `listamount`
 
 Display all the Person(s) in the PersonList with the amount they owe you.
 

docs/diagrams/ExpenseSplitterListAmountCommandSequenceDiagram.puml

@@ -0,0 +1,33 @@
+@startuml
+!include style.puml
+
+Actor User as user USER_COLOR
+Participant ":EYLAH" as ui UI_COLOR
+Participant ":LogicManager" as logic LOGIC_COLOR
+Participant ":ModelManager" as model MODEL_COLOR
+Participant ":PersonAmountBook" as personAmountBook MODEL_COLOR
+
+user -[USER_COLOR]> ui : "listamount"
+activate ui UI_COLOR
+
+ui -[UI_COLOR]> logic : execute("listamount")
+activate logic LOGIC_COLOR
+
+logic -[LOGIC_COLOR]> model : listAmount()
+activate model MODEL_COLOR
+
+model -[MODEL_COLOR]> personAmountBook : toString()
+activate personAmountBook MODEL_COLOR
+
+personAmountBook --[STORAGE_COLOR]> model : String
+deactivate personAmountBook
+
+model --[STORAGE_COLOR]-> logic : String
+deactivate model
+
+logic --[LOGIC_COLOR]> ui : CommandResult
+deactivate logic
+
+ui--[UI_COLOR]> user : CommandResult
+deactivate ui
+@enduml

docs/images/ExpenseSplitterListAmountCommandSequenceDiagram.png

@@ -0,0 +1,13 @@
+package seedu.eylah.commons.model;
+
+import java.nio.file.Path;
+
+/**
+ * Unmodifiable view of user prefs.
+ */
+public interface ReadOnlyUserPrefs {
+
+    Path getFoodBookFilePath();
+
+    Path getPersonAmountFilePath();
+}

src/main/java/seedu/eylah/commons/model/ReadOnlyUserPrefs.java

@@ -0,0 +1,103 @@
+package seedu.eylah.commons.model;
+
+import static java.util.Objects.requireNonNull;
+
+import java.nio.file.Path;
+import java.nio.file.Paths;
+import java.util.Objects;
+
+/**
+ * Represents User's preferences.
+ */
+public class UserPrefs implements ReadOnlyUserPrefs {
+
+    private Path foodBookFilePath = Paths.get("data" , "foodbook.json");
+    private Path personAmountFilePath = Paths.get("data", "personamount.json");
+
+    /**
+     * Creates a {@code UserPrefs} with default values.
+     */
+    public UserPrefs() {}
+
+    /**
+     * Creates a {@code UserPrefs} with the prefs in {@code userPrefs}.
+     */
+    public UserPrefs(UserPrefs userPrefs) {
+        this();
+        resetData(userPrefs);
+    }
+
+    /**
+     * Resets the existing data of this {@code UserPrefs} with {@code newUserPrefs}.
+     */
+    public void resetData(ReadOnlyUserPrefs newUserPrefs) {
+        requireNonNull(newUserPrefs);
+        setFoodBookFilePath(newUserPrefs.getFoodBookFilePath());
+        setPersonAmountFilePath(newUserPrefs.getPersonAmountFilePath());
+    }
+
+    /**
+     * Returns the FoodBook file path.
+     *
+     * @return FoodBook file path
+     */
+    public Path getFoodBookFilePath() {
+        return foodBookFilePath;
+    }
+
+    /**
+     * Set the FoodBook file path based on the given path.
+     *
+     * @param foodBookFilePath the given file path.
+     */
+    public void setFoodBookFilePath(Path foodBookFilePath) {
+        requireNonNull(foodBookFilePath);
+        this.foodBookFilePath = foodBookFilePath;
+    }
+
+    /**
+     * Returns the PersonAmount file path.
+     *
+     * @return PersonAmount file path
+     */
+    public Path getPersonAmountFilePath() {
+        return personAmountFilePath;
+    }
+
+    /**
+     * Set the Person Amount file path based on the given path.
+     *
+     * @param personAmountFilePath the given file path.
+     */
+    public void setPersonAmountFilePath(Path personAmountFilePath) {
+        requireNonNull(personAmountFilePath);
+        this.personAmountFilePath = personAmountFilePath;
+    }
+
+    @Override
+    public boolean equals(Object other) {
+        if (other == this) {
+            return true;
+        }
+        if (!(other instanceof UserPrefs)) { //this handles null as well.
+            return false;
+        }
+
+        UserPrefs o = (UserPrefs) other;
+
+        return foodBookFilePath.equals(o.foodBookFilePath)
+                && personAmountFilePath.equals(o.personAmountFilePath);
+    }
+
+    @Override
+    public int hashCode() {
+        return Objects.hash(foodBookFilePath, personAmountFilePath);
+    }
+
+    @Override
+    public String toString() {
+        StringBuilder sb = new StringBuilder();
+        sb.append(String.format("Local data file location : %s %s", foodBookFilePath, personAmountFilePath));
+        return sb.toString();
+    }
+}

src/main/java/seedu/eylah/commons/model/UserPrefs.java

@@ -0,0 +1,35 @@
+package seedu.eylah.commons.storage;
+
+import java.io.IOException;
+import java.nio.file.Path;
+import java.util.Optional;
+
+import seedu.eylah.commons.exceptions.DataConversionException;
+import seedu.eylah.commons.model.ReadOnlyUserPrefs;
+import seedu.eylah.commons.model.UserPrefs;
+
+/**
+ * Represents a storage for {@link UserPrefs}.
+ */
+public interface UserPrefsStorage {
+
+    /**
+     * Returns the file path of the UserPrefs data file.
+     */
+    Path getUserPrefsFilePath();
+
+    /**
+     * Returns UserPrefs data from storage.
+     *   Returns {@code Optional.empty()} if storage file is not found.
+     * @throws DataConversionException if the data in storage is not in the expected format.
+     * @throws IOException if there was any problem when reading from the storage.
+     */
+    Optional<UserPrefs> readUserPrefs() throws DataConversionException, IOException;
+
+    /**
+     * Saves the given {@link ReadOnlyUserPrefs} to the storage.
+     * @param userPrefs cannot be null.
+     * @throws IOException if there was any problem writing to the file.
+     */
+    void saveUserPrefs(ReadOnlyUserPrefs userPrefs) throws IOException;
+}

src/main/java/seedu/eylah/commons/storage/UserPrefsStorage.java

@@ -22,7 +22,6 @@ public JsonUserPrefsStorage(Path filePath) {
 
     @Override
     public Path getUserPrefsFilePath() {
-
         return filePath;
     }
 
@@ -31,8 +30,13 @@ public Optional<UserPrefs> readUserPrefs() throws DataConversionException {
         return readUserPrefs(filePath);
     }
 
-    public Optional<UserPrefs> readUserPrefs(Path presFilePath) throws DataConversionException {
-        return JsonUtil.readJsonFile(presFilePath, UserPrefs.class);
+    /**
+     * Similar to {@link #readUserPrefs()}
+     * @param prefsFilePath location of the data. Cannot be null.
+     * @throws DataConversionException if the file format is not as expected.
+     */
+    public Optional<UserPrefs> readUserPrefs(Path prefsFilePath) throws DataConversionException {
+        return JsonUtil.readJsonFile(prefsFilePath, UserPrefs.class);
     }
 
     @Override