[geeliette] iP #455

geeliette · 2025-02-04T08:18:36Z

Fleur: Your Key To Blooming 🌸

"A good system shortens the road to the goal." - Orison Swett Marden

Fleur is the system for you to keep track of all your daily tasks, so that you can achieve your goals more efficiently.

Why You'll Love Fleur

Text-based 📄 : Simple and straightforward interaction
User-friendly 🩵 : Intuitive commands that anyone can learn
Lightning fast ⚡ : Instant feedback and speedy task management

How To Use It

Download Fleur from here
Double-click it or run it using the command: java -jar "fleur.jar"
Start adding your tasks
Sit back and enjoy a more organised life! 🦔

And it's FREE!

Features

Manage tasks (ToDos, Deadlines and Events)
Find tasks using keywords
Reminders (coming soon)

Main Method

If you are a Java programmer, you can use it to practice Java too. Here's the main method:

public class Main {
    public static void main(String[] args) {
        new Fleur("fleur.txt").run();
    }
}

In build.gradle, the dependencies on distZip and/or distTar causes the shadowJar task to generate a second JAR file for which the mainClass.set("seedu.duke.Duke") does not take effect. Hence, this additional JAR file cannot be run. For this product, there is no need to generate a second JAR file to begin with. Let's remove this dependency from the build.gradle to prevent the shadowJar task from generating the extra JAR file.

charlenelau-20

Looks good overall! Also liked how unique the responses are!

charlenelau-20 · 2025-02-06T16:12:19Z

src/main/java/fleur/Parser.java

+            if (str.equalsIgnoreCase("bye")) {
+                exit();
+            } else if (str.equalsIgnoreCase("list")) {
+                this.taskList.listTasks();
+            } else if (str.startsWith("mark")) {
+                int index = Integer.parseInt(str.substring(5)) - 1;
+                this.taskList.markDone(index);
+                System.out.println("Enchanté! I 'ave marked zis task as done:");
+                System.out.println(this.taskList.getTask(index).toString());
+            } else if (str.startsWith("unmark")) {
+                int index = Integer.parseInt(str.substring(7)) - 1;
+                this.taskList.markUndone(index);
+                System.out.println("Zut! I 'ave marked zis task as not done:");
+                System.out.println(this.taskList.getTask(index).toString());
+            } else if (str.startsWith("todo")) {
+                addToDo(str);
+            } else if (str.startsWith("deadline")) {
+                addDeadline(str);
+            } else if (str.startsWith("event")) {
+                addEvent(str);
+            } else if (str.startsWith("delete")) {
+                int index = Integer.parseInt(str.substring(7)) - 1;
+                Task deletedTask = this.taskList.getTask(index);
+                System.out.println("D'accord, I 'ave removed zis task from your list:");
+                System.out.println(deletedTask.toString());
+                this.taskList.deleteTask(index);
+                System.out.println("Now you 'ave " + this.taskList.size() + " task(s) in your list.");
+            } else {
+                throw new FleurInvalidCommandException();
+            }


Maybe using switch case statements could make the code easier to read?

charlenelau-20 · 2025-02-06T16:17:35Z

src/main/java/fleur/Storage.java

