[Joshua Chiang] iP #374

ChickenChiang · 2023-01-31T08:41:36Z

Cluck! 🐔

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

Cluck! helps you keep track of your tasks, so you can go about your day by putting all your eggs in one basket.

text-based
easy to use
fun and interactive
Faster than a chicken can cross the road! :

All you need to do is:

Download it here
Start running Cluck!
Add your tasks
Let Cluck! handle the rest

Did we mention it was FREE?!

Features:

Managing Task
Find Tasks
Sort by date (coming soon!)

If you 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 Cluck("Your_File_Directory_Here").run();
    }
}

Implement a skeletal version of Cluck that starts by greeting the user, simply echos commands entered by the user, and exits when the user types bye.

…tion, 2. Deadlines with description and due date, 3. Events with description, start and end time

Use the input/output redirection technique to semi-automate the testing of Duke(or rather, CLUCK)

Adding exception classes to handle errors by Duke

Now you can delete tasks from the todo list with Cluck. Tasks are also now stored in an ArrayList.

Jun-How

In terms of coding standard, it looks mostly fine, except a few naming issues and unnecessary white spaces.
Some improvements requested below.

Jun-How · 2023-01-31T14:19:43Z

src/main/java/Duke.java

+    static private final String MAKE_DEADLINE = "deadline";
+    static private final String MAKE_TODO = "todo";
+    static private final String MAKE_EVENT = "event";
+    static private final String DUE_DATE_FLAG = "/by ";
+    static private final String EVENT_START_FLAG = "/from ";
+    static private final String EVENT_END_FLAG = "/to ";


Should the "static" keyword come before the access modifier ("private" in this case)?
private static final might be the preferred format.

Namings align with the coding standard, which is great!

Jun-How · 2023-01-31T14:25:50Z

src/main/java/Deadline.java

+        return this.isMarked
+                ? String.format("[D][X] %1$s (by: %2$s)", this.description, this.dueDate)
+                : String.format("[D][ ] %1$s (by: %2$s)", this.description, this.dueDate);


Could this method make use of abstraction so that the toString() method in the parent class Task could be used here? Then, you would only need to add the correct task icon ("D" for Deadline here) and the due date, making it easier to read.

Jun-How · 2023-01-31T14:40:11Z

src/main/java/Duke.java

+        boolean loop = true;
+        List<Task> toDoList = new ArrayList<>();


Perhaps a better name could be used for the boolean name sound more like a boolean. toDoList could also be renamed to be more specific and descriptive of a container of multiple tasks.

Suggested change

boolean loop = true;

List<Task> toDoList = new ArrayList<>();

boolean isActive = true;

List<Task> tasks = new ArrayList<>();

Jun-How · 2023-01-31T14:43:26Z

src/main/java/Event.java

+        return this.isMarked
+                ? String.format("[E][X] %1$s (from:%2$s to:%3$s)", this.description, this.startTime, this.endTime)
+                : String.format("[E][ ] %1$s (from:%2$s to:%3$s)", this.description, this.startTime, this.endTime);


Similar to the comment under Deadline, perhaps this could make use of the toString() method in the parent class Task?

src/main/java/Duke.java

Jun-How · 2023-01-31T14:52:00Z

src/main/java/Duke.java

+                    System.out.println("    ____________________________________________________________");
+                    System.out.println("    You gotta give me a command!");
+                    System.out.println("    ____________________________________________________________");
+


Perhaps remove unnecessary white spaces between lines of code, such as within the switch statement? So that the format is standardised. This applies to some parts above too.

adam07018

Overall code is clean and nice

adam07018 · 2023-02-03T04:15:00Z

src/main/java/Duke.java

