Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Ryan Chew] Duke Increments #355

Open
wants to merge 50 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
50 commits
Select commit Hold shift + click to select a range
65f72a8
Add support for Gradle workflow
j-lum Aug 6, 2019
0112efe
Add sample checkstyle configuration
j-lum Aug 12, 2019
7faa65a
Added Greet, Echo, Exit features
iltep64 Aug 16, 2019
46c55c6
Implement list add and show features.
iltep64 Aug 23, 2019
94b4414
Created Task class to represent tasks.
iltep64 Aug 23, 2019
4cec14a
Implemented marking a task as done.
iltep64 Aug 23, 2019
013cc37
Refactor IO interface into DukeIO instance, and Duke logic into objec…
iltep64 Aug 23, 2019
9303e1d
Implement deadline task class and addition logic
iltep64 Aug 23, 2019
5abe5d0
Refactor out and improve task-adding logic.
iltep64 Aug 23, 2019
11f4134
Create a uniform command interface, with parsing logic.
iltep64 Aug 23, 2019
3ec4d4e
Implement dialog block logic, so messages get aggregated into a singl…
iltep64 Aug 23, 2019
b79c5c0
Add header to list command output.
iltep64 Aug 23, 2019
3a0d632
Add Event task and make it available by the 'event' command.
iltep64 Aug 23, 2019
0139127
Add basic error handling support.
iltep64 Aug 24, 2019
16718fb
Added deletion functionality.
iltep64 Aug 24, 2019
8dd4b9b
Implement basic JSON decoder
iltep64 Aug 27, 2019
d7e9187
Add basic JSON writer
iltep64 Aug 27, 2019
501ae91
Add type registry for JSON serializiation
iltep64 Aug 28, 2019
9880921
Add convenience functions for JSON encoding/decoding.
iltep64 Aug 30, 2019
db72071
Refactor task types to enums
iltep64 Aug 30, 2019
6ca4441
Add JSON builder class for Tasks
iltep64 Sep 2, 2019
1cf63ce
Add listOf function, and produce ArrayList<> values instead of just L…
iltep64 Sep 2, 2019
f5ccf6e
Use JSON to load/store task list
iltep64 Sep 2, 2019
a0d17c1
Fix completed status not being loaded
iltep64 Sep 2, 2019
0b162a2
Add date parsing logic
iltep64 Sep 2, 2019
c842c6f
Have EventTask and DeadlineTask to use date logic.
iltep64 Sep 2, 2019
355f065
Merge branch 'branch-Level-7'
iltep64 Sep 2, 2019
93b6e1c
Merge branch 'branch-Level-8'
iltep64 Sep 2, 2019
dce444a
Add encoder lookup cache for Registry, and avoid printing debug messages
iltep64 Sep 2, 2019
45172d8
Move all classes into (sub)packages of org.duke
iltep64 Sep 2, 2019
9f28efa
Add task find command
iltep64 Sep 2, 2019
ed5ea49
Reformat code to satisfy standards
iltep64 Sep 3, 2019
8c16531
Add javadocs to public classes and methods.
iltep64 Sep 3, 2019
c907b2c
Merge branch 'branch-Level-9'
iltep64 Sep 3, 2019
c5eee9a
Merge branch 'codingstandard'
iltep64 Sep 3, 2019
af1b0d4
Merge branch 'javadocs'
iltep64 Sep 3, 2019
7e2227e
Merge branch 'gradle'
iltep64 Sep 3, 2019
e0b6066
Add JAR build plugin.
iltep64 Sep 3, 2019
63d9c81
Add tests for Command and DateParser, and automate via Gradle.
iltep64 Sep 3, 2019
3bfe760
Refactor out IO and command parsing.
iltep64 Sep 3, 2019
1e6e594
Implement a basic JavaFX UI.
iltep64 Sep 3, 2019
31fb5b4
Merge branch 'branch-Level-10'
iltep64 Sep 3, 2019
b04abda
Encapsulate Command fields.
iltep64 Sep 10, 2019
354adca
Beautify DukeFx UI, by adding colored message boxes for Duke and user.
iltep64 Sep 17, 2019
f653e2d
Extract command handlers into their own classes, and add a help command.
iltep64 Sep 17, 2019
7ea74be
Refactor storage out into own class, and improve CounterDecorator.
iltep64 Sep 17, 2019
00772ef
Refactored JavaFX UI to use FXML custom components.
iltep64 Sep 17, 2019
6d9eb22
Fix JavaFX startup classpath issues.
iltep64 Sep 17, 2019
1eebc7b
Add user guide/documentation.
iltep64 Sep 17, 2019
b508421
Set theme jekyll-theme-slate
iltep64 Sep 17, 2019
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 52 additions & 0 deletions src/main/java/Command.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
import java.util.Map;
import java.util.HashMap;
import java.util.regex.Pattern;
public class Command {
public final String type;
public final String arguments;
public final Map<String,String> namedArguments;

public Command(String type, String arguments, Map<String, String> namedArguments) {
this.type = type;
this.arguments = arguments;
this.namedArguments = namedArguments;
}

private static final Pattern switchBoundary = Pattern.compile("\\s+/");
private static final Pattern cmdBoundary = Pattern.compile("\\s+");

public static Command parse(String input) {
input = input.trim();

//Split on the presence of any switches
String[] splits = switchBoundary.split(input);

//First split value is "cmd-type args..."
String[] mainArgs = cmdBoundary.split(splits[0], 2);
if(mainArgs[0].isEmpty()) {
return null;
}

String type = mainArgs[0];
//If no arguments, leave as empty string
String arguments = mainArgs.length > 1 ? mainArgs[1] : "";
Map<String, String> namedArguments = new HashMap<>();

if(splits.length > 1) {
//Each split value is "switch-name args..."
//with no preceding slash
for(int i=1;i<splits.length;i++) {

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it would be more readable to include spaces to become for (int i = 1; i < splits.length; i++)

if(splits[i].isEmpty()) {
continue;
}
//Split at first whitespace
String[] switchArgs = cmdBoundary.split(splits[i], 2);
String switchName = switchArgs[0];
//If no arguments, leave as empty string
String switchArguments = switchArgs.length > 1 ? switchArgs[1] : "";
namedArguments.put(switchName, switchArguments);

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I find it a bit confusing to use HashMap and pass them around as there would be a need to remember the keys. May I know why you decided to proceed with it?

}
}
return new Command(type, arguments, namedArguments);
}
}
13 changes: 13 additions & 0 deletions src/main/java/CounterDecorator.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
import java.util.function.Function;

