[jasperng] iP #461

jasperng-nus · 2024-02-05T17:29:48Z

Luke

“Learn from yesterday, live for today, hope for tomorrow. The important thing is not to stop questioning.” – Albert Einstein (source)

text based
easy to use
~~SUPER~~ FAST to use

download from here.
double click it.
add your tasks.
let it manage yours tasks for you 👍

And it is FREE!

Features:

managing task
add task
delete task

Note

There some things to note.

this is an inline code it has back-ticks around it

public class Main {
    public static void main(String[] args) {
        System.out.println("Hello World!");
    }
}

Let's tweak the docs/README.md (which is used as the user guide) to fit Duke better. Specifically, 1. mention product name in the title 2. mention adding a product screenshot and a product intro 3. tweak the flow to describe feature-by-feature

Austintjh19

Good start. The basics are there just some modifications to the Luke class are needed.

Austintjh19 · 2024-02-06T16:30:45Z

src/main/java/Deadline.java

@@ -0,0 +1,13 @@
+public class Deadline extends Task {
+    protected String by;


Is using protected the most suitable option ? It makes it accessible to other classes from the same package ... I noticed the same issue in several other places too.

Austintjh19 · 2024-02-06T16:32:54Z

src/main/java/Event.java

@@ -0,0 +1,16 @@
+public class Event extends Task{


Whitespace should proceed { , according to our coding standard. Just something to take note.

Austintjh19 · 2024-02-06T16:36:02Z

src/main/java/Luke.java

+
+        // Conditions
+        while (!input.equals("bye")) {
+            if (input.equals("list")) {


Maybe consider creating functions to execute the commands ? E.g. when input.equals("list ") it call a separate function like outputTasks(). You can possibly perform you validation checks in these functions as well.

Austintjh19 · 2024-02-06T16:41:11Z

src/main/java/Luke.java

+import java.util.ArrayList;
+import java.util.Scanner;
+
+public class Luke {


Maybe enhance the class structure by decomposing the functionality into separate classes such as InputValidator for validating user inputs, Outputs for managing output operations, and InputInterpreter for processing user commands, thereby promoting a clearer separation of concerns.

Austintjh19 · 2024-02-06T16:42:27Z

src/main/java/Luke.java

+
+        // Conditions
+        while (!input.equals("bye")) {
+            if (input.equals("list")) {


Consider switching to a case statement it can potentially enhance code readability.

Austintjh19 · 2024-02-06T16:43:10Z

src/main/java/Luke.java

+                        int index = Integer.parseInt(instruction[1]) - 1;  // array is 0-indexed
+
+                        if (index >= list.size()) {
+                            throw new LukeException("Hold up!! There is no such task in the list.\n"


Nice to see you are already incorporating Exceptions.

Austintjh19 · 2024-02-06T16:46:18Z

src/main/java/TaskException.java

@@ -0,0 +1,5 @@
+public class TaskException extends Exception {


Maybe have this extend LukeException ? e.g. LukeTaskException. Won't have to check for LukeException | TaskException for each relevant exception.

Austintjh19 · 2024-02-06T16:50:48Z

src/main/java/Luke.java

+                }
+                System.out.println("________________________________________________________________________");
+
+            } else if (input.contains("mark")) {


Might be a redundant if check. You can just split the string and verify if the mark/ unmark is present, while also ensuring the length of the split instruction is 2. This way, you confirm the task name's presence without extra checks. This might be applicable for other commands as well.

Austintjh19 · 2024-02-06T16:52:24Z

src/main/java/Luke.java

+        // User inputs
+        Scanner sc = new Scanner(System.in);
+        String input = sc.nextLine();
+        ArrayList<Task> list = new ArrayList<>();


Possibly a more appropriate variable name to make the code more readable.

Austintjh19 · 2024-02-06T16:54:24Z

src/main/java/Luke.java

+
+            } else {
+                try {
+                    if (input.equals("todo") || input.equals("deadline") || input.equals("event")) {


Maybe consider the case where user enters "todo " or "deadline " or "event ".

Austintjh19

Great work on coding standards. Seems like it was well followed.

Austintjh19 · 2024-02-06T17:22:45Z

src/main/java/Deadline.java

@@ -0,0 +1,13 @@
+public class Deadline extends Task {


JavaDoc comments of classes and functions would be nice.

Austintjh19 · 2024-02-06T17:24:29Z

src/main/java/Event.java

+    @Override
+    public String toString() {
+        return "[E]" + super.toString() + " (from: " + this.from + " to: " + this.to + ")";
+


Trailing whitespaces are quite prevalent in your code. Just remove them and you're good.

This reverts commit 10347a1.

This reverts commit 5857864.

…gStandards with the master branch

ChillinRage · 2024-02-12T09:54:33Z

src/main/java/luke/parser/Parser.java

+import luke.exception.FileException;
+import luke.exception.LukeException;
+import luke.exception.TaskException;
+import luke.task.*;


Would it be better if you split the wildcard import and instead import each module explicitly?

ChillinRage · 2024-02-12T09:55:22Z

src/main/java/luke/parser/Parser.java

+     * @param ui The user interface.
+     * @param storage The storage of the tasks.
+     */
+    public void parse(TaskList list, Ui ui, Storage storage) {


Will a switch-case work better instead of if-else blocks?

ChillinRage · 2024-02-12T09:58:34Z

src/main/java/luke/parser/Parser.java

+        } else if (input.contains("delete")) {
+            try {
+                if (input.equals("delete")) {
+                    throw new LukeException("Hold up!! There must be a task to delete!\n"
+                            + "Please enter an index after " + input + ".");
+                }
+
+                try {
+                    String[] instruction = input.split(" ");
+                    String delete = instruction[0];
+
+                    if (!delete.equals("delete")) {
+                        throw new LukeException("Hold up!! I am sorry, but I don't know what you mean by that :'(");
+                    }


How about using ".startsWith("delete")" instead to check for commands? That way, you wouldn't need a separate if equals block.

ChillinRage · 2024-02-12T09:59:28Z

src/main/java/luke/parser/Parser.java

+                        // 6 is the index after "event ", so starts from index 6
+                        // -1 to remove the space before "/from"
+                        String description = input.substring(6, input.indexOf("/from") - 1);
+                        // +6 to remove the "/from " and start from the index after "/from "
+                        // -1 to remove the space before "/to"
+                        String from = input.substring(input.indexOf("/from") + 6, input.indexOf("/to") - 1);
+                        // +4 to remove the "/to " and start from the index after "/to "


I like that you use comments to explain the purpose of your code.

ChillinRage · 2024-02-12T10:00:03Z

src/main/java/luke/task/Event.java

+import luke.exception.DateException;
+import luke.parser.DateTimeParser;
+
+import java.time.LocalDateTime;
+import java.time.format.DateTimeFormatter;


I like that you separated the imports by packages.

ChillinRage · 2024-02-12T10:01:46Z

src/main/java/luke/ui/Ui.java

Would it be better to have a separate function of constant variable to print the horizontal lines instead?

Ensuring consistent coding standards is crucial for code quality and readability. Applied CheckStyle rules to the entire codebase. Resolved CheckStyle violations related to indentation, naming conventions, and coding style. Enforcing CheckStyle rules ensures a clean and consistent codebase, making it easier to maintain and understand.

The readTask() method is too long. To enhance code maintainability and readability, it is necessary to address the existing method's length and complexity. Using a new method handleMarkOrUnmark(), to handle the conditional statement to shorten the method length and make it more readable.

The current situation lacks assumption in the Storage and Luke classes. Introduce assertions at various points to ensure that important assumptions are made before running the rest of the code.

Add assertions into Storage and Luke classes

Add more methods to separate and shorten the parse method

damithc and others added 11 commits January 7, 2024 18:33

docs/README.md: Tweak document template

55f9f9f

Let's tweak the docs/README.md (which is used as the user guide) to fit Duke better. Specifically, 1. mention product name in the title 2. mention adding a product screenshot and a product intro 3. tweak the flow to describe feature-by-feature

Add Gradle support

f837ddb

Bump gradle and lib version

a6f7324

Level 0. Rename, Greet, Exit

ce92999

Level 1. Echo

6027b54

Level 2. Add, List

3978fe8

Level 3. Mark as Done

9469460

Level 4. ToDos, Events, Deadlines

ea26f80

A-TextUiTesting: Automated Text UI Testing

8eab31f

Level 5. Handle Errors

cb2fd36

Level 6. Delete

7c64367

jasperng-nus changed the title ~~jasperng-nus IP~~ [jasperng] IP Feb 5, 2024

jasperng-nus changed the title ~~[jasperng] IP~~ [jasperng] iP Feb 5, 2024

Austintjh19 reviewed Feb 6, 2024

View reviewed changes

jasperng-nus added 15 commits February 7, 2024 18:43

Level 7. Save

64d9047

Merge branch 'branch-Level-7'

9fafe6f

Level 8. Dates and Times

4a7ddf1

Merge branch 'branch-Level-8'

66148d1

A-MoreOOP: Use More OOP

10347a1

Revert "A-MoreOOP: Use More OOP"

5857864

This reverts commit 10347a1.

Revert "Revert "A-MoreOOP: Use More OOP""

e095358

This reverts commit 5857864.

A-Packages: Organize into Packages

cd3d963

Merge branch 'branch-A-Packages'

9df2089

Merge branch 'add-gradle-support'

1073fd3

A-Gradle: Use Gradle

5863631

Merge branch 'add-gradle-support'

8fd3892

A-JUnit: Add JUnit Tests

3b436bb

Merge branch 'branch-A-JUnit'

d06f8cc

A-JavaDoc: JavaDoc

3e6b152

jasperng-nus added 4 commits February 8, 2024 10:55

A-CodingStandard: Follow the Coding Standard

e7a5407

Level 9. Find

8abadf7

Merge branch 'branch-Level-9'

e54a79a

Merge Conflict: combined both the branch-A-JavaDoc and branch-A-Codin…

072fb1f

…gStandards with the master branch

ChillinRage reviewed Feb 12, 2024

View reviewed changes

jasperng-nus and others added 16 commits February 16, 2024 08:56

Level 10. GUI

e957f81

Merge conflict: some changes have not been committed.

1b4ca1a

Merge branch 'branch-Level-10'

a799c9c

Merge branch 'A-CheckStyle'

aef80cc

Add assertions into Storage and Luke classes

c7da514

The current situation lacks assumption in the Storage and Luke classes. Introduce assertions at various points to ensure that important assumptions are made before running the rest of the code.

Merge pull request #2 from jasperng-nus/branch-A-Assertions

62d3425

Add assertions into Storage and Luke classes

fix: files are the same but shown as different

96f6a55

Merge branch 'master' of https://github.com/jasperng-nus/ip

bd73516

Add more methods to separate and shorten the parse method

574a288

Merge pull request #3 from jasperng-nus/branch-A-CodeQuality

c29d284

Add more methods to separate and shorten the parse method

Add a help page to guide the user on the commands to use

6046bb4

Add the Product Screenshot

8a84c77

Merge branch 'master' of https://github.com/jasperng-nus/ip

00c11eb

Add a User Guide

c28cee8

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[jasperng] iP #461

[jasperng] iP #461

jasperng-nus commented Feb 5, 2024 •

edited

Loading

Austintjh19 left a comment

Austintjh19 Feb 6, 2024

Austintjh19 Feb 6, 2024

Austintjh19 Feb 6, 2024

Austintjh19 Feb 6, 2024

Austintjh19 Feb 6, 2024

Austintjh19 Feb 6, 2024

Austintjh19 Feb 6, 2024

Austintjh19 Feb 6, 2024

Austintjh19 Feb 6, 2024

Austintjh19 Feb 6, 2024

Austintjh19 left a comment

Austintjh19 Feb 6, 2024

Austintjh19 Feb 6, 2024

ChillinRage Feb 12, 2024

ChillinRage Feb 12, 2024

ChillinRage Feb 12, 2024

ChillinRage Feb 12, 2024

ChillinRage Feb 12, 2024

ChillinRage Feb 12, 2024

		@@ -0,0 +1,13 @@
		public class Deadline extends Task {
		protected String by;

		@@ -0,0 +1,5 @@
		public class TaskException extends Exception {

[jasperng] iP #461

Are you sure you want to change the base?

[jasperng] iP #461

Conversation

jasperng-nus commented Feb 5, 2024 • edited Loading

Luke

Austintjh19 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Austintjh19 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

Choose a reason for hiding this comment

jasperng-nus commented Feb 5, 2024 •

edited

Loading