[Darkarche3]iP #289

Darkarche3 · 2024-01-31T05:27:55Z

AreaPro

“Your mind is for having ideas, not holding them.” – David Allen (source)

AreaPro frees your mind of having to remember things you need to do. It's,

text-based
+easy to learn
~~Fast~~ SUPER FAST to use

All you need is to

download it from here
double-click it.
add your tasks.
let it manage your tasks for you 💯

It is also FREE!

Features include:

Managing tasks
Managing deadlines
Reminders (coming soon)

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) throws Exception {
        new Area("./storage/duke.txt").run();
    }
}

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

SimHanKiong

LGTM, just a few coding standard violations.

SimHanKiong · 2024-02-06T07:31:58Z

src/main/java/Duke.java

@@ -1,10 +1,100 @@
+import java.util.ArrayList;
+import java.util.Scanner;
 public class Duke {


Maybe can change the class name to your bot's name?

Thanks. I will do so!

SimHanKiong · 2024-02-06T07:33:55Z

src/main/java/Duke.java

+        while(true){
+            if(sc.hasNextLine()) {
+                // checks if there is another instruction
+                instruction = sc.nextLine();
+            }else{
+                // ends conversation
+                sc.close();
+                break;
+            }
+            if(instruction.equals("bye")){ // command to end chat with chatbot
+                System.out.println("Bye. Hope to see you again soon!");
+                break;
+            }else if(instruction.equals("list")){
+                // lists out all tasks
+                for(int i=0;i<count;i++){
+                        System.out.println(i + 1 + "." + storage.get(i).toString());
+                }
+                System.out.println();
+            }else if(instruction.contains("unmark")){
+                // marks a specific task as undone
+                String[] arr = instruction.split(" ");
+                int num = Integer.parseInt(arr[1]) - 1; // task to be unmarked
+                storage.get(num).taskUndone(); //marks a task as done
+                System.out.println("OK, I've marked this task as not done yet:\n " +
+                        storage.get(num).toString());
+            }else if(instruction.contains("mark")){
+                // marks a task as done
+                String[] arr = instruction.split(" "); // splits the task into individual word
+                int num = Integer.parseInt(arr[1]) - 1; // task to be unmarked
+                storage.get(num).taskDone(); // marks a task as done
+                System.out.println("Nice! I've marked this task as done:\n " +
+                        storage.get(num).toString());
+            }else if(instruction.contains("deadline")){
+                if(instruction.equals("deadline")){
+                    // throws error for incomplete instruction
+                    DukeException error = new DukeException(instruction);
+                    System.out.println(error.toString());
+                }else {
+                    String[] arr = instruction.split(" /by "); // splits the task into description and deadline
+                    storage.add(new Deadline(arr[0].substring(9), arr[1]));
+                    count++; // keep track of number of tasks
+                    System.out.println("Got it. I've added this task:\n" + storage.get(count - 1).toString()
+                            + "\n" + "Now you have " + count + " tasks in the list" + ".\n");
+                }
+            }else if(instruction.contains("todo")){
+                if(instruction.equals("todo")){
+                    // throws error for incomplete instruction
+                    DukeException error = new DukeException(instruction);
+                    System.out.println(error.toString());
+                }else {
+                    storage.add(new Todo(instruction.substring(5)));
+                    count++; //keep track of number of tasks
+                    System.out.println("Got it. I've added this task:\n" + storage.get(count - 1).toString()
+                            + "\n" + "Now you have " + count + " tasks in the list" + ".\n");
+                }
+            }else if(instruction.contains("event")){
+                if(instruction.equals("event")){
+                    // throw error for incomplete instruction
+                    DukeException error = new DukeException(instruction);
+                    System.out.println(error.toString());
+                }else {
+                    String[] arr = instruction.split(" /from "); // split task into description and deadline
+                    String[] arr1 = arr[1].split(" /to "); // split deadline into from and to
+                    storage.add(new Event(arr[0].substring(6), arr1[0], arr1[1]));
+                    count++; // keeps track of tasks
+                    System.out.println("Got it. I've added this task:\n" + storage.get(count - 1).toString()
+                            + "\n" + "Now you have " + count + " tasks in the list" + ".\n");
+                }
+            }else if(instruction.contains("delete")){
+                String[] arr = instruction.split(" "); // split instruction into delete and index of item to be deleted
+                Task removal = storage.get(Integer.parseInt(arr[1]) - 1); // task to be removed
+                storage.remove(Integer.parseInt(arr[1]) - 1);
+                count -=1;
+                System.out.println("Noted. I've removed this task:\n" + removal.toString() + "\n" + "Now you have "
+                        + count + " tasks in the list.\n");
+
+            }else{
+                /*
+                any instruction that is not clear that has not
+                been covered
+                */
+                DukeException error = new DukeException(instruction);
+                System.out.println(error.toString());
+            }
+        }
    }


Maybe can indent your parenthesis based on the coding standard? Eg. while () and if ()

