Sharing iP code quality feedback [for @Gu0Fengming] #1
Description
@Gu0Fengming We did an automated analysis of your code to detect potential areas to improve the code quality. We are sharing the results below, to help you improve the iP code further.
IMPORTANT: Note that the script looked for just a few easy-to-detect problems only, and at-most three example are given i.e., there can be other areas/places to improve.
Aspect: Tab Usage
No easy-to-detect issues 👍
Aspect: Naming boolean variables/methods
Example from src/main/java/Whiost.java lines 25-25:
boolean p = true;Suggestion: Follow the given naming convention for boolean variables/methods (e.g., use a boolean-sounding prefix).You may ignore the above if you think the name already follows the convention (the script can report false positives in some cases)
Aspect: Brace Style
No easy-to-detect issues 👍
Aspect: Package Name Style
No easy-to-detect issues 👍
Aspect: Class Name Style
No easy-to-detect issues 👍
Aspect: Dead Code
No easy-to-detect issues 👍
Aspect: Method Length
Example from src/main/java/Whiost.java lines 10-206:
public static void main(String[] args) {
String greeting = "Hello! I'm Whiost\nWhat can I do for you?\n";
String addTask = "Got it. I've added this task:";
String marked = "Nice! I've marked this task as done:";
String unmarked = "OK, I've marked this task as not done yet:";
String reportTask1 = "Now you have ";
String reportTask2 = " tasks in the list.";
String deleted = "Noted. I've removed this task:";
String error0 = "OOPS!!! I'm sorry, but I don't know what that means.";
String errorEmpty = "OOPS!!! The description cannot be empty.";
String errorNotFound = "OOPS!!! The task you select doesn't exist.";
String errorEmptyList = "OOPS!!! There's no task.";
System.out.println(greeting);
boolean p = true;
ArrayList<String> lst = new ArrayList<>();
ArrayList<String> typeLst = new ArrayList<>();
ArrayList<String> markLst = new ArrayList<>();
String[] monthTrans = {"Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"};
FileWriter data = null;
try {
File file = new File("./data/whiost.txt");
BufferedReader reader = new BufferedReader(new FileReader(file));
ArrayList<String> temp_lst = new ArrayList<>();
String line;
while ((line = reader.readLine()) != null) {
if (line.length() > 0) {
temp_lst.add(line.substring(0, line.length()));
} else {
temp_lst.add(line);
}
}
reader.close();
System.out.println(temp_lst);
int state = 0;
for (int i = 0; i < temp_lst.size(); i++) {
if (state == 0) {
state = 1;
typeLst.add(temp_lst.get(i));
} else if (state == 1) {
state = 2;
markLst.add(temp_lst.get(i));
} else {
state = 0;
lst.add(temp_lst.get(i));
}
}
System.out.println(typeLst);
System.out.println(markLst);
System.out.println(lst);
data = new FileWriter("./data/whiost.txt", false);
} catch (IOException e) {
System.out.println("Error reading the file: " + e.getMessage());
}
Scanner scanner = new Scanner(System.in);
while (p) {
String inp = scanner.nextLine();
if (inp.equals("todo") || inp.equals("todo ") ||
inp.equals("deadline") || inp.equals("deadline ") ||
inp.equals("event") || inp.equals("event ") ||
inp.equals("mark") || inp.equals("mark ") ||
inp.equals("unmark") || inp.equals("unmark ") ||
inp.equals("delete") || inp.equals("delete ")) {
System.out.println(errorEmpty);
continue;
} else if (inp.equals("bye")) {
p = false;
System.out.println("Bye. Hope to see you again soon!\n");
try {
if (data != null) {
data.close();
}
data = new FileWriter("./data/whiost.txt", false);
save(data, typeLst, markLst, lst);
data.close();
} catch (IOException e) {
System.out.println("Error writing to the file: " + e.getMessage());
}
} else if (inp.equals("list")) {
if (lst.size() == 0) {
System.out.println(errorEmptyList);
}
for (int i = 0; i < lst.size(); i++) {
System.out.println((i + 1) + "." + typeLst.get(i) + markLst.get(i) + " " + lst.get(i));
}
} else if (inp.length() >= 5 && inp.substring(0, 5).equals("todo ")) {
System.out.println(addTask);
typeLst.add("[T]");
markLst.add("[ ]");
lst.add(inp.substring(5));
System.out.println(" " + "[T]" + "[ ]" + " " + inp.substring(5));
System.out.println(reportTask1 + lst.size() + reportTask2);
try {
save(data, typeLst, markLst, lst);
} catch (IOException e) {
System.out.println("Error writing to the file: " + e.getMessage());
}
} else if (inp.length() >= 9 && inp.substring(0, 9).equals("deadline ")) {
System.out.println(addTask);
typeLst.add("[D]");
markLst.add("[ ]");
int pos = inp.indexOf("/");
String datePart = inp.substring(pos + 1);
if (datePart.length() >= 11 && datePart.charAt(7) == '-' && datePart.charAt(10) == '-') {
String taskDesc = inp.substring(9, pos);
int monthIndex = Integer.parseInt(datePart.substring(8, 10)) - 1;
String day = datePart.substring(11, 13);
String year = datePart.substring(3, 7);
String fullTask = taskDesc + "(by " + monthTrans[monthIndex] + " " + day + ", " + year + ")";
lst.add(fullTask);
System.out.println(" " + "[D]" + "[ ]" + " " + fullTask);
} else {
String taskDesc = inp.substring(9, pos);
String fullTask = taskDesc + "(" + inp.substring(pos + 1) + ")";
lst.add(fullTask);
System.out.println(" " + "[D]" + "[ ]" + " " + fullTask);
}
System.out.println(reportTask1 + lst.size() + reportTask2);
try {
save(data, typeLst, markLst, lst);
} catch (IOException e) {
System.out.println("Error writing to the file: " + e.getMessage());
}
} else if (inp.length() >= 6 && inp.substring(0, 6).equals("event ")) {
System.out.println(addTask);
typeLst.add("[E]");
markLst.add("[ ]");
int pos1 = inp.indexOf("/");
int pos2 = pos1 + 1 + inp.substring(pos1 + 1).indexOf("/");
String taskDesc = inp.substring(6, pos1);
String fromTime = inp.substring(pos1 + 5, pos2);
String toTime = inp.substring(pos2 + 4);
String fullTask = taskDesc + "(from:" + fromTime + " to:" + toTime + ")";
lst.add(fullTask);
System.out.println(" " + "[E]" + "[ ]" + fullTask);
System.out.println(reportTask1 + lst.size() + reportTask2);
try {
save(data, typeLst, markLst, lst);
} catch (IOException e) {
System.out.println("Error writing to the file: " + e.getMessage());
}
} else if (inp.length() >= 5 && inp.substring(0, 5).equals("mark ")) {
int pos = Integer.parseInt(inp.substring(5, 6)) - 1;
if (pos >= lst.size()) {
System.out.println(errorNotFound);
continue;
}
System.out.println(marked);
markLst.set(pos, "[X]");
System.out.println(" " + typeLst.get(pos) + markLst.get(pos) + " " + lst.get(pos));
try {
save(data, typeLst, markLst, lst);
} catch (IOException e) {
System.out.println("Error writing to the file: " + e.getMessage());
}
} else if (inp.length() >= 7 && inp.substring(0, 7).equals("unmark ")) {
int pos = Integer.parseInt(inp.substring(7, 8)) - 1;
if (pos >= lst.size()) {
System.out.println(errorNotFound);
continue;
}
System.out.println(unmarked);
markLst.set(pos, "[ ]");
System.out.println(" " + typeLst.get(pos) + markLst.get(pos) + " " + lst.get(pos));
try {
save(data, typeLst, markLst, lst);
} catch (IOException e) {
System.out.println("Error writing to the file: " + e.getMessage());
}
} else if (inp.length() >= 7 && inp.substring(0, 7).equals("delete ")) {
int pos = Integer.parseInt(inp.substring(7, 8)) - 1;
if (pos >= lst.size()) {
System.out.println(errorNotFound);
continue;
}
System.out.println(deleted);
System.out.println(" " + typeLst.get(pos) + markLst.get(pos) + lst.get(pos));
lst.remove(pos);
markLst.remove(pos);
typeLst.remove(pos);
System.out.println(reportTask1 + lst.size() + reportTask2);
try {
save(data, typeLst, markLst, lst);
} catch (IOException e) {
System.out.println("Error writing to the file: " + e.getMessage());
}
} else {
System.out.println(error0);
}
}
scanner.close();
}Suggestion: Consider applying SLAP (and other abstraction mechanisms) to shorten methods e.g., extract some code blocks into separate methods. You may ignore this suggestion if you think a longer method is justified in a particular case.
Aspect: Class size
No easy-to-detect issues 👍
Aspect: Header Comments
No easy-to-detect issues 👍
Aspect: Recent Git Commit Messages
No easy-to-detect issues 👍
Aspect: Binary files in repo
No easy-to-detect issues 👍
ℹ️ The bot account used to post this issue is un-manned. Do not reply to this post (as those replies will not be read). Instead, contact cs2103@comp.nus.edu.sg if you want to follow up on this post.