Merge pull request #168 from JeffinsonDarmawan/Jeff-PPP

Jeffinson's PPP

docs/team/JeffinsonDarmawan.md

@@ -1,13 +1,70 @@
-# Design & Implementation
+# Jeffinson Darmawan - Project Portfolio Page
 
-## Flower Removal Command
+## Overview
+Florizz is a digital florist replacement that helps users choose appropriate
+flowers to put into a bouquet for various occasions. 
 
-**Step 1:** Removing flowers utilise the `parser` class to parse user command to identify which flower to remove, 
-how much to remove and from which bouquet to remove.
+### Summary of Contributions 
+Code Contribution: [Jeffinson Darmawan RepoSense Report](https://nus-cs2113-ay2324s2.github.io/tp-dashboard/?search=jeffinsondarmawan&breakdown=true)
 
-**Step 2:** User will input `remove <flowerName> /q <quantity> /from <bouquetName>` and once `parser` identifies the 
-appropriate keywords, it will instantiate the `HelpCommand` class and run its `execute()` method.
+**New Features:**
 
-**Step 3:** `HelpCommand` class will call `printHelpMessage()` method of `Ui` class
+1. Fuzzy Logic (Pull Request [#71](https://github.com/AY2324S2-CS2113-T11-3/tp/pull/71), 
+[#83](https://github.com/AY2324S2-CS2113-T11-3/tp/pull/83),
+[#84](https://github.com/AY2324S2-CS2113-T11-3/tp/pull/84),
+[#87](https://github.com/AY2324S2-CS2113-T11-3/tp/pull/87),
+[#162](https://github.com/AY2324S2-CS2113-T11-3/tp/pull/162))
 
-**Step 4:** The list of valid commands will be printed by the `Ui` class
+    - What it is: 
+
+      Theoretically, Fuzzy Logic is a mathematical framework that deals with uncertainty and imprecision in 
+      decision-making. Rather than only accepting a binary value of truth (i.e. true or false), Fuzzy Logic allows variables
+      to have a degree of truth which gives it the sense of "Fuzziness". Practically, Fuzzy Logic is implemented in 
+      the Florizz programme to reduce human error in typing inputs with typos. For example, take a valid command of 
+      `info Rose` where Florizz will show information regarding that flower. Suppose that a user mistakenly input
+      `invo Ross` and another user mistakenly input `zjgh bfre`. Without Fuzzy Logic, both `invo Ross` and `zjgh bfre` 
+      will be regarded as equaly invalid commands and the programme will throw an exception. However, one can make a 
+      strong case that `invo Ross` is definitely closer to `info Rose` compared to `zjgh bfre`. Thus, Fuzzy Logic helps
+      users by correcting their typos due to accidental human errors and increase the overall convenience of using the 
+      programme. Imagine having to retype `adds Rose /q 1 /to Bouquet for My 3th Anniversary with My Girlfriend` because
+      of a small mistake of having an "s" after "add"!
+
+    - How it works: 
+
+      Fuzzy Logic in Florizz works primarily in 3 ways. Firstly, applying 
+      `detectItem(userInput, validCommand)`, Florizz will calculate the Damerau-Levenshtein distance which is a metric 
+      used to measure the similarity between the user input and a list of predetermined valid commands. 
+      It calculates the minimum number of single-character edits required to change userInput to a valid command,
+      by counting the number of insertions, deletions, substitutions and transpositions of individual characters. For
+      Florizz, we use a SIMILARITY_THRESHOLD of 2, meaning that we would only match a userInput to a valid command which
+      has the smallest distance that is less than 2. example, the userInput: `myboquets` compared to a validCommand: 
+      `mybouquets` has a Damerau-Levenshtein distance of one. Secondly, Florizz also recognises inputs which mistakenly 
+      have whitespaces separating alphabets which form valid commands. For example, Florriz is able to correct `h e l p`
+      into `help` or `re mov e Lily /q 1 /from bouquet`into `remove Lily /q 1 /from bouquet`. Thirdly, Florizz can 
+      also correct inputs which are mistakenly glued to each other, such as `flowersmothersday` into `flowers Mothers Day`.
+
+2. Listing Available Occasion (Pull Request [#26](https://github.com/AY2324S2-CS2113-T11-3/tp/pull/26))
+   - What it is:
+      `Occasion` lists out all the occasions which are associated will all flowers in our database. This
+      allows users to have a quick look at what occasions they can choose for their flowers. Once users know what occasion 
+      they can input `flowers <occasion>` to see all the flowers associated with the occasion of choosing.
+
+3. Help Command (Pull Request [#16](https://github.com/AY2324S2-CS2113-T11-3/tp/pull/16))
+   - What it is:
+     `help` assists users in using Florizz by showing a quick list of commands that users can use.
+
+**Enhancements:**
+1. Applying appropriate exceptions to ensure valid integer inputs in all commands involving integers 
+(Pull Request [#166](https://github.com/AY2324S2-CS2113-T11-3/tp/pull/166)) 
+2. Added price information to bouquets (Pull Request [#65](https://github.com/AY2324S2-CS2113-T11-3/tp/pull/65))
+3. Improving Parser class by applying FuzzyLogic.detectItem() 
+(Pull Request [#71](https://github.com/AY2324S2-CS2113-T11-3/tp/pull/71))
+
+**Documentation**
+1. Developer Guide
+(Pull Request [#82](https://github.com/AY2324S2-CS2113-T11-3/tp/pull/82))
+   - Added UML diagrams and implementation details for `remove` and `help`
+2. User Guide 
+(Pull Request [#106](https://github.com/AY2324S2-CS2113-T11-3/tp/pull/106))
+   - Added documentation on Fuzzy Logic 
+   - Updated documentation on `help`, `new`, `add` and `remove`

src/main/java/florizz/core/Ui.java

@@ -27,6 +27,7 @@ public void printIntroMessage(){
                 " |_| |_|\\___/|_|  |_/___/___|\n" +
                 "\n";
         System.out.println("Hello from\n" + logo);
+        System.out.println("Type `help`, to view a list of valid commands!");
     }
 
     /**

text-ui-test/EXPECTED-UNIX.TXT

@@ -8,6 +8,7 @@ Hello from
  |_| |_|\___/|_|  |_/___/___|
 
 
+Type `help`, to view a list of valid commands!
 What can I do for you?
 Here are the list of commands you can use:
 1. new <bouquetName> - Add a bouquet

text-ui-test/EXPECTED.TXT

@@ -8,6 +8,7 @@ Hello from
  |_| |_|\___/|_|  |_/___/___|
 
 
+Type `help`, to view a list of valid commands!
 What can I do for you?
 Here are the list of commands you can use:
 1. new <bouquetName> - Add a bouquet