Thanks for pointing it out!

SimHanKiong · 2024-02-06T07:34:25Z

src/main/java/DukeException.java

+        if(this.description.equals("todo") || this.description.equals("deadline")||this.description.equals("event")){
+            return "Your input is incomplete. Please add more details for " + this.description + ".";
+        }else{
+            return "I do not understand your input.";
+        }


Maybe can indent your parenthesis based on the coding standard? Eg. while () and if ()

SimHanKiong · 2024-02-06T07:35:49Z

src/main/java/Deadline.java

+
+    @Override
+    public String toString() {
+        return "[D]" + super.toString() + " (by: " + by + ")";


I like how you called the super class method

joelgoh1

LGTM! Just a few nits to fix.

joelgoh1 · 2024-02-08T04:41:36Z

src/main/java/Duke.java

+        System.out.println("Hello! I'm Area.\n" +
+                "What can I do for you?\n");
+
+        boolean chatting = true;


Perhaps you could change the variable name to sound like a boolean to align better with naming practices

Suggested change

boolean chatting = true;

boolean isChatting = true;

joelgoh1 · 2024-02-08T04:43:39Z

src/main/java/Duke.java

+                System.out.println("Got it. I've added this task:\n" + storage.get(count - 1).toString()
+                        + "\n" + "Now you have " + count + " tasks in the list" + ".\n");
+            } else if (command.equals("deadline")) {
+                String[] arr = description.split(" /by "); // splits the task into description and deadline


Perhaps a more descriptive variable could be used?

joelgoh1 · 2024-02-08T04:45:02Z

src/main/java/Duke.java

 public class Duke {
+    static ArrayList<Task> storage;
+    static ArrayList<String> instructions = new ArrayList<String>();
+    static int count = 0;


Maybe a more explanatory name for count could be used to explain what this variable is counting?

Suggested change

static int count = 0;

static int taskCount = 0;

joelgoh1 · 2024-02-08T04:47:02Z

src/main/java/Task.java

+    /**
+     * sets work as done
+     */
+    public void taskDone() {


Maybe this could be worded more as a verb to indicate what this method is doing precisely?

Suggested change

public void taskDone() {

public void markTaskAsDone() {

will do so. Thank you for the help!

Following Git conventions can help make it easier to understand and follow the codebase. Any changes made will also be easy to understand.

The find method will help make it possible to quickly search for certain task based on keywords.

Updated comments to follow Coding standards to ensure it is easy to read for others.

TarinPairor · 2024-02-12T18:46:10Z

src/main/java/Duke.java

-                    storage[count] = new Event(arr[0].substring(6), arr1[0], arr1[1]);
-                    count++;
-                    System.out.println("Got it. I've added this task:\n" + storage[count - 1].toString()
+                    String[] arr = instruction.split(" /from "); // split task into description and deadline


Some variable names are not descriptive (like arr and arr1). Maybe more descriptive names are better. (This is hypocritical as I do the same)

TarinPairor · 2024-02-12T18:47:51Z

src/main/java/Duke.java

        while(true){
            if(sc.hasNextLine()) {
+                // checks if there is another instruction
                instruction = sc.nextLine();
            }else{


Small styling violation as, if I am not wrong, there should be a space between the brackets and the condition.

Suggested change

}else{

} else {

Level-10

Bug Fix: Add assert to minimise incorrect input. Certain classes use inputs to create Task object or child of Task object. Exceptions are used to tackle errors in input by user. However, assertions help internal logic check to ensure code functions correctly. For example, assert is used to check that deadline set is in the future and not in the past. Let's add assert statement to ensure that code logic. This ensure the the code gives correct output to user and there is no logic error when using chatbot.

improve security: Add assert to check for incorrect input

Improve Code Quality There was some code that did not meet coding standards. Modify certains part of the code to include proper spacing. Modify header comments to give a more accurate description of method This will help improve readability and quality of code.

Error while merging branches A-CodeQuality and master. This is resolved to allow the 2 branches to merge. Add assert statement to check count is greater than or equal to 0. This prevents count from negative.

Improved Code Quality

Task class: add priority As part of Week 5, need to allow chatbot to assign priority to task based on user. Add methods to allow priority to be changed based on user input Initialise priority as 0 when new Task is created. This allows easy change of priority for a particular task.

BCD Extension

Forgot to create branch-Level-10. Delete redundant method.

Added UI.png as part of week 6 task requirements Add Ui.png to docs folder.

Readme is incomplete. Updating Readme allows for user to understand how to use the chatbot. Update Readme by adding features of chatbot such as the commands. This is to make it easy and direct for users to understand what commands the chatbot can follow.

Junit Tests did not include Priority Changed tests to include Priority attribute in Task creation Update output in assertEquals in DeadlineTest

Fixed certain files to get the necessary error message or output Update the files to reflect these changes.

Error message was created when launching jar file Update createNewFile method to resolve error

Changed parsePriority method to return error message based on incorrect input Update parsePriority method

Removed AreaExeception.java class as it was redundant.

Updated javadocs so that all methods and classes had their respective javadocs comments.

Updated Javadocs Made some minor edits in code.

damithc and others added 13 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

Update Duke.java

11c23f1

Update Duke.java

67db755

new commit

d5d99ba

commit

7ab8cfa

commit

9168cd0

Level 4

a182b95

A-TextUITesting

4a7d6ec

Level-6

73fd420

A-TextUiTesting

dcc4e88

Readme

2951ae8

SimHanKiong reviewed Feb 6, 2024

View reviewed changes

Darkarche3 added 2 commits February 7, 2024 13:28

Level-7

f8fff56

Level-8

f310cf9

joelgoh1 reviewed Feb 8, 2024

View reviewed changes

Darkarche3 added 10 commits February 9, 2024 06:56

A-MoreOOP

a56ea79

A-Packages

58e9e97

Merge branch 'master' into add-gradle-support

50230f5

A-Gradle

2dde6a1

A-JUnit

dd41218

A-JavaDoc

827b375

Update coding standard

5fb1769

Following Git conventions can help make it easier to understand and follow the codebase. Any changes made will also be easy to understand.

Add find method

f50c691

The find method will help make it possible to quickly search for certain task based on keywords.

A-JavaDoc

5a495a2

Update to Comments

51a023b

Updated comments to follow Coding standards to ensure it is easy to read for others.

TarinPairor suggested changes Feb 12, 2024

View reviewed changes

Darkarche3 added 2 commits February 16, 2024 03:14

Level-10

b24aceb

Merge pull request #2 from Darkarche3/branch-A-CheckStyle

73242b6

Level-10

Darkarche3 added 18 commits February 22, 2024 20:29

Merge pull request #3 from Darkarche3/branch-A-Assertions

22c4163

improve security: Add assert to check for incorrect input

Improved Code Quality

c304230

Improve Code Quality There was some code that did not meet coding standards. Modify certains part of the code to include proper spacing. Modify header comments to give a more accurate description of method This will help improve readability and quality of code.

Update TaskList.java

770aa38

Error while merging branches A-CodeQuality and master. This is resolved to allow the 2 branches to merge. Add assert statement to check count is greater than or equal to 0. This prevents count from negative.

Merge branch 'master' into branch-A-CodeQuality

784f097

Merge pull request #4 from Darkarche3/branch-A-CodeQuality

d501c56

Improved Code Quality

Merge pull request #5 from Darkarche3/branch-BCD-Extension

6f2b08b

BCD Extension

Forgot to create branch-Level-10

bc9cd3d

Forgot to create branch-Level-10. Delete redundant method.

Add Ui.png

1cce413

Added UI.png as part of week 6 task requirements Add Ui.png to docs folder.

Update Readme.md

ec85b9b

Readme is incomplete. Updating Readme allows for user to understand how to use the chatbot. Update Readme by adding features of chatbot such as the commands. This is to make it easy and direct for users to understand what commands the chatbot can follow.

Update JUnit Tests

950f864

Junit Tests did not include Priority Changed tests to include Priority attribute in Task creation Update output in assertEquals in DeadlineTest

Update code to fix errors

3b4b9d4

Fixed certain files to get the necessary error message or output Update the files to reflect these changes.

Fix Storage createNewFile method

b51cf26

Error message was created when launching jar file Update createNewFile method to resolve error

Update Parser.java

524ea4c

Changed parsePriority method to return error message based on incorrect input Update parsePriority method

Remove AreaException.java

1034ed5

Removed AreaExeception.java class as it was redundant.

Update Javadocs

1e5f67c

Updated javadocs so that all methods and classes had their respective javadocs comments.

Update Javadocs

8fb5a90

Updated Javadocs Made some minor edits in code.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Darkarche3]iP #289

[Darkarche3]iP #289

Darkarche3 commented Jan 31, 2024 •

edited

Loading

SimHanKiong left a comment

SimHanKiong Feb 6, 2024

Darkarche3 Feb 9, 2024

SimHanKiong Feb 6, 2024

Darkarche3 Feb 9, 2024

SimHanKiong Feb 6, 2024

SimHanKiong Feb 6, 2024

joelgoh1 left a comment

joelgoh1 Feb 8, 2024

Darkarche3 Feb 9, 2024

joelgoh1 Feb 8, 2024

joelgoh1 Feb 8, 2024

Darkarche3 Feb 9, 2024

joelgoh1 Feb 8, 2024

Darkarche3 Feb 9, 2024

TarinPairor Feb 12, 2024

TarinPairor Feb 12, 2024

[Darkarche3]iP #289

Are you sure you want to change the base?

[Darkarche3]iP #289

Conversation

Darkarche3 commented Jan 31, 2024 • edited Loading

AreaPro

SimHanKiong 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

joelgoh1 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

Darkarche3 commented Jan 31, 2024 •

edited

Loading