Added Quote Command

README.md

@@ -7,8 +7,8 @@ This is a project template for a greenfield Java project. It's named after the J
 Prerequisites: JDK 11 (use the exact version), update Intellij to the most recent version.
 
 1. **Ensure Intellij JDK 11 is defined as an SDK**, as described [here](https://www.jetbrains.com/help/idea/sdk.html#set-up-jdk) -- this step is not needed if you have used JDK 11 in a previous Intellij project.
-1. **Import the project _as a Gradle project_**, as described [here](https://se-education.org/guides/tutorials/intellijImportGradleProject.html).
-1. **Verify the set up**: After the importing is complete, locate the `src/main/java/seedu/duke/Duke.java` file, right-click it, and choose `Run Duke.main()`. If the setup is correct, you should see something like the below:
+2. **Import the project _as a Gradle project_**, as described [here](https://se-education.org/guides/tutorials/intellijImportGradleProject.html).
+3. **Verify the set-up**: After the importing is complete, locate the `src/main/java/seedu/duke/Duke.java` file, right-click it, and choose `Run Duke.main()`. If the setup is correct, you should see something like the below:
    ```
    > Task :compileJava
    > Task :processResources NO-SOURCE
@@ -58,7 +58,7 @@ The project uses [GitHub actions](https://github.com/features/actions) for CI. W
 Steps for publishing documentation to the public: 
 1. If you are using this project template for an individual project, go your fork on GitHub.<br>
    If you are using this project template for a team project, go to the team fork on GitHub.
-1. Click on the `settings` tab.
-1. Scroll down to the `GitHub Pages` section.
-1. Set the `source` as `master branch /docs folder`.
-1. Optionally, use the `choose a theme` button to choose a theme for your documentation.
+2. Click on the `settings` tab.
+3. Scroll down to the `GitHub Pages` section.
+4. Set the `source` as `master branch /docs folder`.
+5. Optionally, use the `choose a theme` button to choose a theme for your documentation.

docs/UserGuide.md

@@ -333,13 +333,13 @@ Format: `add -op -n ITEM_NAME -d ITEM_DESCRIPTION -q ITEM_QUANTITY -e EXPIRY_DAT
 
 Examples:
 
-- `add -op -n milk -d to make cofee -q 2 -e 03-10-2024 -c 1.30`<br>
+- `add -op -n milk -d to make coffee -q 2 -e 03-10-2024 -c 1.30`<br>
    ```text
    -------------------------------------------------------------
    Noted! I have added the following item into your inventory:
 
    [P][O] milk
-       description: to make cofee
+       description: to make coffee
        quantity: 2
        cost price: $1.30
        expiry date: 03-10-2024
@@ -640,6 +640,18 @@ Format: `bye`
 * [Back to table of contents](#table-of-contents)
 ---
 
+### Getting Inspirational Quotes: `quote`
+
+> This command fetches a random quote to uplift your spirits.
+
+Need a little motivation? The quote command retrieves random inspirational messages to brighten your day. Whether you're feeling stuck or just need a boost, BinBash has got you covered!
+
+Format: `quote`
+
+> ℹ️ BinBash brings you a variety of inspiring messages to keep you motivated throughout your inventory management journey. So go ahead, type quote and let the positivity flow!
+* [Back to table of contents](#table-of-contents)
+---
+
 ### Saving and Loading data
 
 Unsure as to how you can save your BinBash data? Don't worry! Your data is automatically saved to your local storage. No manual saving of data is required.
@@ -657,17 +669,18 @@ Similarly, your saved data will be automatically loaded into BinBash when you st
 
 ## Command Summary
 
-| **Command** | **Usage**                                                                                                                                                                                                                                     | **Description**                                                                                                       |
-|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------|
-| **add**     | `add -re -n ITEM_NAME -d ITEM_DESCRIPTION -q ITEM_QUANTITY -e EXPIRY_DATE -s SALE_PRICE -c COST_PRICE -t THRESHOLD` <br> `add -op -n ITEM_NAME -d ITEM_DESCRIPTION -q ITEM_QUANTITY -e EXPIRY_DATE -c COST_PRICE -t THRESHOLD`                | Adds a new item to the inventory.                                                                                     |
-| **search**  | `search -n NAME_QUERY -d DESCRIPTION_QUERY -q QUANTITY_RANGE -c COST_PRICE_RANGE -s SALE_PRICE_RANGE -e EXPIRY_DATE_RANGE -l NUMBER_OF_RESULTS`                                                                                               | Searches for items in the inventory based on various criteria.                                                        |
-| **list**    | `list` <br> `list -c` <br> `list -s` <br> `list -e` <br> `list -p`                                                                                                                                                                            | Lists all items in the inventory, with optional sorting based on cost price, sale price, expiry date or profits.      |
-| **delete**  | `delete -i ITEM_INDEX` <br> `delete -n ITEM_NAME`                                                                                                                                                                                             | Deletes an item from the inventory.                                                                                   |
-| **sell**    | `sell -n ITEM_NAME -q ITEM_QUANTITY` <br> `sell -i ITEM_INDEX -q ITEM_QUANTITY`                                                                                                                                                               | Decreases the quantity of an item after a sale.                                                                       |
-| **restock** | `restock -n ITEM_NAME -q ITEM_QUANTITY` <br> `restock -i ITEM_INDEX -q ITEM_QUANTITY`                                                                                                                                                         | Increases the quantity of an item after restocking.                                                                   |
-| **update**  | `update -n ITEM_NAME -d ITEM_DESCRIPTION -q ITEM_QUANTITY -e EXPIRY_DATE -s SALE_PRICE -c COST_PRICE -t THRESHOLD` <br> `update -i ITEM_INDEX -d ITEM_DESCRIPTION -q ITEM_QUANTITY -e EXPIRY_DATE -s SALE_PRICE -c COST_PRICE -t THRESHOLD`   | Updates the details of an existing item in the inventory.                                                             |
-| **profit**  | `profit`                                                                                                                                                                                                                                      | Displays the total profit earned from the inventory.                                                                  |
-| **bye**     | `bye` <br> `exit` <br> `quit`                                                                                                                                                                                                                 | Exits the application.                                                                                                |
+| **Command** | **Usage**                                                                                                                                                                                                                               | **Description**                                                                                                  |
+|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------|
+| **add**     | `add -re -n ITEM_NAME -d ITEM_DESCRIPTION -q ITEM_QUANTITY -e EXPIRY_DATE -s SALE_PRICE -c COST_PRICE -t THRESHOLD` <br> `add -op -n ITEM_NAME -d ITEM_DESCRIPTION -q ITEM_QUANTITY -e EXPIRY_DATE -c COST_PRICE -t THRESHOLD`          | Adds a new item to the inventory.                                                                                |
+| **search**  | `search -n NAME_QUERY -d DESCRIPTION_QUERY -q QUANTITY_RANGE -c COST_PRICE_RANGE -s SALE_PRICE_RANGE -e EXPIRY_DATE_RANGE -l NUMBER_OF_RESULTS`                                                                                         | Searches for items in the inventory based on various criteria.                                                   |
+| **list**    | `list` <br> `list -c` <br> `list -s` <br> `list -e` <br> `list -p`                                                                                                                                                                      | Lists all items in the inventory, with optional sorting based on cost price, sale price, expiry date or profits. |
+| **delete**  | `delete -i ITEM_INDEX` <br> `delete -n ITEM_NAME`                                                                                                                                                                                       | Deletes an item from the inventory.                                                                              |
+| **sell**    | `sell -n ITEM_NAME -q ITEM_QUANTITY` <br> `sell -i ITEM_INDEX -q ITEM_QUANTITY`                                                                                                                                                         | Decreases the quantity of an item after a sale.                                                                  |
+| **restock** | `restock -n ITEM_NAME -q ITEM_QUANTITY` <br> `restock -i ITEM_INDEX -q ITEM_QUANTITY`                                                                                                                                                   | Increases the quantity of an item after restocking.                                                              |
+| **update**  | `update -n ITEM_NAME -d ITEM_DESCRIPTION -q ITEM_QUANTITY -e EXPIRY_DATE -s SALE_PRICE -c COST_PRICE -t THRESHOLD` <br> `update -i ITEM_INDEX -d ITEM_DESCRIPTION -q ITEM_QUANTITY -e EXPIRY_DATE -s SALE_PRICE -c COST_PRICE -t THRESHOLD` | Updates the details of an existing item in the inventory.                                                        |
+| **profit**  | `profit`                                                                                                                                                                                                                                | Displays the total profit earned from the inventory.                                                             |
+| **quote**   | `quote`                                                                                                                                                                                                                                 | Displays a random quote on the screen.                                                                           |
+| **bye**     | `bye` <br> `exit` <br> `quit`                                                                                                                                                                                                           | Exits the application.                                                                                           |
 
 * [Back to table of contents](#table-of-contents)
 ---

src/main/java/seedu/binbash/BinBash.java

@@ -30,6 +30,7 @@ private void run() {
 
         userInterface.greet();
         userInterface.talk(itemList.getProfitMargin());
+        userInterface.talk(userInterface.getRandomMessage());
 
         while (userInterface.isUserActive()) {
             String userInput = userInterface.readUserCommand();
@@ -53,7 +54,7 @@ private void run() {
         }
         logger.info("BinBash exiting...");
     }
-    
+
     /**
      * Main entry-point for the BinBash application.
      */

src/main/java/seedu/binbash/command/QuoteCommand.java

@@ -0,0 +1,19 @@
+package seedu.binbash.command;
+
+import seedu.binbash.inventory.ItemList;
+import seedu.binbash.quotes.Quotes;
+import seedu.binbash.logger.BinBashLogger;
+
+public class QuoteCommand extends Command {
+
+    public QuoteCommand() {
+        commandLogger = new BinBashLogger(QuoteCommand.class.getName());
+        commandLogger.info("Creating Quote Command...");
+    }
+
+    @Override
+    public boolean execute(ItemList itemList) {
+        executionUiOutput = Quotes.getRandomQuote();
+        return true;
+    }
+}

src/main/java/seedu/binbash/parser/Parser.java

@@ -8,7 +8,10 @@
 import seedu.binbash.command.SearchCommand;
 import seedu.binbash.command.ListCommand;
 import seedu.binbash.command.ProfitCommand;
+import seedu.binbash.command.QuoteCommand;
+
 import seedu.binbash.exceptions.BinBashException;
+
 import seedu.binbash.exceptions.InvalidCommandException;
 
 import org.apache.commons.cli.ParseException;
@@ -96,6 +99,8 @@ public Command parseCommand(String userInput) throws BinBashException {
             return parseUpdateCommand(commandArgs);
         case "profit":
             return new ProfitCommand();
+        case "quote":
+            return new QuoteCommand();
         default:
             throw new InvalidCommandException("Invalid command: "  + commandString);
         }

src/main/java/seedu/binbash/quotes/Quotes.java

@@ -0,0 +1,58 @@
+package seedu.binbash.quotes;
+
+import java.util.Random;
+
+public class Quotes {
+    public static final String[] CUSTOM_MESSAGES = {
+        "Hope you have a good day of inventory management.",
+        "Have a nice day!",
+        "Welcome back to BinBash!",
+        "Make today amazing!",
+        "Enjoy your time with BinBash!",
+        "Wishing you a productive day!",
+        "Get ready for some BinBash fun!",
+        "Let's make today great!",
+        "Time to conquer your inventory!",
+        "Sending positive vibes your way!",
+        "Welcome to another BinBash adventure!",
+        "Stay positive and keep BinBashing!",
+        "Today's a good day to organize!",
+        "You've got this!",
+        "Hope your day is BinBash-tastic!",
+        "Get ready to rock your inventory!",
+        "BinBash is here to help!",
+        "Hope you find everything you need!",
+        "Have a wonderful day ahead!",
+        "Start your day with a smile!",
+        "Sending you BinBash blessings!",
+        "Let's make magic happen!",
+        "Embrace the BinBash journey!",
+        "You're awesome, just like BinBash!",
+        "Seize the day with BinBash!",
+        "Welcome to BinBash excellence!",
+        "Time to unleash your inventory power!",
+        "Hope you have a blast with BinBash!",
+        "Today's a good day to BinBash!",
+        "Stay motivated and BinBash on!",
+        "Enjoy every moment with BinBash!",
+        "Make today memorable!",
+        "Let's create some BinBash miracles!",
+        "Believe in yourself and BinBash!",
+        "Welcome to the world of BinBash!",
+        "Today's forecast: BinBash brilliance!",
+        "BinBash wishes you a fantastic day!",
+        "May your day be filled with BinBash joy!",
+        "Let's make today legendary!",
+        "Stay positive and BinBash strong!"
+    };
+
+    private static final Random RANDOM = new Random();
+
+    // Private constructor to prevent instantiation
+    private Quotes() {}
+
+    public static String getRandomQuote() {
+        int randomIndex = RANDOM.nextInt(CUSTOM_MESSAGES.length);
+        return CUSTOM_MESSAGES[randomIndex];
+    }
+}

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

@@ -1,17 +1,17 @@
 package seedu.binbash.ui;
 
+import java.util.Random;
 import org.jline.reader.LineReader;
 import org.jline.reader.LineReaderBuilder;
 import org.jline.reader.EndOfFileException;
 import org.jline.reader.UserInterruptException;
 import org.jline.builtins.Completers.OptDesc;
 import org.jline.terminal.Terminal;
 import org.jline.terminal.TerminalBuilder;
-
 import seedu.binbash.logger.BinBashLogger;
-
 import java.io.IOException;
 import java.util.ArrayList;
+import seedu.binbash.quotes.Quotes;
 
 /**
  * The user facing text interface of the program.
@@ -26,6 +26,7 @@ public class Ui {
     private static final String WELCOME_MESSAGE = "Welcome to BinBash!";
     private static final String LINE_DIVIDER = "-------------------------------------------------------------";
     private static final BinBashLogger UILOGGER = new BinBashLogger(Ui.class.getName());
+    private static final Random RANDOM = new Random();
 
     private static LineReader inputReader;
     private static boolean isUserActive;
@@ -42,13 +43,13 @@ public Ui(ArrayList<ArrayList<OptDesc>> allCommandsOptionDescriptions) {
         System.setProperty("org.jline.terminal.exec.redirectPipeCreationMode", "native");
         try {
             Terminal userTerminal = TerminalBuilder.builder()
-                .system(true)
-                .dumb(true) // TODO: omit and catch using logger
-                .build();
+                    .system(true)
+                    .dumb(true) // TODO: omit and catch using logger
+                    .build();
             inputReader = LineReaderBuilder.builder()
-                .terminal(userTerminal)
-                .completer(new CommandCompleter(allCommandsOptionDescriptions))
-                .build();
+                    .terminal(userTerminal)
+                    .completer(new CommandCompleter(allCommandsOptionDescriptions))
+                    .build();
         } catch (IOException e) {
             UILOGGER.info("failed to get system terminal!");
             throw new RuntimeException(e);
@@ -82,7 +83,7 @@ public String readUserCommand() {
     }
 
     public void greet() {
-        talk(LOGO + WELCOME_MESSAGE);
+        talk(NEWLINE + LOGO + WELCOME_MESSAGE);
     }
 
     /**
@@ -93,4 +94,9 @@ public void greet() {
     public void talk(String line) {
         System.out.println(LINE_DIVIDER + NEWLINE + line + NEWLINE + LINE_DIVIDER);
     }
+
+    public String getRandomMessage() {
+        int randomIndex = RANDOM.nextInt(Quotes.CUSTOM_MESSAGES.length);
+        return Quotes.CUSTOM_MESSAGES[randomIndex];
+    }
 }

src/test/java/seedu/binbash/parser/ParserTest.java

@@ -11,6 +11,7 @@
 import seedu.binbash.command.Command;
 import seedu.binbash.command.ListCommand;
 import seedu.binbash.command.ByeCommand;
+import seedu.binbash.command.QuoteCommand;
 import seedu.binbash.exceptions.BinBashException;
 import seedu.binbash.exceptions.InvalidCommandException;
 import seedu.binbash.item.Item;
@@ -40,6 +41,16 @@ public void testParseCommand_validCommandBye_returnsByeCommand() {
         }
     }
 
+    @Test
+    public void testParseCommand_validCommandQuote_returnsQuoteCommand() {
+        try {
+            Command command = parser.parseCommand("quote");
+            assertTrue(command instanceof QuoteCommand);
+        } catch (BinBashException e) {
+            fail("Unexpected InvalidCommandException: " + e.getMessage());
+        }
+    }
+
     @Test
     public void testParseCommand_invalidCommand_throwsInvalidCommandException() {
         assertThrows(InvalidCommandException.class, () -> parser.parseCommand("invalid"));

text-ui-test/EXPECTED.TXT

@@ -1,4 +1,5 @@
 -------------------------------------------------------------
+
   ____  _       ____            _
  | __ )(_)_ __ | __ )  __ _ ___| |__
  |  _ \| | '_ \|  _ \ / _` / __| '_ \
@@ -13,6 +14,9 @@ Here are your metrics:
 	Total Revenue: 0.00
 	Net Profit: 0.00
 
+-------------------------------------------------------------
+-------------------------------------------------------------
+
 -------------------------------------------------------------
 binbash> -------------------------------------------------------------