+    static private final String EVENT_END_FLAG = "/to ";
+
+    public static boolean isNumeric(String strNum) {
+        if (strNum == null) {


Love your code! Tidy and clean

adam07018 · 2023-02-03T04:18:31Z

src/main/java/Duke.java

+                        Integer itemNumber = Integer.parseInt(words[1]);
+                        if (itemNumber > toDoList.size() || itemNumber <= 0) {
+                            System.out.println("    ____________________________________________________________");
+                            System.out.println("    That's not...? In the list...? Buh caw?");


Interesting and Creative ui design

adam07018 · 2023-02-03T04:21:03Z

src/main/java/Duke.java

+        Scanner sc = new Scanner(System.in);
+
+        while (loop) {
+            String input = sc.nextLine();


Should we add a sc.close() at the end

Making the Task class abstract ensures that it cannot be instantiated. The new makeSaveFormat() function is an abstract method in Task, and it is overridden in each child class such that it returns a string that is formatted with respect to the child class for saving tasks.

Now the tasks in the todo list are saved into a txt file with consistent formmating with respect to the type of task. It also captures the status of the task, whether or not it is marked or unmarked.

Save the tasks in the hard disk automatically whenever the task list changes. Load the data from the hard disk when Cluck starts up.

…e and restructure of package Instead of saving the due dates of deadlines as strings they are now LocalDateTime objects which uses the java.time.LocalDateTime package

Added support for gradle to the project as well as denpendencies and tests

# Conflicts: # src/main/java/Deadline.java # src/main/java/Tasks/Task.java

# Conflicts: # src/main/java/Tasks/Task.java

Added Exceptions for better exception handling

To allow for better OOP and more packages down the line, the files have been renamed and restructured.

TaskList is created to handle task operations. TaskIndexOutOfBoundsException is thrown when a given index is out of the range of the taskList TaskNotFoundException is thrown when a task is not found within a taskList (function that throws this is yet to be implemented)

Branch fix user guide

Improve formatting of user guide

Fixing indentation levels

…nch-fixUserGuide

Branch fix user guide

The Cluck!.jar now creates a directory and a text file that saves the tasks of the user

Fixed saving issue for Cluck!

# Conflicts: # src/main/java/cluck/Cluck.java # src/main/java/cluck/storage/Storage.java

Make Cluck! close on bye command

Previous implementation to allow for more flexble parsing of date time given by the user cause some problems. In the previous commit I added optional patterns to allow for user to input various forms of date time, e.g. the user can input either 06, Jun, or June for a date on june. The user also has the option to omit the century of the year (i.e. the "20" in "2023") or minute of the time. The change in FORMATTER in the task class cause the toString() and makeSaveFormat() methods in Event and Deadline classes to format the LocalDateTime classes into the wrong format, as the FORMATTER's optional patterns are all used to format the LocalDateTime, resulting in strange date strings like "21 03MarMarc 202323 1200". To resolve the issue, I added an additional formatter by the name of default formatter where the DateTimeFormatter does not have optional patterns, and thus gives us consistent and correct string formats of the date when used by toString() and makeSaveFormat() methods.

Branch c natural dates

User guide now contains additional information about the newly added date time format

Updated user guide

Fix user guide formattiing

This class was a feature that was in progress, not to be committed in master

Branch c natural dates

damithc and others added 12 commits July 31, 2022 17:20

Add Gradle support

556af3f

git tag Level-1

013bad8

Greet, Echo, Exit

ad0950e

Implement a skeletal version of Cluck that starts by greeting the user, simply echos commands entered by the user, and exits when the user types bye.

Add, List

de5b7bb

Merge remote-tracking branch 'origin/master'

bfa99a9

Update .gitignore

29d0e64

Now you can mark tasks as done and change them back to not done

1220c06

Merge branch 'master' of https://github.com/ChickenChiang/ip

da609ba

Added the following types of tasks: 1. Todos, which only have descrip…

07c5ecc

…tion, 2. Deadlines with description and due date, 3. Events with description, start and end time

A-TextUiTesting

4e293ce

Use the input/output redirection technique to semi-automate the testing of Duke(or rather, CLUCK)

A-Exceptions

6290dbd

Adding exception classes to handle errors by Duke

Level-6 Delete and A-Collections

9392222

Now you can delete tasks from the todo list with Cluck. Tasks are also now stored in an ArrayList.

Jun-How suggested changes Jan 31, 2023

View reviewed changes

adam07018 reviewed Feb 3, 2023

View reviewed changes

ChickenChiang and others added 16 commits February 7, 2023 12:49

Added save functionality

e4ce66a

Now the tasks in the todo list are saved into a txt file with consistent formmating with respect to the type of task. It also captures the status of the task, whether or not it is marked or unmarked.

Level-7. Save

be7a1ad

Save the tasks in the hard disk automatically whenever the task list changes. Load the data from the hard disk when Cluck starts up.

Level-8. Added functionality for deadlines to understand date and tim…

58a0861

…e and restructure of package Instead of saving the due dates of deadlines as strings they are now LocalDateTime objects which uses the java.time.LocalDateTime package

Merge remote-tracking branch 'upstream/add-gradle-support'

26059d0

Using Gradle to automate building and testing for Cluck

d1feb10

Added support for gradle to the project as well as denpendencies and tests

Changes to checkstyle and addition of JUnit test classes

452abdb

Merge branch 'master' into branch-level-7

0ad8c0a

Merge branch 'branch-Level-8'

5c13de8

# Conflicts: # src/main/java/Deadline.java # src/main/java/Tasks/Task.java

Merge commit 'be7a1ad6d4dc6d185298f52a006cb21c7b77cf49'

5034f20

Merge branch 'branch-Level-8'

170bf64

# Conflicts: # src/main/java/Deadline.java # src/main/java/Tasks/Task.java

Merge branch 'master' of https://github.com/ChickenChiang/ip

f048683

# Conflicts: # src/main/java/Tasks/Task.java

Merge branch 'A-Exceptions'

bbc1346

Added Exceptions for better exception handling

Reformatting for files and adding messages as a class

e54f110

To allow for better OOP and more packages down the line, the files have been renamed and restructured.

Replaced text with strings from Messages package

52729dc

ChickenChiang added 30 commits March 14, 2023 14:10

Fixing anchor links and clarifying guide

74c06b1

Merge pull request #13 from ChickenChiang/branch-fixUserGuide

aafbd96

Branch fix user guide

Improve formatting of user guide

1a9fd8e

Merge pull request #14 from ChickenChiang/branch-fixUserGuide

e68d24a

Improve formatting of user guide

Fixing indentation levels

944c732

Merge pull request #15 from ChickenChiang/branch-fixUserGuide

84b8ddd

Fixing indentation levels

Fixing indentation AGAIN

cb8c4e1

Merge branch 'master' of https://github.com/ChickenChiang/ip into bra…

62511a4

…nch-fixUserGuide

Merge pull request #16 from ChickenChiang/branch-fixUserGuide

80113b4

Branch fix user guide

Fixed pathing issue for saved file

d71a7fb

The Cluck!.jar now creates a directory and a text file that saves the tasks of the user

Minor codestyle fixes in JUnit test classes

9eb5ee2

Merge pull request #18 from ChickenChiang/branch-FixSave

d99d9cb

Fixed saving issue for Cluck!

Merge branch 'master' into branch-C-NaturalDates

be0b09e

# Conflicts: # src/main/java/cluck/Cluck.java # src/main/java/cluck/storage/Storage.java

Allow for more flexibility when entering dates

a822193

no message

f086a15

Make Cluck! close on bye command

8d77a7e

Merge pull request #19 from ChickenChiang/branch-ExitGuiOnByeCommand

28f027b

Make Cluck! close on bye command

Merge branch 'master' into branch-C-NaturalDates

56086f7

Merge pull request #20 from ChickenChiang/branch-C-NaturalDates

975c908

Branch c natural dates

Updated user guide

feba5d8

User guide now contains additional information about the newly added date time format

Merge pull request #21 from ChickenChiang/branch-UpdateUserGuide

60c8347

Updated user guide

Fix user guide formattiing

7015e14

Merge pull request #22 from ChickenChiang/branch-UpdateUserGuide

abfe93f

Fix user guide formattiing

Delete Cluck!.zip

b329b64

Remove DateTimeHandler class

f99848d

This class was a feature that was in progress, not to be committed in master

Fix checkstyle errors

81ff40d

fix checkstyle

e3608e4

Merge branch 'master' into branch-C-NaturalDates

211bdb5

Merge pull request #23 from ChickenChiang/branch-C-NaturalDates

fe68fca

Branch c natural dates

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Joshua Chiang] iP #374

[Joshua Chiang] iP #374

ChickenChiang commented Jan 31, 2023 •

edited

Loading

Jun-How left a comment

Jun-How Jan 31, 2023

Jun-How Jan 31, 2023

Jun-How Jan 31, 2023

Jun-How Jan 31, 2023

Jun-How Jan 31, 2023

adam07018 left a comment

adam07018 Feb 3, 2023

adam07018 Feb 3, 2023

adam07018 Feb 3, 2023

		boolean loop = true;
		List<Task> toDoList = new ArrayList<>();

[Joshua Chiang] iP #374

Are you sure you want to change the base?

[Joshua Chiang] iP #374

Conversation

ChickenChiang commented Jan 31, 2023 • edited Loading

Cluck! 🐔

All you need to do is:

Features:

Jun-How 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

adam07018 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

ChickenChiang commented Jan 31, 2023 •

edited

Loading