zzkzzzz / ip Goto Github PK
View Code? Open in Web Editor NEWThis project forked from nus-cs2103-ay2122s2/ip
This project forked from nus-cs2103-ay2122s2/ip
@zzkzzzz We did an automated analysis of your code to detect potential areas to improve the code quality. We are sharing the results below, so that you can avoid similar problems in your tP code (which will be graded more strictly for code quality).
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.
No easy-to-detect issues
No easy-to-detect issues
No easy-to-detect issues
No easy-to-detect issues
No easy-to-detect issues
No easy-to-detect issues
Example from src/main/java/meep/parser/Parser.java
lines 37-107
:
public Command parseUserInput(String userInput, List<Task> tasks) throws InvalidInputException {
boolean isEmptyInput = userInput.trim().length() == 0;
if (isEmptyInput) {
throw new InvalidInputException(Messages.MESSAGE_EMPTY_INPUT);
}
String[] arr = userInput.split(" ", 2);
switch (arr[0]) {
case ExitCommand.COMMAND_WORD:
if (isValidCommandLength(ExitCommand.COMMAND_LENGTH, arr)) {
return new ExitCommand();
}
break;
case HelpCommand.COMMAND_WORD:
if (isValidCommandLength(HelpCommand.COMMAND_LENGTH, arr)) {
return new HelpCommand();
}
break;
case ListCommand.COMMAND_WORD:
if (isValidCommandLength(ListCommand.COMMAND_LIST_LENGTH, arr)) {
// list without date
return new ListCommand();
} else if (isValidCommandLength(ListCommand.COMMAND_LIST_DATE_LENGTH, arr)) {
// list with date given
return new ListCommand(true, parseDate(arr[1]));
}
break;
case MarkCommand.COMMAND_WORD:
if (isValidCommandLength(MarkCommand.COMMAND_LENGTH, arr)) {
int index = parseListIndex(arr[1], tasks);
assert index >= 0 && index < tasks.size() : Messages.MESSAGE_OUTBOUND_NUMBER;
return new MarkCommand(index);
}
break;
case UnmarkCommand.COMMAND_WORD:
if (isValidCommandLength(UnmarkCommand.COMMAND_LENGTH, arr)) {
int index = parseListIndex(arr[1], tasks);
assert index >= 0 && index < tasks.size() : Messages.MESSAGE_OUTBOUND_NUMBER;
return new UnmarkCommand(index);
}
break;
case DeleteCommand.COMMAND_WORD:
if (isValidCommandLength(DeleteCommand.COMMAND_LENGTH, arr)) {
int index = parseListIndex(arr[1], tasks);
assert index >= 0 && index < tasks.size() : Messages.MESSAGE_OUTBOUND_NUMBER;
return new DeleteCommand(index);
}
break;
case AddCommand.COMMAND_TODO:
ToDo todo = parseTodoCommand(arr);
return new AddCommand(todo);
// Fallthrough
case AddCommand.COMMAND_DEADLINE:
Deadline deadline = parseDeadlineCommand(arr);
return new AddCommand(deadline);
// Fallthrough
case AddCommand.COMMAND_EVENT:
Event event = parseEventCommand(arr);
return new AddCommand(event);
// Fallthrough
case FindCommand.COMMAND_WORD:
if (isValidCommandLength(FindCommand.COMMAND_LENGTH, arr)) {
return new FindCommand(arr[1]);
}
break;
default:
throw new InvalidInputException(Messages.MESSAGE_INVALID_FORMAT);
}
throw new InvalidInputException(Messages.MESSAGE_INVALID_FORMAT);
}
Example from src/main/java/meep/ui/Gui.java
lines 54-129
:
public void start(Stage stage) {
//Step 1. Setting up required components
//The container for the content of the chat to scroll.
scrollPane = new ScrollPane();
dialogContainer = new VBox();
scrollPane.setContent(dialogContainer);
userInput = new TextField();
sendButton = new Button();
AnchorPane mainLayout = new AnchorPane();
mainLayout.getChildren().addAll(scrollPane, userInput, sendButton);
scene = new Scene(mainLayout);
stage.setScene(scene);
stage.show();
//Step 2. Formatting the window to look as expected
stage.setTitle("Meep");
stage.setResizable(false);
stage.setMinHeight(6000.0);
stage.setMinWidth(400.0);
mainLayout.setPrefSize(400.0, 600.0);
scrollPane.setPrefSize(385, 535);
scrollPane.setHbarPolicy(ScrollPane.ScrollBarPolicy.NEVER);
scrollPane.setVbarPolicy(ScrollPane.ScrollBarPolicy.ALWAYS);
scrollPane.setVvalue(1.0);
scrollPane.setFitToWidth(true);
// You will need to import `javafx.scene.layout.Region` for this.
dialogContainer.setPrefHeight(Region.USE_COMPUTED_SIZE);
userInput.setPrefWidth(325.0);
sendButton.setPrefWidth(55.0);
AnchorPane.setTopAnchor(scrollPane, 1.0);
AnchorPane.setBottomAnchor(sendButton, 1.0);
AnchorPane.setRightAnchor(sendButton, 1.0);
AnchorPane.setLeftAnchor(userInput, 1.0);
AnchorPane.setBottomAnchor(userInput, 1.0);
//Step 3. Add functionality to handle user input.
sendButton.setOnMouseClicked((event) -> {
dialogContainer.getChildren().add(getDialogLabel(userInput.getText()));
userInput.clear();
});
userInput.setOnAction((event) -> {
dialogContainer.getChildren().add(getDialogLabel(userInput.getText()));
userInput.clear();
});
//Scroll down to the end every time dialogContainer's height changes.
dialogContainer.heightProperty().addListener((observable) -> scrollPane.setVvalue(1.0));
//Part 3. Add functionality to handle user input.
sendButton.setOnMouseClicked((event) -> {
handleUserInput();
});
userInput.setOnAction((event) -> {
handleUserInput();
});
}
Suggestion: Consider applying SLAP (and other abstraction mechanisms) to shorten methods. You may ignore this suggestion if you think a longer method is justified in a particular case.
No easy-to-detect issues
Example from src/main/java/meep/task/Task.java
lines 67-69
:
/**
* To String.
*/
Example from src/main/java/meep/textui/Ui.java
lines 51-53
:
/**
* Print logo.
*/
Example from src/main/java/meep/textui/Ui.java
lines 62-64
:
/**
* Print bye.
*/
Suggestion: Ensure method/class header comments follow the format specified in the coding standard, in particular, the phrasing of the overview statement.
No easy-to-detect issues
No easy-to-detect issues
[email protected]
if you want to follow up on this post.
@zzkzzzz 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.
No easy-to-detect issues
No easy-to-detect issues
No easy-to-detect issues
No easy-to-detect issues
No easy-to-detect issues
Example from src/test/java/meep/storage/StorageTest.java
lines 37-37
:
//String filePath = "/src/test/java/Meep/test.txt";
Example from src/test/java/meep/storage/StorageTest.java
lines 38-38
:
//String home = System.getProperty("user.dir");
Example from src/test/java/meep/storage/StorageTest.java
lines 39-39
:
//String path = home + filePath;
Suggestion: Remove dead code from the codebase.
Example from src/main/java/meep/parser/Parser.java
lines 136-217
:
public Command parseUserInput(String userInput, List<Task> tasks) throws InvalidInputException {
boolean isEmptyInput = userInput.trim().length() == 0;
if (isEmptyInput) {
throw new InvalidInputException(Messages.MESSAGE_EMPTY_INPUT);
}
String[] arr = userInput.split(" ", 2);
switch (arr[0]) {
case ExitCommand.COMMAND_WORD:
if (isValidCommandLength(ExitCommand.COMMAND_LENGTH, arr)) {
return new ExitCommand();
}
break;
case HelpCommand.COMMAND_WORD:
if (isValidCommandLength(HelpCommand.COMMAND_LENGTH, arr)) {
return new HelpCommand();
}
break;
case ListCommand.COMMAND_WORD:
if (isValidCommandLength(ListCommand.COMMAND_LIST_LENGTH, arr)) {
// list without date
return new ListCommand();
} else if (isValidCommandLength(ListCommand.COMMAND_LIST_DATE_LENGTH, arr)) {
// list with date given
return new ListCommand(true, parseDate(arr[1]));
}
break;
case MarkCommand.COMMAND_WORD:
if (isValidCommandLength(MarkCommand.COMMAND_LENGTH, arr)) {
int index = parseListIndex(arr[1], tasks);
assert index >= 0 && index < tasks.size() : Messages.MESSAGE_OUTBOUND_NUMBER;
return new MarkCommand(index);
}
break;
case UnmarkCommand.COMMAND_WORD:
if (isValidCommandLength(UnmarkCommand.COMMAND_LENGTH, arr)) {
int index = parseListIndex(arr[1], tasks);
assert index >= 0 && index < tasks.size() : Messages.MESSAGE_OUTBOUND_NUMBER;
return new UnmarkCommand(index);
}
break;
case DeleteCommand.COMMAND_WORD:
if (isValidCommandLength(DeleteCommand.COMMAND_LENGTH, arr)) {
int index = parseListIndex(arr[1], tasks);
assert index >= 0 && index < tasks.size() : Messages.MESSAGE_OUTBOUND_NUMBER;
return new DeleteCommand(index);
}
break;
case AddCommand.COMMAND_TODO:
if (isValidCommandLength(AddCommand.COMMAND_LENGTH, arr)) {
String taskTitle = checkEmptyTask(arr[1]);
assert taskTitle.length() > 0 : Messages.MESSAGE_EMPTY_TASK;
return new AddCommand(new ToDo(taskTitle));
}
break;
case AddCommand.COMMAND_DEADLINE:
String[] deadline = parseTaskFormat(arr[1]);
assert deadline.length == 2 : Messages.MESSAGE_INVALID_COMMAND_LENGTH;
String deadlineDate = checkPrepositionFormat(deadline[1], AddCommand.COMMAND_DEADLINE);
String deadlineTitle = checkEmptyTask(deadline[0]);
assert deadlineTitle.length() > 0 : Messages.MESSAGE_EMPTY_TASK;
return new AddCommand(new Deadline(deadlineTitle, parseDate(deadlineDate)));
// Fallthrough
case AddCommand.COMMAND_EVENT:
String[] event = parseTaskFormat(arr[1]);
assert event.length == 2 : Messages.MESSAGE_INVALID_COMMAND_LENGTH;
String eventDate = checkPrepositionFormat(event[1], AddCommand.COMMAND_EVENT);
String eventTitle = checkEmptyTask(event[0]);
assert eventTitle.length() > 0 : Messages.MESSAGE_EMPTY_TASK;
return new AddCommand(new Event(eventTitle, parseDate(eventDate)));
// Fallthrough
case FindCommand.COMMAND_WORD:
if (isValidCommandLength(FindCommand.COMMAND_LENGTH, arr)) {
return new FindCommand(arr[1]);
}
break;
default:
throw new InvalidInputException(Messages.MESSAGE_INVALID_FORMAT);
}
throw new InvalidInputException(Messages.MESSAGE_INVALID_FORMAT);
}
Example from src/main/java/meep/ui/Gui.java
lines 54-129
:
public void start(Stage stage) {
//Step 1. Setting up required components
//The container for the content of the chat to scroll.
scrollPane = new ScrollPane();
dialogContainer = new VBox();
scrollPane.setContent(dialogContainer);
userInput = new TextField();
sendButton = new Button();
AnchorPane mainLayout = new AnchorPane();
mainLayout.getChildren().addAll(scrollPane, userInput, sendButton);
scene = new Scene(mainLayout);
stage.setScene(scene);
stage.show();
//Step 2. Formatting the window to look as expected
stage.setTitle("Meep");
stage.setResizable(false);
stage.setMinHeight(6000.0);
stage.setMinWidth(400.0);
mainLayout.setPrefSize(400.0, 600.0);
scrollPane.setPrefSize(385, 535);
scrollPane.setHbarPolicy(ScrollPane.ScrollBarPolicy.NEVER);
scrollPane.setVbarPolicy(ScrollPane.ScrollBarPolicy.ALWAYS);
scrollPane.setVvalue(1.0);
scrollPane.setFitToWidth(true);
// You will need to import `javafx.scene.layout.Region` for this.
dialogContainer.setPrefHeight(Region.USE_COMPUTED_SIZE);
userInput.setPrefWidth(325.0);
sendButton.setPrefWidth(55.0);
AnchorPane.setTopAnchor(scrollPane, 1.0);
AnchorPane.setBottomAnchor(sendButton, 1.0);
AnchorPane.setRightAnchor(sendButton, 1.0);
AnchorPane.setLeftAnchor(userInput, 1.0);
AnchorPane.setBottomAnchor(userInput, 1.0);
//Step 3. Add functionality to handle user input.
sendButton.setOnMouseClicked((event) -> {
dialogContainer.getChildren().add(getDialogLabel(userInput.getText()));
userInput.clear();
});
userInput.setOnAction((event) -> {
dialogContainer.getChildren().add(getDialogLabel(userInput.getText()));
userInput.clear();
});
//Scroll down to the end every time dialogContainer's height changes.
dialogContainer.heightProperty().addListener((observable) -> scrollPane.setVvalue(1.0));
//Part 3. Add functionality to handle user input.
sendButton.setOnMouseClicked((event) -> {
handleUserInput();
});
userInput.setOnAction((event) -> {
handleUserInput();
});
}
Suggestion: Consider applying SLAP (and other abstraction mechanisms) to shorten methods. You may ignore this suggestion if you think a longer method is justified in a particular case.
No easy-to-detect issues
Example from src/main/java/meep/commands/Command.java
lines 18-23
:
/**
* Execute method should be implemented by child classes.
*
* @param tasks the task list.
* @return None
*/
Example from src/main/java/meep/storage/Storage.java
lines 72-79
:
/**
* Read task date file.
*
* @param path the path of the file.
* @return the list of tasks.
* @throws IOException If the file path is invalid.
* @throws InvalidInputException If the datetime format is invalid.
*/
Example from src/main/java/meep/task/Task.java
lines 52-54
:
/**
* Mark task isDone.
*/
Suggestion: Ensure method/class header comments follow the format specified in the coding standard, in particular, the phrasing of the overview statement
No easy-to-detect issues
[email protected]
if you want to follow up on this post.
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.