+            switch (str.charAt(1)) {
+                case 'T':
+                    t = new ToDo(str.substring(7));
+                    break;
+                case 'D':
+                    String desc = str.substring(7).split("\\(by: ")[0];
+                    String date = str.substring(7).split("\\(by: ")[1].replace(")", "");
+                    LocalDate by = LocalDate.parse(date, INPUT);
+                    t = new Deadline(desc, by);
+                    break;
+                case 'E':
+                    String[] arr = str.substring(7).split("\\(from: ");
+                    String description = arr[0];
+                    String from = arr[1].split("to: ")[0].trim();
+                    String to = arr[1].split("to: ")[1].replace(")", "");
+                    LocalDate dateFrom = LocalDate.parse(from, INPUT);
+                    LocalDate dateTo = LocalDate.parse(to, INPUT);
+                    t = new Event(description, dateFrom, dateTo);
+                    break;


Just a minor layout fix; remember not to have indentations for case clauses in this course!

charlenelau-20 · 2025-02-06T16:28:07Z

src/main/java/fleur/Ui.java

+        this.scanner = new Scanner(System.in);
+    }
+
+    public void welcomeMessage() {


Perhaps using a verb for the method name, e.g. showWelcomeMessage(), could make it more intuitive.

charlenelau-20 · 2025-02-06T16:33:02Z

src/main/java/fleur/Storage.java

+                    String desc = str.substring(7).split("\\(by: ")[0];
+                    String date = str.substring(7).split("\\(by: ")[1].replace(")", "");
+                    LocalDate by = LocalDate.parse(date, INPUT);
+                    t = new Deadline(desc, by);
+                    break;
+                case 'E':
+                    String[] arr = str.substring(7).split("\\(from: ");


Maybe using full/more descriptive words for the variable names 'desc' and 'arr' would make it easier for readers to understand what they are used for.

kai824

Looks good overall! Love the creativity in the use of French in your responses.

Do remember to add javadoc comments.

kai824 · 2025-02-07T09:41:29Z

src/main/java/fleur/Storage.java

+        this.dataFile = dataFile;
+    }
+
+    protected ArrayList<Task> loadData() throws IOException, FleurCorruptFileException {


protected

Why do you choose to use protected here? Will there be any class that will inherit from Storage and need access to this method?

kai824 · 2025-02-07T09:43:47Z

src/main/java/fleur/Fleur.java

+//                System.out.println(e.getMessage());
+//            }
+//        }
+//    }
+//
+//    private void listTasks() {
+//        if (tasks.isEmpty()) {
+//            System.out.println("You 'ave non tasks in your list.");
+//        } else {
+//            System.out.println("'Ere are all ze tasks in your list:");
+//            for (int i = 0; i < count; i++) {
+//                System.out.println((i + 1) + "." + tasks.get(i).toString());
+//            }
+//        }
+//    }
+//
+//    private void markDone(int index) {
+//        tasks.get(index).markAsDone();
+//        System.out.println("Enchanté! I 'ave marked zis task as done:");
+//        System.out.println(tasks.get(index).toString());
+//    }
+//
+//    private void markUndone(int index) {
+//        tasks.get(index).markAsUndone();
+//        System.out.println("Zut! I 'ave marked zis task as not done:");
+//        System.out.println(tasks.get(index).toString());
+//    }
+//
+//    private void addToDo(String str) throws FleurMissingDetailsException {
+//        try {
+//            String desc = str.substring(5);
+//            Task t = new ToDo(desc);
+//            tasks.add(t);
+//            count++;
+//            System.out.println("Bah, oui! I 'ave added zis todo task to your list:");
+//            System.out.println(t.toString());
+//            System.out.println("Now you 'ave " + count + " task(s) in your list.");
+//        } catch (StringIndexOutOfBoundsException e) {
+//            throw new FleurMissingDetailsException();
+//        }
+//    }
+//
+//    private void addDeadline(String str) throws FleurMissingDetailsException, FleurInvalidDateException {
+//        try {
+//            String desc = str.substring(9).split("/by")[0];
+//            String date = str.substring(9).split("/by")[1].trim();
+//            LocalDate by = LocalDate.parse(date, INPUT);
+//            Task t = new Deadline(desc, by);
+//            tasks.add(t);
+//            count++;
+//            System.out.println("Bah, oui! I 'ave added zis deadline task to your list:");
+//            System.out.println(t.toString());
+//            System.out.println("Now you 'ave " + count + " task(s) in your list.");
+//        } catch (IndexOutOfBoundsException e) {
+//            throw new FleurMissingDetailsException();
+//        } catch (DateTimeParseException e) {
+//            throw new FleurInvalidDateException();
+//        }
+//    }
+//
+//    private void addEvent(String str) throws FleurMissingDetailsException, FleurInvalidDateException {
+//        try {
+//            String[] arr = str.substring(6).split("/from");
+//            String desc = arr[0];
+//            String from = arr[1].split("/to")[0].trim();
+//            String to = arr[1].split("/to")[1].trim();
+//            LocalDate dateFrom = LocalDate.parse(from, INPUT);
+//            LocalDate dateTo = LocalDate.parse(to, INPUT);
+//            Task t = new Event(desc, dateFrom, dateTo);
+//            tasks.add(t);
+//            count++;
+//            System.out.println("Bah, oui! I 'ave added zis event task to your list:");
+//            System.out.println(t.toString());
+//            System.out.println("Now you 'ave " + count + " task(s) in your list.");
+//        } catch (ArrayIndexOutOfBoundsException | StringIndexOutOfBoundsException e) {
+//            throw new FleurMissingDetailsException();
+//        } catch (DateTimeParseException e) {
+//            throw new FleurInvalidDateException();
+//        }
+//    }
+//
+//    private void deleteTask(int index) {
+//        Task deletedTask = tasks.get(index);
+//        count--;
+//        System.out.println("D'accord, I 'ave removed zis task from your list:");
+//        System.out.println(deletedTask.toString());
+//        System.out.println("Now you 'ave " + count + " task(s) in your list.");
+//        tasks.remove(index);
+//    }
+//
+//    private void exit() {
+//        try {
+//            saveData();
+//            System.out.println("Au revoir, 'ope to see you again soon!");
+//        } catch (IOException e) {
+//            System.out.println("Mince! Zere was an error when saving your tasks.");
+//        }
+//    }
+//
+//}


Having such a block of commented code may not be the best practice. Consider deleting it

kai824 · 2025-02-07T09:46:10Z

src/main/java/fleur/Parser.java

+            this.taskList.addTask(t);
+            System.out.println("Bah, oui! I 'ave added zis event task to your list:");
+            System.out.println(t.toString());


While this Task object is temporary, consider using a more descriptive name (e.g. taskToAdd)

kai824 · 2025-02-07T09:46:45Z

src/main/java/fleur/Parser.java

+        }
+    }
+
+    private void addEvent(String str) throws FleurMissingDetailsException, FleurInvalidDateException {


Good job specifying the two checked Exceptions separately instead of just specifying throws FleurException, so that the callers can choose to handle them separately.

kai824 · 2025-02-07T09:49:46Z

src/main/java/fleur/Storage.java

+            switch (str.charAt(1)) {
+                case 'T':
+                    t = new ToDo(str.substring(7));
+                    break;
+                case 'D':
+                    String desc = str.substring(7).split("\\(by: ")[0];
+                    String date = str.substring(7).split("\\(by: ")[1].replace(")", "");
+                    LocalDate by = LocalDate.parse(date, INPUT);
+                    t = new Deadline(desc, by);
+                    break;
+                case 'E':
+                    String[] arr = str.substring(7).split("\\(from: ");
+                    String description = arr[0];
+                    String from = arr[1].split("to: ")[0].trim();
+                    String to = arr[1].split("to: ")[1].replace(")", "");
+                    LocalDate dateFrom = LocalDate.parse(from, INPUT);
+                    LocalDate dateTo = LocalDate.parse(to, INPUT);
+                    t = new Event(description, dateFrom, dateTo);
+                    break;


Remember to configure your IDE not to have indentations for case clauses for this course

kai824 · 2025-02-07T09:51:18Z

text-ui-test/input.txt

+delete 3
+hi
+todo


Good job testing the edge cases and error messages! Consider testing the case of index out of bounds as well

kai824 · 2025-02-07T09:54:17Z

src/main/java/fleur/FleurException.java

+package fleur;
+
+public class FleurException extends Exception {


Perhaps you could group the Exception classes together into 1 package to make the file organisation even tidier

The current implementation does not enforce certain key assumptions about user input and task modifications. Task indices in commands like delete, mark, and unmark should be more than 0 and less than the total number of tasks. Additionally, parse() does not explicitly check for empty input strings before processing them. These missing validations can lead to unexpected runtime errors, causing the program to crash instead of failing early with a clear message. Let's add assert statements in critical parts of the code to ensure valid preconditions hold before execution. Specifically: * Add assertions in parse() to validate that input is non-null and non-empty * Introduce assertions in execute() method in DeleteCommand, MarkCommand, and UnmarkCommand to check that task indices are within a valid range

The loadData() method in Storage is too long and tightly coupled with the task creation logic. It attempts to parse raw text data, determine task types, and instantiate the correct task objects within a single method. The method contains more details than what the reader can process at a time, making it difficult to maintain and extend in the future. Refactoring loadData() by adding new methods in the Command classes allows us to abstract and move task creation logic to a more appropriate place, improving code quality and readability. Let's, * introduce createToDo(), createDeadline(), and createEvent() in AddToDoCommand, AddDeadlineCommand, and AddEventCommand * modify loadData() to delegate task creation to these methods instead of handling it directly

Add assert statements to enforce key assumptions in input validation

Refactor Storage and Command classes to improve task loading and saving

damithc and others added 20 commits July 11, 2024 16:52

Add Gradle support

68c58c1

Bump gradle and lib version

03523ec

Change name and greeting

b4d4d70

Update Fleur.java

9a1905b

Echo user

86c668b

Add task storing

fcb63ef

Add Task class

81cda75

Add task types

847d330

Test using I/O

ea5cf33

Add Exceptions

c263c51

Add delete function

d259d82

Add save to hard disk function

55a0507

Merge branch 'branch-Level-7'

a1ab209

Change dates to LocalDate

cbca761

Merge branch 'branch-Level-8'

45d49b3

Add new Ui, Storage, Parser and TaskList classes

926138a

Use more OOP

f05a51f

Merge branch 'branch-A-MoreOOP'

4fac2b7

Fix bugs

16c363c

charlenelau-20 reviewed Feb 6, 2025

View reviewed changes

geeliette added 2 commits February 7, 2025 10:12

Fix bugs in testing

35b42d7

Merge branch 'add-gradle-support'

b93a02f

kai824 reviewed Feb 7, 2025

View reviewed changes

geeliette added 6 commits February 10, 2025 15:30

Add gradle

8fe40ca

Add JUnit tests

5ae2a3e

Add JAR file

f769bd3

Edit Fleur class

35d03a5

Add JavaDoc comments

50966f9

Match Java coding standard

91a8154

geeliette and others added 24 commits February 13, 2025 00:18

Add find function

6b207e2

Merge branch 'A-JavaDoc'

8f52b7c

Fix merge conflicts

cfc682b

Merge branch 'branch-Level-9'

8678aa6

Fix naming error

2883744

Add packages

fcdebfe

Fix bugs

bea0808

Add Commands class

2885e73

Fix exception handling

d9fec0c

Merge branch 'branch-A-Commands'

bd3ea43

Add GUI

19aa7a6

Merge branch 'branch-Level-10'

97a990e

Merge pull request #2 from geeliette/branch-A-Assertions

883b3ab

Add assert statements to enforce key assumptions in input validation

Merge pull request #3 from geeliette/branch-A-CodeQuality

18fc432

Refactor Storage and Command classes to improve task loading and saving

Add edit command class

d6461c1

Shorten edit execute method

995848f

Merge branch 'branch-C-Update'

bb09805

Update GUI

3af8ad0

Merge branch 'branch-A-BetterGui'

6317550

Display welcome message

a1757e0

Add representative screenshot

c00aec0

Update README.md

6272f07

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[geeliette] iP #455

[geeliette] iP #455

geeliette commented Feb 4, 2025 •

edited

Loading

charlenelau-20 left a comment

charlenelau-20 Feb 6, 2025

charlenelau-20 Feb 6, 2025

charlenelau-20 Feb 6, 2025

charlenelau-20 Feb 6, 2025

kai824 left a comment

kai824 Feb 7, 2025

kai824 Feb 7, 2025

kai824 Feb 7, 2025

kai824 Feb 7, 2025

kai824 Feb 7, 2025

kai824 Feb 7, 2025

kai824 Feb 7, 2025

		package fleur;

		public class FleurException extends Exception {

[geeliette] iP #455

Are you sure you want to change the base?

[geeliette] iP #455

Conversation

geeliette commented Feb 4, 2025 • edited Loading

Fleur: Your Key To Blooming 🌸

Why You'll Love Fleur

How To Use It

Features

Main Method

charlenelau-20 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kai824 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

geeliette commented Feb 4, 2025 •

edited

Loading