[CS2113T-T10-1] SplitLah

.gitignore

@@ -14,4 +14,10 @@ src/main/resources/docs/
 bin/
 
 /text-ui-test/ACTUAL.txt
-text-ui-test/EXPECTED-UNIX.TXT
+/text-ui-test/ACTUAL.TXT
+/text-ui-test/EXPECTED-UNIX.txt
+/text-ui-test/EXPECTED-UNIX.TXT
+
+# Storage files
+/data/
+/data/SplitLah.data

build.gradle

@@ -29,11 +29,11 @@ test {
 }
 
 application {
-    mainClassName = "seedu.duke.Duke"
+    mainClassName = "seedu.splitlah.SplitLah"
 }
 
 shadowJar {
-    archiveBaseName = "duke"
+    archiveBaseName = "splitlah"
     archiveClassifier = null
 }
 
@@ -43,4 +43,5 @@ checkstyle {
 
 run{
     standardInput = System.in
+    enableAssertions = true
 }

docs/AboutUs.md

@@ -1,9 +1,9 @@
 # About us
 
-Display | Name | Github Profile | Portfolio 
---------|:----:|:--------------:|:---------:
-![](https://via.placeholder.com/100.png?text=Photo) | John Doe | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
-![](https://via.placeholder.com/100.png?text=Photo) | Don Joe | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
-![](https://via.placeholder.com/100.png?text=Photo) | Ron John | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
-![](https://via.placeholder.com/100.png?text=Photo) | John Roe | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
-![](https://via.placeholder.com/100.png?text=Photo) | Don Roe | [Github](https://github.com/) | [Portfolio](docs/team/johndoe.md)
+Display |   Name   |               Github Profile                | Portfolio 
+--------|:--------:|:-------------------------------------------:|:---------:
+![](https://via.placeholder.com/100.png?text=Photo) |   Ivan   | [Github](https://github.com/ivanaitzliddat) | [Portfolio](docs/team/johndoe.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Ren Tianle  |  [Github](https://github.com/lelerer)    | [Portfolio](docs/team/johndoe.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Saurav  |    [Github](https://github.com/matheril)    | [Portfolio](docs/team/johndoe.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Roy Tang |        [Github](https://github.com/froststein)        | [Portfolio](docs/team/johndoe.md)
+![](https://via.placeholder.com/100.png?text=Photo) | Warren Chong Xu Wei |   [Github](https://github.com/warrencxw)    | [Portfolio](docs/team/johndoe.md)

docs/README.md

@@ -1,6 +1,9 @@
-# Duke
+# SplitLah
+
+SplitLah is an application for keeping track of expenses during group outing sessions, specifically for those 
+who are budget conscious. It then proceeds to split the expenses according to the group members' individual costs for 
+the activities they participated in, for a particular session, via a Command Line Interface(CLI).
 
-{Give product intro here}
 
 Useful links:
 * [User Guide](UserGuide.md)

docs/_config.yml

@@ -0,0 +1,2 @@
+theme: jekyll-theme-cayman
+markdown: kramdown

src/main/java/seedu/splitlah/SplitLah.java

@@ -0,0 +1,54 @@
+package seedu.splitlah;
+
+import seedu.splitlah.command.Command;
+import seedu.splitlah.data.Manager;
+import seedu.splitlah.parser.Parser;
+import seedu.splitlah.ui.Message;
+
+import java.util.logging.Level;
+
+/**
+ * Entry point of the SplitLah application.
+ * Initializes SplitLah and starts interacting with the user.
+ */
+public class SplitLah {
+    Manager manager;
+
+    public static void main(String[] args) {
+        new SplitLah().run();
+    }
+
+    /** Sets up the required objects for application.  */
+    public SplitLah() {
+        manager = new Manager(true);
+    }
+
+    /** Runs the program until it terminates.  */
+    private void run() {
+        showWelcomeMessage();
+        runProcessLoop();
+        exitApplication();
+    }
+
+    /** Prints welcome message.  */
+    private void showWelcomeMessage() {
+        manager.getUi().printWelcome();
+    }
+
+    /** Exits the program.  */
+    private void exitApplication() {
+        Manager.getLogger().log(Level.INFO, Message.LOGGER_SPLITLAH_APPLICATION_EXIT);
+        System.exit(0);
+    }
+
+    /** Reads the user input until the user enters the exit command.  */
+    private void runProcessLoop() {
+        Command command;
+        do {
+            String userInput = manager.getUi().readNextLine();
+            command = Parser.getCommand(userInput);
+            command.run(manager);
+        } while (!command.isExitCommand());
+        manager.saveProfile();
+    }
+}

src/main/java/seedu/splitlah/command/ActivityCreateCommand.java

@@ -0,0 +1,239 @@
+package seedu.splitlah.command;
+
+import seedu.splitlah.data.Activity;
+import seedu.splitlah.data.Manager;
+import seedu.splitlah.data.Person;
+import seedu.splitlah.data.Profile;
+import seedu.splitlah.data.Session;
+import seedu.splitlah.data.PersonList;
+import seedu.splitlah.exceptions.InvalidDataException;
+import seedu.splitlah.ui.Message;
+import seedu.splitlah.ui.TextUI;
+
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.logging.Level;
+
+/**
+ * Represents a command that creates an Activity object from user input and stores it in the Session object.
+ *
+ * @author Ivan
+ */
+public class ActivityCreateCommand extends Command {
+
+    private static final String COMMAND_SUCCESS = "The activity was created successfully.\n";
+
+    private final int sessionId;
+    private final String activityName;
+    private double totalCost;
+    private final String payer;
+    private final String[] involvedList;
+    private double[] costList;
+    private final double gst;
+    private final double serviceCharge;
+
+    private static final double ZERO_COST_PAID = 0;
+    public static final double ZERO_COST_OWED = 0;
+    private static final int NO_COST = 0;
+
+    /**
+     * Initializes an ActivityCreateCommand object.
+     *
+     * @param sessionId     An integer that uniquely identifies a session.
+     * @param activityName  A String object that represents the Activity object's name.
+     * @param totalCost     A double that represents total cost of the activity.
+     * @param payer         A String object that represents the name of the person who paid for the activity.
+     * @param involvedList  An array of String objects that represents the names of the persons
+     *                      who are involved in the activity.
+     * @param costList      A double array object that represents the respective costs of
+     *                      each person involved in the activity.
+     * @param gst           A double that represents the GST percentage to be included for the cost of the activity.
+     * @param serviceCharge A double that represents the service charge to be included for the cost of the activity.
+     */
+    public ActivityCreateCommand(int sessionId, String activityName, double totalCost, String payer,
+                                 String[] involvedList, double[] costList, double gst, double serviceCharge) {
+        assert sessionId > 0 : Message.ASSERT_ACTIVITYCREATE_SESSION_ID_LESS_THAN_ONE;
+        assert activityName != null : Message.ASSERT_ACTIVITYCREATE_ACTIVITY_NAME_MISSING;
+        assert payer != null : Message.ASSERT_ACTIVITYCREATE_PAYER_NAME_MISSING;
+        assert involvedList != null : Message.ASSERT_ACTIVITYCREATE_INVOLVED_LIST_ARRAY_NULL;
+        this.sessionId = sessionId;
+        this.activityName = activityName;
+        this.totalCost = totalCost;
+        this.payer = payer;
+        this.involvedList = involvedList;
+        this.costList = costList;
+        this.gst = gst;
+        this.serviceCharge = serviceCharge;
+    }
+
+    /**
+     * Adds all relevant activity costs to each involved person's list of activity costs.
+     *
+     * @param involvedPersonList An ArrayList object containing Person objects
+     *                           each representing a person involved in the activity.
+     * @param personPaid         A Person object representing the person who paid for the activity.
+     * @param activityId         An integer that uniquely identifies an activity.
+     */
+    private void addAllActivityCost(ArrayList<Person> involvedPersonList, Person personPaid, int activityId) {
+        boolean hasAddedForPersonPaid = false;
+        for (int i = 0; i < involvedPersonList.size(); i++) {
+            Person person = involvedPersonList.get(i);
+            addCostOwedAndCostPaid(personPaid, activityId, i, person);
+            hasAddedForPersonPaid = isPersonPaid(personPaid, hasAddedForPersonPaid, person);
+        }
+        if (!hasAddedForPersonPaid) {
+            personPaid.addActivityCost(activityId, totalCost, ZERO_COST_OWED);
+        }
+    }
+
+    /**
+     * Checks if the Person object currently referred to represents the person who paid for the activity.
+     *
+     * @param personPaid            A Person object representing the person who paid for the activity.
+     * @param hasAddedForPersonPaid A boolean representing whether the activity cost has been added for the person who
+     *                              paid for the activity.
+     * @param person                A Person object representing the person currently referred to
+     *                              among the persons involved.
+     * @return true if the Person object currently referred to represents the person who paid for the activity,
+     *         hasAddedForPersonPaid otherwise.
+     */
+    private boolean isPersonPaid(Person personPaid, boolean hasAddedForPersonPaid, Person person) {
+        if (person == personPaid) {
+            hasAddedForPersonPaid = true;
+        }
+        return hasAddedForPersonPaid;
+    }
+
+    /**
+     * Adds cost owed and cost paid to each individual's list of activity costs.
+     * Checks if the current person is the person who paid for the activity.
+     * If it is, the cost paid is set to the total cost of the activity.
+     * Else, the cost paid is set to 0.
+     *
+     * @param personPaid      A Person object representing the person who paid for the activity.
+     * @param activityId      An integer that uniquely identifies an activity.
+     * @param indexOfCostOwed An integer representing the index of the cost owed in the list of costs.
+     * @param person          A person object representing the person whose costs are added to the
+     *                        list of activity costs.
+     */
+    private void addCostOwedAndCostPaid(Person personPaid, int activityId, int indexOfCostOwed, Person person) {
+        if (person == personPaid) {
+            person.addActivityCost(activityId, totalCost, costList[indexOfCostOwed]);
+        } else {
+            person.addActivityCost(activityId, ZERO_COST_PAID, costList[indexOfCostOwed]);
+        }
+    }
+
+    /**
+     * Updates cost and list of costs by adding the extra charges and
+     * checks if cost list or cost was provided by the user.
+     * If cost was not provided by the user, the list of costs is summed up to get the total cost of the activity.
+     * Else, the total cost is distributed evenly.
+     */
+    private void updateCostAndCostList() {
+        boolean isZeroCost = totalCost == NO_COST;
+        if (isZeroCost) {
+            updateCostListWithExtraCharges();
+            calculateTotalCost();
+        } else {
+            updateCostWithExtraCharges();
+            int numberOfPeopleInvolved = involvedList.length;
+            costList = distributeCostEvenly(numberOfPeopleInvolved);
+        }
+    }
+
+    /**
+     * Updates cost list by including the extra charges.
+     * Extra charges may include GST and service charge.
+     * Assumption: GST and service charge are non-negative values.
+     */
+    private void updateCostListWithExtraCharges() {
+        double extraCharges = getExtraCharges();
+        for (int i = 0; i < costList.length; i++) {
+            costList[i] *= extraCharges;
+        }
+    }
+
+    /**
+     * Updates the total cost of the activity by summing up the costs in the list of costs.
+     */
+    private void calculateTotalCost() {
+        for (double cost : costList) {
+            totalCost += cost;
+        }
+    }
+
+    /**
+     * Updates total cost by including the extra charges.
+     * Extra charges may include GST and service charge.
+     * Assumption: GST and service charge are non-negative values.
+     */
+    private void updateCostWithExtraCharges() {
+        double extraCharges = getExtraCharges();
+        totalCost *= extraCharges;
+    }
+
+    /**
+     * Returns a double representing the extra charges that is to be included in costs of the activity.
+     *
+     * @return A double representing the extra charges.
+     */
+    private double getExtraCharges() {
+        double gstMultiplier = 1 + gst / 100;
+        double serviceChargeMultiplier = 1 + serviceCharge / 100;
+        return gstMultiplier * serviceChargeMultiplier;
+    }
+
+    /**
+     * Returns an array of doubles of the costs that has been distributed evenly
+     * among the persons involved in the activity.
+     * Divides the total cost by the number of people involved in the activity.
+     *
+     * @param numberOfPeopleInvolved An integer representing the number of people involved in the activity.
+     * @return An array of doubles representing the costs of each person involved in the activity.
+     */
+    private double[] distributeCostEvenly(int numberOfPeopleInvolved) {
+        double dividedCost = totalCost / numberOfPeopleInvolved;
+        double[] costList = new double[numberOfPeopleInvolved];
+        Arrays.fill(costList, dividedCost);
+        return costList;
+    }
+
+    /**
+     * Runs the command to create an Activity object to be stored in a Session object managed by the Profile object.
+     * Gets relevant parameters to create an Activity object.
+     * If no errors getting parameters, an Activity object is created and added to the session.
+     *
+     * @param manager A Manager object that manages the TextUI, Profile and Storage object.
+     */
+    @Override
+    public void run(Manager manager) {
+        boolean hasDuplicates = PersonList.hasNameDuplicates(involvedList);
+        TextUI ui = manager.getUi();
+        if (hasDuplicates) {
+            ui.printlnMessage(Message.ERROR_PERSONLIST_DUPLICATE_NAME_IN_ACTIVITY);
+            Manager.getLogger().log(Level.FINEST,Message.LOGGER_PERSONLIST_NAME_DUPLICATE_EXISTS_IN_CREATEACTIVITY);
+            return;
+        }
+        try {
+            updateCostAndCostList();
+            assert costList != null : Message.ASSERT_ACTIVITYCREATE_COST_LIST_ARRAY_NULL;
+            assert totalCost > 0 : Message.ASSERT_ACTIVITYCREATE_TOTAL_COST_LESS_THAN_ONE;
+            Profile profile = manager.getProfile();
+            Session session = profile.getSession(sessionId);
+            Person personPaid = session.getPersonByName(payer);
+            ArrayList<Person> involvedPersonList = session.getPersonListByName(involvedList);
+            int activityId = profile.getNewActivityId();
+            addAllActivityCost(involvedPersonList, personPaid, activityId);
+            Activity activity = new Activity(activityId, activityName, totalCost, personPaid, involvedPersonList);
+            session.addActivity(activity);
+            manager.saveProfile();
+            ui.printlnMessage(COMMAND_SUCCESS + activity);
+            Manager.getLogger().log(Level.FINEST,Message.LOGGER_ACTIVITYCREATE_ACTIVITY_ADDED + activityId);
+        } catch (InvalidDataException e) {
+            ui.printlnMessage(e.getMessage());
+            Manager.getLogger().log(Level.FINEST,Message.LOGGER_ACTIVITYCREATE_FAILED_ADDING_ACTIVITY
+                    + "\n" + e.getMessage());
+        }
+    }
+}