class CounterDecorator implements Function<String, String> {

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like that you create a class to format the string representation of a Task.

private int counter;
public CounterDecorator(int start) {
this.counter = start;
}
public String apply(String str) {
String ret = String.format("%d: %s", this.counter, str);
this.counter++;
return ret;
}
}
19 changes: 19 additions & 0 deletions src/main/java/DeadlineTask.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
public class DeadlineTask extends Task {
private final String deadline;

public DeadlineTask(String task, String deadline) {
super(task);
this.deadline = deadline;
}

@Override
protected String getTypeMarker() {
return "[D]";
}

@Override
public String toString() {
String baseDescription = super.toString();
return String.format("%s (by: %s)", baseDescription, deadline);
}
}
107 changes: 101 additions & 6 deletions src/main/java/Duke.java
Original file line number Diff line number Diff line change
@@ -1,10 +1,105 @@
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.function.Predicate;

public class Duke {

private static final String[] initialGreeting = new String[]{
"Hello! I'm Duke",
"What can I do for you?"
};

private DukeIO io;
private final List<Task> taskList;

private void addTask(Task t) {
this.taskList.add(t);
this.io.say(
"Got it. I've added this task:",
" " + t,
String.format("Now you have %d task%s in the list.",
this.taskList.size(),
this.taskList.size() == 1 ? "" : "s")
);
}

private boolean handleBye(Command input) {
this.io.say("Bye. Hope to see you again soon!");
return true;
}

private boolean displayList(Command input) {
this.io.say(this.taskList.stream()
.map(Object::toString)
.map(new CounterDecorator(1))
.iterator());
return false;
}

private boolean makeDeadlineTask(Command input) {
String description = input.arguments;
String deadline = input.namedArguments.get("by");
if(deadline == null) {
deadline = "unknown";
}

DeadlineTask task = new DeadlineTask(description, deadline);

this.addTask(task);
return false;
}
private boolean makeToDoTask(Command input) {
this.addTask(new Task(input.arguments));
return false;
}

private boolean markAsDone(Command input) {
int index;
try {
index = Integer.parseInt(input.arguments);
} catch(NumberFormatException e) {
this.io.say("Index provided was not an integer!");
return false;
}

if(index < 0 || index > this.taskList.size()) {
this.io.say("There's no task with that index!");
return false;
}

Task selectedTask = this.taskList.get(index-1);
selectedTask.markComplete();
this.io.say("Nice! I've marked this task as done:",
" " + selectedTask);
return false;
}

private Duke() {
this.io = new DukeIO();
//Bind command handlers
this.io.bindCommand("list", this::displayList);
this.io.bindCommand("done", this::markAsDone);
this.io.bindCommand("bye", this::handleBye);
this.io.bindCommand("deadline", this::makeDeadlineTask);
this.io.bindCommand("todo", this::makeToDoTask);

this.taskList = new ArrayList<>();
}

private void run() {
//Start off greeting the user.
this.io.say(initialGreeting);

//Start listen loop.
this.io.listen();
}

public static void main(String[] args) {
String logo = " ____ _ \n"
+ "| _ \\ _ _| | _____ \n"
+ "| | | | | | | |/ / _ \\\n"
+ "| |_| | |_| | < __/\n"
+ "|____/ \\__,_|_|\\_\\___|\n";
System.out.println("Hello from\n" + logo);
Duke duke = new Duke();
duke.run();
}
}
73 changes: 73 additions & 0 deletions src/main/java/DukeIO.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
import java.util.Arrays;
import java.util.Iterator;
import java.util.HashMap;
import java.util.Map;
import java.util.Scanner;
import java.util.function.Predicate;

public class DukeIO {

private static final String lineRule =
"____________________________________________________________";

private final Map<String, Predicate<Command>> commandMap
= new HashMap<>();
private Predicate<Command> defaultHandler = null;

private final Scanner scanner;

public DukeIO() {
this.scanner = new Scanner(System.in);
}

public void say(String... lines) {
say(Arrays.asList(lines).iterator());
}
public void say(Iterator<String> lines) {
//Print start of reply line
System.out.println(lineRule);

//Print each given line
while(lines.hasNext()) {
System.out.println(lines.next());
}

//Print end of reply line, and extra empty line
System.out.println(lineRule);
System.out.println();
}

public void bindCommand(String command, Predicate<Command> handler) {
this.commandMap.put(command, handler);
}

public void setUnknownCommandHandler(Predicate<Command> handler) {
this.defaultHandler = handler;
}

public void listen() {
//While there is still input from user
while(scanner.hasNextLine()) {
//Read single line of user input, and remove extra spaces
String userInput = scanner.nextLine();

Command command = Command.parse(userInput);

Predicate<Command> cmdHandler = commandMap.get(command.type);
boolean shouldExit;
if(cmdHandler != null) {
shouldExit = cmdHandler.test(command);
} else if(defaultHandler != null) {
shouldExit = defaultHandler.test(command);
} else {
say(String.format("Unknown command %s", command.type));
shouldExit = false;
}

if(shouldExit) {
break;
}
}
}

}
33 changes: 33 additions & 0 deletions src/main/java/Task.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
public class Task {
private final String description;
private boolean completed;

public Task(String description) {
this.description = description;
this.completed = false;
}

public void markComplete() {
this.completed = true;
}

public boolean isCompleted() {
return this.completed;
}

private static final String completedMarker = "[✓]";
private static final String incompleteMarker = "[✗]";

protected String getTypeMarker() {
return "[T]";
}

private String getCompleteMarker() {
return this.completed ? completedMarker : incompleteMarker;
}

@Override
public String toString() {
return this.getTypeMarker() + this.getCompleteMarker() + ' ' + this.description;
}
}